All Classes and Interfaces
Class
Description
Action is the interface that all Genkit primitives (e.g., flows, models,
tools) have in common.
ActionContext provides context for action execution including tracing and
flow information.
Builder for ActionContext.
ActionDef is the default implementation of an Action.
Function interface for non-streaming actions.
Function interface for streaming actions.
ActionDesc is a descriptor of an action containing its metadata and schemas.
Builder for ActionDesc.
ActionRunResult contains the result of an action execution along with
telemetry information.
Builder for ActionRunResult.
ActionTelemetry provides metrics collection for general action execution.
ActionType represents the kind of an action.
Represents an agent that can be used as a tool in multi-agent systems.
Result of an agent transfer.
Configuration for defining an agent (prompt as tool).
Builder for AgentConfig.
Exception thrown when an agent tool is called to signal a handoff.
Answer Accuracy metric evaluator.
Answer Relevancy metric evaluator.
Response schema for answer relevancy evaluation.
Anthropic Claude model implementation for Genkit.
AnthropicPlugin provides Anthropic Claude model integrations for Genkit.
Options for configuring the Anthropic plugin.
Builder for AnthropicPluginOptions.
Authentication context for Firebase Cloud Functions.
AWS Bedrock model implementation for Genkit.
AwsBedrockPlugin provides AWS Bedrock model integrations for Genkit.
Configuration options for the AWS Bedrock plugin.
Builder for AwsBedrockPluginOptions.
AzureFoundryPlugin provides Azure AI Foundry model integrations for Genkit.
Configuration options for the Azure AI Foundry plugin.
Builder for AzureFoundryPluginOptions.
Candidate represents a single model response candidate.
Chat represents a conversation within a session thread.
Options for individual send operations.
Builder for SendOptions.
ChatOptions provides configuration options for creating a Chat instance.
Builder for ChatOptions.
CoherePlugin provides Cohere model integrations for Genkit.
CommonMiddleware provides factory methods for creating commonly-used
middleware functions.
OpenAI-compatible API model implementation for Genkit.
CompatOAIPlugin provides a generic OpenAI-compatible API integration for
Genkit.
Builder for CompatOAIPlugin.
Model definition for a compat-oai model.
Options for configuring OpenAI-compatible API plugins.
Builder for CompatOAIPluginOptions.
Request to create a new dataset.
Metadata about a dataset stored in the dataset store.
Represents a single sample in an inference dataset.
Interface for dataset storage operations.
Type of dataset based on the target action.
Represents a stored document value with its embedding.
Deep Equal metric evaluator.
DeepSeekPlugin provides DeepSeek model integrations for Genkit.
DefaultRegistry is the default implementation of the Registry interface.
Document represents a document for use with embedders and retrievers.
DotPrompt provides support for .prompt files using Handlebars templating.
DynamicPlugin is a Plugin that can dynamically resolve actions.
Embedder is an action that generates embeddings from documents.
Builder for Embedder.
EmbedderInfo contains metadata about an embedder's capabilities.
EmbedderCapabilities describes what an embedder can do.
EmbedRequest contains documents to embed.
EmbedResponse contains the embeddings generated from documents.
Embedding represents a single embedding vector.
Represents a single data point for evaluation.
Represents a single metric score from an evaluator.
Request to run an evaluator on a dataset.
Response from an evaluator for a single test case.
A single evaluation result combining input data with metric scores.
Represents a complete evaluation run with results.
Key that uniquely identifies an evaluation run.
Status of an evaluation result.
Interface for storing and retrieving evaluation runs.
Manages the execution of evaluations.
Evaluator represents an evaluation action that assesses the quality of AI
outputs.
Builder for creating Evaluator instances.
Functional interface for evaluator functions.
Information about an evaluator including display metadata and metrics.
Evaluators plugin for Genkit.
Configuration options for the GenkitEval plugin.
ExecutablePrompt wraps a DotPrompt and provides direct generation
capabilities.
Functional interface for the generate function.
Functional interface for the generateObject function.
Faithfulness metric evaluator.
FeatureTelemetry provides metrics collection for top-level feature (flow)
execution.
FinishReason indicates why the model stopped generating.
Firebase plugin for Genkit providing integration with Firebase services.
Builder for FirebasePlugin.
Configuration for the Firebase plugin.
Builder for FirebasePluginConfig.
Firebase telemetry integration for Genkit Monitoring.
Builder for FirebaseTelemetry.
Configuration for a Firestore vector search retriever.
Builder for FirestoreRetrieverConfig.
Distance measure options for vector similarity search.
Firestore vector store implementation for RAG workflows.
A Flow is a user-defined Action.
StreamingFlowValue represents either a streamed chunk or the final output of
a flow.
Gemini embedder implementation using the official Google GenAI SDK.
Gemini model implementation using the official Google GenAI SDK.
GenerateAction is a utility action that provides a unified interface for
generating content from AI models.
Options for the generate utility action.
Options for text generation requests.
Builder for GenerateOptions.
GenerateTelemetry provides metrics collection for model generate actions.
GenerationConfig contains configuration for model generation.
Builder for GenerationConfig.
Genkit is the main entry point for the Genkit framework.
Builder for Genkit.
GenkitException is the base exception for all Genkit errors.
Builder for GenkitException.
REST controller that exposes Genkit flows as HTTP endpoints.
Enumeration of supported evaluation metric types.
GenkitOptions contains configuration options for Genkit.
Builder for GenkitOptions.
GenkitSpanData represents information about a trace span.
Annotation represents an annotation.
BoolValue wraps a boolean to match the expected JSON format.
InstrumentationScope represents the instrumentation library.
Link describes the relationship between two Spans.
SpanContextData contains identifying trace information about a Span.
Status represents the span status.
TimeEvent represents a time-based event.
TimeEvents holds time-based events.
Spring Boot application class for Genkit.
Google GenAI plugin for Genkit using the official Google GenAI SDK.
Options for configuring the Google GenAI plugin.
Builder for GoogleGenAIPluginOptions.
GroqPlugin provides Groq model integrations for Genkit.
HTTP-based telemetry client that sends traces to the Genkit telemetry server.
Configuration options for OpenAI image generation models (DALL-E, gpt-image).
Builder for ImageGenerationConfig.
Imagen model implementation for image generation using the official Google
GenAI SDK.
Indexer is an action that indexes documents into a vector store.
Builder for Indexer.
Request to index documents into a vector store.
Response from an indexer operation.
InMemorySessionStore is a simple in-memory implementation of SessionStore.
Configuration for defining an interrupt tool.
Builder for InterruptConfig.
Represents an interrupt request from a tool.
JettyPlugin provides HTTP endpoints for Genkit flows.
Options for configuring the Jetty plugin.
Builder for JettyPluginOptions.
JSONata metric evaluator.
JsonUtils provides JSON serialization and deserialization utilities for
Genkit.
File-based implementation of DatasetStore.
File-based implementation of EvalStore.
A SpanProcessor that stores traces locally for the Dev UI to access.
Configuration for a local vector store.
Builder for LocalVecConfig.
Local file-based document store implementation.
Local file-based vector store plugin for development and testing.
Builder for LocalVecPlugin.
Response schema for the long-form answer extraction in faithfulness
evaluation.
Maliciousness metric evaluator.
Response schema for maliciousness evaluation.
MCP Client that manages connections to MCP servers and provides access to
their tools and resources.
MCP Plugin for Genkit.
Configuration options for the MCP plugin.
Builder for MCPPluginOptions.
Represents an MCP resource.
Represents the content of an MCP resource.
Represents a single part of resource content.
MCP Server that exposes Genkit tools, prompts, and flows as MCP endpoints.
Configuration for connecting to an MCP server.
Builder for MCPServerConfig.
Transport type for MCP communication.
Configuration options for an MCP server.
Builder for MCPServerOptions.
Media represents media content in a message part.
Message represents a message in a conversation with a generative AI model.
Builder for Message.
Configuration for a specific evaluation metric.
Middleware is a function that wraps action execution, allowing pre-processing
and post-processing of requests and responses.
MiddlewareCache is a simple cache interface for use with caching middleware.
MiddlewareChain manages a list of middleware and provides execution of the
complete chain.
MiddlewareNext represents the next function in the middleware chain.
MistralPlugin provides Mistral AI model integrations for Genkit.
Model is the interface for AI model implementations.
ModelInfo contains metadata about a model's capabilities.
ModelCapabilities describes what a model can do.
ModelRequest represents a request to a generative AI model.
Builder for ModelRequest.
ModelResponse represents a response from a generative AI model.
Builder for ModelResponse.
ModelResponseChunk represents a streaming chunk from a generative AI model.
ModelTelemetryHelper provides utilities for recording model telemetry.
Functional interface for model execution.
Functional interface for streaming model execution.
Response schema for NLI (Natural Language Inference) evaluation.
A single NLI (Natural Language Inference) response item.
Ollama model implementation for Genkit.
OllamaPlugin provides local Ollama model integrations for Genkit.
Options for configuring the Ollama plugin.
Builder for OllamaPluginOptions.
Firebase Cloud Functions integration for Genkit flows.
Functional interface for authorization policies.
OpenAI embedder implementation for Genkit.
OpenAI image generation model implementation for Genkit.
OpenAI model implementation for Genkit.
OpenAIPlugin provides OpenAI model integrations for Genkit.
Options for configuring the OpenAI plugin.
Builder for OpenAIPluginOptions.
OutputConfig contains configuration for model output generation.
OutputFormat specifies the format for model output.
Part represents a part of a message content, which can be text, media, tool
request, or tool response.
Configuration for a Pinecone index used for vector storage.
Builder for PineconeIndexConfig.
Cloud providers for serverless indexes.
Metric types for vector similarity search.
Pinecone plugin for Genkit providing vector database functionality.
Builder for PineconePlugin.
Pinecone vector store implementation.
Plugin is the interface implemented by types that extend Genkit's
functionality.
PostgreSQL plugin for Genkit providing vector database functionality using
pgvector.
Builder for PostgresPlugin.
Configuration for a PostgreSQL table used for vector storage.
Builder for PostgresTableConfig.
Distance strategies for vector similarity search.
PostgreSQL vector store implementation using pgvector extension.
Prompt is a template that generates ModelRequests from input variables.
Builder for Prompt.
Utility class for loading and rendering prompt templates.
ReflectionServer provides an HTTP API for the Genkit Developer UI to interact
with.
Regex metric evaluator.
Registerable allows a primitive to be registered with a registry.
Registry holds all registered actions and associated types, and provides
methods to register, query, and look up actions.
Options for resuming after an interrupt.
Builder for ResumeOptions.
Retriever is an action that retrieves documents based on a query.
Builder for Retriever.
Options for the local vector store retriever.
RetrieverRequest contains a query for document retrieval.
RetrieverOptions contains options for retrieval.
RetrieverResponse contains documents retrieved from a query.
Role represents the role of a message sender in a conversation.
Request to run a new evaluation.
Data source for evaluation - either a dataset ID or inline data.
Options for evaluation.
RuntimeFileWriter writes runtime discovery files for the Genkit Dev UI.
SchemaUtils provides utilities for JSON Schema generation and validation.
Score represents the result of an evaluation.
Details about an evaluation score, including reasoning.
ServerPlugin is an extended Plugin interface for plugins that provide HTTP
server functionality.
Session represents a stateful chat session that persists conversation history
and custom state across multiple interactions.
Provides access to the current session context.
Exception thrown when session operations fail.
SessionData represents the persistent data structure for a session, including
state and conversation threads.
Builder for SessionData.
SessionOptions provides configuration options for creating or loading
sessions.
Builder for SessionOptions.
SessionStore is an interface for persisting session data.
SimpleCache is a thread-safe in-memory cache implementation for use with
caching middleware.
SpanContext contains trace and span identifiers for distributed tracing.
SpanMetadata contains metadata for a tracing span.
Builder for SpanMetadata.
SpringPlugin provides HTTP endpoints for Genkit flows using Spring Boot.
Options for configuring the Spring Boot plugin.
Builder for SpringPluginOptions.
TelemetryClient interface for sending traces to a telemetry server.
Central configuration for Genkit telemetry.
OpenTelemetry SpanProcessor that exports spans to the Genkit telemetry
server.
Tool represents a function that can be called by an AI model.
Builder for Tool.
ToolDefinition describes a tool that can be used by a model.
Exception thrown when a tool execution is interrupted.
ToolRequest represents a request from the model to invoke a tool.
ToolResponse represents a response from a tool invocation.
ToolTelemetry provides metrics collection for tool execution.
TraceData represents a complete trace with all its spans.
Tracer provides tracing utilities for Genkit operations.
Text-to-Speech model using Gemini TTS models.
Request to update an existing dataset.
Usage represents token usage statistics from a model response.
Video generation model using Google Veo.
Configuration for a Weaviate collection (class) in the plugin.
Builder for WeaviateCollectionConfig.
Distance measure options for vector similarity search.
Weaviate plugin for Genkit providing vector database integration.
Builder for WeaviatePlugin.
Weaviate vector store implementation for RAG workflows.
XAIPlugin provides XAI (x.ai / Grok) model integrations for Genkit.