Class GenkitBeta`Beta`

Genkit BETA APIs.

Hierarchy (View Summary)

Genkit
- GenkitBeta

Constructors

constructor

new GenkitBeta(options?: GenkitOptions): GenkitBeta
Beta
Parameters
- Optionaloptions: GenkitOptions
Returns GenkitBeta
Overrides Genkit.constructor
- Defined in genkit/src/genkit-beta.ts:60

Properties

`Readonly`flows

flows: Action<any, any, any, ActionRunOptions<any>>[] = []

List of flows that have been registered in this instance.

`Readonly`options

options: GenkitOptions

Developer-configured options.

`Readonly`registry

registry: Registry

Registry instance that is exclusively modified by this Genkit instance.

Accessors

apiStability

get apiStability(): "beta" | "stable"
Beta
Returns "beta" | "stable"
Inherited from Genkit.apiStability
- Defined in genkit/src/genkit.ts:158

Methods

chat

chat(options?: ChatOptions<I, any>): Chat

Beta

Create a chat session with the provided options.

const chat = ai.chat({
  system: 'talk like a pirate',
})
let response = await chat.send('tell me a joke')
response = await chat.send('another one')

Type Parameters

Parameters

Optionaloptions: ChatOptions<I, any>

Returns Chat

chat(
preamble: ExecutablePrompt<I, ZodTypeAny, ZodTypeAny>,
options?: ChatOptions<I, any>,
): Chat
Beta
Create a chat session with the provided preabmle.
```
const triageAgent = ai.definePrompt({
 system: 'help the user triage a problem',
})
const chat = ai.chat(triageAgent)
const { text } = await chat.send('my phone feels hot');
```
Type Parameters
- I
Parameters
- preamble: ExecutablePrompt<I, ZodTypeAny, ZodTypeAny>
- Optionaloptions: ChatOptions<I, any>
Returns Chat
- Defined in genkit/src/genkit-beta.ts:93

createSession

createSession<S = any>(options?: SessionOptions<S>): Session<S>
Beta
Create a session for this environment.
Type Parameters
- S = any
Parameters
- Optionaloptions: SessionOptions<S>
Returns Session<S>
- Defined in genkit/src/genkit-beta.ts:135

currentContext

currentContext(): undefined | ActionContext
Returns current action (or flow) invocation context. Can be used to access things like auth data set by HTTP server frameworks. If invoked outside of an action (e.g. flow or tool) will return undefined.

Returns undefined | ActionContext
Inherited from Genkit.currentContext
- Defined in genkit/src/genkit.ts:777

currentSession

currentSession<S = any>(): Session<S>
Beta
Gets the current session from async local storage.
Type Parameters
- S = any
Returns Session<S>
- Defined in genkit/src/genkit-beta.ts:174

defineEmbedder

defineEmbedder<
 ConfigSchema extends ZodType<any, any, any, ConfigSchema> = ZodTypeAny,
>(
 options: {
 configSchema?: ConfigSchema;
 info?: {
 dimensions?: number;
 label?: string;
 supports?: {
 input?: ("video" | "image" | "text")[];
 multilingual?: boolean;
 };
 };
 name: string;
 },
 runner: EmbedderFn<ConfigSchema>,
): EmbedderAction<ConfigSchema>
Creates embedder model for the provided EmbedderFn model implementation.
Type Parameters
- ConfigSchema extends ZodType<any, any, any, ConfigSchema> = ZodTypeAny
Parameters
- options: {
 configSchema?: ConfigSchema;
 info?: {
 dimensions?: number;
 label?: string;
 supports?: {
 input?: ("video" | "image" | "text")[];
 multilingual?: boolean;
 };
 };
 name: string;
 }
- runner: EmbedderFn<ConfigSchema>
Returns EmbedderAction<ConfigSchema>
Inherited from Genkit.defineEmbedder
- Defined in genkit/src/genkit.ts:439

defineEvaluator

defineEvaluator<
 DataPoint extends
 ZodObject<
 {
 context: ZodOptional<ZodArray<ZodUnknown, "many">>;
 input: ZodUnknown;
 output: ZodOptional<ZodUnknown>;
 reference: ZodOptional<ZodUnknown>;
 testCaseId: ZodOptional<ZodString>;
 traceIds: ZodOptional<ZodArray<ZodString, "many">>;
 },
 "strip",
 ZodTypeAny,
 {
 context?: unknown[];
 input?: unknown;
 output?: unknown;
 reference?: unknown;
 testCaseId?: string;
 traceIds?: string[];
 },
 {
 context?: unknown[];
 input?: unknown;
 output?: unknown;
 reference?: unknown;
 testCaseId?: string;
 traceIds?: string[];
 },
 DataPoint,
 > = ZodObject<
 {
 context: ZodOptional<ZodArray<ZodUnknown, "many">>;
 input: ZodUnknown;
 output: ZodOptional<ZodUnknown>;
 reference: ZodOptional<ZodUnknown>;
 testCaseId: ZodOptional<ZodString>;
 traceIds: ZodOptional<ZodArray<ZodString, "many">>;
 },
 "strip",
 ZodTypeAny,
 {
 context?: unknown[];
 input?: unknown;
 output?: unknown;
 reference?: unknown;
 testCaseId?: string;
 traceIds?: string[];
 },
 {
 context?: unknown[];
 input?: unknown;
 output?: unknown;
 reference?: unknown;
 testCaseId?: string;
 traceIds?: string[];
 },
 >,
 EvalDataPoint extends
 ZodObject<
 extendShape<
 {
 context: ZodOptional<ZodArray<ZodUnknown, "many">>;
 input: ZodUnknown;
 output: ZodOptional<ZodUnknown>;
 reference: ZodOptional<ZodUnknown>;
 testCaseId: ZodOptional<ZodString>;
 traceIds: ZodOptional<ZodArray<ZodString, "many">>;
 },
 { testCaseId: ZodString },
 >,
 "strip",
 ZodTypeAny,
 {
 context?: unknown[];
 input?: unknown;
 output?: unknown;
 reference?: unknown;
 testCaseId: string;
 traceIds?: string[];
 },
 {
 context?: unknown[];
 input?: unknown;
 output?: unknown;
 reference?: unknown;
 testCaseId: string;
 traceIds?: string[];
 },
 EvalDataPoint,
 > = ZodObject<
 extendShape<
 {
 context: ZodOptional<ZodArray<ZodUnknown, "many">>;
 input: ZodUnknown;
 output: ZodOptional<ZodUnknown>;
 reference: ZodOptional<ZodUnknown>;
 testCaseId: ZodOptional<ZodString>;
 traceIds: ZodOptional<ZodArray<ZodString, "many">>;
 },
 { testCaseId: ZodString },
 >,
 "strip",
 ZodTypeAny,
 {
 context?: unknown[];
 input?: unknown;
 output?: unknown;
 reference?: unknown;
 testCaseId: string;
 traceIds?: string[];
 },
 {
 context?: unknown[];
 input?: unknown;
 output?: unknown;
 reference?: unknown;
 testCaseId: string;
 traceIds?: string[];
 },
 >,
 EvaluatorOptions extends
 ZodType<any, any, any, EvaluatorOptions> = ZodTypeAny,
>(
 options: {
 configSchema?: EvaluatorOptions;
 dataPointType?: DataPoint;
 definition: string;
 displayName: string;
 isBilled?: boolean;
 name: string;
 },
 runner: EvaluatorFn<EvalDataPoint, EvaluatorOptions>,
): EvaluatorAction<
 ZodObject<
 {
 context: ZodOptional<ZodArray<ZodUnknown, "many">>;
 input: ZodUnknown;
 output: ZodOptional<ZodUnknown>;
 reference: ZodOptional<ZodUnknown>;
 testCaseId: ZodOptional<ZodString>;
 traceIds: ZodOptional<ZodArray<ZodString, "many">>;
 },
 "strip",
 ZodTypeAny,
 {
 context?: unknown[];
 input?: unknown;
 output?: unknown;
 reference?: unknown;
 testCaseId?: string;
 traceIds?: string[];
 },
 {
 context?: unknown[];
 input?: unknown;
 output?: unknown;
 reference?: unknown;
 testCaseId?: string;
 traceIds?: string[];
 },
 >,
 ZodTypeAny,
>
Creates evaluator action for the provided EvaluatorFn implementation.
Type Parameters
- DataPoint extends ZodObject<
 {
 context: ZodOptional<ZodArray<ZodUnknown, "many">>;
 input: ZodUnknown;
 output: ZodOptional<ZodUnknown>;
 reference: ZodOptional<ZodUnknown>;
 testCaseId: ZodOptional<ZodString>;
 traceIds: ZodOptional<ZodArray<ZodString, "many">>;
 },
 "strip",
 ZodTypeAny,
 {
 context?: unknown[];
 input?: unknown;
 output?: unknown;
 reference?: unknown;
 testCaseId?: string;
 traceIds?: string[];
 },
 {
 context?: unknown[];
 input?: unknown;
 output?: unknown;
 reference?: unknown;
 testCaseId?: string;
 traceIds?: string[];
 },
 DataPoint,
 > = ZodObject<
 {
 context: ZodOptional<ZodArray<ZodUnknown, "many">>;
 input: ZodUnknown;
 output: ZodOptional<ZodUnknown>;
 reference: ZodOptional<ZodUnknown>;
 testCaseId: ZodOptional<ZodString>;
 traceIds: ZodOptional<ZodArray<ZodString, "many">>;
 },
 "strip",
 ZodTypeAny,
 {
 context?: unknown[];
 input?: unknown;
 output?: unknown;
 reference?: unknown;
 testCaseId?: string;
 traceIds?: string[];
 },
 {
 context?: unknown[];
 input?: unknown;
 output?: unknown;
 reference?: unknown;
 testCaseId?: string;
 traceIds?: string[];
 },
 >
- EvalDataPoint extends ZodObject<
 extendShape<
 {
 context: ZodOptional<ZodArray<ZodUnknown, "many">>;
 input: ZodUnknown;
 output: ZodOptional<ZodUnknown>;
 reference: ZodOptional<ZodUnknown>;
 testCaseId: ZodOptional<ZodString>;
 traceIds: ZodOptional<ZodArray<ZodString, "many">>;
 },
 { testCaseId: ZodString },
 >,
 "strip",
 ZodTypeAny,
 {
 context?: unknown[];
 input?: unknown;
 output?: unknown;
 reference?: unknown;
 testCaseId: string;
 traceIds?: string[];
 },
 {
 context?: unknown[];
 input?: unknown;
 output?: unknown;
 reference?: unknown;
 testCaseId: string;
 traceIds?: string[];
 },
 EvalDataPoint,
 > = ZodObject<
 extendShape<
 {
 context: ZodOptional<ZodArray<ZodUnknown, "many">>;
 input: ZodUnknown;
 output: ZodOptional<ZodUnknown>;
 reference: ZodOptional<ZodUnknown>;
 testCaseId: ZodOptional<ZodString>;
 traceIds: ZodOptional<ZodArray<ZodString, "many">>;
 },
 { testCaseId: ZodString },
 >,
 "strip",
 ZodTypeAny,
 {
 context?: unknown[];
 input?: unknown;
 output?: unknown;
 reference?: unknown;
 testCaseId: string;
 traceIds?: string[];
 },
 {
 context?: unknown[];
 input?: unknown;
 output?: unknown;
 reference?: unknown;
 testCaseId: string;
 traceIds?: string[];
 },
 >
- EvaluatorOptions extends ZodType<any, any, any, EvaluatorOptions> = ZodTypeAny
Parameters
- options: {
 configSchema?: EvaluatorOptions;
 dataPointType?: DataPoint;
 definition: string;
 displayName: string;
 isBilled?: boolean;
 name: string;
 }
- runner: EvaluatorFn<EvalDataPoint, EvaluatorOptions>
Returns EvaluatorAction<
 ZodObject<
 {
 context: ZodOptional<ZodArray<ZodUnknown, "many">>;
 input: ZodUnknown;
 output: ZodOptional<ZodUnknown>;
 reference: ZodOptional<ZodUnknown>;
 testCaseId: ZodOptional<ZodString>;
 traceIds: ZodOptional<ZodArray<ZodString, "many">>;
 },
 "strip",
 ZodTypeAny,
 {
 context?: unknown[];
 input?: unknown;
 output?: unknown;
 reference?: unknown;
 testCaseId?: string;
 traceIds?: string[];
 },
 {
 context?: unknown[];
 input?: unknown;
 output?: unknown;
 reference?: unknown;
 testCaseId?: string;
 traceIds?: string[];
 },
 >,
 ZodTypeAny,
>
Inherited from Genkit.defineEvaluator
- Defined in genkit/src/genkit.ts:417

defineFlow

defineFlow = ZodTypeAny,
 O extends ZodType<any, any, any, O> = ZodTypeAny,
 S extends ZodType<any, any, any, S> = ZodTypeAny,
>(
 config: string | FlowConfig<I, O, S>,
 fn: FlowFn<I, O, S>,
): Action<I, O, S, ActionRunOptions<S>>
Beta
Defines and registers a non-streaming flow.
Type Parameters
- I extends ZodType<any, any, any, I> = ZodTypeAny
- O extends ZodType<any, any, any, O> = ZodTypeAny
- S extends ZodType<any, any, any, S> = ZodTypeAny
Parameters
- config: string | FlowConfig<I, O, S>
- fn: FlowFn<I, O, S>
Returns Action<I, O, S, ActionRunOptions<S>>
Todo
TODO: Improve this documentation (show snippets, etc).
Inherited from Genkit.defineFlow
- Defined in genkit/src/genkit.ts:179

defineFormat

defineFormat(
 options: { name: string } & {
 constrained?: boolean;
 contentType?: string;
 format?: string;
 instructions?: string;
 schema?: Record<string, any>;
 },
 handler: (
 schema?: any,
 ) => {
 instructions?: string;
 parseChunk?: (chunk: GenerateResponseChunk<unknown>) => unknown;
 parseMessage(message: Message<unknown>): unknown;
 },
): {
 config: | undefined
 | {
 constrained?: boolean;
 contentType?: string;
 format?: string;
 instructions?: string;
 schema?: Record<string, any>;
 };
 handler: (
 schema?: any,
 ) => {
 instructions?: string;
 parseChunk?: (chunk: GenerateResponseChunk<unknown>) => unknown;
 parseMessage(message: Message<unknown>): unknown;
 };
}
Beta
Defines and registers a custom model output formatter.

Here's an example of a custom JSON output formatter:
```
import { extractJson } from 'genkit/extract';

ai.defineFormat(
 { name: 'customJson' },
 (schema) => {
 let instructions: string | undefined;
 if (schema) {
 instructions = `Output should be in JSON format and conform to the following schema:
\`\`\`
${JSON.stringify(schema)}
\`\`\`
`;
 }
 return {
 parseChunk: (chunk) => extractJson(chunk.accumulatedText),
 parseMessage: (message) => extractJson(message.text),
 instructions,
 };
 }
);

const { output } = await ai.generate({
 prompt: 'Invent a menu item for a pirate themed restaurant.',
 output: { format: 'customJson', schema: MenuItemSchema },
});
```
Parameters
- options: { name: string } & {
 constrained?: boolean;
 contentType?: string;
 format?: string;
 instructions?: string;
 schema?: Record<string, any>;
 }
- handler: (
 schema?: any,
 ) => {
 instructions?: string;
 parseChunk?: (chunk: GenerateResponseChunk<unknown>) => unknown;
 parseMessage(message: Message<unknown>): unknown;
 }
Returns {
 config:
 | undefined
 | {
 constrained?: boolean;
 contentType?: string;
 format?: string;
 instructions?: string;
 schema?: Record<string, any>;
 };
 handler: (
 schema?: any,
 ) => {
 instructions?: string;
 parseChunk?: (chunk: GenerateResponseChunk<unknown>) => unknown;
 parseMessage(message: Message<unknown>): unknown;
 };
}
- Defined in genkit/src/genkit-beta.ts:217

defineHelper

defineHelper(name: string, fn: HelperDelegate): void
create a handlebards helper (https://handlebarsjs.com/guide/block-helpers.html) to be used in dotpormpt templates.
Parameters
- name: string
- fn: HelperDelegate
Returns void
Inherited from Genkit.defineHelper
- Defined in genkit/src/genkit.ts:453

defineIndexer

defineIndexer<IndexerOptions extends ZodType<any, any, any, IndexerOptions>>(
 options: {
 configSchema?: IndexerOptions;
 embedderInfo?: {
 dimensions?: number;
 label?: string;
 supports?: {
 input?: ("video" | "image" | "text")[];
 multilingual?: boolean;
 };
 };
 name: string;
 },
 runner: IndexerFn<IndexerOptions>,
): IndexerAction<IndexerOptions>
Creates an indexer action for the provided IndexerFn implementation.
Type Parameters
- IndexerOptions extends ZodType<any, any, any, IndexerOptions>
Parameters
- options: {
 configSchema?: IndexerOptions;
 embedderInfo?: {
 dimensions?: number;
 label?: string;
 supports?: {
 input?: ("video" | "image" | "text")[];
 multilingual?: boolean;
 };
 };
 name: string;
 }
- runner: IndexerFn<IndexerOptions>
Returns IndexerAction<IndexerOptions>
Inherited from Genkit.defineIndexer
- Defined in genkit/src/genkit.ts:403

defineInterrupt

defineInterrupt,
 O extends ZodType<any, any, any, O>,
>(
 config: InterruptConfig<I, O>,
): ToolAction<I, O>
Beta
Defines and registers an interrupt.

Interrupts are special tools that halt model processing and return control back to the caller. Interrupts make it simpler to implement "human-in-the-loop" and out-of-band processing patterns that require waiting on external actions to complete.
Type Parameters
- I extends ZodType<any, any, any, I>
- O extends ZodType<any, any, any, O>
Parameters
- config: InterruptConfig<I, O>
Returns ToolAction<I, O>
- Defined in genkit/src/genkit-beta.ts:234

defineJsonSchema

defineJsonSchema(name: string, jsonSchema: any): any
Defines and registers a schema from a JSON schema.

Defined schemas can be referenced by name in prompts in place of inline schemas.
Parameters
- name: string
- jsonSchema: any
Returns any
Inherited from Genkit.defineJsonSchema
- Defined in genkit/src/genkit.ts:218

defineModel

defineModel<
 CustomOptionsSchema extends
 ZodType<any, any, any, CustomOptionsSchema> = ZodTypeAny,
>(
 options: DefineModelOptions<CustomOptionsSchema>,
 runner: (
 request: GenerateRequest<CustomOptionsSchema>,
 streamingCallback?: StreamingCallback<
 {
 aggregated?: boolean;
 content: (
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media: { contentType?: string; url: string };
 metadata?: Record<string, unknown>;
 text?: undefined;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 text: string;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 text?: undefined;
 toolRequest: { input?: unknown; name: string; ref?: string };
 toolResponse?: undefined;
 }
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 text?: undefined;
 toolRequest?: undefined;
 toolResponse: { name: string; output?: unknown; ref?: string };
 }
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 text?: undefined;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 | {
 custom: Record<string, any>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 text?: undefined;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 )[];
 custom?: unknown;
 index?: number;
 role?: "user"
 | "model"
 | "tool"
 | "system";
 },
 >,
 ) => Promise<
 {
 candidates?: {
 custom?: unknown;
 finishMessage?: string;
 finishReason: | "length"
 | "stop"
 | "interrupted"
 | "blocked"
 | "unknown"
 | "other";
 index: number;
 message: {
 content: (
 | {
 custom?: (...)
 | (...);
 data?: unknown;
 media: { contentType?: ...; url: ... };
 metadata?: (...) | (...);
 text?: undefined;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 | {
 custom?: (...)
 | (...);
 data?: unknown;
 media?: undefined;
 metadata?: (...) | (...);
 text: string;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 | {
 custom?: (...)
 | (...);
 data?: unknown;
 media?: undefined;
 metadata?: (...) | (...);
 text?: undefined;
 toolRequest: { input?: ...; name: ...; ref?: ... };
 toolResponse?: undefined;
 }
 | {
 custom?: (...)
 | (...);
 data?: unknown;
 media?: undefined;
 metadata?: (...) | (...);
 text?: undefined;
 toolRequest?: undefined;
 toolResponse: { name: ...; output?: ...; ref?: ... };
 }
 | {
 custom?: (...)
 | (...);
 data?: unknown;
 media?: undefined;
 metadata?: (...) | (...);
 text?: undefined;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 | {
 custom: Record<(...), (...)>;
 data?: unknown;
 media?: undefined;
 metadata?: (...) | (...);
 text?: undefined;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 )[];
 metadata?: Record<string, unknown>;
 role: "user" | "model" | "tool" | "system";
 };
 usage?: {
 custom?: Record<string, number>;
 inputAudioFiles?: number;
 inputCharacters?: number;
 inputImages?: number;
 inputTokens?: number;
 inputVideos?: number;
 outputAudioFiles?: number;
 outputCharacters?: number;
 outputImages?: number;
 outputTokens?: number;
 outputVideos?: number;
 totalTokens?: number;
 };
 }[];
 custom?: unknown;
 finishMessage?: string;
 finishReason?: | "length"
 | "stop"
 | "interrupted"
 | "blocked"
 | "unknown"
 | "other";
 latencyMs?: number;
 message?: {
 content: (
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media: { contentType?: string; url: string };
 metadata?: Record<string, unknown>;
 text?: undefined;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 text: string;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 text?: undefined;
 toolRequest: { input?: unknown; name: string; ref?: string };
 toolResponse?: undefined;
 }
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 text?: undefined;
 toolRequest?: undefined;
 toolResponse: { name: string; output?: unknown; ref?: string };
 }
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 text?: undefined;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 | {
 custom: Record<string, any>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 text?: undefined;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 )[];
 metadata?: Record<string, unknown>;
 role: "user" | "model" | "tool" | "system";
 };
 raw?: unknown;
 request?: {
 candidates?: number;
 config?: any;
 docs?: {
 content: ({ media?: ...; text: ... } | { media: ...; text?: ... })[];
 metadata?: Record<string, any>;
 }[];
 messages: {
 content: (
 | {
 custom?: (...)
 | (...);
 data?: unknown;
 media: { contentType?: ...; url: ... };
 metadata?: (...) | (...);
 text?: undefined;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 | {
 custom?: (...)
 | (...);
 data?: unknown;
 media?: undefined;
 metadata?: (...) | (...);
 text: string;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 | {
 custom?: (...)
 | (...);
 data?: unknown;
 media?: undefined;
 metadata?: (...) | (...);
 text?: undefined;
 toolRequest: { input?: ...; name: ...; ref?: ... };
 toolResponse?: undefined;
 }
 | {
 custom?: (...)
 | (...);
 data?: unknown;
 media?: undefined;
 metadata?: (...) | (...);
 text?: undefined;
 toolRequest?: undefined;
 toolResponse: { name: ...; output?: ...; ref?: ... };
 }
 | {
 custom?: (...)
 | (...);
 data?: unknown;
 media?: undefined;
 metadata?: (...) | (...);
 text?: undefined;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 | {
 custom: Record<(...), (...)>;
 data?: unknown;
 media?: undefined;
 metadata?: (...) | (...);
 text?: undefined;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 )[];
 metadata?: Record<string, unknown>;
 role: "user" | "model" | "tool" | "system";
 }[];
 output?: {
 constrained?: boolean;
 contentType?: string;
 format?: string;
 instructions?: string;
 schema?: Record<string, any>;
 };
 toolChoice?: "required"
 | "auto"
 | "none";
 tools?: {
 description: string;
 inputSchema?: null | Record<string, any>;
 metadata?: Record<string, any>;
 name: string;
 outputSchema?: null | Record<string, any>;
 }[];
 };
 usage?: {
 custom?: Record<string, number>;
 inputAudioFiles?: number;
 inputCharacters?: number;
 inputImages?: number;
 inputTokens?: number;
 inputVideos?: number;
 outputAudioFiles?: number;
 outputCharacters?: number;
 outputImages?: number;
 outputTokens?: number;
 outputVideos?: number;
 totalTokens?: number;
 };
 },
 >,
): ModelAction<CustomOptionsSchema>
Defines a new model and adds it to the registry.
Type Parameters
- CustomOptionsSchema extends ZodType<any, any, any, CustomOptionsSchema> = ZodTypeAny
Parameters
- options: DefineModelOptions<CustomOptionsSchema>
- runner: (
 request: GenerateRequest<CustomOptionsSchema>,
 streamingCallback?: StreamingCallback<
 {
 aggregated?: boolean;
 content: (
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media: { contentType?: string; url: string };
 metadata?: Record<string, unknown>;
 text?: undefined;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 text: string;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 text?: undefined;
 toolRequest: { input?: unknown; name: string; ref?: string };
 toolResponse?: undefined;
 }
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 text?: undefined;
 toolRequest?: undefined;
 toolResponse: { name: string; output?: unknown; ref?: string };
 }
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 text?: undefined;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 | {
 custom: Record<string, any>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 text?: undefined;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 )[];
 custom?: unknown;
 index?: number;
 role?: "user"
 | "model"
 | "tool"
 | "system";
 },
 >,
 ) => Promise<
 {
 candidates?: {
 custom?: unknown;
 finishMessage?: string;
 finishReason: | "length"
 | "stop"
 | "interrupted"
 | "blocked"
 | "unknown"
 | "other";
 index: number;
 message: {
 content: (
 | {
 custom?: (...)
 | (...);
 data?: unknown;
 media: { contentType?: ...; url: ... };
 metadata?: (...) | (...);
 text?: undefined;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 | {
 custom?: (...)
 | (...);
 data?: unknown;
 media?: undefined;
 metadata?: (...) | (...);
 text: string;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 | {
 custom?: (...)
 | (...);
 data?: unknown;
 media?: undefined;
 metadata?: (...) | (...);
 text?: undefined;
 toolRequest: { input?: ...; name: ...; ref?: ... };
 toolResponse?: undefined;
 }
 | {
 custom?: (...)
 | (...);
 data?: unknown;
 media?: undefined;
 metadata?: (...) | (...);
 text?: undefined;
 toolRequest?: undefined;
 toolResponse: { name: ...; output?: ...; ref?: ... };
 }
 | {
 custom?: (...)
 | (...);
 data?: unknown;
 media?: undefined;
 metadata?: (...) | (...);
 text?: undefined;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 | {
 custom: Record<(...), (...)>;
 data?: unknown;
 media?: undefined;
 metadata?: (...) | (...);
 text?: undefined;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 )[];
 metadata?: Record<string, unknown>;
 role: "user" | "model" | "tool" | "system";
 };
 usage?: {
 custom?: Record<string, number>;
 inputAudioFiles?: number;
 inputCharacters?: number;
 inputImages?: number;
 inputTokens?: number;
 inputVideos?: number;
 outputAudioFiles?: number;
 outputCharacters?: number;
 outputImages?: number;
 outputTokens?: number;
 outputVideos?: number;
 totalTokens?: number;
 };
 }[];
 custom?: unknown;
 finishMessage?: string;
 finishReason?: | "length"
 | "stop"
 | "interrupted"
 | "blocked"
 | "unknown"
 | "other";
 latencyMs?: number;
 message?: {
 content: (
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media: { contentType?: string; url: string };
 metadata?: Record<string, unknown>;
 text?: undefined;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 text: string;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 text?: undefined;
 toolRequest: { input?: unknown; name: string; ref?: string };
 toolResponse?: undefined;
 }
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 text?: undefined;
 toolRequest?: undefined;
 toolResponse: { name: string; output?: unknown; ref?: string };
 }
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 text?: undefined;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 | {
 custom: Record<string, any>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 text?: undefined;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 )[];
 metadata?: Record<string, unknown>;
 role: "user" | "model" | "tool" | "system";
 };
 raw?: unknown;
 request?: {
 candidates?: number;
 config?: any;
 docs?: {
 content: ({ media?: ...; text: ... } | { media: ...; text?: ... })[];
 metadata?: Record<string, any>;
 }[];
 messages: {
 content: (
 | {
 custom?: (...)
 | (...);
 data?: unknown;
 media: { contentType?: ...; url: ... };
 metadata?: (...) | (...);
 text?: undefined;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 | {
 custom?: (...)
 | (...);
 data?: unknown;
 media?: undefined;
 metadata?: (...) | (...);
 text: string;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 | {
 custom?: (...)
 | (...);
 data?: unknown;
 media?: undefined;
 metadata?: (...) | (...);
 text?: undefined;
 toolRequest: { input?: ...; name: ...; ref?: ... };
 toolResponse?: undefined;
 }
 | {
 custom?: (...)
 | (...);
 data?: unknown;
 media?: undefined;
 metadata?: (...) | (...);
 text?: undefined;
 toolRequest?: undefined;
 toolResponse: { name: ...; output?: ...; ref?: ... };
 }
 | {
 custom?: (...)
 | (...);
 data?: unknown;
 media?: undefined;
 metadata?: (...) | (...);
 text?: undefined;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 | {
 custom: Record<(...), (...)>;
 data?: unknown;
 media?: undefined;
 metadata?: (...) | (...);
 text?: undefined;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 )[];
 metadata?: Record<string, unknown>;
 role: "user" | "model" | "tool" | "system";
 }[];
 output?: {
 constrained?: boolean;
 contentType?: string;
 format?: string;
 instructions?: string;
 schema?: Record<string, any>;
 };
 toolChoice?: "required"
 | "auto"
 | "none";
 tools?: {
 description: string;
 inputSchema?: null | Record<string, any>;
 metadata?: Record<string, any>;
 name: string;
 outputSchema?: null | Record<string, any>;
 }[];
 };
 usage?: {
 custom?: Record<string, number>;
 inputAudioFiles?: number;
 inputCharacters?: number;
 inputImages?: number;
 inputTokens?: number;
 inputVideos?: number;
 outputAudioFiles?: number;
 outputCharacters?: number;
 outputImages?: number;
 outputTokens?: number;
 outputVideos?: number;
 totalTokens?: number;
 };
 },
 >
Returns ModelAction<CustomOptionsSchema>
Inherited from Genkit.defineModel
- Defined in genkit/src/genkit.ts:225

definePartial

definePartial(name: string, source: string): void
Creates a handlebars partial (https://handlebarsjs.com/guide/partials.html) to be used in dotpormpt templates.
Parameters
- name: string
- source: string
Returns void
Inherited from Genkit.definePartial
- Defined in genkit/src/genkit.ts:460

definePrompt

definePrompt = ZodTypeAny,
 O extends ZodType<any, any, any, O> = ZodTypeAny,
 CustomOptions extends ZodType<any, any, any, CustomOptions> = ZodTypeAny,
>(
 options: PromptConfig<I, O, CustomOptions>,
 templateOrFn?: string | PromptFn<I, ZodTypeAny>,
): ExecutablePrompt<TypeOf, O, CustomOptions>
Defines and registers a prompt based on a function.

This is an alternative to defining and importing a .prompt file, providing the most advanced control over how the final request to the model is made.
Type Parameters
- I extends ZodType<any, any, any, I> = ZodTypeAny
- O extends ZodType<any, any, any, O> = ZodTypeAny
- CustomOptions extends ZodType<any, any, any, CustomOptions> = ZodTypeAny
Parameters
- options: PromptConfig<I, O, CustomOptions>
 Prompt metadata including model, model params, input/output schemas, etc
- OptionaltemplateOrFn: string | PromptFn<I, ZodTypeAny>
 Deprecated
 use options.messages with a template string instead.
Returns ExecutablePrompt<TypeOf, O, CustomOptions>
Inherited from Genkit.definePrompt
- Defined in genkit/src/genkit.ts:332

defineReranker

defineReranker<
 OptionsType extends ZodType<any, any, any, OptionsType> = ZodTypeAny,
>(
 options: {
 configSchema?: OptionsType;
 info?: { label?: string; supports?: { media?: boolean } };
 name: string;
 },
 runner: RerankerFn<OptionsType>,
): RerankerAction<OptionsType>
Creates a reranker action for the provided RerankerFn implementation.
Type Parameters
- OptionsType extends ZodType<any, any, any, OptionsType> = ZodTypeAny
Parameters
- options: {
 configSchema?: OptionsType;
 info?: { label?: string; supports?: { media?: boolean } };
 name: string;
 }
- runner: RerankerFn<OptionsType>
Returns RerankerAction<OptionsType>
Inherited from Genkit.defineReranker
- Defined in genkit/src/genkit.ts:467

defineRetriever

defineRetriever<
 OptionsType extends ZodType<any, any, any, OptionsType> = ZodTypeAny,
>(
 options: {
 configSchema?: OptionsType;
 info?: { label?: string; supports?: { media?: boolean } };
 name: string;
 },
 runner: RetrieverFn<OptionsType>,
): RetrieverAction<OptionsType>
Creates a retriever action for the provided RetrieverFn implementation.
Type Parameters
- OptionsType extends ZodType<any, any, any, OptionsType> = ZodTypeAny
Parameters
- options: {
 configSchema?: OptionsType;
 info?: { label?: string; supports?: { media?: boolean } };
 name: string;
 }
- runner: RetrieverFn<OptionsType>
Returns RetrieverAction<OptionsType>
Inherited from Genkit.defineRetriever
- Defined in genkit/src/genkit.ts:374

defineSchema

defineSchema<T extends ZodType<any, any, any, T>>(name: string, schema: T): T
Defines and registers a schema from a Zod schema.

Defined schemas can be referenced by name in prompts in place of inline schemas.
Type Parameters
- T extends ZodType<any, any, any, T>
Parameters
- name: string
- schema: T
Returns T
Inherited from Genkit.defineSchema
- Defined in genkit/src/genkit.ts:209

defineSimpleRetriever

defineSimpleRetriever<C extends ZodType<any, any, any, C> = ZodTypeAny, R = any>(
options: SimpleRetrieverOptions<C, R>,
handler: (query: Document, config: TypeOf<C>) => Promise<R[]>,
): RetrieverAction<C>
Beta
defineSimpleRetriever makes it easy to map existing data into documents that can be used for prompt augmentation.
Type Parameters
- C extends ZodType<any, any, any, C> = ZodTypeAny
- R = any
Parameters
- options: SimpleRetrieverOptions<C, R>
 Configuration options for the retriever.
- handler: (query: Document, config: TypeOf<C>) => Promise<R[]>
 A function that queries a datastore and returns items from which to extract documents.
Returns RetrieverAction<C>
A Genkit retriever.
Inherited from Genkit.defineSimpleRetriever
- Defined in genkit/src/genkit.ts:393

defineTool

defineTool,
 O extends ZodType<any, any, any, O>,
>(
 config: ToolConfig<I, O>,
 fn: ToolFn<I, O>,
): ToolAction<I, O>
Defines and registers a tool.

Tools can be passed to models by name or value during generate calls to be called automatically based on the prompt and situation.
Type Parameters
- I extends ZodType<any, any, any, I>
- O extends ZodType<any, any, any, O>
Parameters
- config: ToolConfig<I, O>
- fn: ToolFn<I, O>
Returns ToolAction<I, O>
Inherited from Genkit.defineTool
- Defined in genkit/src/genkit.ts:197

embed

embed<CustomOptions extends ZodType<any, any, any, CustomOptions>>(
params: EmbedderParams<CustomOptions>,
): Promise<{ embedding: number[]; metadata?: Record<string, unknown> }[]>
Embeds the given content using the specified embedder.
Type Parameters
- CustomOptions extends ZodType<any, any, any, CustomOptions>
Parameters
- params: EmbedderParams<CustomOptions>
Returns Promise<{ embedding: number[]; metadata?: Record<string, unknown> }[]>
Inherited from Genkit.embed
- Defined in genkit/src/genkit.ts:481

embedMany

embedMany<
 ConfigSchema extends ZodType<any, any, any, ConfigSchema> = ZodTypeAny,
>(
 params: {
 content:
 | string[]
 | {
 content: (
 | { media?: undefined; text: string }
 | { media: { contentType?: string; url: string }; text?: undefined }
 )[];
 metadata?: Record<string, any>;
 }[];
 embedder: EmbedderArgument<ConfigSchema>;
 metadata?: Record<string, unknown>;
 options?: TypeOf<ConfigSchema>;
 },
): Promise<EmbeddingBatch>
A veneer for interacting with embedder models in bulk.
Type Parameters
- ConfigSchema extends ZodType<any, any, any, ConfigSchema> = ZodTypeAny
Parameters
- params: {
 content:
 | string[]
 | {
 content: (
 | { media?: undefined; text: string }
 | { media: { contentType?: string; url: string }; text?: undefined }
 )[];
 metadata?: Record<string, any>;
 }[];
 embedder: EmbedderArgument<ConfigSchema>;
 metadata?: Record<string, unknown>;
 options?: TypeOf<ConfigSchema>;
 }
Returns Promise<EmbeddingBatch>
Inherited from Genkit.embedMany
- Defined in genkit/src/genkit.ts:490

evaluate

evaluate<
 DataPoint extends
 ZodObject<
 {
 context: ZodOptional<ZodArray<ZodUnknown, "many">>;
 input: ZodUnknown;
 output: ZodOptional<ZodUnknown>;
 reference: ZodOptional<ZodUnknown>;
 testCaseId: ZodOptional<ZodString>;
 traceIds: ZodOptional<ZodArray<ZodString, "many">>;
 },
 "strip",
 ZodTypeAny,
 {
 context?: unknown[];
 input?: unknown;
 output?: unknown;
 reference?: unknown;
 testCaseId?: string;
 traceIds?: string[];
 },
 {
 context?: unknown[];
 input?: unknown;
 output?: unknown;
 reference?: unknown;
 testCaseId?: string;
 traceIds?: string[];
 },
 DataPoint,
 > = ZodObject<
 {
 context: ZodOptional<ZodArray<ZodUnknown, "many">>;
 input: ZodUnknown;
 output: ZodOptional<ZodUnknown>;
 reference: ZodOptional<ZodUnknown>;
 testCaseId: ZodOptional<ZodString>;
 traceIds: ZodOptional<ZodArray<ZodString, "many">>;
 },
 "strip",
 ZodTypeAny,
 {
 context?: unknown[];
 input?: unknown;
 output?: unknown;
 reference?: unknown;
 testCaseId?: string;
 traceIds?: string[];
 },
 {
 context?: unknown[];
 input?: unknown;
 output?: unknown;
 reference?: unknown;
 testCaseId?: string;
 traceIds?: string[];
 },
 >,
 CustomOptions extends ZodType<any, any, any, CustomOptions> = ZodTypeAny,
>(
 params: EvaluatorParams<DataPoint, CustomOptions>,
): Promise<
 {
 evaluation: | {
 details?: objectOutputType<
 { reasoning: ZodOptional<ZodString> },
 ZodTypeAny,
 "passthrough",
 >;
 error?: string;
 id?: string;
 score?: string | number | boolean;
 }
 | {
 details?: objectOutputType<
 { reasoning: ZodOptional<ZodString> },
 ZodTypeAny,
 "passthrough",
 >;
 error?: string;
 id?: string;
 score?: string | number | boolean;
 }[];
 sampleIndex?: number;
 spanId?: string;
 testCaseId: string;
 traceId?: string;
 }[],
>
Evaluates the given dataset using the specified evaluator.
Type Parameters
- DataPoint extends ZodObject<
 {
 context: ZodOptional<ZodArray<ZodUnknown, "many">>;
 input: ZodUnknown;
 output: ZodOptional<ZodUnknown>;
 reference: ZodOptional<ZodUnknown>;
 testCaseId: ZodOptional<ZodString>;
 traceIds: ZodOptional<ZodArray<ZodString, "many">>;
 },
 "strip",
 ZodTypeAny,
 {
 context?: unknown[];
 input?: unknown;
 output?: unknown;
 reference?: unknown;
 testCaseId?: string;
 traceIds?: string[];
 },
 {
 context?: unknown[];
 input?: unknown;
 output?: unknown;
 reference?: unknown;
 testCaseId?: string;
 traceIds?: string[];
 },
 DataPoint,
 > = ZodObject<
 {
 context: ZodOptional<ZodArray<ZodUnknown, "many">>;
 input: ZodUnknown;
 output: ZodOptional<ZodUnknown>;
 reference: ZodOptional<ZodUnknown>;
 testCaseId: ZodOptional<ZodString>;
 traceIds: ZodOptional<ZodArray<ZodString, "many">>;
 },
 "strip",
 ZodTypeAny,
 {
 context?: unknown[];
 input?: unknown;
 output?: unknown;
 reference?: unknown;
 testCaseId?: string;
 traceIds?: string[];
 },
 {
 context?: unknown[];
 input?: unknown;
 output?: unknown;
 reference?: unknown;
 testCaseId?: string;
 traceIds?: string[];
 },
 >
- CustomOptions extends ZodType<any, any, any, CustomOptions> = ZodTypeAny
Parameters
- params: EvaluatorParams<DataPoint, CustomOptions>
Returns Promise<
 {
 evaluation: | {
 details?: objectOutputType<
 { reasoning: ZodOptional<ZodString> },
 ZodTypeAny,
 "passthrough",
 >;
 error?: string;
 id?: string;
 score?: string | number | boolean;
 }
 | {
 details?: objectOutputType<
 { reasoning: ZodOptional<ZodString> },
 ZodTypeAny,
 "passthrough",
 >;
 error?: string;
 id?: string;
 score?: string | number | boolean;
 }[];
 sampleIndex?: number;
 spanId?: string;
 testCaseId: string;
 traceId?: string;
 }[],
>
Inherited from Genkit.evaluate
- Defined in genkit/src/genkit.ts:502

generate

generate<O extends ZodType<any, any, any, O> = ZodTypeAny>(
strPrompt: string,
): Promise<GenerateResponse<TypeOf<O>>>
Make a generate call to the default model with a simple text prompt.
```
const ai = genkit({
 plugins: [googleAI()],
 model: gemini15Flash, // default model
})

const { text } = await ai.generate('hi');
```
Type Parameters
- O extends ZodType<any, any, any, O> = ZodTypeAny
Parameters
- strPrompt: string
Returns Promise<GenerateResponse<TypeOf<O>>>
Inherited from Genkit.generate
- Defined in genkit/src/genkit.ts:548
generate<O extends ZodType<any, any, any, O> = ZodTypeAny>(
 parts: (
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 text: string;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media: { contentType?: string; url: string };
 metadata?: Record<string, unknown>;
 text?: undefined;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 text?: undefined;
 toolRequest: { input?: unknown; name: string; ref?: string };
 toolResponse?: undefined;
 }
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 text?: undefined;
 toolRequest?: undefined;
 toolResponse: { name: string; output?: unknown; ref?: string };
 }
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 text?: undefined;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 | {
 custom: Record<string, any>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 text?: undefined;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 )[],
): Promise<GenerateResponse<TypeOf<O>>>
Make a generate call to the default model with a multipart request.
```
const ai = genkit({
 plugins: [googleAI()],
 model: gemini15Flash, // default model
})

const { text } = await ai.generate([
 { media: {url: 'http://....'} },
 { text: 'describe this image' }
]);
```
Type Parameters
- O extends ZodType<any, any, any, O> = ZodTypeAny
Parameters
- parts: (
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 text: string;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media: { contentType?: string; url: string };
 metadata?: Record<string, unknown>;
 text?: undefined;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 text?: undefined;
 toolRequest: { input?: unknown; name: string; ref?: string };
 toolResponse?: undefined;
 }
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 text?: undefined;
 toolRequest?: undefined;
 toolResponse: { name: string; output?: unknown; ref?: string };
 }
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 text?: undefined;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 | {
 custom: Record<string, any>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 text?: undefined;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 )[]
Returns Promise<GenerateResponse<TypeOf<O>>>
Inherited from Genkit.generate
- Defined in genkit/src/genkit.ts:567
generate<
 O extends ZodType<any, any, any, O> = ZodTypeAny,
 CustomOptions extends
 ZodType<any, any, any, CustomOptions> = ZodObject<
 {
 maxOutputTokens: ZodOptional<ZodNumber>;
 stopSequences: ZodOptional<ZodArray<ZodString, "many">>;
 temperature: ZodOptional<ZodNumber>;
 topK: ZodOptional<ZodNumber>;
 topP: ZodOptional<ZodNumber>;
 version: ZodOptional<ZodString>;
 },
 "strip",
 ZodTypeAny,
 {
 maxOutputTokens?: number;
 stopSequences?: string[];
 temperature?: number;
 topK?: number;
 topP?: number;
 version?: string;
 },
 {
 maxOutputTokens?: number;
 stopSequences?: string[];
 temperature?: number;
 topK?: number;
 topP?: number;
 version?: string;
 },
 >,
>(
 opts:
 | GenerateOptions<O, CustomOptions>
 | PromiseLike<GenerateOptions<O, CustomOptions>>,
): Promise<GenerateResponse<TypeOf<O>>>
Generate calls a generative model based on the provided prompt and configuration. If messages is provided, the generation will include a conversation history in its request. If tools are provided, the generate method will automatically resolve tool calls returned from the model unless returnToolRequests is set to true.

See GenerateOptions for detailed information about available options.
```
const ai = genkit({
 plugins: [googleAI()],
})

const { text } = await ai.generate({
 system: 'talk like a pirate',
 prompt: [
 { media: { url: 'http://....' } },
 { text: 'describe this image' }
 ],
 messages: conversationHistory,
 tools: [ userInfoLookup ],
 model: gemini15Flash,
});
```
Type Parameters
- O extends ZodType<any, any, any, O> = ZodTypeAny
- CustomOptions extends ZodType<any, any, any, CustomOptions> = ZodObject<
 {
 maxOutputTokens: ZodOptional<ZodNumber>;
 stopSequences: ZodOptional<ZodArray<ZodString, "many">>;
 temperature: ZodOptional<ZodNumber>;
 topK: ZodOptional<ZodNumber>;
 topP: ZodOptional<ZodNumber>;
 version: ZodOptional<ZodString>;
 },
 "strip",
 ZodTypeAny,
 {
 maxOutputTokens?: number;
 stopSequences?: string[];
 temperature?: number;
 topK?: number;
 topP?: number;
 version?: string;
 },
 {
 maxOutputTokens?: number;
 stopSequences?: string[];
 temperature?: number;
 topK?: number;
 topP?: number;
 version?: string;
 },
 >
Parameters
- opts:
 | GenerateOptions<O, CustomOptions>
 | PromiseLike<GenerateOptions<O, CustomOptions>>
Returns Promise<GenerateResponse<TypeOf<O>>>
Inherited from Genkit.generate
- Defined in genkit/src/genkit.ts:596

generateStream

generateStream<O extends ZodType<any, any, any, O> = ZodTypeAny>(
strPrompt: string,
): GenerateStreamResponse<TypeOf<O>>
Make a streaming generate call to the default model with a simple text prompt.
```
const ai = genkit({
 plugins: [googleAI()],
 model: gemini15Flash, // default model
})

const { response, stream } = ai.generateStream('hi');
for await (const chunk of stream) {
 console.log(chunk.text);
}
console.log((await response).text);
```
Type Parameters
- O extends ZodType<any, any, any, O> = ZodTypeAny
Parameters
- strPrompt: string
Returns GenerateStreamResponse<TypeOf<O>>
Inherited from Genkit.generateStream
- Defined in genkit/src/genkit.ts:644
generateStream<O extends ZodType<any, any, any, O> = ZodTypeAny>(
 parts: (
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 text: string;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media: { contentType?: string; url: string };
 metadata?: Record<string, unknown>;
 text?: undefined;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 text?: undefined;
 toolRequest: { input?: unknown; name: string; ref?: string };
 toolResponse?: undefined;
 }
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 text?: undefined;
 toolRequest?: undefined;
 toolResponse: { name: string; output?: unknown; ref?: string };
 }
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 text?: undefined;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 | {
 custom: Record<string, any>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 text?: undefined;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 )[],
): GenerateStreamResponse<TypeOf<O>>
Make a streaming generate call to the default model with a multipart request.
```
const ai = genkit({
 plugins: [googleAI()],
 model: gemini15Flash, // default model
})

const { response, stream } = ai.generateStream([
 { media: {url: 'http://....'} },
 { text: 'describe this image' }
]);
for await (const chunk of stream) {
 console.log(chunk.text);
}
console.log((await response).text);
```
Type Parameters
- O extends ZodType<any, any, any, O> = ZodTypeAny
Parameters
- parts: (
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 text: string;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media: { contentType?: string; url: string };
 metadata?: Record<string, unknown>;
 text?: undefined;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 text?: undefined;
 toolRequest: { input?: unknown; name: string; ref?: string };
 toolResponse?: undefined;
 }
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 text?: undefined;
 toolRequest?: undefined;
 toolResponse: { name: string; output?: unknown; ref?: string };
 }
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 text?: undefined;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 | {
 custom: Record<string, any>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 text?: undefined;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 )[]
Returns GenerateStreamResponse<TypeOf<O>>
Inherited from Genkit.generateStream
- Defined in genkit/src/genkit.ts:667
generateStream<
 O extends ZodType<any, any, any, O> = ZodTypeAny,
 CustomOptions extends
 ZodType<any, any, any, CustomOptions> = ZodObject<
 {
 maxOutputTokens: ZodOptional<ZodNumber>;
 stopSequences: ZodOptional<ZodArray<ZodString, "many">>;
 temperature: ZodOptional<ZodNumber>;
 topK: ZodOptional<ZodNumber>;
 topP: ZodOptional<ZodNumber>;
 version: ZodOptional<ZodString>;
 },
 "strip",
 ZodTypeAny,
 {
 maxOutputTokens?: number;
 stopSequences?: string[];
 temperature?: number;
 topK?: number;
 topP?: number;
 version?: string;
 },
 {
 maxOutputTokens?: number;
 stopSequences?: string[];
 temperature?: number;
 topK?: number;
 topP?: number;
 version?: string;
 },
 >,
>(
 parts:
 | GenerateOptions<O, CustomOptions>
 | PromiseLike<GenerateOptions<O, CustomOptions>>,
): GenerateStreamResponse<TypeOf<O>>
Streaming generate calls a generative model based on the provided prompt and configuration. If messages is provided, the generation will include a conversation history in its request. If tools are provided, the generate method will automatically resolve tool calls returned from the model unless returnToolRequests is set to true.

See GenerateOptions for detailed information about available options.
```
const ai = genkit({
 plugins: [googleAI()],
})

const { response, stream } = ai.generateStream({
 system: 'talk like a pirate',
 prompt: [
 { media: { url: 'http://....' } },
 { text: 'describe this image' }
 ],
 messages: conversationHistory,
 tools: [ userInfoLookup ],
 model: gemini15Flash,
});
for await (const chunk of stream) {
 console.log(chunk.text);
}
console.log((await response).text);
```
Type Parameters
- O extends ZodType<any, any, any, O> = ZodTypeAny
- CustomOptions extends ZodType<any, any, any, CustomOptions> = ZodObject<
 {
 maxOutputTokens: ZodOptional<ZodNumber>;
 stopSequences: ZodOptional<ZodArray<ZodString, "many">>;
 temperature: ZodOptional<ZodNumber>;
 topK: ZodOptional<ZodNumber>;
 topP: ZodOptional<ZodNumber>;
 version: ZodOptional<ZodString>;
 },
 "strip",
 ZodTypeAny,
 {
 maxOutputTokens?: number;
 stopSequences?: string[];
 temperature?: number;
 topK?: number;
 topP?: number;
 version?: string;
 },
 {
 maxOutputTokens?: number;
 stopSequences?: string[];
 temperature?: number;
 topK?: number;
 topP?: number;
 version?: string;
 },
 >
Parameters
- parts:
 | GenerateOptions<O, CustomOptions>
 | PromiseLike<GenerateOptions<O, CustomOptions>>
Returns GenerateStreamResponse<TypeOf<O>>
Inherited from Genkit.generateStream
- Defined in genkit/src/genkit.ts:700

index

index<CustomOptions extends ZodType<any, any, any, CustomOptions>>(
params: IndexerParams<CustomOptions>,
): Promise<void>
Indexes documents using the provided indexer.
Type Parameters
- CustomOptions extends ZodType<any, any, any, CustomOptions>
Parameters
- params: IndexerParams<CustomOptions>
Returns Promise<void>
Inherited from Genkit.index
- Defined in genkit/src/genkit.ts:521

loadSession

loadSession(
sessionId: string,
options: SessionOptions<any>,
): Promise<Session<any>>
Beta
Loads a session from the store.
Parameters
- sessionId: string
- options: SessionOptions<any>
Returns Promise<Session<any>>
- Defined in genkit/src/genkit-beta.ts:153

prompt

prompt = ZodTypeAny,
 O extends ZodType<any, any, any, O> = ZodTypeAny,
 CustomOptions extends ZodType<any, any, any, CustomOptions> = ZodTypeAny,
>(
 name: string,
 options?: { variant?: string },
): ExecutablePrompt<TypeOf, O, CustomOptions>
Beta
Looks up a prompt by name and optional variant.
Type Parameters
- I extends ZodType<any, any, any, I> = ZodTypeAny
- O extends ZodType<any, any, any, O> = ZodTypeAny
- CustomOptions extends ZodType<any, any, any, CustomOptions> = ZodTypeAny
Parameters
- name: string
- Optionaloptions: { variant?: string }
Returns ExecutablePrompt<TypeOf, O, CustomOptions>
Todo
TODO: Show an example of a name and variant.
Inherited from Genkit.prompt
- Defined in genkit/src/genkit.ts:240

rerank

rerank<CustomOptions extends ZodType<any, any, any, CustomOptions>>(
params: RerankerParams<CustomOptions>,
): Promise<RankedDocument[]>
Reranks documents from a RerankerArgument based on the provided query.
Type Parameters
- CustomOptions extends ZodType<any, any, any, CustomOptions>
Parameters
- params: RerankerParams<CustomOptions>
Returns Promise<RankedDocument[]>
Inherited from Genkit.rerank
- Defined in genkit/src/genkit.ts:512

retrieve

retrieve<CustomOptions extends ZodType<any, any, any, CustomOptions>>(
params: RetrieverParams<CustomOptions>,
): Promise<Document[]>
Retrieves documents from the retriever based on the provided query.
Type Parameters
- CustomOptions extends ZodType<any, any, any, CustomOptions>
Parameters
- params: RetrieverParams<CustomOptions>
Returns Promise<Document[]>
Inherited from Genkit.retrieve
- Defined in genkit/src/genkit.ts:530

run

run<T>(name: string, func: () => Promise<T>): Promise<T>
A flow step that executes the provided function. Each run step is recorded separately in the trace.
```
ai.defineFlow('hello', async() => {
 await ai.run('step1', async () => {
 // ... step 1
 });
 await ai.run('step2', async () => {
 // ... step 2
 });
 return result;
})
```
Type Parameters
- T
Parameters
- name: string
- func: () => Promise<T>
Returns Promise<T>
Inherited from Genkit.run
- Defined in genkit/src/genkit.ts:739
run<T>(name: string, input: any, func: (input?: any) => Promise<T>): Promise<T>
A flow step that executes the provided function. Each run step is recorded separately in the trace.
```
ai.defineFlow('hello', async() => {
 await ai.run('step1', async () => {
 // ... step 1
 });
 await ai.run('step2', async () => {
 // ... step 2
 });
 return result;
```
Type Parameters
- T
Parameters
- name: string
- input: any
- func: (input?: any) => Promise<T>
Returns Promise<T>
Inherited from Genkit.run
- Defined in genkit/src/genkit.ts:755

stopServers

stopServers(): Promise<void>
Stops all servers.

Returns Promise<void>
Inherited from Genkit.stopServers
- Defined in genkit/src/genkit.ts:820

Class GenkitBetaBeta

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns GenkitBeta

Properties

Readonlyflows

Readonlyoptions

Readonlyregistry

Accessors

apiStability

Returns "beta" | "stable"

Methods

chat

Type Parameters

Parameters

Returns Chat

Type Parameters

Parameters

Returns Chat

createSession

Type Parameters

Parameters

Returns Session<S>

currentContext

Returns undefined | ActionContext

currentSession

Type Parameters

Returns Session<S>

defineEmbedder

Type Parameters

Parameters

Returns EmbedderAction<ConfigSchema>

defineEvaluator

Type Parameters

Parameters

defineFlow

Type Parameters

Parameters

Returns Action<I, O, S, ActionRunOptions<S>>

Todo

defineFormat

Parameters

defineHelper

Parameters

Returns void

defineIndexer

Type Parameters

Parameters

Returns IndexerAction<IndexerOptions>

defineInterrupt

Type Parameters

Parameters

Returns ToolAction<I, O>

defineJsonSchema

Parameters

Returns any

defineModel

Type Parameters

Parameters

Returns ModelAction<CustomOptionsSchema>

definePartial

Parameters

Returns void

definePrompt

Type Parameters

Parameters

Deprecated

Returns ExecutablePrompt<TypeOf<I>, O, CustomOptions>

defineReranker

Type Parameters

Parameters

Returns RerankerAction<OptionsType>

defineRetriever

Class GenkitBeta`Beta`

`Readonly`flows

`Readonly`options

`Readonly`registry