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
- $AgentAbortRequest
- $AgentAbortResponse
- $AgentErrorInfo
- $AgentInit
- $AgentInput
- $AgentMetadata
- $AgentOutput
- $AgentResult
- $AgentResume
- $AgentStreamChunk
- $Artifact
- $BaseDataPoint
- $Candidate
- $CustomPart
- $DataPart
- $DocumentData
- $Embedding
- $EmbedRequest
- $EmbedResponse
- $EvalFnResponse
- $EvalRequest
- $GenerateActionOptions
- $GenerateActionOutputConfig
- $GenerateRequest
- $GenerateResponse
- $GenerateResumeOptions
- $GenerationUsage
- $GetSnapshotDataInput
- $JsonPatchOperation
- $Media
- $MediaPart
- $Message
- $MiddlewareRef
- $ModelInfo
- $ModelRequest
- $ModelResponse
- $ModelResponseChunk
- $Operation
- $OutputConfig
- $Part
- $ReasoningPart
- $ReflectionCancelActionParams
- $ReflectionCancelActionResponse
- $ReflectionConfigureParams
- $ReflectionEndInputStreamParams
- $ReflectionListActionsResponse
- $ReflectionListValuesParams
- $ReflectionListValuesResponse
- $ReflectionRegisterParams
- $ReflectionRunActionParams
- $ReflectionRunActionStateParams
- $ReflectionSendInputStreamChunkParams
- $ReflectionStreamChunkParams
- $ResourcePart
- $RuntimeError
- $Score
- $SessionSnapshot
- $SessionState
- $TextPart
- $ToolDefinition
- $ToolRequest
- $ToolRequestPart
- $ToolResponse
- $ToolResponsePart
- $TurnEnd
-
ActionStream<
Chunk, Response> - A stream of chunks emitted by an action, which also resolves to a final response.
- AgentAbortRequest
- AgentAbortResponse
- AgentErrorInfo
- AgentInit
- AgentInput
- AgentMetadata
- AgentOutput
- AgentResult
- AgentResume
- AgentStreamChunk
- Artifact
- BaseDataPoint
- CancellationController
- The writable side of a cancellation.
- CancellationToken
- A read-only view of a cancellation request.
- Candidate
- CustomPart
- DataPart
- DocumentData
- Embedding
- EmbedRequest
- EmbedResponse
- EvalFnResponse
- EvalFnResponseEvaluation
- EvalRequest
- GenerateActionOptions
- GenerateActionOutputConfig
- GenerateActionOutputConfigInstructions
- GenerateRequest
- GenerateResponse
- GenerateResumeOptions
- GenerationUsage
- GetSnapshotDataInput
- JsonPatchOperation
- Media
- MediaPart
- Message
- MiddlewareRef
- ModelInfo
- ModelRequest
- ModelResponse
- ModelResponseChunk
- Operation
- OutputConfig
- Part
- ReasoningPart
- ReflectionCancelActionParams
- ReflectionCancelActionResponse
- ReflectionConfigureParams
- ReflectionEndInputStreamParams
- ReflectionListActionsResponse
- ReflectionListValuesParams
- ReflectionListValuesResponse
- ReflectionRegisterParams
- ReflectionRunActionParams
- ReflectionRunActionStateParams
- ReflectionSendInputStreamChunkParams
- ReflectionStreamChunkParams
-
RemoteAction<
Input, Output, Chunk, Init> - Represents a remote Genkit action (flow) that can be invoked or streamed.
- ResourcePart
- RuntimeError
- Score
- ScoreScore
- SessionSnapshot
- SessionState
- TextPart
- ToolDefinition
- ToolRequest
- ToolRequestPart
- ToolResponse
- ToolResponsePart
- TurnEnd
Enums
- StatusCodes
- Exception thrown for errors encountered during Genkit flow operations. Common status codes for Genkit operations.
Extension Types
Extensions
- MessageExtension on Message
- ModelResponseChunkExtension on ModelResponseChunk
- ModelResponseExtension on ModelResponse
- PartExtension on Part
- Extension methods for Part.
- ToolRequestPartExtension on ToolRequestPart
- Extension methods for ToolRequestPart.
Functions
-
defineRemoteAction<
Input, Output, Chunk, Init> ({required String url, Map< String, String> ? defaultHeaders, Client? httpClient, Output fromResponse(dynamic jsonData)?, Chunk fromStreamChunk(dynamic jsonData)?, SchemanticType<Input> ? inputSchema, SchemanticType<Output> ? outputSchema, SchemanticType<Chunk> ? streamSchema}) → RemoteAction<Input, Output, Chunk, Init> - Defines a remote Genkit action (flow) client.
Exceptions / Errors
- GenkitException
- Exception thrown for errors encountered during Genkit flow operations.