Genkit 的相容 API 插件
@genkit-ai/compat-oai 是使用 OpenAI 兼容 API 的插件 精灵。 。 。 .
用编码代理? 先安装基因组JS技能.
npx skills add genkit-ai/skills --skill developing-genkit-js它教你的代理人 现任Genkit JS APIs 和普通的gitchas. 其他语言的来源、人工安装和技能: 技能/技能。 。 。 .
这个Genkit插件允许通过OpenAI模型的官方API使用.
官方 OpenAI 兼容提供者文件 :
支持的模型
这个插件还支持OpenAI模型,以及来自其他模型提供者的自定义模型.
安装
使用您最喜欢的软件包管理器在您的工程中安装插件 :
npm install @genkit-ai/compat-oaiyarn add @genkit-ai/compat-oaipnpm add @genkit-ai/compat-oai
使用量
初始化
import dotenv from 'dotenv';
import { genkit } from 'genkit';
import openAI, { gpt35Turbo } from '@genkit-ai/compat-oai';
dotenv.config();
const ai = genkit({
plugins: [openAI({ apiKey: process.env.OPENAI_API_KEY })],
// specify a default model if not provided in generate params:
model: gpt35Turbo,
});
基本实例
生成文本的最简单方法是使用 generate 方法 :
const response = await ai.generate({
model: gpt4o
prompt: 'Tell me a joke.',
});
console.log(response.text);
结构化产出
使用 config.strict: true 在支持 OpenAI 结构化输出的模型上有一个输出计划:
import { z } from 'genkit';
import { openAI } from '@genkit-ai/compat-oai/openai';
const response = await ai.generate({
model: openAI.model('gpt-5'),
prompt: 'Extract the answer from the text.',
output: {
schema: z
.object({
answer: z.string(),
})
.strict(),
},
config: {
strict: true,
},
});
console.log(response.output);
应用 .strict() 切入图中的每个对象; 源基特不自动设定 additionalProperties: false。 。 。 .
见 结构化产出指南。 。 。 .
多式联运提示
const response = await ai.generate({
model: gpt4o,
prompt: [
{ text: 'What animal is in the photo?' },
{ media: { url: imageUrl } },
],
config: {
// control of the level of visual detail when processing image embeddings
// Low detail level also decreases the token usage
visualDetailLevel: 'low',
},
});
console.log(response.text);
文本嵌入
import { textEmbeddingAda002 } from '@genkit-ai/compat-oai';
const embedding = await ai.embed({
embedder: textEmbeddingAda002,
content: 'Hello world',
});
console.log(embedding);
在流动中
import { z } from 'genkit';
export const jokeFlow = ai.defineFlow(
{
name: 'jokeFlow',
inputSchema: z.string(),
outputSchema: z.string(),
},
async (subject) => {
const llmResponse = await ai.generate({
prompt: `tell me a joke about ${subject}`,
});
return llmResponse.text;
}
);
工具使用
import { z } from 'genkit';
// ...initialize genkit (as shown above)
const createReminder = ai.defineTool(
{
name: 'createReminder',
description: 'Use this to create reminders for things in the future',
inputSchema: z.object({
time: z
.string()
.describe('ISO timestamp string, e.g. 2024-04-03T12:23:00Z'),
reminder: z.string().describe('the content of the reminder'),
}),
outputSchema: z.number().describe('the ID of the created reminder'),
},
(reminder) => Promise.resolve(3)
);
const result = await ai.generate({
tools: [createReminder],
prompt: `
You are a reminder assistant.
If you create a reminder, describe in text the reminder you created as a response.
Query: I have a meeting with Anna at 3 for dinner - can you set a reminder for the time?
`,
});
console.log(result.text);
自定义模式和其他云提供者( O)
import { GenerationCommonConfigSchema, genkit, z } from 'genkit';
import { ModelInfo } from 'genkit/model';
import openAI from '@genkit-ai/compat-oai';
const modelInfo: ModelInfo = {
label: 'Claude - Claude 3.7 Sonnet',
supports: {
multiturn: true,
tools: true,
media: false,
systemRole: true,
output: ['json', 'text'],
},
};
const schema = GenerationCommonConfigSchema.extend({});
const ai = genkit({
plugins: [
openAI({
apiKey: process.env.ANTHROPIC_API_KEY,
baseURL: 'https://api.anthropic.com/v1/',
models: [
{ name: 'claude-3-7-sonnet', info: modelInfo, configSchema: schema },
],
}),
],
});
export const customModelFlow = ai.defineFlow(
{
name: 'customModelFlow',
inputSchema: z.string(),
outputSchema: z.string(),
},
async (subject) => {
const llmResponse = await ai.generate({
prompt: `tell me a joke about ${subject}`,
model: 'openai/claude-3-7-sonnet',
config: {
version: 'claude-3-7-sonnet-20250219',
},
});
return llmResponse.text;
}
);
捐款
想为这个项目捐款吗? 这太棒了! 去我们家 贡献准则。 。 。 .
需要帮忙吗?
许可证
本项目根据以下规定获得许可证: Apache 2.0 许可证。 。 。 .