/** * Copyright 2024 Google LLC * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ import { type ModelAction } from '@genkit-ai/ai/model'; import { GenkitError, type Action, type ActionMetadata, type BackgroundAction, } from '@genkit-ai/core'; import type { Genkit } from './genkit.js'; import type { ActionType } from './registry.js'; export { embedder, embedderActionMetadata } from '@genkit-ai/ai/embedder'; export { evaluator } from '@genkit-ai/ai/evaluator'; export { backgroundModel, model, modelActionMetadata, } from '@genkit-ai/ai/model'; export { reranker } from '@genkit-ai/ai/reranker'; export { indexer, retriever } from '@genkit-ai/ai/retriever'; export interface PluginProvider { name: string; initializer: () => void | Promise; resolver?: (action: ActionType, target: string) => Promise; listActions?: () => Promise; } export type ResolvableAction = Action | BackgroundAction; export interface GenkitPluginV2 { version: 'v2'; name: string; init?: () => ResolvableAction[] | Promise; resolve?: ( actionType: ActionType, name: string ) => ResolvableAction | undefined | Promise; list?: () => ActionMetadata[] | Promise; // A shortcut for resolving a model. model(name: string): Promise; } export type GenkitPlugin = (genkit: Genkit) => PluginProvider; export type PluginInit = (genkit: Genkit) => void | Promise; export type PluginActionResolver = ( genkit: Genkit, action: ActionType, target: string ) => Promise; /** * Defines a Genkit plugin. */ export function genkitPlugin( pluginName: string, initFn: T, resolveFn?: PluginActionResolver, listActionsFn?: () => Promise ): GenkitPlugin { return (genkit: Genkit) => ({ name: pluginName, initializer: async () => { await initFn(genkit); }, resolver: async (action: ActionType, target: string): Promise => { if (resolveFn) { return await resolveFn(genkit, action, target); } }, listActions: async (): Promise => { if (listActionsFn) { return await listActionsFn(); } return []; }, }); } export class GenkitPluginV2Instance implements Required { readonly version = 'v2'; readonly name: string; private plugin: Omit; constructor(plugin: Omit) { this.name = plugin.name; this.plugin = plugin; } init(): ResolvableAction[] | Promise { if (!this.plugin.init) { return []; } return this.plugin.init(); } list(): ActionMetadata[] | Promise { if (!this.plugin.list) { return []; } return this.plugin.list(); } resolve( actionType: ActionType, name: string ): ResolvableAction | undefined | Promise { if (!this.plugin.resolve) { return undefined; } return this.plugin.resolve(actionType, name); } async model(name: string): Promise { const model = await this.resolve('model', name); if (!model) { throw new GenkitError({ message: `Failed to resolve model ${name} for plugin ${this.name}`, status: 'NOT_FOUND', }); } return model as ModelAction; } } export function genkitPluginV2( options: Omit ): GenkitPluginV2Instance { return new GenkitPluginV2Instance(options); } export function isPluginV2(plugin: unknown): plugin is GenkitPluginV2 { return (plugin as GenkitPluginV2).version === 'v2'; }