plugin library

Classes

$Candidate

$CustomPart

$DataPart

$DocumentData

$Embedding

$EmbedRequest

$EmbedResponse

$GenerateActionOptions

$GenerateActionOutputConfig

$GenerateRequest

$GenerateResponse

$GenerateResumeOptions

$GenerationUsage

$Media

$MediaPart

$Message

$ModelInfo

$ModelRequest

$ModelResponse

$ModelResponseChunk

$Operation

$OutputConfig

$Part

$ReasoningPart

$ResourcePart

$TextPart

$ToolDefinition

$ToolRequest

$ToolRequestPart

$ToolResponse

$ToolResponsePart

Action<Input, Output, Chunk, Init>

ActionMetadata<Input, Output, Chunk, Init>

BidiModel<C>

Candidate

CustomPart

DataPart

DocumentData

Embedder<C>

EmbedderRef<C>

Embedding

EmbedRequest

EmbedResponse

GenerateActionOptions

GenerateActionOutputConfig

GenerateActionOutputConfigInstructions

GenerateMiddleware

Middleware for the processing of a Generation request.

GenerateMiddlewareDef<C>

GenerateMiddlewareRef<C>

GenerateRequest

GenerateResponse

GenerateResponseChunk<O>

A chunk of a response from a generate action.

GenerateResponseHelper<O>

A response from a generate action.

GenerateResumeOptions

GenerationUsage

GenkitPlugin

A plugin for Genkit.

InterruptResponse

A response to an interrupted tool request.

Media

MediaPart

Message

Model<C>

ModelInfo

ModelRef<C>

ModelRequest

ModelResponse

ModelResponseChunk

Operation

OutputConfig

Part

ReasoningPart

ResourcePart

TextPart

Tool<I, O>

ToolDefinition

ToolFnArgs<I>

Arguments passed to a tool function execution.

ToolRequest

ToolRequestPart

ToolResponse

ToolResponsePart

Enums

StatusCodes

Exception thrown for errors encountered during Genkit flow operations. Common status codes for Genkit operations.

Extension Types

FinishReason

Role

Extensions

MessageExtension on Message

ModelResponseChunkExtension on ModelResponseChunk

ModelResponseExtension on ModelResponse

PartExtension on Part

Constants

genkitVersion → const String

Functions

defineMiddleware<C>({required String name, required GenerateMiddleware create([C? config]), SchemanticType<C>? configSchema}) → GenerateMiddlewareDef<C>

embedderMetadata(String name, {SchemanticType? customOptions}) → ActionMetadata

embedderRef<C>(String name, {SchemanticType<C>? customOptions}) → EmbedderRef<C>

getConfigVar(String name) → String?

getPlatformLanguageVersion() → String

middlewareRef<C>({required String name, C? config}) → GenerateMiddlewareRef<C>

modelMetadata(String name, {ModelInfo? modelInfo, SchemanticType? customOptions}) → ActionMetadata

modelRef<C>(String name, {SchemanticType<C>? customOptions}) → ModelRef<C>

Typedefs

ActionFnArg<Chunk, Input, Init> = ({Map<String, dynamic>? context, Init? init, Stream<Input>? inputStream, StreamingCallback<Chunk> sendChunk, bool streamingRequested})

ToolFn<I, O> = Future<O> Function(I input, ToolFnArgs<I> context)

A function that implements a tool.

Exceptions / Errors

GenkitException

Exception thrown for errors encountered during Genkit flow operations.

ToolInterruptException

Exception thrown by a tool to interrupt the generation loop.