Class GenkitPluginV2Instance

Concrete implementation of a v2 plugin that wraps a GenkitPluginV2 definition and provides default implementations for all optional hooks.

Implements

Required<GenkitPluginV2>

Index

Constructors

Properties

Methods

init list middleware model resolve

Constructors

constructor

new GenkitPluginV2Instance(
plugin: Omit<GenkitPluginV2, "version" | "model">,
): GenkitPluginV2Instance
Parameters
- plugin: Omit<GenkitPluginV2, "version" | "model">
Returns GenkitPluginV2Instance
- Defined in genkit/src/plugin.ts:112

Properties

`Readonly`name

name: string

`Readonly`version

version: "v2" = 'v2'

Methods

init

init(): ResolvableAction[] | Promise<ResolvableAction[]>
Returns ResolvableAction[] | Promise<ResolvableAction[]>
Implementation of GenkitPluginV2.init
- Defined in genkit/src/plugin.ts:117

list

list(): | ActionMetadata<z.ZodTypeAny, z.ZodTypeAny, z.ZodTypeAny>[]
| Promise<ActionMetadata<z.ZodTypeAny, z.ZodTypeAny, z.ZodTypeAny>[]>
Returns
| ActionMetadata<z.ZodTypeAny, z.ZodTypeAny, z.ZodTypeAny>[]
| Promise<ActionMetadata<z.ZodTypeAny, z.ZodTypeAny, z.ZodTypeAny>[]>
Implementation of GenkitPluginV2.list
- Defined in genkit/src/plugin.ts:124

middleware

middleware(): GenerateMiddleware<any, any>[]
Returns GenerateMiddleware<any, any>[]
Implementation of GenkitPluginV2.middleware
- Defined in genkit/src/plugin.ts:131

model

model(name: string): Promise<ModelAction>
Parameters
- name: string
Returns Promise<ModelAction>
Implementation of GenkitPluginV2.model
- Defined in genkit/src/plugin.ts:148

resolve

resolve(
    actionType:
        | "custom"
        | "prompt"
        | "model"
        | "tool"
        | "dynamic-action-provider"
        | "embedder"
        | "evaluator"
        | "executable-prompt"
        | "flow"
        | "indexer"
        | "background-model"
        | "check-operation"
        | "cancel-operation"
        | "reranker"
        | "retriever"
        | "tool.v2"
        | "util"
        | "resource",
    name: string,
): ResolvableAction | Promise<(ResolvableAction | undefined)> | undefined
Parameters
- actionType:
      | "custom"
      | "prompt"
      | "model"
      | "tool"
      | "dynamic-action-provider"
      | "embedder"
      | "evaluator"
      | "executable-prompt"
      | "flow"
      | "indexer"
      | "background-model"
      | "check-operation"
      | "cancel-operation"
      | "reranker"
      | "retriever"
      | "tool.v2"
      | "util"
      | "resource"
- name: string
Returns ResolvableAction | Promise<(ResolvableAction | undefined)> | undefined
Implementation of GenkitPluginV2.resolve
- Defined in genkit/src/plugin.ts:138