UNPKG

@genkit-ai/googleai

Version:

Genkit AI framework plugin for Google AI APIs, including Gemini APIs.

1 lines 12.6 kB
{"version":3,"sources":["../src/index.ts"],"sourcesContent":["/**\n * Copyright 2024 Google LLC\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n embedderActionMetadata,\n embedderRef,\n modelActionMetadata,\n type ActionMetadata,\n type EmbedderReference,\n type Genkit,\n type ModelReference,\n type z,\n} from 'genkit';\nimport { logger } from 'genkit/logging';\nimport { modelRef } from 'genkit/model';\nimport { genkitPlugin, type GenkitPlugin } from 'genkit/plugin';\nimport type { ActionType } from 'genkit/registry';\nimport { getApiKeyFromEnvVar } from './common.js';\nimport {\n SUPPORTED_MODELS as EMBEDDER_MODELS,\n GeminiEmbeddingConfigSchema,\n defineGoogleAIEmbedder,\n textEmbedding004,\n textEmbeddingGecko001,\n type GeminiEmbeddingConfig,\n} from './embedder.js';\nimport {\n GeminiConfigSchema,\n SUPPORTED_V15_MODELS,\n defineGoogleAIModel,\n gemini,\n gemini10Pro,\n gemini15Flash,\n gemini15Flash8b,\n gemini15Pro,\n gemini20Flash,\n gemini20FlashExp,\n gemini20FlashLite,\n gemini20ProExp0205,\n gemini25FlashPreview0417,\n gemini25ProExp0325,\n gemini25ProPreview0325,\n type GeminiConfig,\n type GeminiVersionString,\n} from './gemini.js';\nimport { listModels } from './list-models.js';\nexport {\n gemini,\n gemini10Pro,\n gemini15Flash,\n gemini15Flash8b,\n gemini15Pro,\n gemini20Flash,\n gemini20FlashExp,\n gemini20FlashLite,\n gemini20ProExp0205,\n gemini25FlashPreview0417,\n gemini25ProExp0325,\n gemini25ProPreview0325,\n textEmbedding004,\n textEmbeddingGecko001,\n type GeminiConfig,\n type GeminiVersionString,\n};\n\nexport interface PluginOptions {\n /**\n * Provide the API key to use to authenticate with the Gemini API. By\n * default, an API key must be provided explicitly here or through the\n * `GEMINI_API_KEY` or `GOOGLE_API_KEY` environment variables.\n *\n * If `false` is explicitly passed, the plugin will be configured to\n * expect an `apiKey` option to be provided to the model config at\n * call time.\n **/\n apiKey?: string | false;\n apiVersion?: string | string[];\n baseUrl?: string;\n models?: (\n | ModelReference</** @ignore */ typeof GeminiConfigSchema>\n | string\n )[];\n experimental_debugTraces?: boolean;\n}\n\nasync function initializer(ai: Genkit, options?: PluginOptions) {\n let apiVersions = ['v1'];\n\n if (options?.apiVersion) {\n if (Array.isArray(options?.apiVersion)) {\n apiVersions = options?.apiVersion;\n } else {\n apiVersions = [options?.apiVersion];\n }\n }\n\n if (apiVersions.includes('v1beta')) {\n Object.keys(SUPPORTED_V15_MODELS).forEach((name) =>\n defineGoogleAIModel({\n ai,\n name,\n apiKey: options?.apiKey,\n apiVersion: 'v1beta',\n baseUrl: options?.baseUrl,\n debugTraces: options?.experimental_debugTraces,\n })\n );\n }\n if (apiVersions.includes('v1')) {\n Object.keys(SUPPORTED_V15_MODELS).forEach((name) =>\n defineGoogleAIModel({\n ai,\n name,\n apiKey: options?.apiKey,\n apiVersion: undefined,\n baseUrl: options?.baseUrl,\n debugTraces: options?.experimental_debugTraces,\n })\n );\n Object.keys(EMBEDDER_MODELS).forEach((name) =>\n defineGoogleAIEmbedder(ai, name, { apiKey: options?.apiKey })\n );\n }\n\n if (options?.models) {\n for (const modelOrRef of options?.models) {\n const modelName =\n typeof modelOrRef === 'string'\n ? modelOrRef\n : // strip out the `googleai/` prefix\n modelOrRef.name.split('/')[1];\n const modelRef =\n typeof modelOrRef === 'string' ? gemini(modelOrRef) : modelOrRef;\n defineGoogleAIModel({\n ai,\n name: modelName,\n apiKey: options?.apiKey,\n baseUrl: options?.baseUrl,\n info: {\n ...modelRef.info,\n label: `Google AI - ${modelName}`,\n },\n debugTraces: options?.experimental_debugTraces,\n });\n }\n }\n}\n\nasync function resolver(\n ai: Genkit,\n actionType: ActionType,\n actionName: string,\n options?: PluginOptions\n) {\n switch (actionType) {\n case 'model':\n resolveModel(ai, actionName, options);\n break;\n case 'embedder':\n resolveEmbedder(ai, actionName, options);\n break;\n default:\n // no-op\n }\n}\n\nfunction resolveModel(ai: Genkit, actionName: string, options?: PluginOptions) {\n const modelRef = gemini(actionName);\n defineGoogleAIModel({\n ai,\n name: modelRef.name,\n apiKey: options?.apiKey,\n baseUrl: options?.baseUrl,\n info: {\n ...modelRef.info,\n label: `Google AI - ${actionName}`,\n },\n debugTraces: options?.experimental_debugTraces,\n });\n}\n\nfunction resolveEmbedder(\n ai: Genkit,\n actionName: string,\n options?: PluginOptions\n) {\n defineGoogleAIEmbedder(ai, `googleai/${actionName}`, {\n apiKey: options?.apiKey,\n });\n}\n\nasync function listActions(options?: PluginOptions): Promise<ActionMetadata[]> {\n const apiKey = options?.apiKey || getApiKeyFromEnvVar();\n if (!apiKey) {\n // If API key is not configured we don't want to error, just return empty.\n // In practice it will never actually reach this point without the API key,\n // plugin initializer will fail before that.\n logger.error(\n 'Pass in the API key or set the GEMINI_API_KEY or GOOGLE_API_KEY environment variable.'\n );\n return [];\n }\n\n const models = await listModels(\n options?.baseUrl || 'https://generativelanguage.googleapis.com',\n apiKey\n );\n\n return [\n // Models\n ...models\n .filter((m) => m.supportedGenerationMethods.includes('generateContent'))\n // Filter out deprecated\n .filter((m) => !m.description || !m.description.includes('deprecated'))\n .map((m) => {\n const ref = gemini(\n m.name.startsWith('models/')\n ? m.name.substring('models/'.length)\n : m.name\n );\n\n return modelActionMetadata({\n name: ref.name,\n info: ref.info,\n configSchema: GeminiConfigSchema,\n });\n }),\n // Embedders\n ...models\n .filter((m) => m.supportedGenerationMethods.includes('embedContent'))\n // Filter out deprecated\n .filter((m) => !m.description || !m.description.includes('deprecated'))\n .map((m) => {\n const name =\n 'googleai/' +\n (m.name.startsWith('models/')\n ? m.name.substring('models/'.length)\n : m.name);\n\n return embedderActionMetadata({\n name,\n configSchema: GeminiEmbeddingConfigSchema,\n info: {\n dimensions: 768,\n label: `Google Gen AI - ${name}`,\n supports: {\n input: ['text'],\n },\n },\n });\n }),\n ];\n}\n\n/**\n * Google Gemini Developer API plugin.\n */\nexport function googleAIPlugin(options?: PluginOptions): GenkitPlugin {\n let listActionsCache;\n return genkitPlugin(\n 'googleai',\n async (ai: Genkit) => await initializer(ai, options),\n async (ai: Genkit, actionType: ActionType, actionName: string) =>\n await resolver(ai, actionType, actionName, options),\n async () => {\n if (listActionsCache) return listActionsCache;\n listActionsCache = await listActions(options);\n return listActionsCache;\n }\n );\n}\n\nexport type GoogleAIPlugin = {\n (params?: PluginOptions): GenkitPlugin;\n model(\n name: GeminiVersionString,\n config?: z.infer<typeof GeminiConfigSchema>\n ): ModelReference<typeof GeminiConfigSchema>;\n embedder(\n name: string,\n config?: GeminiEmbeddingConfig\n ): EmbedderReference<typeof GeminiEmbeddingConfigSchema>;\n};\n\n/**\n * Google Gemini Developer API plugin.\n */\nexport const googleAI = googleAIPlugin as GoogleAIPlugin;\ngoogleAI.model = (\n name: GeminiVersionString,\n config?: GeminiConfig\n): ModelReference<typeof GeminiConfigSchema> => {\n return modelRef({\n name: `googleai/${name}`,\n config,\n configSchema: GeminiConfigSchema,\n });\n};\ngoogleAI.embedder = (\n name: string,\n config?: GeminiEmbeddingConfig\n): EmbedderReference<typeof GeminiEmbeddingConfigSchema> => {\n return embedderRef({\n name: `googleai/${name}`,\n config,\n configSchema: GeminiEmbeddingConfigSchema,\n });\n};\n\nexport default googleAI;\n"],"mappings":"AAgBA;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,OAMK;AACP,SAAS,cAAc;AACvB,SAAS,gBAAgB;AACzB,SAAS,oBAAuC;AAEhD,SAAS,2BAA2B;AACpC;AAAA,EACE,oBAAoB;AAAA,EACpB;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OAEK;AACP;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OAGK;AACP,SAAS,kBAAkB;AAwC3B,eAAe,YAAY,IAAY,SAAyB;AAC9D,MAAI,cAAc,CAAC,IAAI;AAEvB,MAAI,SAAS,YAAY;AACvB,QAAI,MAAM,QAAQ,SAAS,UAAU,GAAG;AACtC,oBAAc,SAAS;AAAA,IACzB,OAAO;AACL,oBAAc,CAAC,SAAS,UAAU;AAAA,IACpC;AAAA,EACF;AAEA,MAAI,YAAY,SAAS,QAAQ,GAAG;AAClC,WAAO,KAAK,oBAAoB,EAAE;AAAA,MAAQ,CAAC,SACzC,oBAAoB;AAAA,QAClB;AAAA,QACA;AAAA,QACA,QAAQ,SAAS;AAAA,QACjB,YAAY;AAAA,QACZ,SAAS,SAAS;AAAA,QAClB,aAAa,SAAS;AAAA,MACxB,CAAC;AAAA,IACH;AAAA,EACF;AACA,MAAI,YAAY,SAAS,IAAI,GAAG;AAC9B,WAAO,KAAK,oBAAoB,EAAE;AAAA,MAAQ,CAAC,SACzC,oBAAoB;AAAA,QAClB;AAAA,QACA;AAAA,QACA,QAAQ,SAAS;AAAA,QACjB,YAAY;AAAA,QACZ,SAAS,SAAS;AAAA,QAClB,aAAa,SAAS;AAAA,MACxB,CAAC;AAAA,IACH;AACA,WAAO,KAAK,eAAe,EAAE;AAAA,MAAQ,CAAC,SACpC,uBAAuB,IAAI,MAAM,EAAE,QAAQ,SAAS,OAAO,CAAC;AAAA,IAC9D;AAAA,EACF;AAEA,MAAI,SAAS,QAAQ;AACnB,eAAW,cAAc,SAAS,QAAQ;AACxC,YAAM,YACJ,OAAO,eAAe,WAClB;AAAA;AAAA,QAEA,WAAW,KAAK,MAAM,GAAG,EAAE,CAAC;AAAA;AAClC,YAAMA,YACJ,OAAO,eAAe,WAAW,OAAO,UAAU,IAAI;AACxD,0BAAoB;AAAA,QAClB;AAAA,QACA,MAAM;AAAA,QACN,QAAQ,SAAS;AAAA,QACjB,SAAS,SAAS;AAAA,QAClB,MAAM;AAAA,UACJ,GAAGA,UAAS;AAAA,UACZ,OAAO,eAAe,SAAS;AAAA,QACjC;AAAA,QACA,aAAa,SAAS;AAAA,MACxB,CAAC;AAAA,IACH;AAAA,EACF;AACF;AAEA,eAAe,SACb,IACA,YACA,YACA,SACA;AACA,UAAQ,YAAY;AAAA,IAClB,KAAK;AACH,mBAAa,IAAI,YAAY,OAAO;AACpC;AAAA,IACF,KAAK;AACH,sBAAgB,IAAI,YAAY,OAAO;AACvC;AAAA,IACF;AAAA,EAEF;AACF;AAEA,SAAS,aAAa,IAAY,YAAoB,SAAyB;AAC7E,QAAMA,YAAW,OAAO,UAAU;AAClC,sBAAoB;AAAA,IAClB;AAAA,IACA,MAAMA,UAAS;AAAA,IACf,QAAQ,SAAS;AAAA,IACjB,SAAS,SAAS;AAAA,IAClB,MAAM;AAAA,MACJ,GAAGA,UAAS;AAAA,MACZ,OAAO,eAAe,UAAU;AAAA,IAClC;AAAA,IACA,aAAa,SAAS;AAAA,EACxB,CAAC;AACH;AAEA,SAAS,gBACP,IACA,YACA,SACA;AACA,yBAAuB,IAAI,YAAY,UAAU,IAAI;AAAA,IACnD,QAAQ,SAAS;AAAA,EACnB,CAAC;AACH;AAEA,eAAe,YAAY,SAAoD;AAC7E,QAAM,SAAS,SAAS,UAAU,oBAAoB;AACtD,MAAI,CAAC,QAAQ;AAIX,WAAO;AAAA,MACL;AAAA,IACF;AACA,WAAO,CAAC;AAAA,EACV;AAEA,QAAM,SAAS,MAAM;AAAA,IACnB,SAAS,WAAW;AAAA,IACpB;AAAA,EACF;AAEA,SAAO;AAAA;AAAA,IAEL,GAAG,OACA,OAAO,CAAC,MAAM,EAAE,2BAA2B,SAAS,iBAAiB,CAAC,EAEtE,OAAO,CAAC,MAAM,CAAC,EAAE,eAAe,CAAC,EAAE,YAAY,SAAS,YAAY,CAAC,EACrE,IAAI,CAAC,MAAM;AACV,YAAM,MAAM;AAAA,QACV,EAAE,KAAK,WAAW,SAAS,IACvB,EAAE,KAAK,UAAU,UAAU,MAAM,IACjC,EAAE;AAAA,MACR;AAEA,aAAO,oBAAoB;AAAA,QACzB,MAAM,IAAI;AAAA,QACV,MAAM,IAAI;AAAA,QACV,cAAc;AAAA,MAChB,CAAC;AAAA,IACH,CAAC;AAAA;AAAA,IAEH,GAAG,OACA,OAAO,CAAC,MAAM,EAAE,2BAA2B,SAAS,cAAc,CAAC,EAEnE,OAAO,CAAC,MAAM,CAAC,EAAE,eAAe,CAAC,EAAE,YAAY,SAAS,YAAY,CAAC,EACrE,IAAI,CAAC,MAAM;AACV,YAAM,OACJ,eACC,EAAE,KAAK,WAAW,SAAS,IACxB,EAAE,KAAK,UAAU,UAAU,MAAM,IACjC,EAAE;AAER,aAAO,uBAAuB;AAAA,QAC5B;AAAA,QACA,cAAc;AAAA,QACd,MAAM;AAAA,UACJ,YAAY;AAAA,UACZ,OAAO,mBAAmB,IAAI;AAAA,UAC9B,UAAU;AAAA,YACR,OAAO,CAAC,MAAM;AAAA,UAChB;AAAA,QACF;AAAA,MACF,CAAC;AAAA,IACH,CAAC;AAAA,EACL;AACF;AAKO,SAAS,eAAe,SAAuC;AACpE,MAAI;AACJ,SAAO;AAAA,IACL;AAAA,IACA,OAAO,OAAe,MAAM,YAAY,IAAI,OAAO;AAAA,IACnD,OAAO,IAAY,YAAwB,eACzC,MAAM,SAAS,IAAI,YAAY,YAAY,OAAO;AAAA,IACpD,YAAY;AACV,UAAI,iBAAkB,QAAO;AAC7B,yBAAmB,MAAM,YAAY,OAAO;AAC5C,aAAO;AAAA,IACT;AAAA,EACF;AACF;AAiBO,MAAM,WAAW;AACxB,SAAS,QAAQ,CACf,MACA,WAC8C;AAC9C,SAAO,SAAS;AAAA,IACd,MAAM,YAAY,IAAI;AAAA,IACtB;AAAA,IACA,cAAc;AAAA,EAChB,CAAC;AACH;AACA,SAAS,WAAW,CAClB,MACA,WAC0D;AAC1D,SAAO,YAAY;AAAA,IACjB,MAAM,YAAY,IAAI;AAAA,IACtB;AAAA,IACA,cAAc;AAAA,EAChB,CAAC;AACH;AAEA,IAAO,cAAQ;","names":["modelRef"]}