Product
Introducing License Enforcement in Socket
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
genkitx-github
Advanced tools
genkitx-github
is a community plugin for using GitHub Models APIs with
Firebase Genkit. Built by Xavier Portilla Edo.
This Genkit plugin allows to use GitHub models through their official APIs.
Install the plugin in your project with your favorite package manager:
npm install genkitx-github
yarn add genkitx-github
pnpm add genkitx-github
To use the plugin, you need to configure it with your GitHub Token key. You can do this by calling the configureGenkit
function:
import {github, openAIGpt4o} from "genkitx-github";
configureGenkit({
plugins: [
github({
githubToken: '<my-github-token>',
}),
],
logLevel: "debug",
enableTracingAndMetrics: true,
});
You can also intialize the plugin in this way if you have set the GITHUB_TOKEN
environment variable:
import {github, openAIGpt4o} from "genkitx-github";
configureGenkit({
plugins: [
github({}),
],
logLevel: "debug",
enableTracingAndMetrics: true,
});
The simplest way to call the text generation model is by using the helper function generate
:
import {github, openAIGpt4o} from "genkitx-github";
// Basic usage of an LLM
const response = await generate({
model: openAIGpt4o, // model imported from genkitx-github
prompt: 'Tell me a joke.',
});
console.log(await response.text());
// ...configure Genkit (as shown above)...
export const myFlow = defineFlow(
{
name: 'menuSuggestionFlow',
inputSchema: z.string(),
outputSchema: z.string(),
},
async (subject) => {
const llmResponse = await generate({
prompt: `Suggest an item for the menu of a ${subject} themed restaurant`,
model: openAIGpt4o,
});
return llmResponse.text();
}
);
// ...configure Genkit (as shown above)...
const specialToolInputSchema = z.object({ meal: z.enum(["breakfast", "lunch", "dinner"]) });
const specialTool = defineTool(
{
name: "specialTool",
description: "Retrieves today's special for the given meal",
inputSchema: specialToolInputSchema,
outputSchema: z.string(),
},
async ({ meal }): Promise<string> => {
// Retrieve up-to-date information and return it. Here, we just return a
// fixed value.
return "Baked beans on toast";
}
);
const result = generate({
model: openAIGpt4o,
tools: [specialTool],
prompt: "What's for breakfast?",
});
console.log(result.then((res) => res.text()));
For more detailed examples and the explanation of other functionalities, refer to the official Genkit documentation.
This plugin supports all currently available Chat/Completion and Embeddings models from GitHub Models. This plugin supports image input and multimodal models.
Still in progress:
You can find the full API reference in the API Reference Documentation
Want to contribute to the project? That's awesome! Head over to our Contribution Guidelines.
[!NOTE]
This repository depends on Google's Firebase Genkit. For issues and questions related to Genkit, please refer to instructions available in Genkit's repository.
Reach out by opening a discussion on GitHub Discussions.
This plugin is proudly maintained by Xavier Portilla Edo Xavier Portilla Edo.
I got the inspiration, structure and patterns to create this plugin from the Genkit Community Plugins repository built by the Fire Compnay as well as the ollama plugin.
This project is licensed under the Apache 2.0 License.
FAQs
Firebase Genkit AI framework plugin for GitHub Models APIs.
The npm package genkitx-github receives a total of 242 weekly downloads. As such, genkitx-github popularity was classified as not popular.
We found that genkitx-github demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
Product
We're launching a new set of license analysis and compliance features for analyzing, managing, and complying with licenses across a range of supported languages and ecosystems.
Product
We're excited to introduce Socket Optimize, a powerful CLI command to secure open source dependencies with tested, optimized package overrides.