client library
Client-side utilities for interacting with Genkit.
Use this library when building clients (e.g., web or mobile apps) that communicate with Genkit actions or flows, or when using Genkit in a purely client-side context (e.g. with Chrome AI).
Classes
- $Candidate
- $CustomPart
- $DataPart
- $DocumentData
- $GenerateActionOptions
- $GenerateActionOutputConfig
- $GenerateRequest
- $GenerateResponse
- $GenerationUsage
- $Media
- $MediaPart
- $Message
- $ModelInfo
- $ModelRequest
- $ModelResponse
- $ModelResponseChunk
- $Operation
- $OutputConfig
- $Part
- $ReasoningPart
- $ResourcePart
- $TextPart
- $ToolDefinition
- $ToolRequest
- $ToolRequestPart
- $ToolResponse
- $ToolResponsePart
-
ActionStream<
S, F> - Candidate
- CustomPart
- DataPart
- DocumentData
- GenerateActionOptions
- GenerateActionOutputConfig
- GenerateActionOutputConfigInstructions
- GenerateRequest
- GenerateResponse
- GenerationUsage
- Media
- MediaPart
- Message
- ModelInfo
- ModelRequest
- ModelResponse
- ModelResponseChunk
- Operation
- OutputConfig
- Part
- ReasoningPart
-
RemoteAction<
I, O, S, Init> - Represents a remote Genkit action (flow) that can be invoked or streamed.
- ResourcePart
- TextPart
- ToolDefinition
- ToolRequest
- ToolRequestPart
- ToolResponse
- ToolResponsePart
Enums
- StatusCodes
- Exception thrown for errors encountered during Genkit flow operations. Common status codes for Genkit operations.
Extension Types
Extensions
Functions
-
defineRemoteAction<
I, O, S, Init> ({required String url, Map< String, String> ? defaultHeaders, Client? httpClient, O fromResponse(dynamic jsonData)?, S fromStreamChunk(dynamic jsonData)?, SchemanticType<I> ? inputSchema, SchemanticType<O> ? outputSchema, SchemanticType<S> ? streamSchema}) → RemoteAction<I, O, S, Init> - Defines a remote Genkit action (flow) client.
Exceptions / Errors
- GenkitException
- Exception thrown for errors encountered during Genkit flow operations.