Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- abort() - Method in class com.google.genkit.ai.agent.AgentChat
-
Aborts the latest pending snapshot for this chat.
- abort(String) - Method in class com.google.genkit.ai.agent.Agent
- abort(String) - Method in interface com.google.genkit.ai.agent.AgentApi
-
Attempts to abort a snapshot that is currently in
SnapshotStatus.PENDINGstate. - abort(String) - Method in interface com.google.genkit.ai.agent.AgentTransport
-
Attempts to abort a pending snapshot.
- abort(String) - Method in class com.google.genkit.ai.agent.internal.InProcessTransport
- abort(String) - Method in class com.google.genkit.client.HttpAgentTransport
- abort(String, JsonNode, HttpServletRequest) - Method in class com.google.genkit.plugins.spring.GenkitAgentController
-
Companion endpoint for aborting a pending agent session snapshot.
- abortable(boolean) - Method in class com.google.genkit.ai.agent.AgentMetadata.Builder
- abortAgentAction() - Method in class com.google.genkit.ai.agent.Agent
-
Returns the companion abort action, or
nullif not applicable. - AbortAwareMutator - Class in com.google.genkit.ai.agent.internal
-
Wraps a
SnapshotMutatorso that it returnsnull(no-op) when the current row is alreadySnapshotStatus.ABORTED, preventing a completed or failed write from clobbering a concurrent abort. - ABORTED - Enum constant in enum class com.google.genkit.ai.agent.AgentFinishReason
-
The agent was aborted.
- ABORTED - Enum constant in enum class com.google.genkit.ai.agent.SnapshotStatus
-
The snapshot was aborted.
- abortSignal() - Method in class com.google.genkit.ai.agent.AgentFnContext
-
Returns the abort signal for this invocation.
- abortUrl() - Method in class com.google.genkit.client.RemoteAgentOptions
-
Returns the companion abort URL (defaults to
url + "/abort"). - abortUrl(String) - Method in class com.google.genkit.client.RemoteAgentOptions.Builder
-
Overrides the abort URL.
- acknowledgement - Variable in class com.google.genkit.plugins.middleware.SimulateSystemPromptMiddleware.Options
- Action<I,
O, - Interface in com.google.genkit.coreS> -
Action is the interface that all Genkit primitives (e.g., flows, models, tools) have in common.
- actionConfig(Object) - Method in class com.google.genkit.ai.evaluation.EvalRunKey.Builder
- ActionContext - Class in com.google.genkit.core
-
ActionContext provides context for action execution including tracing and flow information.
- ActionContext(Registry) - Constructor for class com.google.genkit.core.ActionContext
-
Creates a new ActionContext with default values.
- ActionContext(SpanContext, String, Registry) - Constructor for class com.google.genkit.core.ActionContext
-
Creates a new ActionContext.
- ActionContext(SpanContext, String, String, Registry) - Constructor for class com.google.genkit.core.ActionContext
-
Creates a new ActionContext.
- ActionContext(SpanContext, String, String, Registry, String, String) - Constructor for class com.google.genkit.core.ActionContext
-
Creates a new ActionContext.
- ActionContext(SpanContext, String, String, Registry, String, String, Map<String, Object>) - Constructor for class com.google.genkit.core.ActionContext
-
Creates a new ActionContext.
- ActionContext(SpanContext, String, String, Registry, String, String, Map<String, Object>, Object, Object) - Constructor for class com.google.genkit.core.ActionContext
-
Creates a new ActionContext including resume-awareness fields.
- ActionContext.Builder - Class in com.google.genkit.core
-
Builder for ActionContext.
- ActionDef<I,
O, - Class in com.google.genkit.coreS> -
ActionDef is the default implementation of an Action.
- ActionDef(String, ActionType, Map<String, Object>, Map<String, Object>, Class<I>, Class<O>, ActionDef.StreamingFunction<I, O, S>) - Constructor for class com.google.genkit.core.ActionDef
-
Creates a new ActionDef.
- ActionDef.ActionFunction<I,
O> - Interface in com.google.genkit.core -
Function interface for non-streaming actions.
- ActionDef.StreamingFunction<I,
O, - Interface in com.google.genkit.coreS> -
Function interface for streaming actions.
- ActionDesc - Class in com.google.genkit.core
-
ActionDesc is a descriptor of an action containing its metadata and schemas.
- ActionDesc() - Constructor for class com.google.genkit.core.ActionDesc
-
Default constructor for Jackson deserialization.
- ActionDesc(ActionType, String, String, Map<String, Object>, Map<String, Object>, Map<String, Object>) - Constructor for class com.google.genkit.core.ActionDesc
-
Creates a new ActionDesc with the specified parameters.
- ActionDesc.Builder - Class in com.google.genkit.core
-
Builder for ActionDesc.
- actionRef(String) - Method in class com.google.genkit.ai.evaluation.EvalRunKey.Builder
- ActionRunResult<T> - Class in com.google.genkit.core
-
ActionRunResult contains the result of an action execution along with telemetry information.
- ActionRunResult(T, String, String) - Constructor for class com.google.genkit.core.ActionRunResult
-
Creates a new ActionRunResult.
- ActionRunResult.Builder<T> - Class in com.google.genkit.core
-
Builder for ActionRunResult.
- ActionTelemetry - Class in com.google.genkit.ai.telemetry
-
ActionTelemetry provides metrics collection for general action execution.
- ActionType - Enum Class in com.google.genkit.core
-
ActionType represents the kind of an action.
- addAdditionalMetadata(String, Object) - Method in class com.google.genkit.plugins.chroma.ChromaCollectionConfig.Builder
-
Adds a metadata entry merged into every indexed document.
- addAdditionalMetadata(String, Object) - Method in class com.google.genkit.plugins.milvus.MilvusCollectionConfig.Builder
-
Adds a metadata entry merged into every indexed document.
- addAdditionalMetadata(String, Object) - Method in class com.google.genkit.plugins.mongodb.MongoVectorStoreConfig.Builder
-
Adds a metadata entry merged into every indexed document.
- addAdditionalMetadata(String, Object) - Method in class com.google.genkit.plugins.qdrant.QdrantCollectionConfig.Builder
-
Adds a metadata entry merged into every indexed document's payload.
- addArtifacts(Artifact...) - Method in interface com.google.genkit.ai.agent.ArtifactStore
-
Adds artifacts, deduplicating by name.
- addArtifacts(Artifact...) - Method in class com.google.genkit.ai.agent.Session
-
Adds artifacts with deduplication by name.
- addArtifacts(Artifact...) - Method in class com.google.genkit.ai.agent.SessionRunner
-
Adds artifacts to the session.
- addArtifacts(List<Artifact>) - Method in class com.google.genkit.ai.agent.Session
-
Adds artifacts with deduplication by name (list overload).
- addAttribute(String, Object) - Method in class com.google.genkit.core.tracing.GenkitSpanData
- addAttribute(String, Object) - Method in class com.google.genkit.core.tracing.SpanMetadata
-
Adds an attribute to the span metadata.
- addAttribute(String, Object) - Method in class com.google.genkit.core.tracing.SpanMetadata.Builder
- addCandidate(Candidate) - Method in class com.google.genkit.ai.ModelResponse.Builder
- addCollection(ChromaCollectionConfig) - Method in class com.google.genkit.plugins.chroma.ChromaPlugin.Builder
-
Adds a collection configuration.
- addCollection(MilvusCollectionConfig) - Method in class com.google.genkit.plugins.milvus.MilvusPlugin.Builder
-
Adds a collection configuration.
- addCollection(MongoVectorStoreConfig) - Method in class com.google.genkit.plugins.mongodb.MongoPlugin.Builder
-
Adds a collection configuration.
- addCollection(QdrantCollectionConfig) - Method in class com.google.genkit.plugins.qdrant.QdrantPlugin.Builder
-
Adds a collection configuration.
- addCollection(WeaviateCollectionConfig) - Method in class com.google.genkit.plugins.weaviate.WeaviatePlugin.Builder
-
Adds a collection configuration.
- addEvent(String, Map<String, String>) - Static method in class com.google.genkit.core.tracing.Tracer
-
Adds an event to the current span.
- addIndex(PineconeIndexConfig) - Method in class com.google.genkit.plugins.pinecone.PineconePlugin.Builder
-
Adds an index configuration.
- additionalMetadata(String, Object) - Method in class com.google.genkit.plugins.pinecone.PineconeIndexConfig.Builder
-
Adds additional metadata to include with all indexed documents.
- additionalMetadata(String, Object) - Method in class com.google.genkit.plugins.postgresql.PostgresTableConfig.Builder
-
Adds additional metadata to include with all indexed documents.
- additionalMetadata(Map<String, Object>) - Method in class com.google.genkit.plugins.pinecone.PineconeIndexConfig.Builder
-
Sets all additional metadata to include with indexed documents.
- additionalMetadata(Map<String, Object>) - Method in class com.google.genkit.plugins.postgresql.PostgresTableConfig.Builder
-
Sets all additional metadata to include with indexed documents.
- additionalProperty(String, Object) - Method in class com.google.genkit.ai.evaluation.ScoreDetails.Builder
- addMessage(Message) - Method in class com.google.genkit.ai.ModelRequest
-
Adds a message to the request.
- addMessage(Message) - Method in class com.google.genkit.ai.ModelRequest.Builder
- addMessages(Message...) - Method in class com.google.genkit.ai.agent.Session
-
Appends the given messages to the session.
- addMessages(Message...) - Method in class com.google.genkit.ai.agent.SessionRunner
-
Appends messages to the session.
- addMessages(List<Message>) - Method in class com.google.genkit.ai.agent.Session
-
Appends the given messages to the session.
- addMetric(GenkitMetric) - Method in class com.google.genkit.plugins.evaluators.EvaluatorsPluginOptions.Builder
- addMetric(MetricConfig) - Method in class com.google.genkit.plugins.evaluators.EvaluatorsPluginOptions.Builder
- addModel(String) - Method in class com.google.genkit.plugins.compatoai.CompatOAIPlugin.Builder
-
Adds a model to register.
- addModel(String, String) - Method in class com.google.genkit.plugins.compatoai.CompatOAIPlugin.Builder
-
Adds a model with a custom label.
- addModels(String...) - Method in class com.google.genkit.plugins.compatoai.CompatOAIPlugin.Builder
-
Adds multiple models.
- addPart(Part) - Method in class com.google.genkit.ai.Message
-
Adds a part to the message content.
- addPart(Part) - Method in class com.google.genkit.ai.Message.Builder
- addRetriever(FirestoreRetrieverConfig) - Method in class com.google.genkit.plugins.firebase.FirebasePlugin.Builder
-
Adds a Firestore retriever configuration.
- addRetrieverConfig(FirestoreRetrieverConfig) - Method in class com.google.genkit.plugins.firebase.FirebasePluginConfig.Builder
- addServer(String, MCPServerConfig) - Method in class com.google.genkit.plugins.mcp.MCPPluginOptions.Builder
-
Adds an MCP server configuration.
- addSpan(GenkitSpanData) - Method in class com.google.genkit.core.tracing.TraceData
- addStore(LocalVecConfig) - Method in class com.google.genkit.plugins.localvec.LocalVecPlugin.Builder
-
Adds a vector store configuration.
- addStore(String, Embedder) - Method in class com.google.genkit.plugins.localvec.LocalVecPlugin.Builder
-
Convenience method to add a store with minimal configuration using an embedder instance.
- addStore(String, String) - Method in class com.google.genkit.plugins.localvec.LocalVecPlugin.Builder
-
Convenience method to add a store with minimal configuration using an embedder name.
- addSystemMessage(String) - Method in class com.google.genkit.ai.ModelRequest.Builder
- addTable(PostgresTableConfig) - Method in class com.google.genkit.plugins.postgresql.PostgresPlugin.Builder
-
Adds a table configuration.
- addText(String) - Method in class com.google.genkit.ai.Message.Builder
- addUserMessage(String) - Method in class com.google.genkit.ai.ModelRequest.Builder
- Agent<S> - Class in com.google.genkit.ai.agent
-
Agent is a bidirectional streaming agent action that manages session state and provides typed facades for snapshot retrieval and abort.
- Agent(BidiActionImpl<AgentInput, AgentOutput<S>, AgentStreamChunk, AgentInit<S>>, SessionStore<S>, boolean, Action<?, ?, ?>, Action<?, ?, ?>, ClientTransform<S>, SessionStoreOptions, String, String, Registry) - Constructor for class com.google.genkit.ai.agent.Agent
-
Constructs an Agent.
- AGENT - Enum constant in enum class com.google.genkit.core.ActionType
-
An agent action representing a bidirectional agent interaction.
- AGENT_ABORT - Enum constant in enum class com.google.genkit.core.ActionType
-
An agent-abort action for stopping agent execution.
- AGENT_SNAPSHOT - Enum constant in enum class com.google.genkit.core.ActionType
-
An agent-snapshot action for capturing agent state.
- AgentAbortRequest - Class in com.google.genkit.ai.agent
-
AgentAbortRequest is the request body for aborting an agent execution.
- AgentAbortRequest() - Constructor for class com.google.genkit.ai.agent.AgentAbortRequest
-
Default constructor.
- AgentAbortRequest.Builder - Class in com.google.genkit.ai.agent
-
Builder for AgentAbortRequest.
- AgentAbortResponse - Class in com.google.genkit.ai.agent
-
AgentAbortResponse is the response body for an agent abort operation.
- AgentAbortResponse() - Constructor for class com.google.genkit.ai.agent.AgentAbortResponse
-
Default constructor.
- AgentAbortResponse.Builder - Class in com.google.genkit.ai.agent
-
Builder for AgentAbortResponse.
- AgentActions - Class in com.google.genkit.ai.agent.internal
-
Factory for defining custom agents.
- AgentApi<S> - Interface in com.google.genkit.ai.agent
-
AgentApi is the typed facade interface exposed by an agent, providing snapshot retrieval, abort, identification, and chat-client creation.
- AgentChat<S> - Class in com.google.genkit.ai.agent
-
AgentChat is the ergonomic programmatic client for driving an agent across multiple turns while carrying session state automatically.
- AgentChunk<S> - Class in com.google.genkit.ai.agent
-
AgentChunk is the ergonomic wrapper
AgentChat.sendStream(java.lang.String, java.util.function.Consumer<com.google.genkit.ai.agent.AgentChunk<S>>)hands to the per-chunk callback. - AgentConfig<S> - Class in com.google.genkit.agent
-
Facade-level configuration for the ergonomic, prompt-backed agents created via
GenkitBeta.defineAgentandGenkitBeta.definePromptAgent. - AgentConfig.Builder<S> - Class in com.google.genkit.agent
-
Builder for
AgentConfig. - AgentFinishReason - Enum Class in com.google.genkit.ai.agent
-
AgentFinishReason indicates why an agent finished execution.
- AgentFn<S> - Interface in com.google.genkit.ai.agent
-
Custom agent handler: runs one invocation's turn loop body for ONE turn at a time via the runner.
- AgentFnContext - Class in com.google.genkit.ai.agent
-
Context handed to an
AgentFnfor one invocation. - AgentFnContext(Consumer<AgentStreamChunk>, AtomicBoolean) - Constructor for class com.google.genkit.ai.agent.AgentFnContext
-
Constructs an AgentFnContext without an ActionContext.
- AgentFnContext(Consumer<AgentStreamChunk>, AtomicBoolean, ActionContext) - Constructor for class com.google.genkit.ai.agent.AgentFnContext
-
Constructs an AgentFnContext.
- AgentFnContext(Consumer<AgentStreamChunk>, AtomicBoolean, ActionContext, ToolResume) - Constructor for class com.google.genkit.ai.agent.AgentFnContext
-
Constructs an AgentFnContext with resume data.
- AgentInit<S> - Class in com.google.genkit.ai.agent
-
AgentInit represents the initialization data for an agent session.
- AgentInit() - Constructor for class com.google.genkit.ai.agent.AgentInit
-
Default constructor.
- AgentInit.Builder<S> - Class in com.google.genkit.ai.agent
-
Builder for AgentInit.
- AgentInput - Class in com.google.genkit.ai.agent
-
AgentInput represents the input to an agent turn.
- AgentInput() - Constructor for class com.google.genkit.ai.agent.AgentInput
-
Default constructor.
- AgentInput.Builder - Class in com.google.genkit.ai.agent
-
Builder for AgentInput.
- AgentInterrupt - Class in com.google.genkit.ai.agent
-
AgentInterrupt represents a tool request that paused agent execution awaiting a caller response.
- AgentInterrupt(String, Object, Part) - Constructor for class com.google.genkit.ai.agent.AgentInterrupt
-
Constructs an AgentInterrupt.
- AgentMetadata - Class in com.google.genkit.ai.agent
-
AgentMetadata describes the capabilities and configuration of an agent endpoint.
- AgentMetadata() - Constructor for class com.google.genkit.ai.agent.AgentMetadata
-
Default constructor.
- AgentMetadata.Builder - Class in com.google.genkit.ai.agent
-
Builder for AgentMetadata.
- AgentOutput<S> - Class in com.google.genkit.ai.agent
-
AgentOutput represents the output of an agent turn.
- AgentOutput() - Constructor for class com.google.genkit.ai.agent.AgentOutput
-
Default constructor.
- AgentOutput.Builder<S> - Class in com.google.genkit.ai.agent
-
Builder for AgentOutput.
- AgentRef - Class in com.google.genkit.ai.agent
-
AgentRef is a lightweight reference to an agent, carrying only its name and description.
- AgentRef(String, String) - Constructor for class com.google.genkit.ai.agent.AgentRef
-
Constructs an AgentRef.
- agentRefs(AgentRef...) - Method in class com.google.genkit.plugins.middleware.AgentsOptions.Builder
-
Adds sub-agents from
AgentRefs (usesAgentRef.getName()). - AgentResponse<S> - Class in com.google.genkit.ai.agent
-
AgentResponse is the ergonomic wrapper
AgentChat.send(java.lang.String)returns for one completed turn. - AgentResult - Class in com.google.genkit.ai.agent
-
AgentResult represents the final result of an agent execution.
- AgentResult() - Constructor for class com.google.genkit.ai.agent.AgentResult
-
Default constructor.
- AgentResult.Builder - Class in com.google.genkit.ai.agent
-
Builder for AgentResult.
- agents(String...) - Method in class com.google.genkit.plugins.middleware.AgentsOptions.Builder
-
Sets the sub-agent names (required, at least one).
- agents(List<String>) - Method in class com.google.genkit.plugins.middleware.AgentsOptions.Builder
-
Sets the sub-agent names (required, at least one).
- Agents - Class in com.google.genkit.plugins.middleware
-
Factory for sub-agent delegation tools.
- Agents.ArtifactRef - Class in com.google.genkit.plugins.middleware
-
A namespaced reference to an artifact produced by a sub-agent.
- Agents.DelegateInput - Class in com.google.genkit.plugins.middleware
-
Input for a delegation tool.
- Agents.DelegateOutput - Class in com.google.genkit.plugins.middleware
-
Output for a delegation tool.
- AgentSessionContext - Class in com.google.genkit.ai.agent
-
AgentSessionContext binds a
Sessionto the current thread so that prompts, middleware, and tools can access the active session without passing it through every call frame. - AgentsOptions - Class in com.google.genkit.plugins.middleware
-
Options controlling the sub-agent delegation tools produced by
Agents. - AgentsOptions.Builder - Class in com.google.genkit.plugins.middleware
-
Builder for
AgentsOptions. - AgentStreamChunk - Class in com.google.genkit.ai.agent
-
AgentStreamChunk represents a streaming chunk from an agent execution.
- AgentStreamChunk() - Constructor for class com.google.genkit.ai.agent.AgentStreamChunk
-
Default constructor.
- AgentStreamChunk.Builder - Class in com.google.genkit.ai.agent
-
Builder for AgentStreamChunk.
- AgentTransport<S> - Interface in com.google.genkit.ai.agent
-
AgentTransport abstracts how a single agent turn is executed.
- Annotation() - Constructor for class com.google.genkit.core.tracing.GenkitSpanData.Annotation
- ANSWER_ACCURACY - Enum constant in enum class com.google.genkit.plugins.evaluators.GenkitMetric
-
Measures the accuracy of the generated answer against a reference answer.
- ANSWER_RELEVANCY - Enum constant in enum class com.google.genkit.plugins.evaluators.GenkitMetric
-
Assesses how pertinent the generated answer is to the given prompt.
- AnswerAccuracyMetric - Class in com.google.genkit.plugins.evaluators.metrics
-
Answer Accuracy metric evaluator.
- AnswerAccuracyMetric(Registry, String, Map<String, Object>) - Constructor for class com.google.genkit.plugins.evaluators.metrics.AnswerAccuracyMetric
- AnswerRelevancyMetric - Class in com.google.genkit.plugins.evaluators.metrics
-
Answer Relevancy metric evaluator.
- AnswerRelevancyMetric(Registry, String, Map<String, Object>, String, Map<String, Object>) - Constructor for class com.google.genkit.plugins.evaluators.metrics.AnswerRelevancyMetric
- AnswerRelevancyResponse - Class in com.google.genkit.plugins.evaluators.metrics
-
Response schema for answer relevancy evaluation.
- AnswerRelevancyResponse() - Constructor for class com.google.genkit.plugins.evaluators.metrics.AnswerRelevancyResponse
- AnswerRelevancyResponse(String, boolean, boolean) - Constructor for class com.google.genkit.plugins.evaluators.metrics.AnswerRelevancyResponse
- AnthropicModel - Class in com.google.genkit.plugins.anthropic
-
Anthropic Claude model implementation for Genkit.
- AnthropicModel(String, AnthropicPluginOptions) - Constructor for class com.google.genkit.plugins.anthropic.AnthropicModel
-
Creates a new AnthropicModel.
- AnthropicPlugin - Class in com.google.genkit.plugins.anthropic
-
AnthropicPlugin provides Anthropic Claude model integrations for Genkit.
- AnthropicPlugin() - Constructor for class com.google.genkit.plugins.anthropic.AnthropicPlugin
-
Creates an AnthropicPlugin with default options.
- AnthropicPlugin(AnthropicPluginOptions) - Constructor for class com.google.genkit.plugins.anthropic.AnthropicPlugin
-
Creates an AnthropicPlugin with the specified options.
- AnthropicPluginOptions - Class in com.google.genkit.plugins.anthropic
-
Options for configuring the Anthropic plugin.
- AnthropicPluginOptions.Builder - Class in com.google.genkit.plugins.anthropic
-
Builder for AnthropicPluginOptions.
- anthropicVersion(String) - Method in class com.google.genkit.plugins.anthropic.AnthropicPluginOptions.Builder
- apiKey(String) - Method in class com.google.genkit.plugins.anthropic.AnthropicPluginOptions.Builder
- apiKey(String) - Method in class com.google.genkit.plugins.azurefoundry.AzureFoundryPluginOptions.Builder
-
Sets the API key for authentication.
- apiKey(String) - Method in class com.google.genkit.plugins.compatoai.CompatOAIPlugin.Builder
-
Sets the API key.
- apiKey(String) - Method in class com.google.genkit.plugins.compatoai.CompatOAIPluginOptions.Builder
-
Sets the API key.
- apiKey(String) - Method in class com.google.genkit.plugins.googlegenai.GoogleGenAIPluginOptions.Builder
-
Sets the API key for Gemini Developer API.
- apiKey(String) - Method in class com.google.genkit.plugins.openai.OpenAIPluginOptions.Builder
- apiKey(String) - Method in class com.google.genkit.plugins.pinecone.PineconePlugin.Builder
-
Sets the Pinecone API key (required unless externalClient is provided).
- apiKey(String) - Method in class com.google.genkit.plugins.qdrant.QdrantPlugin.Builder
-
Sets the Qdrant API key (optional; required for Qdrant Cloud).
- apiKey(String) - Method in class com.google.genkit.plugins.weaviate.WeaviatePlugin.Builder
-
Sets the API key for Weaviate Cloud authentication.
- apiVersion(String) - Method in class com.google.genkit.plugins.azurefoundry.AzureFoundryPluginOptions.Builder
-
Sets the API version.
- apiVersion(String) - Method in class com.google.genkit.plugins.googlegenai.GoogleGenAIPluginOptions.Builder
-
Sets the API version.
- apply(JsonNode, JsonNode) - Static method in class com.google.genkit.core.jsonpatch.JsonPatch
-
Applies an RFC-6902 patch (a JSON array of ops) to
document, returning the new document. - apply(SessionSnapshot<S>) - Method in interface com.google.genkit.ai.agent.SnapshotMutator
-
Applies the mutation.
- apply(ActionContext, GenerateParams) - Method in interface com.google.genkit.ai.middleware.GenerateNext
-
Calls the next handler in the generate chain.
- apply(ActionContext, ModelParams) - Method in interface com.google.genkit.ai.middleware.ModelNext
-
Calls the next handler in the model chain.
- apply(ActionContext, ToolParams) - Method in interface com.google.genkit.ai.middleware.ToolNext
-
Calls the next handler in the tool chain.
- apply(ActionContext, I) - Method in interface com.google.genkit.core.ActionDef.ActionFunction
- apply(ActionContext, I, Consumer<S>) - Method in interface com.google.genkit.core.ActionDef.StreamingFunction
- apply(I, ActionContext) - Method in interface com.google.genkit.core.middleware.MiddlewareNext
-
Calls the next middleware in the chain or the actual action.
- args(String...) - Method in class com.google.genkit.plugins.mcp.MCPServerConfig.Builder
-
Sets the command arguments.
- args(List<String>) - Method in class com.google.genkit.plugins.mcp.MCPServerConfig.Builder
-
Sets the command arguments.
- arraySchema(Map<String, Object>) - Static method in class com.google.genkit.core.SchemaUtils
-
Creates a schema for an array type with the given items schema.
- artifact() - Method in class com.google.genkit.ai.agent.AgentChunk
-
Returns the artifact carried by this chunk.
- artifact(Artifact) - Method in class com.google.genkit.ai.agent.AgentStreamChunk.Builder
- Artifact - Class in com.google.genkit.ai.agent
-
Artifact represents a named collection of content parts produced during agent execution.
- Artifact() - Constructor for class com.google.genkit.ai.agent.Artifact
-
Default constructor.
- Artifact.Builder - Class in com.google.genkit.ai.agent
-
Builder for Artifact.
- ArtifactRef() - Constructor for class com.google.genkit.plugins.middleware.Agents.ArtifactRef
-
Default constructor for JSON deserialization.
- artifacts - Variable in class com.google.genkit.plugins.middleware.Agents.DelegateOutput
- artifacts - Variable in class com.google.genkit.plugins.middleware.internal.Delegation.Result
- artifacts() - Method in class com.google.genkit.ai.agent.AgentChat
-
Returns the accumulated artifacts.
- artifacts() - Method in class com.google.genkit.ai.agent.AgentResponse
-
Returns the turn's artifacts.
- artifacts(List<Artifact>) - Method in class com.google.genkit.ai.agent.AgentOutput.Builder
- artifacts(List<Artifact>) - Method in class com.google.genkit.ai.agent.AgentResult.Builder
- artifacts(List<Artifact>) - Method in class com.google.genkit.ai.agent.SessionState.Builder
- Artifacts - Class in com.google.genkit.plugins.middleware
-
Factory for artifact tools that let a model read and write named artifacts on the active agent session.
- Artifacts.ReadInput - Class in com.google.genkit.plugins.middleware
-
Input for
read_artifact. - Artifacts.ReadOutput - Class in com.google.genkit.plugins.middleware
-
Output for
read_artifact. - Artifacts.WriteInput - Class in com.google.genkit.plugins.middleware
-
Input for
write_artifact. - Artifacts.WriteOutput - Class in com.google.genkit.plugins.middleware
-
Output for
write_artifact. - ArtifactsOptions - Class in com.google.genkit.plugins.middleware
-
Options controlling the artifact tools produced by
Artifacts. - ArtifactsOptions.Builder - Class in com.google.genkit.plugins.middleware
-
Builder for
ArtifactsOptions. - ArtifactStore - Interface in com.google.genkit.ai.agent
-
ArtifactStore is a state-agnostic view of artifact storage used by middleware and tools that do not need to know the custom state type
Sof the session. - artifactStrategy(ArtifactStrategy) - Method in class com.google.genkit.plugins.middleware.AgentsOptions.Builder
-
Sets the artifact strategy (default
ArtifactStrategy.INLINE). - ArtifactStrategy - Enum Class in com.google.genkit.plugins.middleware
-
Strategy controlling how artifacts produced by a sub-agent are surfaced back to the delegating model.
- Atomic writes - Search tag in class com.google.genkit.ai.agent.FileSessionStore
- Section
- attach(Session<S>) - Method in class com.google.genkit.ai.agent.internal.StreamEmitter
-
Attaches this emitter to a Session.
- attributes(Map<String, Object>) - Method in class com.google.genkit.core.tracing.SpanMetadata.Builder
- AuthContext - Class in com.google.genkit.plugins.firebase.functions
-
Authentication context for Firebase Cloud Functions.
- AuthContext() - Constructor for class com.google.genkit.plugins.firebase.functions.AuthContext
-
Creates an empty auth context.
- AuthContext(String) - Constructor for class com.google.genkit.plugins.firebase.functions.AuthContext
-
Creates an auth context with the given token.
- AuthContext.Builder - Class in com.google.genkit.plugins.firebase.functions
- AWS - Enum constant in enum class com.google.genkit.plugins.pinecone.PineconeIndexConfig.Cloud
- AwsBedrockEmbedder - Class in com.google.genkit.plugins.awsbedrock
-
AWS Bedrock embedder implementation for Genkit.
- AwsBedrockEmbedder(String, AwsBedrockPluginOptions) - Constructor for class com.google.genkit.plugins.awsbedrock.AwsBedrockEmbedder
-
Creates a new AwsBedrockEmbedder.
- AwsBedrockModel - Class in com.google.genkit.plugins.awsbedrock
-
AWS Bedrock model implementation for Genkit.
- AwsBedrockModel(String, AwsBedrockPluginOptions) - Constructor for class com.google.genkit.plugins.awsbedrock.AwsBedrockModel
-
Creates a new AwsBedrockModel.
- AwsBedrockPlugin - Class in com.google.genkit.plugins.awsbedrock
-
AwsBedrockPlugin provides AWS Bedrock model integrations for Genkit.
- AwsBedrockPlugin() - Constructor for class com.google.genkit.plugins.awsbedrock.AwsBedrockPlugin
-
Creates an AwsBedrockPlugin with default options.
- AwsBedrockPlugin(AwsBedrockPluginOptions) - Constructor for class com.google.genkit.plugins.awsbedrock.AwsBedrockPlugin
-
Creates an AwsBedrockPlugin with the specified options.
- AwsBedrockPluginOptions - Class in com.google.genkit.plugins.awsbedrock
-
Configuration options for the AWS Bedrock plugin.
- AwsBedrockPluginOptions.Builder - Class in com.google.genkit.plugins.awsbedrock
-
Builder for AwsBedrockPluginOptions.
- AZURE - Enum constant in enum class com.google.genkit.plugins.pinecone.PineconeIndexConfig.Cloud
- AzureFoundryPlugin - Class in com.google.genkit.plugins.azurefoundry
-
AzureFoundryPlugin provides Azure AI Foundry model integrations for Genkit.
- AzureFoundryPlugin(AzureFoundryPluginOptions) - Constructor for class com.google.genkit.plugins.azurefoundry.AzureFoundryPlugin
-
Creates an AzureFoundryPlugin with the specified options.
- AzureFoundryPluginOptions - Class in com.google.genkit.plugins.azurefoundry
-
Configuration options for the Azure AI Foundry plugin.
- AzureFoundryPluginOptions.Builder - Class in com.google.genkit.plugins.azurefoundry
-
Builder for AzureFoundryPluginOptions.
B
- background(String) - Method in class com.google.genkit.plugins.openai.ImageGenerationConfig.Builder
- BACKGROUND_MODEL - Enum constant in enum class com.google.genkit.core.ActionType
-
A background model action for long-running inference operations.
- backoffFactor - Variable in class com.google.genkit.plugins.middleware.RetryMiddleware.Options
- BaseGenerationMiddleware - Class in com.google.genkit.ai.middleware
-
BaseGenerationMiddleware provides default pass-through implementations for all three hooks.
- BaseGenerationMiddleware() - Constructor for class com.google.genkit.ai.middleware.BaseGenerationMiddleware
- basePath(String) - Method in class com.google.genkit.plugins.jetty.JettyPluginOptions.Builder
- basePath(String) - Method in class com.google.genkit.plugins.spring.SpringPluginOptions.Builder
- baseUrl(String) - Method in class com.google.genkit.plugins.anthropic.AnthropicPluginOptions.Builder
- baseUrl(String) - Method in class com.google.genkit.plugins.compatoai.CompatOAIPlugin.Builder
-
Sets the base URL for API requests.
- baseUrl(String) - Method in class com.google.genkit.plugins.compatoai.CompatOAIPluginOptions.Builder
-
Sets the base URL for API requests.
- baseUrl(String) - Method in class com.google.genkit.plugins.googlegenai.GoogleGenAIPluginOptions.Builder
-
Sets the base URL override.
- baseUrl(String) - Method in class com.google.genkit.plugins.ollama.OllamaPluginOptions.Builder
- baseUrl(String) - Method in class com.google.genkit.plugins.openai.OpenAIPluginOptions.Builder
- batchSize(Integer) - Method in class com.google.genkit.ai.evaluation.EvalRequest.Builder
- beforeAfter(BiConsumer<I, ActionContext>, BiConsumer<O, ActionContext>) - Static method in class com.google.genkit.core.middleware.CommonMiddleware
-
Creates a before/after middleware that runs callbacks before and after execution.
- beginTurn() - Method in class com.google.genkit.ai.agent.internal.StreamEmitter
-
Call at the start of each turn.
- beta() - Method in class com.google.genkit.Genkit
-
Returns the beta (experimental) API surface for this Genkit instance.
- BidiAction<I,
O, - Interface in com.google.genkit.coreS, Init> -
A bidirectional streaming action.
- BidiAction.BidiHandler<I,
O, - Interface in com.google.genkit.coreS, Init> -
Functional interface that implements the bidirectional streaming logic.
- BidiActionImpl<I,
O, - Class in com.google.genkit.coreS, Init> -
Concrete implementation of
BidiActionbuilt from a name, type parameters, optional metadata, and aBidiAction.BidiHandler. - BidiActionImpl.Builder<I,
O, - Class in com.google.genkit.coreS, Init> -
Builder for
BidiActionImpl. - BLOCKED - Enum constant in enum class com.google.genkit.ai.agent.AgentFinishReason
-
The agent was blocked from proceeding.
- BLOCKED - Enum constant in enum class com.google.genkit.ai.FinishReason
- booleanSchema() - Static method in class com.google.genkit.core.SchemaUtils
-
Creates a schema for a boolean type.
- BoolValue() - Constructor for class com.google.genkit.core.tracing.GenkitSpanData.BoolValue
- BoolValue(boolean) - Constructor for class com.google.genkit.core.tracing.GenkitSpanData.BoolValue
- BufferedInputSource<I> - Class in com.google.genkit.core
-
A thread-safe
InputSourcethat is fed by a producer viaBufferedInputSource.offer(I)and signals end-of-stream viaBufferedInputSource.end(). - BufferedInputSource() - Constructor for class com.google.genkit.core.BufferedInputSource
-
Creates a new
BufferedInputSource. - build() - Method in class com.google.genkit.agent.AgentConfig.Builder
-
Builds the
AgentConfig. - build() - Method in class com.google.genkit.ai.agent.AgentAbortRequest.Builder
- build() - Method in class com.google.genkit.ai.agent.AgentAbortResponse.Builder
- build() - Method in class com.google.genkit.ai.agent.AgentInit.Builder
- build() - Method in class com.google.genkit.ai.agent.AgentInput.Builder
- build() - Method in class com.google.genkit.ai.agent.AgentMetadata.Builder
- build() - Method in class com.google.genkit.ai.agent.AgentOutput.Builder
- build() - Method in class com.google.genkit.ai.agent.AgentResult.Builder
- build() - Method in class com.google.genkit.ai.agent.AgentStreamChunk.Builder
- build() - Method in class com.google.genkit.ai.agent.Artifact.Builder
- build() - Method in class com.google.genkit.ai.agent.CustomAgentConfig.Builder
-
Builds the
CustomAgentConfig. - build() - Method in class com.google.genkit.ai.agent.FileSessionStore.Builder
-
Builds a new
FileSessionStore. - build() - Method in class com.google.genkit.ai.agent.GetSnapshotOptions.Builder
-
Builds a new
GetSnapshotOptions. - build() - Method in class com.google.genkit.ai.agent.GetSnapshotRequest.Builder
- build() - Method in class com.google.genkit.ai.agent.RuntimeError.Builder
- build() - Method in class com.google.genkit.ai.agent.SessionSnapshot.Builder
- build() - Method in class com.google.genkit.ai.agent.SessionState.Builder
- build() - Method in class com.google.genkit.ai.agent.SessionStoreOptions.Builder
-
Builds a new
SessionStoreOptions. - build() - Method in class com.google.genkit.ai.agent.ToolResume.Builder
- build() - Method in class com.google.genkit.ai.agent.TurnEnd.Builder
- build() - Method in class com.google.genkit.ai.Embedder.Builder
- build() - Method in class com.google.genkit.ai.evaluation.CreateDatasetRequest.Builder
- build() - Method in class com.google.genkit.ai.evaluation.DatasetMetadata.Builder
- build() - Method in class com.google.genkit.ai.evaluation.DatasetSample.Builder
- build() - Method in class com.google.genkit.ai.evaluation.EvalDataPoint.Builder
- build() - Method in class com.google.genkit.ai.evaluation.EvalMetric.Builder
- build() - Method in class com.google.genkit.ai.evaluation.EvalRequest.Builder
- build() - Method in class com.google.genkit.ai.evaluation.EvalResponse.Builder
- build() - Method in class com.google.genkit.ai.evaluation.EvalResult.Builder
- build() - Method in class com.google.genkit.ai.evaluation.EvalRun.Builder
- build() - Method in class com.google.genkit.ai.evaluation.EvalRunKey.Builder
- build() - Method in class com.google.genkit.ai.evaluation.Evaluator.Builder
- build() - Method in class com.google.genkit.ai.evaluation.EvaluatorInfo.Builder
- build() - Method in class com.google.genkit.ai.evaluation.RunEvaluationRequest.Builder
- build() - Method in class com.google.genkit.ai.evaluation.Score.Builder
- build() - Method in class com.google.genkit.ai.evaluation.ScoreDetails.Builder
- build() - Method in class com.google.genkit.ai.evaluation.UpdateDatasetRequest.Builder
- build() - Method in class com.google.genkit.ai.GenerateOptions.Builder
- build() - Method in class com.google.genkit.ai.GenerationConfig.Builder
- build() - Method in class com.google.genkit.ai.Indexer.Builder
- build() - Method in class com.google.genkit.ai.InterruptConfig.Builder
-
Builds the InterruptConfig.
- build() - Method in class com.google.genkit.ai.Message.Builder
- build() - Method in class com.google.genkit.ai.ModelRequest.Builder
- build() - Method in class com.google.genkit.ai.ModelResponse.Builder
- build() - Method in class com.google.genkit.ai.Prompt.Builder
- build() - Method in class com.google.genkit.ai.ResumeOptions.Builder
-
Builds the ResumeOptions.
- build() - Method in class com.google.genkit.ai.Retriever.Builder
- build() - Method in class com.google.genkit.ai.Tool.Builder
- build() - Method in class com.google.genkit.client.RemoteAgentOptions.Builder
-
Builds the
RemoteAgentOptions. - build() - Method in class com.google.genkit.core.ActionContext.Builder
- build() - Method in class com.google.genkit.core.ActionDesc.Builder
- build() - Method in class com.google.genkit.core.ActionRunResult.Builder
- build() - Method in class com.google.genkit.core.BidiActionImpl.Builder
-
Builds the
BidiActionImpl. - build() - Method in class com.google.genkit.core.GenkitException.Builder
- build() - Method in class com.google.genkit.core.tracing.SpanMetadata.Builder
- build() - Method in class com.google.genkit.Genkit.Builder
-
Builds the Genkit instance.
- build() - Method in class com.google.genkit.GenkitOptions.Builder
- build() - Method in class com.google.genkit.plugins.anthropic.AnthropicPluginOptions.Builder
- build() - Method in class com.google.genkit.plugins.awsbedrock.AwsBedrockPluginOptions.Builder
-
Builds the options.
- build() - Method in class com.google.genkit.plugins.awsbedrock.session.DynamoDbSessionStoreOptions.Builder
-
Builds a new
DynamoDbSessionStoreOptions. - build() - Method in class com.google.genkit.plugins.azurefoundry.AzureFoundryPluginOptions.Builder
-
Builds the options.
- build() - Method in class com.google.genkit.plugins.azurefoundry.session.CosmosSessionStoreOptions.Builder
-
Builds a new
CosmosSessionStoreOptions. - build() - Method in class com.google.genkit.plugins.chroma.ChromaCollectionConfig.Builder
-
Builds a new
ChromaCollectionConfig. - build() - Method in class com.google.genkit.plugins.chroma.ChromaPlugin.Builder
-
Builds the plugin.
- build() - Method in class com.google.genkit.plugins.compatoai.CompatOAIPlugin.Builder
-
Builds the plugin.
- build() - Method in class com.google.genkit.plugins.compatoai.CompatOAIPluginOptions.Builder
-
Builds the options.
- build() - Method in class com.google.genkit.plugins.evaluators.EvaluatorsPluginOptions.Builder
- build() - Method in class com.google.genkit.plugins.evaluators.MetricConfig.Builder
- build() - Method in class com.google.genkit.plugins.firebase.FirebasePlugin.Builder
-
Builds the FirebasePlugin.
- build() - Method in class com.google.genkit.plugins.firebase.FirebasePluginConfig.Builder
- build() - Method in class com.google.genkit.plugins.firebase.functions.AuthContext.Builder
- build() - Method in class com.google.genkit.plugins.firebase.retriever.FirestoreRetrieverConfig.Builder
-
Builds the configuration.
- build() - Method in class com.google.genkit.plugins.firebase.session.FirestoreSessionStoreOptions.Builder
-
Builds a new
FirestoreSessionStoreOptions. - build() - Method in class com.google.genkit.plugins.firebase.telemetry.FirebaseTelemetry.Builder
-
Builds the FirebaseTelemetry instance.
- build() - Method in class com.google.genkit.plugins.googlegenai.GoogleGenAIPluginOptions.Builder
-
Builds the GoogleGenAIPluginOptions.
- build() - Method in class com.google.genkit.plugins.jetty.JettyPluginOptions.Builder
- build() - Method in class com.google.genkit.plugins.localvec.LocalVecConfig.Builder
-
Builds the configuration.
- build() - Method in class com.google.genkit.plugins.localvec.LocalVecPlugin.Builder
-
Builds the plugin.
- build() - Method in class com.google.genkit.plugins.mcp.MCPPluginOptions.Builder
-
Builds the MCPPluginOptions.
- build() - Method in class com.google.genkit.plugins.mcp.MCPServerConfig.Builder
-
Builds the MCPServerConfig.
- build() - Method in class com.google.genkit.plugins.mcp.MCPServerOptions.Builder
-
Builds the MCPServerOptions.
- build() - Method in class com.google.genkit.plugins.middleware.AgentsOptions.Builder
-
Builds the
AgentsOptions. - build() - Method in class com.google.genkit.plugins.middleware.ArtifactsOptions.Builder
-
Builds the
ArtifactsOptions. - build() - Method in class com.google.genkit.plugins.milvus.MilvusCollectionConfig.Builder
-
Builds a new
MilvusCollectionConfig. - build() - Method in class com.google.genkit.plugins.milvus.MilvusPlugin.Builder
-
Builds the plugin.
- build() - Method in class com.google.genkit.plugins.mongodb.MongoPlugin.Builder
-
Builds the plugin.
- build() - Method in class com.google.genkit.plugins.mongodb.MongoVectorStoreConfig.Builder
-
Builds a new
MongoVectorStoreConfig. - build() - Method in class com.google.genkit.plugins.mongodb.session.MongoSessionStoreOptions.Builder
-
Builds a new
MongoSessionStoreOptions. - build() - Method in class com.google.genkit.plugins.ollama.OllamaPluginOptions.Builder
- build() - Method in class com.google.genkit.plugins.openai.ImageGenerationConfig.Builder
- build() - Method in class com.google.genkit.plugins.openai.OpenAIPluginOptions.Builder
- build() - Method in class com.google.genkit.plugins.pinecone.PineconeIndexConfig.Builder
-
Builds the PineconeIndexConfig.
- build() - Method in class com.google.genkit.plugins.pinecone.PineconePlugin.Builder
-
Builds the PineconePlugin.
- build() - Method in class com.google.genkit.plugins.postgresql.PostgresPlugin.Builder
-
Builds the PostgresPlugin.
- build() - Method in class com.google.genkit.plugins.postgresql.PostgresTableConfig.Builder
-
Builds the PostgresTableConfig.
- build() - Method in class com.google.genkit.plugins.postgresql.session.PostgresSessionStoreOptions.Builder
-
Builds a new
PostgresSessionStoreOptions. - build() - Method in class com.google.genkit.plugins.qdrant.QdrantCollectionConfig.Builder
-
Builds a new
QdrantCollectionConfig. - build() - Method in class com.google.genkit.plugins.qdrant.QdrantPlugin.Builder
-
Builds the plugin.
- build() - Method in class com.google.genkit.plugins.spring.SpringPluginOptions.Builder
- build() - Method in class com.google.genkit.plugins.weaviate.WeaviateCollectionConfig.Builder
-
Builds the WeaviateCollectionConfig.
- build() - Method in class com.google.genkit.plugins.weaviate.WeaviatePlugin.Builder
-
Builds the WeaviatePlugin.
- builder() - Static method in class com.google.genkit.agent.AgentConfig
-
Creates a builder for AgentConfig.
- builder() - Static method in class com.google.genkit.ai.agent.AgentAbortRequest
-
Creates a builder for AgentAbortRequest.
- builder() - Static method in class com.google.genkit.ai.agent.AgentAbortResponse
-
Creates a builder for AgentAbortResponse.
- builder() - Static method in class com.google.genkit.ai.agent.AgentInit
-
Creates a builder for AgentInit.
- builder() - Static method in class com.google.genkit.ai.agent.AgentInput
-
Creates a builder for AgentInput.
- builder() - Static method in class com.google.genkit.ai.agent.AgentMetadata
-
Creates a builder for AgentMetadata.
- builder() - Static method in class com.google.genkit.ai.agent.AgentOutput
-
Creates a builder for AgentOutput.
- builder() - Static method in class com.google.genkit.ai.agent.AgentResult
-
Creates a builder for AgentResult.
- builder() - Static method in class com.google.genkit.ai.agent.AgentStreamChunk
-
Creates a builder for AgentStreamChunk.
- builder() - Static method in class com.google.genkit.ai.agent.Artifact
-
Creates a builder for Artifact.
- builder() - Static method in class com.google.genkit.ai.agent.CustomAgentConfig
-
Creates a builder for CustomAgentConfig.
- builder() - Static method in class com.google.genkit.ai.agent.GetSnapshotOptions
-
Creates a new builder for
GetSnapshotOptions. - builder() - Static method in class com.google.genkit.ai.agent.GetSnapshotRequest
-
Creates a builder for GetSnapshotRequest.
- builder() - Static method in class com.google.genkit.ai.agent.RuntimeError
-
Creates a builder for RuntimeError.
- builder() - Static method in class com.google.genkit.ai.agent.SessionSnapshot
-
Creates a builder for SessionSnapshot.
- builder() - Static method in class com.google.genkit.ai.agent.SessionState
-
Creates a builder for SessionState.
- builder() - Static method in class com.google.genkit.ai.agent.SessionStoreOptions
-
Creates a new builder for
SessionStoreOptions. - builder() - Static method in class com.google.genkit.ai.agent.ToolResume
-
Creates a builder for ToolResume.
- builder() - Static method in class com.google.genkit.ai.agent.TurnEnd
-
Creates a builder for TurnEnd.
- builder() - Static method in class com.google.genkit.ai.Embedder
-
Creates a builder for Embedder.
- builder() - Static method in class com.google.genkit.ai.evaluation.CreateDatasetRequest
- builder() - Static method in class com.google.genkit.ai.evaluation.DatasetMetadata
- builder() - Static method in class com.google.genkit.ai.evaluation.DatasetSample
- builder() - Static method in class com.google.genkit.ai.evaluation.EvalDataPoint
- builder() - Static method in class com.google.genkit.ai.evaluation.EvalMetric
- builder() - Static method in class com.google.genkit.ai.evaluation.EvalRequest
- builder() - Static method in class com.google.genkit.ai.evaluation.EvalResponse
- builder() - Static method in class com.google.genkit.ai.evaluation.EvalResult
- builder() - Static method in class com.google.genkit.ai.evaluation.EvalRun
- builder() - Static method in class com.google.genkit.ai.evaluation.EvalRunKey
- builder() - Static method in class com.google.genkit.ai.evaluation.Evaluator
-
Creates a new Evaluator builder.
- builder() - Static method in class com.google.genkit.ai.evaluation.EvaluatorInfo
- builder() - Static method in class com.google.genkit.ai.evaluation.RunEvaluationRequest
- builder() - Static method in class com.google.genkit.ai.evaluation.Score
- builder() - Static method in class com.google.genkit.ai.evaluation.ScoreDetails
- builder() - Static method in class com.google.genkit.ai.evaluation.UpdateDatasetRequest
- builder() - Static method in class com.google.genkit.ai.GenerateOptions
-
Creates a builder for GenerateOptions.
- builder() - Static method in class com.google.genkit.ai.GenerationConfig
-
Builder pattern for GenerationConfig.
- builder() - Static method in class com.google.genkit.ai.Indexer
-
Creates a builder for Indexer.
- builder() - Static method in class com.google.genkit.ai.InterruptConfig
-
Creates a new builder.
- builder() - Static method in class com.google.genkit.ai.Message
-
Creates a builder for Message.
- builder() - Static method in class com.google.genkit.ai.ModelRequest
-
Creates a builder for ModelRequest.
- builder() - Static method in class com.google.genkit.ai.ModelResponse
-
Creates a builder for ModelResponse.
- builder() - Static method in class com.google.genkit.ai.Prompt
-
Creates a builder for Prompt.
- builder() - Static method in class com.google.genkit.ai.ResumeOptions
-
Creates a new builder.
- builder() - Static method in class com.google.genkit.ai.Retriever
-
Creates a builder for Retriever.
- builder() - Static method in class com.google.genkit.ai.Tool
-
Creates a builder for Tool.
- builder() - Static method in class com.google.genkit.client.RemoteAgentOptions
-
Creates a builder for
RemoteAgentOptions. - builder() - Static method in class com.google.genkit.core.ActionContext
-
Creates a builder for ActionContext.
- builder() - Static method in class com.google.genkit.core.ActionDesc
-
Creates a builder for ActionDesc.
- builder() - Static method in class com.google.genkit.core.ActionRunResult
-
Creates a builder for ActionRunResult.
- builder() - Static method in class com.google.genkit.core.BidiActionImpl
-
Creates a new builder for
BidiActionImpl. - builder() - Static method in exception class com.google.genkit.core.GenkitException
-
Creates a builder for GenkitException.
- builder() - Static method in class com.google.genkit.core.tracing.SpanMetadata
-
Creates a builder for SpanMetadata.
- builder() - Static method in class com.google.genkit.Genkit
-
Creates a new Genkit builder.
- builder() - Static method in class com.google.genkit.GenkitOptions
-
Creates a new builder.
- builder() - Static method in class com.google.genkit.plugins.anthropic.AnthropicPluginOptions
-
Creates a new builder.
- builder() - Static method in class com.google.genkit.plugins.awsbedrock.AwsBedrockPluginOptions
-
Creates a new builder.
- builder() - Static method in class com.google.genkit.plugins.awsbedrock.session.DynamoDbSessionStoreOptions
-
Creates a new builder.
- builder() - Static method in class com.google.genkit.plugins.azurefoundry.AzureFoundryPluginOptions
-
Creates a new builder.
- builder() - Static method in class com.google.genkit.plugins.azurefoundry.session.CosmosSessionStoreOptions
-
Creates a new builder.
- builder() - Static method in class com.google.genkit.plugins.chroma.ChromaCollectionConfig
-
Creates a new builder.
- builder() - Static method in class com.google.genkit.plugins.chroma.ChromaPlugin
-
Creates a new builder.
- builder() - Static method in class com.google.genkit.plugins.compatoai.CompatOAIPlugin
-
Creates a CompatOAIPlugin builder.
- builder() - Static method in class com.google.genkit.plugins.compatoai.CompatOAIPluginOptions
-
Creates a new builder.
- builder() - Static method in class com.google.genkit.plugins.evaluators.EvaluatorsPluginOptions
- builder() - Static method in class com.google.genkit.plugins.evaluators.MetricConfig
- builder() - Static method in class com.google.genkit.plugins.firebase.FirebasePlugin
-
Creates a builder for FirebasePlugin.
- builder() - Static method in class com.google.genkit.plugins.firebase.FirebasePluginConfig
-
Creates a builder for FirebasePluginConfig.
- builder() - Static method in class com.google.genkit.plugins.firebase.functions.AuthContext
-
Builder for AuthContext.
- builder() - Static method in class com.google.genkit.plugins.firebase.retriever.FirestoreRetrieverConfig
-
Creates a builder for FirestoreRetrieverConfig.
- builder() - Static method in class com.google.genkit.plugins.firebase.session.FirestoreSessionStoreOptions
-
Creates a new builder.
- builder() - Static method in class com.google.genkit.plugins.firebase.telemetry.FirebaseTelemetry
-
Creates a builder for FirebaseTelemetry.
- builder() - Static method in class com.google.genkit.plugins.googlegenai.GoogleGenAIPluginOptions
-
Creates a new builder.
- builder() - Static method in class com.google.genkit.plugins.jetty.JettyPluginOptions
-
Creates a new builder.
- builder() - Static method in class com.google.genkit.plugins.localvec.LocalVecConfig
-
Creates a new builder.
- builder() - Static method in class com.google.genkit.plugins.localvec.LocalVecPlugin
-
Creates a builder for LocalVecPlugin.
- builder() - Static method in class com.google.genkit.plugins.mcp.MCPPluginOptions
-
Creates a new builder for MCPPluginOptions.
- builder() - Static method in class com.google.genkit.plugins.mcp.MCPServerConfig
-
Creates a new builder.
- builder() - Static method in class com.google.genkit.plugins.mcp.MCPServerOptions
-
Creates a new builder.
- builder() - Static method in class com.google.genkit.plugins.middleware.AgentsOptions
-
Creates a builder for
AgentsOptions. - builder() - Static method in class com.google.genkit.plugins.middleware.ArtifactsOptions
-
Creates a builder for
ArtifactsOptions. - builder() - Static method in class com.google.genkit.plugins.milvus.MilvusCollectionConfig
-
Creates a new builder.
- builder() - Static method in class com.google.genkit.plugins.milvus.MilvusPlugin
-
Creates a new builder.
- builder() - Static method in class com.google.genkit.plugins.mongodb.MongoPlugin
-
Creates a new builder.
- builder() - Static method in class com.google.genkit.plugins.mongodb.MongoVectorStoreConfig
-
Creates a new builder.
- builder() - Static method in class com.google.genkit.plugins.mongodb.session.MongoSessionStoreOptions
-
Creates a new builder.
- builder() - Static method in class com.google.genkit.plugins.ollama.OllamaPluginOptions
-
Creates a new builder.
- builder() - Static method in class com.google.genkit.plugins.openai.ImageGenerationConfig
-
Creates a builder for ImageGenerationConfig.
- builder() - Static method in class com.google.genkit.plugins.openai.OpenAIPluginOptions
-
Creates a new builder.
- builder() - Static method in class com.google.genkit.plugins.pinecone.PineconeIndexConfig
-
Creates a new builder for PineconeIndexConfig.
- builder() - Static method in class com.google.genkit.plugins.pinecone.PineconePlugin
-
Creates a new builder for PineconePlugin.
- builder() - Static method in class com.google.genkit.plugins.postgresql.PostgresPlugin
-
Creates a new builder for PostgresPlugin.
- builder() - Static method in class com.google.genkit.plugins.postgresql.PostgresTableConfig
-
Creates a new builder for PostgresTableConfig.
- builder() - Static method in class com.google.genkit.plugins.postgresql.session.PostgresSessionStoreOptions
-
Creates a new builder.
- builder() - Static method in class com.google.genkit.plugins.qdrant.QdrantCollectionConfig
-
Creates a new builder.
- builder() - Static method in class com.google.genkit.plugins.qdrant.QdrantPlugin
-
Creates a new builder.
- builder() - Static method in class com.google.genkit.plugins.spring.SpringPluginOptions
-
Creates a new builder.
- builder() - Static method in class com.google.genkit.plugins.weaviate.WeaviateCollectionConfig
-
Creates a builder for WeaviateCollectionConfig.
- builder() - Static method in class com.google.genkit.plugins.weaviate.WeaviatePlugin
-
Creates a builder for WeaviatePlugin.
- builder(String) - Static method in class com.google.genkit.ai.agent.FileSessionStore
-
Creates a builder for
FileSessionStore. - Builder() - Constructor for class com.google.genkit.ai.agent.AgentAbortRequest.Builder
- Builder() - Constructor for class com.google.genkit.ai.agent.AgentAbortResponse.Builder
- Builder() - Constructor for class com.google.genkit.ai.agent.AgentInit.Builder
- Builder() - Constructor for class com.google.genkit.ai.agent.AgentInput.Builder
- Builder() - Constructor for class com.google.genkit.ai.agent.AgentMetadata.Builder
- Builder() - Constructor for class com.google.genkit.ai.agent.AgentOutput.Builder
- Builder() - Constructor for class com.google.genkit.ai.agent.AgentResult.Builder
- Builder() - Constructor for class com.google.genkit.ai.agent.AgentStreamChunk.Builder
- Builder() - Constructor for class com.google.genkit.ai.agent.Artifact.Builder
- Builder() - Constructor for class com.google.genkit.ai.agent.GetSnapshotRequest.Builder
- Builder() - Constructor for class com.google.genkit.ai.agent.RuntimeError.Builder
- Builder() - Constructor for class com.google.genkit.ai.agent.SessionSnapshot.Builder
- Builder() - Constructor for class com.google.genkit.ai.agent.SessionState.Builder
- Builder() - Constructor for class com.google.genkit.ai.agent.ToolResume.Builder
- Builder() - Constructor for class com.google.genkit.ai.agent.TurnEnd.Builder
- Builder() - Constructor for class com.google.genkit.ai.Embedder.Builder
- Builder() - Constructor for class com.google.genkit.ai.evaluation.CreateDatasetRequest.Builder
- Builder() - Constructor for class com.google.genkit.ai.evaluation.DatasetMetadata.Builder
- Builder() - Constructor for class com.google.genkit.ai.evaluation.DatasetSample.Builder
- Builder() - Constructor for class com.google.genkit.ai.evaluation.EvalDataPoint.Builder
- Builder() - Constructor for class com.google.genkit.ai.evaluation.EvalMetric.Builder
- Builder() - Constructor for class com.google.genkit.ai.evaluation.EvalRequest.Builder
- Builder() - Constructor for class com.google.genkit.ai.evaluation.EvalResponse.Builder
- Builder() - Constructor for class com.google.genkit.ai.evaluation.EvalResult.Builder
- Builder() - Constructor for class com.google.genkit.ai.evaluation.EvalRun.Builder
- Builder() - Constructor for class com.google.genkit.ai.evaluation.EvalRunKey.Builder
- Builder() - Constructor for class com.google.genkit.ai.evaluation.Evaluator.Builder
- Builder() - Constructor for class com.google.genkit.ai.evaluation.EvaluatorInfo.Builder
- Builder() - Constructor for class com.google.genkit.ai.evaluation.RunEvaluationRequest.Builder
- Builder() - Constructor for class com.google.genkit.ai.evaluation.Score.Builder
- Builder() - Constructor for class com.google.genkit.ai.evaluation.ScoreDetails.Builder
- Builder() - Constructor for class com.google.genkit.ai.evaluation.UpdateDatasetRequest.Builder
- Builder() - Constructor for class com.google.genkit.ai.GenerateOptions.Builder
- Builder() - Constructor for class com.google.genkit.ai.GenerationConfig.Builder
- Builder() - Constructor for class com.google.genkit.ai.Indexer.Builder
- Builder() - Constructor for class com.google.genkit.ai.InterruptConfig.Builder
- Builder() - Constructor for class com.google.genkit.ai.Message.Builder
- Builder() - Constructor for class com.google.genkit.ai.ModelRequest.Builder
- Builder() - Constructor for class com.google.genkit.ai.ModelResponse.Builder
- Builder() - Constructor for class com.google.genkit.ai.Prompt.Builder
- Builder() - Constructor for class com.google.genkit.ai.ResumeOptions.Builder
- Builder() - Constructor for class com.google.genkit.ai.Retriever.Builder
- Builder() - Constructor for class com.google.genkit.ai.Tool.Builder
- Builder() - Constructor for class com.google.genkit.core.ActionContext.Builder
- Builder() - Constructor for class com.google.genkit.core.ActionDesc.Builder
- Builder() - Constructor for class com.google.genkit.core.ActionRunResult.Builder
- Builder() - Constructor for class com.google.genkit.core.GenkitException.Builder
- Builder() - Constructor for class com.google.genkit.core.tracing.SpanMetadata.Builder
- Builder() - Constructor for class com.google.genkit.Genkit.Builder
- Builder() - Constructor for class com.google.genkit.GenkitOptions.Builder
- Builder() - Constructor for class com.google.genkit.plugins.anthropic.AnthropicPluginOptions.Builder
- Builder() - Constructor for class com.google.genkit.plugins.awsbedrock.AwsBedrockPluginOptions.Builder
- Builder() - Constructor for class com.google.genkit.plugins.azurefoundry.AzureFoundryPluginOptions.Builder
- Builder() - Constructor for class com.google.genkit.plugins.compatoai.CompatOAIPlugin.Builder
- Builder() - Constructor for class com.google.genkit.plugins.compatoai.CompatOAIPluginOptions.Builder
- Builder() - Constructor for class com.google.genkit.plugins.evaluators.EvaluatorsPluginOptions.Builder
- Builder() - Constructor for class com.google.genkit.plugins.evaluators.MetricConfig.Builder
- Builder() - Constructor for class com.google.genkit.plugins.firebase.FirebasePlugin.Builder
- Builder() - Constructor for class com.google.genkit.plugins.firebase.FirebasePluginConfig.Builder
- Builder() - Constructor for class com.google.genkit.plugins.firebase.functions.AuthContext.Builder
- Builder() - Constructor for class com.google.genkit.plugins.firebase.retriever.FirestoreRetrieverConfig.Builder
- Builder() - Constructor for class com.google.genkit.plugins.firebase.telemetry.FirebaseTelemetry.Builder
- Builder() - Constructor for class com.google.genkit.plugins.googlegenai.GoogleGenAIPluginOptions.Builder
- Builder() - Constructor for class com.google.genkit.plugins.jetty.JettyPluginOptions.Builder
- Builder() - Constructor for class com.google.genkit.plugins.localvec.LocalVecConfig.Builder
- Builder() - Constructor for class com.google.genkit.plugins.localvec.LocalVecPlugin.Builder
- Builder() - Constructor for class com.google.genkit.plugins.mcp.MCPPluginOptions.Builder
- Builder() - Constructor for class com.google.genkit.plugins.mcp.MCPServerConfig.Builder
- Builder() - Constructor for class com.google.genkit.plugins.mcp.MCPServerOptions.Builder
- Builder() - Constructor for class com.google.genkit.plugins.ollama.OllamaPluginOptions.Builder
- Builder() - Constructor for class com.google.genkit.plugins.openai.ImageGenerationConfig.Builder
- Builder() - Constructor for class com.google.genkit.plugins.openai.OpenAIPluginOptions.Builder
- Builder() - Constructor for class com.google.genkit.plugins.pinecone.PineconeIndexConfig.Builder
- Builder() - Constructor for class com.google.genkit.plugins.pinecone.PineconePlugin.Builder
- Builder() - Constructor for class com.google.genkit.plugins.postgresql.PostgresPlugin.Builder
- Builder() - Constructor for class com.google.genkit.plugins.postgresql.PostgresTableConfig.Builder
- Builder() - Constructor for class com.google.genkit.plugins.spring.SpringPluginOptions.Builder
- Builder() - Constructor for class com.google.genkit.plugins.weaviate.WeaviateCollectionConfig.Builder
- Builder() - Constructor for class com.google.genkit.plugins.weaviate.WeaviatePlugin.Builder
C
- cache(MiddlewareCache<O>, Function<I, String>) - Static method in class com.google.genkit.core.middleware.CommonMiddleware
-
Creates a caching middleware that caches results based on a key.
- calculateBasicUsage(ModelRequest, ModelResponse) - Static method in class com.google.genkit.ai.telemetry.ModelTelemetryHelper
-
Calculates basic usage statistics from request and response.
- call(Session<?>, Supplier<T>) - Static method in class com.google.genkit.ai.agent.AgentSessionContext
-
Executes
bodywithsessionbound to the current thread context and returns the result. - callTool(String, String, Map<String, Object>) - Method in class com.google.genkit.plugins.mcp.MCPPlugin
-
Calls an MCP tool directly.
- callTool(String, Map<String, Object>) - Method in class com.google.genkit.plugins.mcp.MCPClient
-
Calls an MCP tool directly.
- CANCEL_OPERATION - Enum constant in enum class com.google.genkit.core.ActionType
-
An action for cancelling operations.
- Candidate - Class in com.google.genkit.ai
-
Candidate represents a single model response candidate.
- Candidate() - Constructor for class com.google.genkit.ai.Candidate
-
Default constructor.
- Candidate(Message) - Constructor for class com.google.genkit.ai.Candidate
-
Creates a Candidate with a message.
- Candidate(Message, FinishReason) - Constructor for class com.google.genkit.ai.Candidate
-
Creates a Candidate with message and finish reason.
- candidates(List<Candidate>) - Method in class com.google.genkit.ai.ModelResponse.Builder
- cause(Throwable) - Method in class com.google.genkit.core.GenkitException.Builder
- chat() - Method in class com.google.genkit.ai.agent.Agent
- chat() - Method in interface com.google.genkit.ai.agent.AgentApi
-
Creates a fresh
AgentChatfor a new conversation, using a default action context built from the registry the agent was defined in. - chat(AgentInit<S>) - Method in class com.google.genkit.ai.agent.Agent
- chat(AgentInit<S>) - Method in interface com.google.genkit.ai.agent.AgentApi
-
Creates an
AgentChatseeded frominit(snapshotId / sessionId / inline state), using a default action context built from the registry the agent was defined in. - chat(RemoteAgentOptions) - Static method in class com.google.genkit.client.RemoteAgent
- chat(ActionContext) - Method in class com.google.genkit.ai.agent.Agent
- chat(ActionContext) - Method in interface com.google.genkit.ai.agent.AgentApi
-
Creates a fresh
AgentChatfor a new conversation. - chat(ActionContext, AgentInit<S>) - Method in class com.google.genkit.ai.agent.Agent
- chat(ActionContext, AgentInit<S>) - Method in interface com.google.genkit.ai.agent.AgentApi
-
Creates an
AgentChatseeded frominit(snapshotId / sessionId / inline state). - CHECK_OPERATION - Enum constant in enum class com.google.genkit.core.ActionType
-
An action for checking operation status.
- checkpointInterval(int) - Method in class com.google.genkit.plugins.awsbedrock.session.DynamoDbSessionStoreOptions.Builder
-
Sets the number of turns between full checkpoints.
- checkpointInterval(int) - Method in class com.google.genkit.plugins.azurefoundry.session.CosmosSessionStoreOptions.Builder
-
Sets the number of turns between full checkpoints.
- checkpointInterval(int) - Method in class com.google.genkit.plugins.firebase.session.FirestoreSessionStoreOptions.Builder
-
Sets the number of turns between full checkpoints.
- checkpointInterval(int) - Method in class com.google.genkit.plugins.mongodb.session.MongoSessionStoreOptions.Builder
-
Sets the number of turns between full checkpoints.
- checkpointInterval(int) - Method in class com.google.genkit.plugins.postgresql.session.PostgresSessionStoreOptions.Builder
-
Sets the number of turns between full checkpoints.
- ChromaCollectionConfig - Class in com.google.genkit.plugins.chroma
-
Configuration for a single Chroma collection managed by
ChromaPlugin. - ChromaCollectionConfig.Builder - Class in com.google.genkit.plugins.chroma
-
Builder for
ChromaCollectionConfig. - ChromaCollectionConfig.Distance - Enum Class in com.google.genkit.plugins.chroma
-
Distance function used by the Chroma HNSW index.
- ChromaPlugin - Class in com.google.genkit.plugins.chroma
-
Chroma vector database plugin for Genkit.
- ChromaPlugin.Builder - Class in com.google.genkit.plugins.chroma
-
Builder for
ChromaPlugin. - ChromaVectorStore - Class in com.google.genkit.plugins.chroma
-
Chroma vector store backed by the Chroma v2 REST API.
- ChromaVectorStore(String, String, String, ChromaCollectionConfig, Embedder) - Constructor for class com.google.genkit.plugins.chroma.ChromaVectorStore
-
Creates a new store.
- claim(String, Object) - Method in class com.google.genkit.plugins.firebase.functions.AuthContext.Builder
- claims(Map<String, Object>) - Method in class com.google.genkit.plugins.firebase.functions.AuthContext.Builder
- cleanup() - Static method in class com.google.genkit.RuntimeFileWriter
-
Cleans up the runtime file using the current directory as project root.
- clear() - Method in interface com.google.genkit.core.middleware.MiddlewareCache
-
Clears all values from the cache.
- clear() - Method in class com.google.genkit.core.middleware.MiddlewareChain
-
Clears all middleware from the chain.
- clear() - Method in class com.google.genkit.core.middleware.SimpleCache
- clear() - Method in class com.google.genkit.plugins.localvec.LocalVecDocStore
-
Clears all documents from the store.
- clearAll() - Method in class com.google.genkit.plugins.postgresql.PostgresVectorStore
-
Clears all documents from the table.
- client(MongoClient) - Method in class com.google.genkit.plugins.mongodb.MongoPlugin.Builder
-
Sets an external MongoDB client to use instead of creating one from a connection string.
- client(Pinecone) - Method in class com.google.genkit.plugins.pinecone.PineconePlugin.Builder
-
Sets an external Pinecone client to use instead of creating one.
- clientTransform(ClientTransform<S>) - Method in class com.google.genkit.agent.AgentConfig.Builder
-
Sets the client-transform applied to session state before returning it to the caller in client-managed mode.
- clientTransform(ClientTransform<S>) - Method in class com.google.genkit.ai.agent.CustomAgentConfig.Builder
-
Sets the client-transform applied to session state before returning it to the caller in client-managed mode.
- ClientTransform<S> - Interface in com.google.genkit.ai.agent
-
ClientTransform allows a client-managed agent to transform session state before returning it to the caller.
- close() - Method in class com.google.genkit.core.BufferedInputSource
-
No-op; the queue needs no explicit resource release.
- close() - Method in interface com.google.genkit.core.InputSource
-
Releases any resources held by this source.
- close() - Method in class com.google.genkit.plugins.postgresql.PostgresPlugin
-
Closes the plugin and releases resources.
- cloud(PineconeIndexConfig.Cloud) - Method in class com.google.genkit.plugins.pinecone.PineconeIndexConfig.Builder
-
Sets the cloud provider for serverless index (default: AWS).
- CoherePlugin - Class in com.google.genkit.plugins.cohere
-
CoherePlugin provides Cohere model integrations for Genkit.
- CoherePlugin() - Constructor for class com.google.genkit.plugins.cohere.CoherePlugin
-
Creates a CoherePlugin with default options (using COHERE_API_KEY environment variable).
- CoherePlugin(CompatOAIPluginOptions) - Constructor for class com.google.genkit.plugins.cohere.CoherePlugin
-
Creates a CoherePlugin with the specified options.
- collection(String) - Method in class com.google.genkit.plugins.firebase.retriever.FirestoreRetrieverConfig.Builder
-
Sets the Firestore collection name.
- collection(String) - Method in class com.google.genkit.plugins.firebase.session.FirestoreSessionStoreOptions.Builder
-
Sets the top-level collection name.
- collectionName(String) - Method in class com.google.genkit.plugins.chroma.ChromaCollectionConfig.Builder
-
Sets the collection name.
- collectionName(String) - Method in class com.google.genkit.plugins.milvus.MilvusCollectionConfig.Builder
-
Sets the collection name.
- collectionName(String) - Method in class com.google.genkit.plugins.mongodb.MongoVectorStoreConfig.Builder
-
Sets the collection name.
- collectionName(String) - Method in class com.google.genkit.plugins.mongodb.session.MongoSessionStoreOptions.Builder
-
Sets the MongoDB collection name.
- collectionName(String) - Method in class com.google.genkit.plugins.qdrant.QdrantCollectionConfig.Builder
-
Sets the collection name.
- com.google.genkit - package com.google.genkit
- com.google.genkit.agent - package com.google.genkit.agent
- com.google.genkit.ai - package com.google.genkit.ai
- com.google.genkit.ai.agent - package com.google.genkit.ai.agent
-
This package provides types for the Genkit agents feature, including enums and models for agent state snapshots, agent execution lifecycle, and agent-related operations.
- com.google.genkit.ai.agent.internal - package com.google.genkit.ai.agent.internal
- com.google.genkit.ai.evaluation - package com.google.genkit.ai.evaluation
- com.google.genkit.ai.middleware - package com.google.genkit.ai.middleware
- com.google.genkit.ai.telemetry - package com.google.genkit.ai.telemetry
-
Telemetry module for Genkit Java SDK.
- com.google.genkit.client - package com.google.genkit.client
- com.google.genkit.core - package com.google.genkit.core
- com.google.genkit.core.jsonpatch - package com.google.genkit.core.jsonpatch
-
RFC 6902 (JSON Patch) support for Genkit Java.
- com.google.genkit.core.middleware - package com.google.genkit.core.middleware
-
Middleware support for Genkit Java.
- com.google.genkit.core.telemetry - package com.google.genkit.core.telemetry
- com.google.genkit.core.tracing - package com.google.genkit.core.tracing
- com.google.genkit.plugins.anthropic - package com.google.genkit.plugins.anthropic
- com.google.genkit.plugins.awsbedrock - package com.google.genkit.plugins.awsbedrock
- com.google.genkit.plugins.awsbedrock.session - package com.google.genkit.plugins.awsbedrock.session
-
DynamoDB-backed agent session persistence.
- com.google.genkit.plugins.azurefoundry - package com.google.genkit.plugins.azurefoundry
- com.google.genkit.plugins.azurefoundry.session - package com.google.genkit.plugins.azurefoundry.session
-
Azure Cosmos DB-backed agent session persistence.
- com.google.genkit.plugins.chroma - package com.google.genkit.plugins.chroma
-
Chroma vector database integration for Genkit.
- com.google.genkit.plugins.cohere - package com.google.genkit.plugins.cohere
- com.google.genkit.plugins.compatoai - package com.google.genkit.plugins.compatoai
- com.google.genkit.plugins.deepseek - package com.google.genkit.plugins.deepseek
- com.google.genkit.plugins.evaluators - package com.google.genkit.plugins.evaluators
- com.google.genkit.plugins.evaluators.metrics - package com.google.genkit.plugins.evaluators.metrics
- com.google.genkit.plugins.firebase - package com.google.genkit.plugins.firebase
-
Firebase plugin for Genkit providing integration with Firebase services.
- com.google.genkit.plugins.firebase.functions - package com.google.genkit.plugins.firebase.functions
-
Firebase Cloud Functions integration for Genkit flows.
- com.google.genkit.plugins.firebase.retriever - package com.google.genkit.plugins.firebase.retriever
-
Firestore vector search retriever and indexer components.
- com.google.genkit.plugins.firebase.session - package com.google.genkit.plugins.firebase.session
-
Firestore-backed session store for Genkit agents.
- com.google.genkit.plugins.firebase.telemetry - package com.google.genkit.plugins.firebase.telemetry
-
Firebase telemetry integration for Genkit Monitoring.
- com.google.genkit.plugins.googlegenai - package com.google.genkit.plugins.googlegenai
- com.google.genkit.plugins.groq - package com.google.genkit.plugins.groq
- com.google.genkit.plugins.jetty - package com.google.genkit.plugins.jetty
- com.google.genkit.plugins.localvec - package com.google.genkit.plugins.localvec
- com.google.genkit.plugins.mcp - package com.google.genkit.plugins.mcp
- com.google.genkit.plugins.middleware - package com.google.genkit.plugins.middleware
-
Middleware plugin for Genkit providing higher-level generation building blocks.
- com.google.genkit.plugins.middleware.internal - package com.google.genkit.plugins.middleware.internal
- com.google.genkit.plugins.milvus - package com.google.genkit.plugins.milvus
-
Milvus vector database integration for Genkit.
- com.google.genkit.plugins.mistral - package com.google.genkit.plugins.mistral
- com.google.genkit.plugins.mongodb - package com.google.genkit.plugins.mongodb
-
MongoDB integration for Genkit.
- com.google.genkit.plugins.mongodb.session - package com.google.genkit.plugins.mongodb.session
-
MongoDB-backed agent session persistence.
- com.google.genkit.plugins.ollama - package com.google.genkit.plugins.ollama
- com.google.genkit.plugins.openai - package com.google.genkit.plugins.openai
- com.google.genkit.plugins.pinecone - package com.google.genkit.plugins.pinecone
-
Pinecone plugin for Genkit providing vector database integration.
- com.google.genkit.plugins.postgresql - package com.google.genkit.plugins.postgresql
-
PostgreSQL plugin for Genkit providing vector database integration using pgvector extension.
- com.google.genkit.plugins.postgresql.session - package com.google.genkit.plugins.postgresql.session
-
PostgreSQL-backed agent session persistence.
- com.google.genkit.plugins.qdrant - package com.google.genkit.plugins.qdrant
-
Qdrant vector database integration for Genkit.
- com.google.genkit.plugins.spring - package com.google.genkit.plugins.spring
- com.google.genkit.plugins.weaviate - package com.google.genkit.plugins.weaviate
-
Weaviate plugin for Genkit providing vector database integration for RAG workflows.
- com.google.genkit.plugins.xai - package com.google.genkit.plugins.xai
- com.google.genkit.prompt - package com.google.genkit.prompt
- command(String) - Method in class com.google.genkit.plugins.mcp.MCPServerConfig.Builder
-
Sets the command for STDIO transport.
- CommonMiddleware - Class in com.google.genkit.core.middleware
-
CommonMiddleware provides factory methods for creating commonly-used middleware functions.
- CompatOAIEmbedder - Class in com.google.genkit.plugins.compatoai
-
Embedder implementation for any provider that exposes an OpenAI-compatible
/embeddingsendpoint (e.g. - CompatOAIEmbedder(String, String, String, CompatOAIPluginOptions) - Constructor for class com.google.genkit.plugins.compatoai.CompatOAIEmbedder
-
Creates a new CompatOAIEmbedder.
- CompatOAIModel - Class in com.google.genkit.plugins.compatoai
-
OpenAI-compatible API model implementation for Genkit.
- CompatOAIModel(String, String, CompatOAIPluginOptions) - Constructor for class com.google.genkit.plugins.compatoai.CompatOAIModel
-
Creates a new CompatOAIModel (backward compatible - uses modelName for both).
- CompatOAIModel(String, String, String, CompatOAIPluginOptions) - Constructor for class com.google.genkit.plugins.compatoai.CompatOAIModel
-
Creates a new CompatOAIModel with separate Genkit and API model names.
- CompatOAIPlugin - Class in com.google.genkit.plugins.compatoai
-
CompatOAIPlugin provides a generic OpenAI-compatible API integration for Genkit.
- CompatOAIPlugin(String, CompatOAIPluginOptions, List<CompatOAIPlugin.ModelDefinition>) - Constructor for class com.google.genkit.plugins.compatoai.CompatOAIPlugin
-
Creates a CompatOAIPlugin with the specified configuration.
- CompatOAIPlugin.Builder - Class in com.google.genkit.plugins.compatoai
-
Builder for CompatOAIPlugin.
- CompatOAIPlugin.ModelDefinition - Class in com.google.genkit.plugins.compatoai
-
Model definition for a compat-oai model.
- CompatOAIPluginOptions - Class in com.google.genkit.plugins.compatoai
-
Options for configuring OpenAI-compatible API plugins.
- CompatOAIPluginOptions.Builder - Class in com.google.genkit.plugins.compatoai
-
Builder for CompatOAIPluginOptions.
- COMPLETED - Enum constant in enum class com.google.genkit.ai.agent.SnapshotStatus
-
The snapshot is completed.
- Concurrency - Search tag in class com.google.genkit.plugins.awsbedrock.session.DynamoDbSessionStore
- Section
- Concurrency - Search tag in class com.google.genkit.plugins.azurefoundry.session.CosmosSessionStore
- Section
- Concurrency - Search tag in class com.google.genkit.plugins.firebase.session.FirestoreSessionStore
- Section
- Concurrency - Search tag in class com.google.genkit.plugins.mongodb.session.MongoSessionStore
- Section
- Concurrency - Search tag in class com.google.genkit.plugins.postgresql.session.PostgresSessionStore
- Section
- conditional(BiPredicate<I, ActionContext>, Middleware<I, O>) - Static method in class com.google.genkit.core.middleware.CommonMiddleware
-
Creates a conditional middleware that only applies if the predicate is true.
- config(GenerationConfig) - Method in class com.google.genkit.agent.AgentConfig.Builder
-
Sets the generation configuration.
- config(GenerationConfig) - Method in class com.google.genkit.ai.GenerateOptions.Builder
- config(GenerationConfig) - Method in class com.google.genkit.ai.Prompt.Builder
- config(Map<String, Object>) - Method in class com.google.genkit.ai.ModelRequest.Builder
- configSchema() - Method in interface com.google.genkit.ai.middleware.GenerationMiddlewareDesc
-
Returns the JSON Schema describing this middleware's configuration parameters, or
nullif the middleware takes no parameters. - configureTelemetryServer(String) - Static method in class com.google.genkit.core.tracing.Tracer
-
Configures the telemetry server URL for exporting traces.
- connect() - Method in class com.google.genkit.plugins.mcp.MCPClient
-
Connects to the MCP server.
- connectionString(String) - Method in class com.google.genkit.plugins.mongodb.MongoPlugin.Builder
-
Sets the MongoDB connection string (required unless an external client is provided).
- connectionString(String) - Method in class com.google.genkit.plugins.postgresql.PostgresPlugin.Builder
-
Sets the JDBC connection string (required unless externalDataSource is provided).
- consumeAppCheckToken(boolean) - Method in class com.google.genkit.plugins.firebase.functions.OnCallGenkit
-
Enables App Check token consumption for extra security.
- containerName(String) - Method in class com.google.genkit.plugins.azurefoundry.session.CosmosSessionStoreOptions.Builder
-
Sets the Cosmos DB container name.
- content - Variable in class com.google.genkit.plugins.middleware.Agents.ArtifactRef
-
Content; populated only under
ArtifactStrategy.INLINE. - content - Variable in class com.google.genkit.plugins.middleware.Artifacts.ReadOutput
- content - Variable in class com.google.genkit.plugins.middleware.Artifacts.WriteInput
- content - Variable in class com.google.genkit.plugins.middleware.internal.Delegation.NamedArtifact
- content(List<Part>) - Method in class com.google.genkit.ai.Message.Builder
- contentColumn(String) - Method in class com.google.genkit.plugins.postgresql.PostgresTableConfig.Builder
-
Sets the content column name (default: "content").
- contentExtractor(Function<QueryDocumentSnapshot, List<Part>>) - Method in class com.google.genkit.plugins.firebase.retriever.FirestoreRetrieverConfig.Builder
-
Sets a custom content extractor function.
- contentField(String) - Method in class com.google.genkit.plugins.firebase.retriever.FirestoreRetrieverConfig.Builder
-
Sets the field name containing document content.
- contentField(String) - Method in class com.google.genkit.plugins.weaviate.WeaviateCollectionConfig.Builder
-
Sets the field name for document content.
- ContentPart(String, String, String) - Constructor for class com.google.genkit.plugins.mcp.MCPResourceContent.ContentPart
-
Creates a new content part.
- context() - Method in class com.google.genkit.ai.agent.AgentFnContext
-
Returns the run's
ActionContext, which carries the request-scoped user context. - context(List<Document>) - Method in class com.google.genkit.ai.ModelRequest.Builder
- context(List<Object>) - Method in class com.google.genkit.ai.evaluation.EvalDataPoint.Builder
- context(List<Object>) - Method in class com.google.genkit.ai.evaluation.EvalResult.Builder
- context(Map<String, Object>) - Method in class com.google.genkit.ai.GenerateOptions.Builder
- context(Map<String, Object>) - Method in class com.google.genkit.core.ActionContext.Builder
- contextPath(String) - Method in class com.google.genkit.plugins.spring.SpringPluginOptions.Builder
- convert(Object) - Static method in class com.google.genkit.prompt.Picoschema
-
Converts a parsed Picoschema definition into a JSON Schema map.
- convert(Object, Class<T>) - Static method in class com.google.genkit.core.JsonUtils
-
Converts an object to the specified type.
- copy() - Method in class com.google.genkit.core.middleware.MiddlewareChain
-
Creates a copy of this MiddlewareChain.
- COSINE - Enum constant in enum class com.google.genkit.plugins.chroma.ChromaCollectionConfig.Distance
- COSINE - Enum constant in enum class com.google.genkit.plugins.firebase.retriever.FirestoreRetrieverConfig.DistanceMeasure
-
Cosine similarity (default).
- COSINE - Enum constant in enum class com.google.genkit.plugins.milvus.MilvusCollectionConfig.Metric
- COSINE - Enum constant in enum class com.google.genkit.plugins.mongodb.MongoVectorStoreConfig.Similarity
- COSINE - Enum constant in enum class com.google.genkit.plugins.pinecone.PineconeIndexConfig.Metric
-
Cosine similarity.
- COSINE - Enum constant in enum class com.google.genkit.plugins.postgresql.PostgresTableConfig.DistanceStrategy
-
Cosine distance (1 - cosine similarity).
- COSINE - Enum constant in enum class com.google.genkit.plugins.qdrant.QdrantCollectionConfig.Distance
- COSINE - Enum constant in enum class com.google.genkit.plugins.weaviate.WeaviateCollectionConfig.DistanceMeasure
-
Cosine similarity (default).
- CosmosSessionStore<S> - Class in com.google.genkit.plugins.azurefoundry.session
-
Azure Cosmos DB-backed implementation of
SessionStoreandSnapshotSubscriber. - CosmosSessionStore(CosmosClient) - Constructor for class com.google.genkit.plugins.azurefoundry.session.CosmosSessionStore
-
Creates a store with default options.
- CosmosSessionStore(CosmosClient, CosmosSessionStoreOptions) - Constructor for class com.google.genkit.plugins.azurefoundry.session.CosmosSessionStore
-
Creates a store.
- CosmosSessionStoreOptions - Class in com.google.genkit.plugins.azurefoundry.session
-
Configuration for
CosmosSessionStore. - CosmosSessionStoreOptions.Builder - Class in com.google.genkit.plugins.azurefoundry.session
-
Builder for
CosmosSessionStoreOptions. - create() - Static method in class com.google.genkit.plugins.anthropic.AnthropicPlugin
-
Creates an AnthropicPlugin using the ANTHROPIC_API_KEY environment variable.
- create() - Static method in class com.google.genkit.plugins.awsbedrock.AwsBedrockPlugin
-
Creates an AwsBedrockPlugin using default AWS credentials and us-east-1 region.
- create() - Static method in class com.google.genkit.plugins.azurefoundry.AzureFoundryPlugin
-
Creates an AzureFoundryPlugin using environment variables or default Azure credentials.
- create() - Static method in class com.google.genkit.plugins.cohere.CoherePlugin
-
Creates a CoherePlugin using the COHERE_API_KEY environment variable.
- create() - Static method in class com.google.genkit.plugins.deepseek.DeepSeekPlugin
-
Creates a DeepSeekPlugin using the DEEPSEEK_API_KEY environment variable.
- create() - Static method in class com.google.genkit.plugins.evaluators.EvaluatorsPlugin
-
Creates an EvaluatorsPlugin with default options.
- create() - Static method in class com.google.genkit.plugins.googlegenai.GoogleGenAIPlugin
-
Creates a GoogleGenAIPlugin using environment variables for configuration.
- create() - Static method in class com.google.genkit.plugins.groq.GroqPlugin
-
Creates a GroqPlugin using the GROQ_API_KEY environment variable.
- create() - Static method in class com.google.genkit.plugins.middleware.GenerationMiddlewarePlugin
-
Creates the plugin.
- create() - Static method in class com.google.genkit.plugins.mistral.MistralPlugin
-
Creates a MistralPlugin using the MISTRAL_API_KEY environment variable.
- create() - Static method in class com.google.genkit.plugins.ollama.OllamaPlugin
-
Creates an OllamaPlugin using default settings.
- create() - Static method in class com.google.genkit.plugins.openai.OpenAIPlugin
-
Creates an OpenAIPlugin using the OPENAI_API_KEY environment variable.
- create() - Static method in class com.google.genkit.plugins.xai.XAIPlugin
-
Creates an XAIPlugin using the XAI_API_KEY environment variable.
- create(int) - Static method in class com.google.genkit.plugins.jetty.JettyPlugin
-
Creates a JettyPlugin with the specified port.
- create(int) - Static method in class com.google.genkit.plugins.spring.SpringPlugin
-
Creates a SpringPlugin with the specified port.
- create(Plugin...) - Static method in class com.google.genkit.Genkit
-
Creates a Genkit instance with the given plugins.
- create(EvaluatorsPluginOptions) - Static method in class com.google.genkit.plugins.evaluators.EvaluatorsPlugin
-
Creates an EvaluatorsPlugin with the specified options.
- create(GoogleGenAIPluginOptions) - Static method in class com.google.genkit.plugins.googlegenai.GoogleGenAIPlugin
-
Creates a GoogleGenAIPlugin with the specified options.
- create(MCPPluginOptions) - Static method in class com.google.genkit.plugins.mcp.MCPPlugin
-
Creates an MCP plugin with the given options.
- create(String) - Static method in class com.google.genkit.plugins.anthropic.AnthropicPlugin
-
Creates an AnthropicPlugin with the specified API key.
- create(String) - Static method in class com.google.genkit.plugins.awsbedrock.AwsBedrockPlugin
-
Creates an AwsBedrockPlugin with the specified region.
- create(String) - Static method in class com.google.genkit.plugins.cohere.CoherePlugin
-
Creates a CoherePlugin with the specified API key.
- create(String) - Static method in class com.google.genkit.plugins.deepseek.DeepSeekPlugin
-
Creates a DeepSeekPlugin with the specified API key.
- create(String) - Static method in class com.google.genkit.plugins.firebase.FirebasePlugin
-
Creates a simple FirebasePlugin with just the project ID.
- create(String) - Static method in class com.google.genkit.plugins.googlegenai.GoogleGenAIPlugin
-
Creates a GoogleGenAIPlugin with the specified API key.
- create(String) - Static method in class com.google.genkit.plugins.groq.GroqPlugin
-
Creates a GroqPlugin with the specified API key.
- create(String) - Static method in class com.google.genkit.plugins.mistral.MistralPlugin
-
Creates a MistralPlugin with the specified API key.
- create(String) - Static method in class com.google.genkit.plugins.ollama.OllamaPlugin
-
Creates an OllamaPlugin with the specified base URL.
- create(String) - Static method in class com.google.genkit.plugins.openai.OpenAIPlugin
-
Creates an OpenAIPlugin with the specified API key.
- create(String) - Static method in class com.google.genkit.plugins.pinecone.PineconePlugin
-
Creates a PineconePlugin with the specified API key.
- create(String) - Static method in class com.google.genkit.plugins.xai.XAIPlugin
-
Creates an XAIPlugin with the specified API key.
- create(String...) - Static method in class com.google.genkit.plugins.ollama.OllamaPlugin
-
Creates an OllamaPlugin with the specified models.
- create(String, ActionType, Map<String, Object>, Map<String, Object>, Class<I>, Class<O>, ActionDef.ActionFunction<I, O>) - Static method in class com.google.genkit.core.ActionDef
-
Creates a non-streaming action.
- create(String, String) - Static method in class com.google.genkit.plugins.azurefoundry.AzureFoundryPlugin
-
Creates an AzureFoundryPlugin with the specified endpoint and API key.
- createCollectionIfMissing(boolean) - Method in class com.google.genkit.plugins.weaviate.WeaviateCollectionConfig.Builder
-
Sets whether to create the collection if it doesn't exist.
- createCollectionIfNotExists(boolean) - Method in class com.google.genkit.plugins.chroma.ChromaCollectionConfig.Builder
-
Sets whether to create the collection on first use if it does not exist.
- createCollectionIfNotExists(boolean) - Method in class com.google.genkit.plugins.milvus.MilvusCollectionConfig.Builder
-
Sets whether to create the collection on first use if it does not exist.
- createCollectionIfNotExists(boolean) - Method in class com.google.genkit.plugins.qdrant.QdrantCollectionConfig.Builder
-
Sets whether to create the collection on first use if it does not exist.
- createdAt(String) - Method in class com.google.genkit.ai.agent.SessionSnapshot.Builder
- createdAt(String) - Method in class com.google.genkit.ai.evaluation.EvalRunKey.Builder
- createDatabaseIfNotExists(boolean) - Method in class com.google.genkit.plugins.firebase.retriever.FirestoreRetrieverConfig.Builder
-
Sets whether to create the Firestore database if it doesn't exist.
- createDataset(CreateDatasetRequest) - Method in interface com.google.genkit.ai.evaluation.DatasetStore
-
Creates a new dataset.
- createDataset(CreateDatasetRequest) - Method in class com.google.genkit.ai.evaluation.LocalFileDatasetStore
- CreateDatasetRequest - Class in com.google.genkit.ai.evaluation
-
Request to create a new dataset.
- CreateDatasetRequest() - Constructor for class com.google.genkit.ai.evaluation.CreateDatasetRequest
- CreateDatasetRequest.Builder - Class in com.google.genkit.ai.evaluation
- createIfNotExists(boolean) - Method in class com.google.genkit.plugins.azurefoundry.session.CosmosSessionStoreOptions.Builder
-
Sets whether to create the database and container on first use if they do not exist.
- createIndexer() - Method in class com.google.genkit.plugins.firebase.retriever.FirestoreVectorStore
-
Creates an Indexer action for this vector store.
- createIndexer() - Method in class com.google.genkit.plugins.localvec.LocalVecDocStore
-
Creates an indexer action for this document store.
- createIndexer() - Method in class com.google.genkit.plugins.weaviate.WeaviateVectorStore
-
Creates an Indexer action for this vector store.
- createIndexIfNotExists(boolean) - Method in class com.google.genkit.plugins.mongodb.MongoVectorStoreConfig.Builder
-
Sets whether to create the Atlas Vector Search index on first use if it does not exist.
- createIndexIfNotExists(boolean) - Method in class com.google.genkit.plugins.pinecone.PineconeIndexConfig.Builder
-
Sets whether to create the index if it doesn't exist (default: false).
- createIndexIfNotExists(boolean) - Method in class com.google.genkit.plugins.postgresql.PostgresTableConfig.Builder
-
Sets whether to create the index if it doesn't exist (default: true).
- createRetriever() - Method in class com.google.genkit.plugins.firebase.retriever.FirestoreVectorStore
-
Creates a Retriever action for this vector store.
- createRetriever() - Method in class com.google.genkit.plugins.localvec.LocalVecDocStore
-
Creates a retriever action for this document store.
- createRetriever() - Method in class com.google.genkit.plugins.weaviate.WeaviateVectorStore
-
Creates a Retriever action for this vector store.
- createStreaming(String, ActionType, Map<String, Object>, Map<String, Object>, Class<I>, Class<O>, ActionDef.StreamingFunction<I, O, S>) - Static method in class com.google.genkit.core.ActionDef
-
Creates a streaming action.
- createTableIfNotExists(boolean) - Method in class com.google.genkit.plugins.awsbedrock.session.DynamoDbSessionStoreOptions.Builder
-
Sets whether to create the table on first use if it does not exist.
- createTableIfNotExists(boolean) - Method in class com.google.genkit.plugins.postgresql.PostgresTableConfig.Builder
-
Sets whether to create the table if it doesn't exist (default: true).
- createTableIfNotExists(boolean) - Method in class com.google.genkit.plugins.postgresql.session.PostgresSessionStoreOptions.Builder
-
Sets whether to create the table on first use if it does not exist.
- createTime(String) - Method in class com.google.genkit.ai.evaluation.DatasetMetadata.Builder
- createVectorIndexIfNotExists(boolean) - Method in class com.google.genkit.plugins.firebase.retriever.FirestoreRetrieverConfig.Builder
-
Sets whether to create the Firestore vector index if it doesn't exist.
- credential(TokenCredential) - Method in class com.google.genkit.plugins.azurefoundry.AzureFoundryPluginOptions.Builder
-
Sets the Azure credential for authentication (alternative to API key).
- credentials(GoogleCredentials) - Method in class com.google.genkit.plugins.firebase.FirebasePlugin.Builder
-
Sets the Google credentials.
- credentials(GoogleCredentials) - Method in class com.google.genkit.plugins.firebase.FirebasePluginConfig.Builder
- credentialsProvider(AwsCredentialsProvider) - Method in class com.google.genkit.plugins.awsbedrock.AwsBedrockPluginOptions.Builder
-
Sets the AWS credentials provider.
- current() - Static method in class com.google.genkit.ai.agent.AgentSessionContext
-
Returns the
Sessioncurrently bound to this thread, ornullif none. - currentArtifactStore() - Static method in class com.google.genkit.ai.agent.AgentSessionContext
-
Returns the current session viewed as an
ArtifactStore, ornullif no session is bound to this thread. - custom() - Method in class com.google.genkit.ai.agent.AgentChunk
-
Returns the custom state after this chunk's
customPatchwas applied to the running client-side state. - custom() - Method in class com.google.genkit.ai.agent.AgentResponse
-
Returns the custom session state after the turn.
- custom(Map<String, Object>) - Method in class com.google.genkit.ai.evaluation.EvalDataPoint.Builder
- custom(Map<String, Object>) - Method in class com.google.genkit.ai.evaluation.EvalResult.Builder
- custom(Map<String, Object>) - Method in class com.google.genkit.ai.GenerationConfig.Builder
- custom(Map<String, Object>) - Method in class com.google.genkit.ai.ModelResponse.Builder
- custom(S) - Method in class com.google.genkit.ai.agent.SessionState.Builder
- CUSTOM - Enum constant in enum class com.google.genkit.core.ActionType
-
A custom action type for user-defined action types.
- CustomAgentConfig<S> - Class in com.google.genkit.ai.agent
-
Configuration for defining a custom agent via
AgentActions.defineCustomAgent. - CustomAgentConfig.Builder<S> - Class in com.google.genkit.ai.agent
-
Builder for
CustomAgentConfig. - customEmbeddingModel(String) - Method in class com.google.genkit.plugins.awsbedrock.AwsBedrockPlugin
-
Registers a custom embedding model ID.
- customEmbeddingModel(String) - Method in class com.google.genkit.plugins.cohere.CoherePlugin
-
Registers a custom embedding model name.
- customEmbeddingModel(String) - Method in class com.google.genkit.plugins.googlegenai.GoogleGenAIPlugin
-
Registers a custom embedding model name.
- customEmbeddingModel(String) - Method in class com.google.genkit.plugins.mistral.MistralPlugin
-
Registers a custom embedding model name.
- customEmbeddingModel(String) - Method in class com.google.genkit.plugins.openai.OpenAIPlugin
-
Registers a custom embedding model name.
- customImageModel(String) - Method in class com.google.genkit.plugins.googlegenai.GoogleGenAIPlugin
-
Registers a custom image generation model name.
- customImageModel(String) - Method in class com.google.genkit.plugins.openai.OpenAIPlugin
-
Registers a custom image generation model name.
- customModel(String) - Method in class com.google.genkit.plugins.anthropic.AnthropicPlugin
-
Registers a custom model name.
- customModel(String) - Method in class com.google.genkit.plugins.awsbedrock.AwsBedrockPlugin
-
Registers a custom model ID or inference profile.
- customModel(String) - Method in class com.google.genkit.plugins.azurefoundry.AzureFoundryPlugin
-
Registers a custom model or deployment name.
- customModel(String) - Method in class com.google.genkit.plugins.cohere.CoherePlugin
-
Registers a custom model name.
- customModel(String) - Method in class com.google.genkit.plugins.deepseek.DeepSeekPlugin
-
Registers a custom model name.
- customModel(String) - Method in class com.google.genkit.plugins.googlegenai.GoogleGenAIPlugin
-
Registers a custom chat/generation model name.
- customModel(String) - Method in class com.google.genkit.plugins.groq.GroqPlugin
-
Registers a custom model name.
- customModel(String) - Method in class com.google.genkit.plugins.mistral.MistralPlugin
-
Registers a custom model name.
- customModel(String) - Method in class com.google.genkit.plugins.openai.OpenAIPlugin
-
Registers a custom chat model name.
- customModel(String) - Method in class com.google.genkit.plugins.xai.XAIPlugin
-
Registers a custom model name.
- customOmniModel(String) - Method in class com.google.genkit.plugins.googlegenai.GoogleGenAIPlugin
-
Registers a custom Gemini Omni model name.
- customPatch(JsonNode) - Method in class com.google.genkit.ai.agent.AgentStreamChunk.Builder
- customTtsModel(String) - Method in class com.google.genkit.plugins.googlegenai.GoogleGenAIPlugin
-
Registers a custom TTS model name.
- customVeoModel(String) - Method in class com.google.genkit.plugins.googlegenai.GoogleGenAIPlugin
-
Registers a custom video generation model name.
D
- data(Object) - Static method in class com.google.genkit.ai.Part
-
Creates a data part.
- data(List<DatasetSample>) - Method in class com.google.genkit.ai.evaluation.CreateDatasetRequest.Builder
- data(List<DatasetSample>) - Method in class com.google.genkit.ai.evaluation.UpdateDatasetRequest.Builder
- database(String) - Method in class com.google.genkit.plugins.chroma.ChromaPlugin.Builder
-
Sets the Chroma database (default "default_database").
- databaseId(String) - Method in class com.google.genkit.plugins.firebase.retriever.FirestoreRetrieverConfig.Builder
-
Sets the Firestore database ID to use.
- databaseName(String) - Method in class com.google.genkit.plugins.azurefoundry.session.CosmosSessionStoreOptions.Builder
-
Sets the Cosmos DB database name.
- databaseName(String) - Method in class com.google.genkit.plugins.mongodb.MongoVectorStoreConfig.Builder
-
Sets the database name.
- databaseName(String) - Method in class com.google.genkit.plugins.mongodb.session.MongoSessionStoreOptions.Builder
-
Sets the MongoDB database name.
- databaseUrl(String) - Method in class com.google.genkit.plugins.firebase.FirebasePlugin.Builder
-
Sets the Firebase Realtime Database URL.
- databaseUrl(String) - Method in class com.google.genkit.plugins.firebase.FirebasePluginConfig.Builder
- dataset(List<EvalDataPoint>) - Method in class com.google.genkit.ai.evaluation.EvalRequest.Builder
- datasetId(String) - Method in class com.google.genkit.ai.evaluation.CreateDatasetRequest.Builder
- datasetId(String) - Method in class com.google.genkit.ai.evaluation.DatasetMetadata.Builder
- datasetId(String) - Method in class com.google.genkit.ai.evaluation.EvalRunKey.Builder
- datasetId(String) - Method in class com.google.genkit.ai.evaluation.UpdateDatasetRequest.Builder
- DatasetMetadata - Class in com.google.genkit.ai.evaluation
-
Metadata about a dataset stored in the dataset store.
- DatasetMetadata() - Constructor for class com.google.genkit.ai.evaluation.DatasetMetadata
- DatasetMetadata.Builder - Class in com.google.genkit.ai.evaluation
- DatasetSample - Class in com.google.genkit.ai.evaluation
-
Represents a single sample in an inference dataset.
- DatasetSample() - Constructor for class com.google.genkit.ai.evaluation.DatasetSample
- DatasetSample.Builder - Class in com.google.genkit.ai.evaluation
- DatasetStore - Interface in com.google.genkit.ai.evaluation
-
Interface for dataset storage operations.
- datasetType(DatasetType) - Method in class com.google.genkit.ai.evaluation.CreateDatasetRequest.Builder
- datasetType(DatasetType) - Method in class com.google.genkit.ai.evaluation.DatasetMetadata.Builder
- DatasetType - Enum Class in com.google.genkit.ai.evaluation
-
Type of dataset based on the target action.
- datasetVersion(Integer) - Method in class com.google.genkit.ai.evaluation.EvalRunKey.Builder
- dataSource(RunEvaluationRequest.DataSource) - Method in class com.google.genkit.ai.evaluation.RunEvaluationRequest.Builder
- dataSource(DataSource) - Method in class com.google.genkit.plugins.postgresql.PostgresPlugin.Builder
-
Sets an external DataSource to use instead of creating one.
- DataSource() - Constructor for class com.google.genkit.ai.evaluation.RunEvaluationRequest.DataSource
- DbValue - Class in com.google.genkit.plugins.localvec
-
Represents a stored document value with its embedding.
- DbValue() - Constructor for class com.google.genkit.plugins.localvec.DbValue
-
Default constructor for Jackson.
- DbValue(Document, List<Float>) - Constructor for class com.google.genkit.plugins.localvec.DbValue
-
Creates a new DbValue.
- DEEP_EQUAL - Enum constant in enum class com.google.genkit.plugins.evaluators.GenkitMetric
-
Tests deep equality between output and reference.
- Deep-copy strategy - Search tag in class com.google.genkit.ai.agent.InMemorySessionStore
- Section
- DeepEqualMetric - Class in com.google.genkit.plugins.evaluators.metrics
-
Deep Equal metric evaluator.
- DeepEqualMetric() - Constructor for class com.google.genkit.plugins.evaluators.metrics.DeepEqualMetric
- DeepSeekPlugin - Class in com.google.genkit.plugins.deepseek
-
DeepSeekPlugin provides DeepSeek model integrations for Genkit.
- DeepSeekPlugin() - Constructor for class com.google.genkit.plugins.deepseek.DeepSeekPlugin
-
Creates a DeepSeekPlugin with default options (using DEEPSEEK_API_KEY environment variable).
- DeepSeekPlugin(CompatOAIPluginOptions) - Constructor for class com.google.genkit.plugins.deepseek.DeepSeekPlugin
-
Creates a DeepSeekPlugin with the specified options.
- DEFAULT_CHECKPOINT_INTERVAL - Static variable in class com.google.genkit.plugins.awsbedrock.session.DynamoDbSessionStoreOptions
-
Default number of turns between full checkpoints.
- DEFAULT_CHECKPOINT_INTERVAL - Static variable in class com.google.genkit.plugins.azurefoundry.session.CosmosSessionStoreOptions
-
Default number of turns between full checkpoints.
- DEFAULT_CHECKPOINT_INTERVAL - Static variable in class com.google.genkit.plugins.firebase.session.FirestoreSessionStoreOptions
-
Default number of turns between full checkpoints.
- DEFAULT_CHECKPOINT_INTERVAL - Static variable in class com.google.genkit.plugins.mongodb.session.MongoSessionStoreOptions
-
Default number of turns between full checkpoints.
- DEFAULT_CHECKPOINT_INTERVAL - Static variable in class com.google.genkit.plugins.postgresql.session.PostgresSessionStoreOptions
-
Default number of turns between full checkpoints.
- DEFAULT_COLLECTION - Static variable in class com.google.genkit.plugins.firebase.session.FirestoreSessionStoreOptions
-
Default top-level collection name.
- DEFAULT_COLLECTION - Static variable in class com.google.genkit.plugins.mongodb.session.MongoSessionStoreOptions
-
Default collection name.
- DEFAULT_CONTAINER - Static variable in class com.google.genkit.plugins.azurefoundry.session.CosmosSessionStoreOptions
-
Default container name.
- DEFAULT_DATABASE - Static variable in class com.google.genkit.plugins.azurefoundry.session.CosmosSessionStoreOptions
-
Default database name.
- DEFAULT_DATABASE - Static variable in class com.google.genkit.plugins.chroma.ChromaPlugin
-
Default Chroma database.
- DEFAULT_DATABASE - Static variable in class com.google.genkit.plugins.mongodb.session.MongoSessionStoreOptions
-
Default database name.
- DEFAULT_POLL_INTERVAL_MS - Static variable in class com.google.genkit.plugins.awsbedrock.session.DynamoDbSessionStoreOptions
-
Default subscription poll interval in milliseconds.
- DEFAULT_POLL_INTERVAL_MS - Static variable in class com.google.genkit.plugins.azurefoundry.session.CosmosSessionStoreOptions
-
Default subscription poll interval in milliseconds.
- DEFAULT_POLL_INTERVAL_MS - Static variable in class com.google.genkit.plugins.mongodb.session.MongoSessionStoreOptions
-
Default subscription poll interval in milliseconds.
- DEFAULT_POLL_INTERVAL_MS - Static variable in class com.google.genkit.plugins.postgresql.session.PostgresSessionStoreOptions
-
Default subscription poll interval in milliseconds.
- DEFAULT_SHARD_SIZE - Static variable in class com.google.genkit.plugins.awsbedrock.session.DynamoDbSessionStoreOptions
-
Default shard size in bytes for checkpoint state (350 KiB, under the 400 KB item cap).
- DEFAULT_SHARD_SIZE - Static variable in class com.google.genkit.plugins.azurefoundry.session.CosmosSessionStoreOptions
-
Default shard size in bytes for checkpoint state (1 MiB, under the 2 MB document cap).
- DEFAULT_SHARD_SIZE - Static variable in class com.google.genkit.plugins.firebase.session.FirestoreSessionStoreOptions
-
Default shard size in bytes for checkpoint state (512 KiB).
- DEFAULT_SHARD_SIZE - Static variable in class com.google.genkit.plugins.mongodb.session.MongoSessionStoreOptions
-
Default shard size in bytes for checkpoint state (1 MiB, under the 16 MB document cap).
- DEFAULT_SHARD_SIZE - Static variable in class com.google.genkit.plugins.postgresql.session.PostgresSessionStoreOptions
-
Default shard size in bytes for checkpoint state (1 MiB).
- DEFAULT_TABLE - Static variable in class com.google.genkit.plugins.awsbedrock.session.DynamoDbSessionStoreOptions
-
Default table name.
- DEFAULT_TABLE - Static variable in class com.google.genkit.plugins.postgresql.session.PostgresSessionStoreOptions
-
Default table name.
- DEFAULT_TENANT - Static variable in class com.google.genkit.plugins.chroma.ChromaPlugin
-
Default Chroma tenant.
- DEFAULT_URL - Static variable in class com.google.genkit.plugins.chroma.ChromaPlugin
-
Default Chroma server URL.
- DEFAULT_URL - Static variable in class com.google.genkit.plugins.milvus.MilvusPlugin
-
Default Milvus server URL.
- DEFAULT_URL - Static variable in class com.google.genkit.plugins.qdrant.QdrantPlugin
-
Default Qdrant server URL.
- defaultLimit(int) - Method in class com.google.genkit.plugins.firebase.retriever.FirestoreRetrieverConfig.Builder
-
Sets the default limit for retrieval results.
- defaultLimit(int) - Method in class com.google.genkit.plugins.weaviate.WeaviateCollectionConfig.Builder
-
Sets the default limit for retrieval.
- DefaultRegistry - Class in com.google.genkit.core
-
DefaultRegistry is the default implementation of the Registry interface.
- DefaultRegistry() - Constructor for class com.google.genkit.core.DefaultRegistry
-
Creates a new root registry.
- DefaultRegistry(Registry) - Constructor for class com.google.genkit.core.DefaultRegistry
-
Creates a new child registry with the given parent.
- defaults() - Static method in class com.google.genkit.plugins.awsbedrock.session.DynamoDbSessionStoreOptions
-
Returns default options.
- defaults() - Static method in class com.google.genkit.plugins.azurefoundry.session.CosmosSessionStoreOptions
-
Returns default options.
- defaults() - Static method in class com.google.genkit.plugins.firebase.session.FirestoreSessionStoreOptions
-
Returns default options.
- defaults() - Static method in class com.google.genkit.plugins.middleware.ArtifactsOptions
-
Returns a default options instance (
readonly = false). - defaults() - Static method in class com.google.genkit.plugins.mongodb.session.MongoSessionStoreOptions
-
Returns default options.
- defaults() - Static method in class com.google.genkit.plugins.postgresql.session.PostgresSessionStoreOptions
-
Returns default options.
- define(Registry) - Static method in class com.google.genkit.ai.GenerateAction
-
Defines and registers the generate utility action.
- define(Registry, String, Class<I>, Class<O>, BiFunction<ActionContext, I, O>) - Static method in class com.google.genkit.core.Flow
-
Defines a new non-streaming flow and registers it.
- define(Registry, String, Class<I>, Class<O>, BiFunction<ActionContext, I, O>, List<Middleware<I, O>>) - Static method in class com.google.genkit.core.Flow
-
Defines a new non-streaming flow with middleware and registers it.
- define(Registry, String, String, String, boolean, Class<O>, EvaluatorFn<O>) - Static method in class com.google.genkit.ai.evaluation.Evaluator
-
Defines a new evaluator with full options and registers it with the registry.
- define(Registry, String, String, String, EvaluatorFn<O>) - Static method in class com.google.genkit.ai.evaluation.Evaluator
-
Defines a new evaluator and registers it with the registry.
- define(String, String, Class<C>, Function<C, GenerationMiddleware>) - Static method in class com.google.genkit.ai.middleware.GenerationMiddlewares
-
Defines a parameterized middleware.
- define(String, String, Supplier<GenerationMiddleware>) - Static method in class com.google.genkit.ai.middleware.GenerationMiddlewares
-
Defines a parameterless middleware (no
configSchema). - defineAgent(AgentConfig<S>) - Method in class com.google.genkit.GenkitBeta
-
Defines an ergonomic, prompt-backed agent.
- defineCustomAgent(CustomAgentConfig<S>, AgentFn<S>) - Method in class com.google.genkit.GenkitBeta
-
Defines a custom agent from an explicit
CustomAgentConfigandAgentFn. - defineCustomAgent(Registry, CustomAgentConfig<S>, AgentFn<S>) - Static method in class com.google.genkit.ai.agent.internal.AgentActions
-
Defines a custom agent, registers it (and any companion actions) with the registry, and returns the agent instance.
- defineEvaluator(String, String, String, boolean, Class<O>, EvaluatorFn<O>) - Method in class com.google.genkit.Genkit
-
Defines a new evaluator with full options.
- defineEvaluator(String, String, String, EvaluatorFn<O>) - Method in class com.google.genkit.Genkit
-
Defines a new evaluator and registers it with the registry.
- defineFlow(String, Class<I>, Class<O>, BiFunction<ActionContext, I, O>) - Method in class com.google.genkit.Genkit
-
Defines a flow.
- defineFlow(String, Class<I>, Class<O>, BiFunction<ActionContext, I, O>, List<Middleware<I, O>>) - Method in class com.google.genkit.Genkit
-
Defines a flow with middleware.
- defineFlow(String, Class<I>, Class<O>, Function<I, O>) - Method in class com.google.genkit.Genkit
-
Defines a flow with a simple handler.
- defineFlow(String, Class<I>, Class<O>, Function<I, O>, List<Middleware<I, O>>) - Method in class com.google.genkit.Genkit
-
Defines a flow with a simple handler and middleware.
- defineIndexer(String, BiFunction<ActionContext, IndexerRequest, IndexerResponse>) - Method in class com.google.genkit.Genkit
-
Defines and registers an indexer.
- defineInterrupt(InterruptConfig<I, O>) - Method in class com.google.genkit.Genkit
-
Defines an interrupt tool for human-in-the-loop interactions.
- definePrompt(String, String, Class<I>, BiFunction<ActionContext, I, ModelRequest>) - Method in class com.google.genkit.Genkit
-
Defines a prompt.
- definePromptAgent(AgentConfig<S>) - Method in class com.google.genkit.GenkitBeta
-
Defines an agent backed by a registered prompt.
- defineRetriever(String, BiFunction<ActionContext, RetrieverRequest, RetrieverResponse>) - Method in class com.google.genkit.Genkit
-
Defines and registers a retriever.
- defineStreaming(Registry, String, Class<I>, Class<O>, ActionDef.StreamingFunction<I, O, S>) - Static method in class com.google.genkit.core.Flow
-
Defines a new streaming flow and registers it.
- defineTool(String, String, BiFunction<ActionContext, I, O>, Class<I>, Class<O>) - Method in class com.google.genkit.Genkit
-
Defines a tool with typed input and output classes.
- defineTool(String, String, Map<String, Object>, Class<I>, BiFunction<ActionContext, I, O>) - Method in class com.google.genkit.Genkit
-
Defines a tool.
- definition(String) - Method in class com.google.genkit.ai.evaluation.Evaluator.Builder
- definition(String) - Method in class com.google.genkit.ai.evaluation.EvaluatorInfo.Builder
- DelegateInput() - Constructor for class com.google.genkit.plugins.middleware.Agents.DelegateInput
-
Default constructor for JSON deserialization.
- DelegateOutput() - Constructor for class com.google.genkit.plugins.middleware.Agents.DelegateOutput
-
Default constructor for JSON deserialization.
- Delegation - Class in com.google.genkit.plugins.middleware.internal
-
Internal helper that runs a single one-shot turn against a sub-agent and packages the result.
- Delegation.NamedArtifact - Class in com.google.genkit.plugins.middleware.internal
-
A sub-agent artifact after namespacing, ready for the tool output.
- Delegation.Result - Class in com.google.genkit.plugins.middleware.internal
-
Result of a single delegation run, ready to be mapped onto the delegation tool output.
- delegationTools(AgentsOptions) - Static method in class com.google.genkit.plugins.middleware.Agents
-
Builds the delegation tools (one per configured sub-agent).
- delete(String) - Method in interface com.google.genkit.ai.evaluation.EvalStore
-
Deletes an evaluation run.
- delete(String) - Method in class com.google.genkit.ai.evaluation.LocalFileEvalStore
- deleteAll() - Method in class com.google.genkit.plugins.pinecone.PineconeVectorStore
-
Deletes all documents in the namespace.
- deleteByIds(List<String>) - Method in class com.google.genkit.plugins.pinecone.PineconeVectorStore
-
Deletes documents by their IDs.
- deleteByIds(List<String>) - Method in class com.google.genkit.plugins.postgresql.PostgresVectorStore
-
Deletes documents by their IDs.
- deleteDataset(String) - Method in interface com.google.genkit.ai.evaluation.DatasetStore
-
Deletes a dataset.
- deleteDataset(String) - Method in class com.google.genkit.ai.evaluation.LocalFileDatasetStore
- deployment(String) - Method in class com.google.genkit.plugins.azurefoundry.AzureFoundryPluginOptions.Builder
-
Sets the deployment name.
- description() - Method in interface com.google.genkit.ai.middleware.GenerationMiddlewareDesc
-
Returns a human-readable description, or
nullif none. - description(String) - Method in class com.google.genkit.agent.AgentConfig.Builder
-
Sets the agent's human-readable description.
- description(String) - Method in class com.google.genkit.ai.agent.CustomAgentConfig.Builder
-
Sets the agent's human-readable description.
- description(String) - Method in class com.google.genkit.ai.InterruptConfig.Builder
-
Sets the description.
- description(String) - Method in class com.google.genkit.ai.Tool.Builder
- description(String) - Method in class com.google.genkit.core.ActionDesc.Builder
- detach(boolean) - Method in class com.google.genkit.ai.agent.AgentInput.Builder
- detach(SessionRunner<S>, SessionStore<S>, SessionStoreOptions, StreamEmitter<S>, AtomicBoolean, DetachController.DetachedTurn<S>) - Static method in class com.google.genkit.ai.agent.internal.DetachController
-
Handles a detached turn for a server-managed agent.
- DetachController - Class in com.google.genkit.ai.agent.internal
-
Runs a detached agent turn: writes a
PENDINGsnapshot, suppresses streaming, starts a heartbeat, runs the turn on a background daemon thread, and finalizes the pending snapshot to a terminal status when the turn completes. - DetachController.DetachedTurn<S> - Interface in com.google.genkit.ai.agent.internal
-
The body of a detached turn.
- DETACHED - Enum constant in enum class com.google.genkit.ai.agent.AgentFinishReason
-
The agent was detached.
- details(ScoreDetails) - Method in class com.google.genkit.ai.evaluation.Score.Builder
- details(Object) - Method in class com.google.genkit.ai.agent.RuntimeError.Builder
- details(Object) - Method in class com.google.genkit.core.GenkitException.Builder
- devMode() - Method in class com.google.genkit.Genkit.Builder
-
Enables dev mode.
- devMode(boolean) - Method in class com.google.genkit.GenkitOptions.Builder
- diff(JsonNode, JsonNode) - Static method in class com.google.genkit.core.jsonpatch.JsonPatch
-
Computes a minimal RFC-6902 patch that transforms
fromintoto. - dimension(int) - Method in class com.google.genkit.plugins.milvus.MilvusCollectionConfig.Builder
-
Sets the embedding dimension.
- dimension(int) - Method in class com.google.genkit.plugins.mongodb.MongoVectorStoreConfig.Builder
-
Sets the embedding dimension.
- dimension(int) - Method in class com.google.genkit.plugins.pinecone.PineconeIndexConfig.Builder
-
Sets the vector dimension (default: 768).
- dimension(int) - Method in class com.google.genkit.plugins.qdrant.QdrantCollectionConfig.Builder
-
Sets the embedding dimension.
- directory(String) - Method in class com.google.genkit.plugins.localvec.LocalVecConfig.Builder
-
Sets the directory for storing data.
- directory(Path) - Method in class com.google.genkit.plugins.localvec.LocalVecConfig.Builder
-
Sets the directory for storing data.
- disabled(boolean) - Method in class com.google.genkit.plugins.mcp.MCPServerConfig.Builder
-
Sets whether this server is disabled.
- disconnect() - Method in class com.google.genkit.plugins.mcp.MCPClient
-
Disconnects from the MCP server.
- disconnect() - Method in class com.google.genkit.plugins.mcp.MCPPlugin
-
Disconnects all MCP clients.
- displayName(String) - Method in class com.google.genkit.ai.evaluation.Evaluator.Builder
- displayName(String) - Method in class com.google.genkit.ai.evaluation.EvaluatorInfo.Builder
- distance(ChromaCollectionConfig.Distance) - Method in class com.google.genkit.plugins.chroma.ChromaCollectionConfig.Builder
-
Sets the distance function.
- distance(QdrantCollectionConfig.Distance) - Method in class com.google.genkit.plugins.qdrant.QdrantCollectionConfig.Builder
-
Sets the distance function.
- distanceMeasure(FirestoreRetrieverConfig.DistanceMeasure) - Method in class com.google.genkit.plugins.firebase.retriever.FirestoreRetrieverConfig.Builder
-
Sets the distance measure for vector similarity.
- distanceMeasure(WeaviateCollectionConfig.DistanceMeasure) - Method in class com.google.genkit.plugins.weaviate.WeaviateCollectionConfig.Builder
-
Sets the distance measure for similarity search.
- distanceResultField(String) - Method in class com.google.genkit.plugins.firebase.retriever.FirestoreRetrieverConfig.Builder
-
Sets the field name to store the distance in result metadata.
- distanceStrategy(PostgresTableConfig.DistanceStrategy) - Method in class com.google.genkit.plugins.postgresql.PostgresTableConfig.Builder
-
Sets the distance strategy (default: COSINE).
- distanceThreshold(Double) - Method in class com.google.genkit.plugins.firebase.retriever.FirestoreRetrieverConfig.Builder
-
Sets the distance threshold for filtering results.
- docs(List<Document>) - Method in class com.google.genkit.ai.GenerateOptions.Builder
- Document - Class in com.google.genkit.ai
-
Document represents a document for use with embedders and retrievers.
- Document() - Constructor for class com.google.genkit.ai.Document
-
Default constructor.
- Document(String) - Constructor for class com.google.genkit.ai.Document
-
Creates a Document with text content.
- Document(List<Part>) - Constructor for class com.google.genkit.ai.Document
-
Creates a Document with parts.
- DOT - Enum constant in enum class com.google.genkit.plugins.weaviate.WeaviateCollectionConfig.DistanceMeasure
-
Dot product.
- DOT_PRODUCT - Enum constant in enum class com.google.genkit.plugins.firebase.retriever.FirestoreRetrieverConfig.DistanceMeasure
-
Dot product.
- DOT_PRODUCT - Enum constant in enum class com.google.genkit.plugins.mongodb.MongoVectorStoreConfig.Similarity
- DOT_PRODUCT - Enum constant in enum class com.google.genkit.plugins.pinecone.PineconeIndexConfig.Metric
-
Dot product similarity.
- DOT_PRODUCT - Enum constant in enum class com.google.genkit.plugins.qdrant.QdrantCollectionConfig.Distance
- DotPrompt<I> - Class in com.google.genkit.prompt
-
DotPrompt provides support for .prompt files using Handlebars templating.
- DotPrompt(String, String, String, String, Map<String, Object>, GenerationConfig) - Constructor for class com.google.genkit.prompt.DotPrompt
-
Creates a new DotPrompt.
- DotPrompt(String, String, String, String, Map<String, Object>, Map<String, Object>, GenerationConfig) - Constructor for class com.google.genkit.prompt.DotPrompt
-
Creates a new DotPrompt.
- DynamicPlugin - Interface in com.google.genkit.core
-
DynamicPlugin is a Plugin that can dynamically resolve actions.
- DynamoDbSessionStore<S> - Class in com.google.genkit.plugins.awsbedrock.session
-
DynamoDB-backed implementation of
SessionStoreandSnapshotSubscriber. - DynamoDbSessionStore(DynamoDbClient) - Constructor for class com.google.genkit.plugins.awsbedrock.session.DynamoDbSessionStore
-
Creates a store with default options.
- DynamoDbSessionStore(DynamoDbClient, DynamoDbSessionStoreOptions) - Constructor for class com.google.genkit.plugins.awsbedrock.session.DynamoDbSessionStore
-
Creates a store.
- DynamoDbSessionStoreOptions - Class in com.google.genkit.plugins.awsbedrock.session
-
Configuration for
DynamoDbSessionStore. - DynamoDbSessionStoreOptions.Builder - Class in com.google.genkit.plugins.awsbedrock.session
-
Builder for
DynamoDbSessionStoreOptions.
E
- email(String) - Method in class com.google.genkit.plugins.firebase.functions.AuthContext.Builder
- emailVerified(boolean) - Method in class com.google.genkit.plugins.firebase.functions.AuthContext.Builder
- embed(String, List<Document>) - Method in class com.google.genkit.Genkit
-
Generates a structured output from the model with a simple prompt.
- embedder(Embedder) - Method in class com.google.genkit.plugins.firebase.retriever.FirestoreRetrieverConfig.Builder
-
Sets the embedder instance to use.
- embedder(Embedder) - Method in class com.google.genkit.plugins.localvec.LocalVecConfig.Builder
-
Sets the embedder.
- embedder(Embedder) - Method in class com.google.genkit.plugins.weaviate.WeaviateCollectionConfig.Builder
-
Sets the embedder instance directly.
- embedder(String) - Method in class com.google.genkit.plugins.evaluators.EvaluatorsPluginOptions.Builder
- embedder(String) - Method in class com.google.genkit.plugins.evaluators.MetricConfig.Builder
- Embedder - Class in com.google.genkit.ai
-
Embedder is an action that generates embeddings from documents.
- Embedder(String, EmbedderInfo, BiFunction<ActionContext, EmbedRequest, EmbedResponse>) - Constructor for class com.google.genkit.ai.Embedder
-
Creates a new Embedder.
- EMBEDDER - Enum constant in enum class com.google.genkit.core.ActionType
-
An embedder action that converts content to vector embeddings.
- Embedder.Builder - Class in com.google.genkit.ai
-
Builder for Embedder.
- EmbedderCapabilities() - Constructor for class com.google.genkit.ai.EmbedderInfo.EmbedderCapabilities
- embedderDimension(int) - Method in class com.google.genkit.plugins.firebase.retriever.FirestoreRetrieverConfig.Builder
-
Sets the dimension of the embeddings for vector index creation.
- EmbedderInfo - Class in com.google.genkit.ai
-
EmbedderInfo contains metadata about an embedder's capabilities.
- EmbedderInfo() - Constructor for class com.google.genkit.ai.EmbedderInfo
-
Default constructor.
- EmbedderInfo.EmbedderCapabilities - Class in com.google.genkit.ai
-
EmbedderCapabilities describes what an embedder can do.
- embedderName(String) - Method in class com.google.genkit.plugins.chroma.ChromaCollectionConfig.Builder
-
Sets the embedder name.
- embedderName(String) - Method in class com.google.genkit.plugins.firebase.retriever.FirestoreRetrieverConfig.Builder
-
Sets the embedder name for resolution from registry.
- embedderName(String) - Method in class com.google.genkit.plugins.localvec.LocalVecConfig.Builder
-
Sets the embedder by name for deferred resolution.
- embedderName(String) - Method in class com.google.genkit.plugins.milvus.MilvusCollectionConfig.Builder
-
Sets the embedder name.
- embedderName(String) - Method in class com.google.genkit.plugins.mongodb.MongoVectorStoreConfig.Builder
-
Sets the embedder name.
- embedderName(String) - Method in class com.google.genkit.plugins.pinecone.PineconeIndexConfig.Builder
-
Sets the embedder name for generating vectors (required).
- embedderName(String) - Method in class com.google.genkit.plugins.postgresql.PostgresTableConfig.Builder
-
Sets the embedder name for generating vectors (required).
- embedderName(String) - Method in class com.google.genkit.plugins.qdrant.QdrantCollectionConfig.Builder
-
Sets the embedder name.
- embedderName(String) - Method in class com.google.genkit.plugins.weaviate.WeaviateCollectionConfig.Builder
-
Sets the embedder name to resolve from registry.
- embedderOptions(Object) - Method in class com.google.genkit.plugins.localvec.LocalVecConfig.Builder
-
Sets the embedder options.
- embedderOptions(Map<String, Object>) - Method in class com.google.genkit.plugins.evaluators.EvaluatorsPluginOptions.Builder
- embedderOptions(Map<String, Object>) - Method in class com.google.genkit.plugins.evaluators.MetricConfig.Builder
- Embedding() - Constructor for class com.google.genkit.ai.EmbedResponse.Embedding
-
Default constructor.
- Embedding(float[]) - Constructor for class com.google.genkit.ai.EmbedResponse.Embedding
-
Creates an Embedding with the given values.
- embeddingColumn(String) - Method in class com.google.genkit.plugins.postgresql.PostgresTableConfig.Builder
-
Sets the embedding column name (default: "embedding").
- embeddingField(String) - Method in class com.google.genkit.plugins.mongodb.MongoVectorStoreConfig.Builder
-
Sets the embedding field name.
- EmbedRequest - Class in com.google.genkit.ai
-
EmbedRequest contains documents to embed.
- EmbedRequest() - Constructor for class com.google.genkit.ai.EmbedRequest
-
Default constructor.
- EmbedRequest(List<Document>) - Constructor for class com.google.genkit.ai.EmbedRequest
-
Creates an EmbedRequest with documents.
- EmbedResponse - Class in com.google.genkit.ai
-
EmbedResponse contains the embeddings generated from documents.
- EmbedResponse() - Constructor for class com.google.genkit.ai.EmbedResponse
-
Default constructor.
- EmbedResponse(List<EmbedResponse.Embedding>) - Constructor for class com.google.genkit.ai.EmbedResponse
-
Creates an EmbedResponse with embeddings.
- EmbedResponse.Embedding - Class in com.google.genkit.ai
-
Embedding represents a single embedding vector.
- empty() - Static method in class com.google.genkit.ai.agent.SessionStoreOptions
-
Returns a default empty
SessionStoreOptions. - enable() - Method in class com.google.genkit.plugins.firebase.telemetry.FirebaseTelemetry
-
Enables telemetry collection and export to Google Cloud.
- enableFromEnvironment() - Static method in class com.google.genkit.plugins.firebase.telemetry.FirebaseTelemetry
-
Enables Firebase telemetry with default configuration based on environment.
- enableTelemetry(boolean) - Method in class com.google.genkit.plugins.firebase.FirebasePlugin.Builder
-
Enables or disables Firebase telemetry.
- enableTelemetry(boolean) - Method in class com.google.genkit.plugins.firebase.FirebasePluginConfig.Builder
- end() - Method in class com.google.genkit.core.BufferedInputSource
-
Signals end-of-stream.
- endpoint(String) - Method in class com.google.genkit.plugins.azurefoundry.AzureFoundryPluginOptions.Builder
-
Sets the Azure AI Foundry endpoint URL.
- enforceAppCheck(boolean) - Method in class com.google.genkit.plugins.firebase.functions.OnCallGenkit
-
Enables App Check enforcement.
- ensureCollectionExists() - Method in class com.google.genkit.plugins.weaviate.WeaviateVectorStore
-
Ensures the Weaviate collection (class) exists, creating it if configured to do so.
- ensureDatabaseExists() - Method in class com.google.genkit.plugins.firebase.retriever.FirestoreVectorStore
-
Ensures the Firestore database exists, creating it if configured to do so.
- ensureVectorIndexExists() - Method in class com.google.genkit.plugins.firebase.retriever.FirestoreVectorStore
-
Ensures the Firestore vector index exists, creating it if configured to do so.
- env(String, String) - Method in class com.google.genkit.plugins.mcp.MCPServerConfig.Builder
-
Adds an environment variable.
- env(Map<String, String>) - Method in class com.google.genkit.plugins.mcp.MCPServerConfig.Builder
-
Sets all environment variables.
- error() - Method in class com.google.genkit.ai.agent.internal.SessionResolver.Resolution
-
Returns the runtime error, or
nullif this is a successful resolution. - error(RuntimeError) - Method in class com.google.genkit.ai.agent.AgentOutput.Builder
- error(RuntimeError) - Method in class com.google.genkit.ai.agent.SessionSnapshot.Builder
- error(String) - Method in class com.google.genkit.ai.evaluation.EvalDataPoint.Builder
- error(String) - Method in class com.google.genkit.ai.evaluation.EvalMetric.Builder
- error(String) - Method in class com.google.genkit.ai.evaluation.EvalResult.Builder
- error(String) - Method in class com.google.genkit.ai.evaluation.Score.Builder
- errorCode(String) - Method in class com.google.genkit.core.GenkitException.Builder
- errorHandler(Function<GenkitException, O>) - Static method in class com.google.genkit.core.middleware.CommonMiddleware
-
Creates an error handling middleware that catches and transforms exceptions.
- EUCLIDEAN - Enum constant in enum class com.google.genkit.plugins.firebase.retriever.FirestoreRetrieverConfig.DistanceMeasure
-
Euclidean distance.
- EUCLIDEAN - Enum constant in enum class com.google.genkit.plugins.mongodb.MongoVectorStoreConfig.Similarity
- EUCLIDEAN - Enum constant in enum class com.google.genkit.plugins.pinecone.PineconeIndexConfig.Metric
-
Euclidean (L2) distance.
- EUCLIDEAN - Enum constant in enum class com.google.genkit.plugins.qdrant.QdrantCollectionConfig.Distance
- EvalDataPoint - Class in com.google.genkit.ai.evaluation
-
Represents a single data point for evaluation.
- EvalDataPoint() - Constructor for class com.google.genkit.ai.evaluation.EvalDataPoint
- EvalDataPoint.Builder - Class in com.google.genkit.ai.evaluation
- EvalMetric - Class in com.google.genkit.ai.evaluation
-
Represents a single metric score from an evaluator.
- EvalMetric() - Constructor for class com.google.genkit.ai.evaluation.EvalMetric
- EvalMetric.Builder - Class in com.google.genkit.ai.evaluation
- EvalRequest - Class in com.google.genkit.ai.evaluation
-
Request to run an evaluator on a dataset.
- EvalRequest() - Constructor for class com.google.genkit.ai.evaluation.EvalRequest
- EvalRequest.Builder - Class in com.google.genkit.ai.evaluation
- EvalResponse - Class in com.google.genkit.ai.evaluation
-
Response from an evaluator for a single test case.
- EvalResponse() - Constructor for class com.google.genkit.ai.evaluation.EvalResponse
- EvalResponse.Builder - Class in com.google.genkit.ai.evaluation
- EvalResult - Class in com.google.genkit.ai.evaluation
-
A single evaluation result combining input data with metric scores.
- EvalResult() - Constructor for class com.google.genkit.ai.evaluation.EvalResult
- EvalResult.Builder - Class in com.google.genkit.ai.evaluation
- EvalRun - Class in com.google.genkit.ai.evaluation
-
Represents a complete evaluation run with results.
- EvalRun() - Constructor for class com.google.genkit.ai.evaluation.EvalRun
- EvalRun.Builder - Class in com.google.genkit.ai.evaluation
- evalRunId(String) - Method in class com.google.genkit.ai.evaluation.EvalRequest.Builder
- evalRunId(String) - Method in class com.google.genkit.ai.evaluation.EvalRunKey.Builder
- EvalRunKey - Class in com.google.genkit.ai.evaluation
-
Key that uniquely identifies an evaluation run.
- EvalRunKey() - Constructor for class com.google.genkit.ai.evaluation.EvalRunKey
- EvalRunKey.Builder - Class in com.google.genkit.ai.evaluation
- EvalStatus - Enum Class in com.google.genkit.ai.evaluation
-
Status of an evaluation result.
- EvalStore - Interface in com.google.genkit.ai.evaluation
-
Interface for storing and retrieving evaluation runs.
- evaluate(EvalDataPoint) - Method in class com.google.genkit.plugins.evaluators.metrics.AnswerAccuracyMetric
-
Evaluates the accuracy of the output against the reference.
- evaluate(EvalDataPoint) - Method in class com.google.genkit.plugins.evaluators.metrics.AnswerRelevancyMetric
-
Evaluates the relevancy of the answer to the question.
- evaluate(EvalDataPoint) - Method in class com.google.genkit.plugins.evaluators.metrics.DeepEqualMetric
-
Evaluates whether the output is deeply equal to the reference.
- evaluate(EvalDataPoint) - Method in class com.google.genkit.plugins.evaluators.metrics.FaithfulnessMetric
-
Evaluates faithfulness of the output against the context.
- evaluate(EvalDataPoint) - Method in class com.google.genkit.plugins.evaluators.metrics.JsonataMetric
-
Evaluates the output using the JSONata expression in the reference.
- evaluate(EvalDataPoint) - Method in class com.google.genkit.plugins.evaluators.metrics.MaliciousnessMetric
-
Evaluates if the output contains malicious content.
- evaluate(EvalDataPoint) - Method in class com.google.genkit.plugins.evaluators.metrics.RegexMetric
-
Evaluates whether the output matches the regex pattern in the reference.
- evaluate(EvalDataPoint, O) - Method in interface com.google.genkit.ai.evaluation.EvaluatorFn
-
Evaluates a single data point.
- evaluate(RunEvaluationRequest) - Method in class com.google.genkit.Genkit
-
Runs an evaluation using the specified request.
- evaluation(Score) - Method in class com.google.genkit.ai.evaluation.EvalResponse.Builder
- evaluation(List<Score>) - Method in class com.google.genkit.ai.evaluation.EvalResponse.Builder
- EvaluationManager - Class in com.google.genkit.ai.evaluation
-
Manages the execution of evaluations.
- EvaluationManager(Registry) - Constructor for class com.google.genkit.ai.evaluation.EvaluationManager
-
Creates a new EvaluationManager.
- EvaluationManager(Registry, DatasetStore, EvalStore) - Constructor for class com.google.genkit.ai.evaluation.EvaluationManager
-
Creates a new EvaluationManager with custom stores.
- EvaluationOptions() - Constructor for class com.google.genkit.ai.evaluation.RunEvaluationRequest.EvaluationOptions
- evaluator(String) - Method in class com.google.genkit.ai.evaluation.EvalMetric.Builder
- Evaluator<O> - Class in com.google.genkit.ai.evaluation
-
Evaluator represents an evaluation action that assesses the quality of AI outputs.
- EVALUATOR - Enum constant in enum class com.google.genkit.core.ActionType
-
An evaluator action that assesses the quality of generated content.
- Evaluator.Builder<O> - Class in com.google.genkit.ai.evaluation
-
Builder for creating Evaluator instances.
- evaluatorFn(EvaluatorFn<O>) - Method in class com.google.genkit.ai.evaluation.Evaluator.Builder
- EvaluatorFn<O> - Interface in com.google.genkit.ai.evaluation
-
Functional interface for evaluator functions.
- EvaluatorInfo - Class in com.google.genkit.ai.evaluation
-
Information about an evaluator including display metadata and metrics.
- EvaluatorInfo() - Constructor for class com.google.genkit.ai.evaluation.EvaluatorInfo
- EvaluatorInfo.Builder - Class in com.google.genkit.ai.evaluation
- evaluators(List<String>) - Method in class com.google.genkit.ai.evaluation.RunEvaluationRequest.Builder
- EvaluatorsPlugin - Class in com.google.genkit.plugins.evaluators
-
Evaluators plugin for Genkit.
- EvaluatorsPlugin() - Constructor for class com.google.genkit.plugins.evaluators.EvaluatorsPlugin
-
Creates an EvaluatorsPlugin with default options.
- EvaluatorsPlugin(EvaluatorsPluginOptions) - Constructor for class com.google.genkit.plugins.evaluators.EvaluatorsPlugin
-
Creates an EvaluatorsPlugin with the specified options.
- EvaluatorsPluginOptions - Class in com.google.genkit.plugins.evaluators
-
Configuration options for the GenkitEval plugin.
- EvaluatorsPluginOptions.Builder - Class in com.google.genkit.plugins.evaluators
- EXECUTABLE_PROMPT - Enum constant in enum class com.google.genkit.ai.evaluation.DatasetType
- EXECUTABLE_PROMPT - Enum constant in enum class com.google.genkit.core.ActionType
-
An executable prompt action that can generate content directly.
- ExecutablePrompt<I> - Class in com.google.genkit.prompt
-
ExecutablePrompt wraps a DotPrompt and provides direct generation capabilities.
- ExecutablePrompt(DotPrompt<I>, Registry, Class<I>) - Constructor for class com.google.genkit.prompt.ExecutablePrompt
-
Creates a new ExecutablePrompt.
- ExecutablePrompt.GenerateFunction - Interface in com.google.genkit.prompt
-
Functional interface for the generate function.
- ExecutablePrompt.GenerateObjectFunction - Interface in com.google.genkit.prompt
-
Functional interface for the generateObject function.
- execute(ModelRequest) - Method in interface com.google.genkit.ai.telemetry.ModelTelemetryHelper.ModelExecutor
-
Executes the model with the given request.
- execute(ModelRequest) - Method in interface com.google.genkit.ai.telemetry.ModelTelemetryHelper.StreamingModelExecutor
-
Executes the model with the given request (streaming mode).
- execute(I, ActionContext, BiFunction<ActionContext, I, O>) - Method in class com.google.genkit.core.middleware.MiddlewareChain
-
Executes the middleware chain with the given request, context, and final action.
- executeFlow(String, JsonNode) - Method in class com.google.genkit.plugins.spring.GenkitFlowController
-
Executes a flow by name.
- experimental(boolean) - Method in class com.google.genkit.GenkitOptions.Builder
- EXPIRED - Enum constant in enum class com.google.genkit.ai.agent.SnapshotStatus
-
The snapshot expired.
F
- FAIL - Enum constant in enum class com.google.genkit.ai.evaluation.EvalStatus
- FAILED - Enum constant in enum class com.google.genkit.ai.agent.AgentFinishReason
-
The agent failed.
- FAILED - Enum constant in enum class com.google.genkit.ai.agent.SnapshotStatus
-
The snapshot failed.
- failure(RuntimeError) - Static method in class com.google.genkit.ai.agent.internal.SessionResolver.Resolution
-
Creates a failure resolution carrying a
RuntimeError. - FAITHFULNESS - Enum constant in enum class com.google.genkit.plugins.evaluators.GenkitMetric
-
Measures the factual consistency of the generated answer against the given context.
- FaithfulnessMetric - Class in com.google.genkit.plugins.evaluators.metrics
-
Faithfulness metric evaluator.
- FaithfulnessMetric(Registry, String, Map<String, Object>) - Constructor for class com.google.genkit.plugins.evaluators.metrics.FaithfulnessMetric
- FallbackMiddleware - Class in com.google.genkit.plugins.middleware
-
Falls back to alternate models when the primary model fails.
- FallbackMiddleware(FallbackMiddleware.Options) - Constructor for class com.google.genkit.plugins.middleware.FallbackMiddleware
- FallbackMiddleware.Options - Class in com.google.genkit.plugins.middleware
-
Configuration parameters for
FallbackMiddleware. - FeatureTelemetry - Class in com.google.genkit.ai.telemetry
-
FeatureTelemetry provides metrics collection for top-level feature (flow) execution.
- FileSessionStore<S> - Class in com.google.genkit.ai.agent
-
Disk-backed implementation of
SessionStoreandSnapshotSubscriber. - FileSessionStore(String) - Constructor for class com.google.genkit.ai.agent.FileSessionStore
-
Creates a new
FileSessionStorewith default options (prefix ="global", no chain pruning, polling every 2000 ms). - FileSessionStore.Builder<S> - Class in com.google.genkit.ai.agent
-
Builder for
FileSessionStore. - finishMessage(String) - Method in class com.google.genkit.ai.ModelResponse.Builder
- finishReason() - Method in class com.google.genkit.ai.agent.AgentResponse
-
Returns the turn's finish reason.
- finishReason(AgentFinishReason) - Method in class com.google.genkit.ai.agent.AgentOutput.Builder
- finishReason(AgentFinishReason) - Method in class com.google.genkit.ai.agent.AgentResult.Builder
- finishReason(AgentFinishReason) - Method in class com.google.genkit.ai.agent.SessionSnapshot.Builder
- finishReason(AgentFinishReason) - Method in class com.google.genkit.ai.agent.TurnEnd.Builder
- finishReason(FinishReason) - Method in class com.google.genkit.ai.ModelResponse.Builder
- FinishReason - Enum Class in com.google.genkit.ai
-
FinishReason indicates why the model stopped generating.
- FirebasePlugin - Class in com.google.genkit.plugins.firebase
-
Firebase plugin for Genkit providing integration with Firebase services.
- FirebasePlugin.Builder - Class in com.google.genkit.plugins.firebase
-
Builder for FirebasePlugin.
- FirebasePluginConfig - Class in com.google.genkit.plugins.firebase
-
Configuration for the Firebase plugin.
- FirebasePluginConfig.Builder - Class in com.google.genkit.plugins.firebase
-
Builder for FirebasePluginConfig.
- FirebaseTelemetry - Class in com.google.genkit.plugins.firebase.telemetry
-
Firebase telemetry integration for Genkit Monitoring.
- FirebaseTelemetry.Builder - Class in com.google.genkit.plugins.firebase.telemetry
-
Builder for FirebaseTelemetry.
- FirestoreRetrieverConfig - Class in com.google.genkit.plugins.firebase.retriever
-
Configuration for a Firestore vector search retriever.
- FirestoreRetrieverConfig.Builder - Class in com.google.genkit.plugins.firebase.retriever
-
Builder for FirestoreRetrieverConfig.
- FirestoreRetrieverConfig.DistanceMeasure - Enum Class in com.google.genkit.plugins.firebase.retriever
-
Distance measure options for vector similarity search.
- FirestoreSessionStore<S> - Class in com.google.genkit.plugins.firebase.session
-
Firestore-backed implementation of
SessionStoreandSnapshotSubscriber. - FirestoreSessionStore(Firestore) - Constructor for class com.google.genkit.plugins.firebase.session.FirestoreSessionStore
-
Creates a store with default options.
- FirestoreSessionStore(Firestore, FirestoreSessionStoreOptions) - Constructor for class com.google.genkit.plugins.firebase.session.FirestoreSessionStore
-
Creates a store.
- FirestoreSessionStoreOptions - Class in com.google.genkit.plugins.firebase.session
-
Configuration for
FirestoreSessionStore. - FirestoreSessionStoreOptions.Builder - Class in com.google.genkit.plugins.firebase.session
-
Builder for
FirestoreSessionStoreOptions. - FirestoreVectorStore - Class in com.google.genkit.plugins.firebase.retriever
-
Firestore vector store implementation for RAG workflows.
- FirestoreVectorStore(Firestore, FirestoreRetrieverConfig, Embedder) - Constructor for class com.google.genkit.plugins.firebase.retriever.FirestoreVectorStore
-
Creates a new FirestoreVectorStore.
- FirestoreVectorStore(Firestore, FirestoreRetrieverConfig, Embedder, String) - Constructor for class com.google.genkit.plugins.firebase.retriever.FirestoreVectorStore
-
Creates a new FirestoreVectorStore with explicit project ID.
- Flow<I,
O, - Class in com.google.genkit.coreS> -
A Flow is a user-defined Action.
- FLOW - Enum constant in enum class com.google.genkit.ai.evaluation.DatasetType
- FLOW - Enum constant in enum class com.google.genkit.core.ActionType
-
A flow action representing a user-defined workflow.
- Flow.StreamingFlowValue<O,
S> - Class in com.google.genkit.core -
StreamingFlowValue represents either a streamed chunk or the final output of a flow.
- flowName(String) - Method in class com.google.genkit.core.ActionContext.Builder
- forceDevExport(boolean) - Method in class com.google.genkit.plugins.firebase.FirebasePlugin.Builder
-
Forces telemetry export in development mode.
- forceDevExport(boolean) - Method in class com.google.genkit.plugins.firebase.FirebasePluginConfig.Builder
- forceDevExport(boolean) - Method in class com.google.genkit.plugins.firebase.telemetry.FirebaseTelemetry.Builder
-
Forces telemetry export in development mode.
- forceFlush() - Method in class com.google.genkit.core.tracing.TelemetryServerExporter
- forceFlush() - Method in class com.google.genkit.LocalTelemetryStore
- found - Variable in class com.google.genkit.plugins.middleware.Artifacts.ReadOutput
- frequencyPenalty(Double) - Method in class com.google.genkit.ai.GenerationConfig.Builder
- fromClass(Class<?>) - Static method in class com.google.genkit.ai.OutputConfig
-
Creates an OutputConfig for JSON output from a class.
- fromFlow(Genkit, Action<?, ?, ?>) - Static method in class com.google.genkit.plugins.firebase.functions.OnCallGenkit
-
Creates an OnCallGenkit handler from a flow action.
- fromFlow(Genkit, String) - Static method in class com.google.genkit.plugins.firebase.functions.OnCallGenkit
-
Creates an OnCallGenkit handler from a flow name.
- fromJson(String, Class<T>) - Static method in class com.google.genkit.core.JsonUtils
-
Parses a JSON string to the specified type.
- fromJsonNode(JsonNode, Class<T>) - Static method in class com.google.genkit.core.JsonUtils
-
Converts a JsonNode to the specified type.
- fromText(String) - Static method in class com.google.genkit.ai.Document
-
Creates a text Document.
- fromText(String) - Static method in class com.google.genkit.ai.RetrieverRequest
-
Creates a RetrieverRequest with a text query.
- fromText(String, Map<String, Object>) - Static method in class com.google.genkit.ai.Document
-
Creates a Document with text and metadata.
- fromValue(String) - Static method in enum class com.google.genkit.ai.agent.AgentFinishReason
-
Creates an AgentFinishReason from a string value.
- fromValue(String) - Static method in enum class com.google.genkit.ai.agent.SnapshotStatus
-
Creates a SnapshotStatus from a string value.
- fromValue(String) - Static method in enum class com.google.genkit.ai.Role
- fromValue(String) - Static method in enum class com.google.genkit.core.ActionType
-
Creates an ActionType from a string value.
- fromValueOrCompleted(String) - Static method in enum class com.google.genkit.ai.agent.SnapshotStatus
-
Creates a SnapshotStatus from a string value, treating null or empty strings as COMPLETED.
G
- GCP - Enum constant in enum class com.google.genkit.plugins.pinecone.PineconeIndexConfig.Cloud
- GeminiEmbedder - Class in com.google.genkit.plugins.googlegenai
-
Gemini embedder implementation using the official Google GenAI SDK.
- GeminiEmbedder(String, GoogleGenAIPluginOptions) - Constructor for class com.google.genkit.plugins.googlegenai.GeminiEmbedder
-
Creates a new GeminiEmbedder.
- GeminiModel - Class in com.google.genkit.plugins.googlegenai
-
Gemini model implementation using the official Google GenAI SDK.
- GeminiModel(String, GoogleGenAIPluginOptions) - Constructor for class com.google.genkit.plugins.googlegenai.GeminiModel
-
Creates a new GeminiModel.
- generate(GenerateOptions) - Method in class com.google.genkit.Genkit
-
Generates a model response using the specified options.
- generate(GenerateOptions<?>) - Method in interface com.google.genkit.prompt.ExecutablePrompt.GenerateFunction
- generate(Registry, I) - Method in class com.google.genkit.prompt.DotPrompt
-
Generates a response using this prompt with the given registry.
- generate(Registry, I, GenerateOptions) - Method in class com.google.genkit.prompt.DotPrompt
-
Generates a response using this prompt with custom options.
- generate(Registry, I, GenerateOptions, Consumer<ModelResponseChunk>) - Method in class com.google.genkit.prompt.DotPrompt
-
Generates a response using this prompt with streaming.
- generate(I) - Method in class com.google.genkit.prompt.ExecutablePrompt
-
Generates a response using the default model specified in the prompt.
- generate(I, GenerateOptions) - Method in class com.google.genkit.prompt.ExecutablePrompt
-
Generates a response with custom options.
- generate(I, Class<T>) - Method in class com.google.genkit.prompt.ExecutablePrompt
-
Generates a structured output using the default model specified in the prompt.
- generate(String, String) - Method in class com.google.genkit.Genkit
-
Generates a model response with a simple prompt.
- GenerateAction - Class in com.google.genkit.ai
-
GenerateAction is a utility action that provides a unified interface for generating content from AI models.
- GenerateAction(Registry) - Constructor for class com.google.genkit.ai.GenerateAction
- GenerateActionOptions - Class in com.google.genkit.ai
-
High-level options for the generate action, representing the generate request before model and tool resolution.
- GenerateActionOptions() - Constructor for class com.google.genkit.ai.GenerateActionOptions
-
Default constructor for JSON deserialization.
- GenerateNext - Interface in com.google.genkit.ai.middleware
- generateObject(GenerateOptions) - Method in class com.google.genkit.Genkit
-
Generates a structured output from the model, returning a typed object.
- generateObject(GenerateOptions<?>, Class<?>) - Method in interface com.google.genkit.prompt.ExecutablePrompt.GenerateObjectFunction
- generateObject(GenerateOptions<?>, Class<T>) - Method in class com.google.genkit.Genkit
-
Generates a structured output from the model, returning a typed object.
- generateObject(String, String, Class<T>) - Method in class com.google.genkit.Genkit
-
Generates a structured output from the model with a simple prompt.
- GenerateOptions<T> - Class in com.google.genkit.ai
-
Options for text generation requests.
- GenerateOptions(String, String, List<Message>, List<Document>, String, List<Tool<?, ?>>, Object, OutputConfig, GenerationConfig, Map<String, Object>, Integer, ResumeOptions, Class<T>, List<GenerationMiddleware>) - Constructor for class com.google.genkit.ai.GenerateOptions
-
Creates new GenerateOptions.
- GenerateOptions.Builder<T> - Class in com.google.genkit.ai
-
Builder for GenerateOptions.
- GenerateParams - Class in com.google.genkit.ai.middleware
- GenerateParams(GenerateActionOptions, int) - Constructor for class com.google.genkit.ai.middleware.GenerateParams
-
Creates GenerateParams with messageIndex defaulting to the message count in the request.
- GenerateParams(GenerateActionOptions, int, int) - Constructor for class com.google.genkit.ai.middleware.GenerateParams
-
Creates GenerateParams.
- GenerateParams(GenerateActionOptions, int, int, Consumer<ModelResponseChunk>) - Constructor for class com.google.genkit.ai.middleware.GenerateParams
-
Creates GenerateParams with all fields including streaming callback.
- generateStream(GenerateOptions<?>, Consumer<ModelResponseChunk>) - Method in class com.google.genkit.Genkit
-
Generates a streaming model response using the specified options.
- GenerateTelemetry - Class in com.google.genkit.ai.telemetry
-
GenerateTelemetry provides metrics collection for model generate actions.
- GenerationConfig - Class in com.google.genkit.ai
-
GenerationConfig contains configuration for model generation.
- GenerationConfig() - Constructor for class com.google.genkit.ai.GenerationConfig
-
Default constructor.
- GenerationConfig.Builder - Class in com.google.genkit.ai
-
Builder for GenerationConfig.
- GenerationMiddleware - Interface in com.google.genkit.ai.middleware
-
GenerationMiddleware provides hooks for different stages of the generation pipeline.
- GenerationMiddlewareDesc - Interface in com.google.genkit.ai.middleware
-
A registered, self-describing, parameterized middleware factory.
- GenerationMiddlewarePlugin - Class in com.google.genkit.plugins.middleware
-
A plugin that ships a set of ready-to-use, parameterized generation middleware.
- GenerationMiddlewarePlugin() - Constructor for class com.google.genkit.plugins.middleware.GenerationMiddlewarePlugin
- GenerationMiddlewares - Class in com.google.genkit.ai.middleware
-
Factory helpers for building
GenerationMiddlewareDescdescriptors. - Genkit - Class in com.google.genkit
-
Genkit is the main entry point for the Genkit framework.
- Genkit() - Constructor for class com.google.genkit.Genkit
-
Creates a new Genkit instance with default options.
- Genkit(GenkitOptions) - Constructor for class com.google.genkit.Genkit
-
Creates a new Genkit instance with the given options.
- GENKIT_CLIENT_HEADER - Static variable in class com.google.genkit.plugins.googlegenai.GenkitClientHeaders
-
Genkit client attribution value, e.g.
- Genkit.Builder - Class in com.google.genkit
-
Builder for Genkit.
- genkitAgentController(ObjectMapper) - Method in class com.google.genkit.plugins.spring.GenkitSpringApplication
-
Creates the Genkit agent controller bean.
- GenkitAgentController - Class in com.google.genkit.plugins.spring
-
REST controller that exposes Genkit agents (
ActionType.AGENTbidi actions) as HTTP endpoints, at parity with theplugins/jettymodule'sAgentHandler/CompanionHandler. - GenkitAgentController(ObjectMapper) - Constructor for class com.google.genkit.plugins.spring.GenkitAgentController
-
Creates a new GenkitAgentController.
- GenkitBeta - Class in com.google.genkit
-
Beta (experimental) API surface for Genkit.
- GenkitClientHeaders - Class in com.google.genkit.plugins.googlegenai
-
Attribution headers for calls made by the Google GenAI plugin.
- GenkitException - Exception Class in com.google.genkit.core
-
GenkitException is the base exception for all Genkit errors.
- GenkitException(String) - Constructor for exception class com.google.genkit.core.GenkitException
-
Creates a new GenkitException.
- GenkitException(String, Throwable) - Constructor for exception class com.google.genkit.core.GenkitException
-
Creates a new GenkitException with a cause.
- GenkitException(String, Throwable, String, Object, String) - Constructor for exception class com.google.genkit.core.GenkitException
-
Creates a new GenkitException with full details.
- GenkitException.Builder - Class in com.google.genkit.core
-
Builder for GenkitException.
- genkitFlowController(ObjectMapper) - Method in class com.google.genkit.plugins.spring.GenkitSpringApplication
-
Creates the Genkit flow controller bean.
- GenkitFlowController - Class in com.google.genkit.plugins.spring
-
REST controller that exposes Genkit flows as HTTP endpoints.
- GenkitFlowController(ObjectMapper) - Constructor for class com.google.genkit.plugins.spring.GenkitFlowController
-
Creates a new GenkitFlowController.
- genkitJackson2MessageConverterConfigurer(ObjectMapper) - Method in class com.google.genkit.plugins.spring.GenkitSpringApplication
-
Configures Spring MVC to deserialize
@RequestBodyJSON using the Jackson 2 (com.fasterxml.jackson.databind)ObjectMapperthatGenkitFlowControllerandGenkitAgentControlleruse forJsonNodehandling. - GenkitMetric - Enum Class in com.google.genkit.plugins.evaluators
-
Enumeration of supported evaluation metric types.
- GenkitOptions - Class in com.google.genkit
-
GenkitOptions contains configuration options for Genkit.
- GenkitOptions.Builder - Class in com.google.genkit
-
Builder for GenkitOptions.
- GenkitSpanData - Class in com.google.genkit.core.tracing
-
GenkitSpanData represents information about a trace span.
- GenkitSpanData() - Constructor for class com.google.genkit.core.tracing.GenkitSpanData
- GenkitSpanData.Annotation - Class in com.google.genkit.core.tracing
-
Annotation represents an annotation.
- GenkitSpanData.BoolValue - Class in com.google.genkit.core.tracing
-
BoolValue wraps a boolean to match the expected JSON format.
- GenkitSpanData.InstrumentationScope - Class in com.google.genkit.core.tracing
-
InstrumentationScope represents the instrumentation library.
- GenkitSpanData.Link - Class in com.google.genkit.core.tracing
-
Link describes the relationship between two Spans.
- GenkitSpanData.SpanContextData - Class in com.google.genkit.core.tracing
-
SpanContextData contains identifying trace information about a Span.
- GenkitSpanData.Status - Class in com.google.genkit.core.tracing
-
Status represents the span status.
- GenkitSpanData.TimeEvent - Class in com.google.genkit.core.tracing
-
TimeEvent represents a time-based event.
- GenkitSpanData.TimeEvents - Class in com.google.genkit.core.tracing
-
TimeEvents holds time-based events.
- GenkitSpringApplication - Class in com.google.genkit.plugins.spring
-
Spring Boot application class for Genkit.
- GenkitSpringApplication() - Constructor for class com.google.genkit.plugins.spring.GenkitSpringApplication
- get(String) - Method in interface com.google.genkit.core.middleware.MiddlewareCache
-
Gets a value from the cache.
- get(String) - Method in class com.google.genkit.core.middleware.SimpleCache
- getActionConfig() - Method in class com.google.genkit.ai.evaluation.EvalRunKey
- getActionConfig() - Method in class com.google.genkit.ai.evaluation.RunEvaluationRequest.EvaluationOptions
- getActionRef() - Method in class com.google.genkit.ai.evaluation.EvalRunKey
- getAdditionalMetadata() - Method in class com.google.genkit.plugins.chroma.ChromaCollectionConfig
-
Returns additional metadata merged into every indexed document.
- getAdditionalMetadata() - Method in class com.google.genkit.plugins.milvus.MilvusCollectionConfig
-
Returns additional metadata merged into every indexed document.
- getAdditionalMetadata() - Method in class com.google.genkit.plugins.mongodb.MongoVectorStoreConfig
-
Returns additional metadata merged into every indexed document.
- getAdditionalMetadata() - Method in class com.google.genkit.plugins.pinecone.PineconeIndexConfig
-
Gets additional metadata to add to all indexed documents.
- getAdditionalMetadata() - Method in class com.google.genkit.plugins.postgresql.PostgresTableConfig
-
Gets additional metadata to add to all indexed documents.
- getAdditionalMetadata() - Method in class com.google.genkit.plugins.qdrant.QdrantCollectionConfig
-
Returns additional metadata merged into every indexed document's payload.
- getAdditionalProperties() - Method in class com.google.genkit.ai.evaluation.ScoreDetails
- getAgents() - Method in class com.google.genkit.plugins.middleware.AgentsOptions
-
Returns the configured sub-agent names.
- getAnnotation() - Method in class com.google.genkit.core.tracing.GenkitSpanData.TimeEvent
- getAnthropicVersion() - Method in class com.google.genkit.plugins.anthropic.AnthropicPluginOptions
-
Gets the Anthropic API version.
- getApiKey() - Method in class com.google.genkit.plugins.anthropic.AnthropicPluginOptions
-
Gets the API key.
- getApiKey() - Method in class com.google.genkit.plugins.azurefoundry.AzureFoundryPluginOptions
-
Gets the API key.
- getApiKey() - Method in class com.google.genkit.plugins.compatoai.CompatOAIPluginOptions
-
Gets the API key.
- getApiKey() - Method in class com.google.genkit.plugins.googlegenai.GoogleGenAIPluginOptions
-
Gets the API key.
- getApiKey() - Method in class com.google.genkit.plugins.openai.OpenAIPluginOptions
-
Gets the API key.
- getApiVersion() - Method in class com.google.genkit.plugins.azurefoundry.AzureFoundryPluginOptions
-
Gets the API version.
- getApiVersion() - Method in class com.google.genkit.plugins.googlegenai.GoogleGenAIPluginOptions
-
Gets the API version.
- getArgs() - Method in class com.google.genkit.plugins.mcp.MCPServerConfig
-
Gets the command arguments.
- getArtifact() - Method in class com.google.genkit.ai.agent.AgentStreamChunk
-
Returns the artifact in this chunk.
- getArtifacts() - Method in class com.google.genkit.ai.agent.AgentOutput
-
Returns the output artifacts.
- getArtifacts() - Method in class com.google.genkit.ai.agent.AgentResult
-
Returns the result artifacts.
- getArtifacts() - Method in interface com.google.genkit.ai.agent.ArtifactStore
-
Returns a copy of the current list of artifacts.
- getArtifacts() - Method in class com.google.genkit.ai.agent.Session
-
Returns a copy of the current artifacts list.
- getArtifacts() - Method in class com.google.genkit.ai.agent.SessionRunner
-
Returns a copy of the current artifacts list.
- getArtifacts() - Method in class com.google.genkit.ai.agent.SessionState
-
Returns the session artifacts.
- getArtifactStrategy() - Method in class com.google.genkit.plugins.middleware.AgentsOptions
-
Returns the artifact strategy.
- getAttributes() - Method in class com.google.genkit.core.tracing.GenkitSpanData.Annotation
- getAttributes() - Method in class com.google.genkit.core.tracing.GenkitSpanData
- getAttributes() - Method in class com.google.genkit.core.tracing.GenkitSpanData.Link
- getAttributes() - Method in class com.google.genkit.core.tracing.SpanMetadata
- getBackground() - Method in class com.google.genkit.plugins.openai.ImageGenerationConfig
- getBasePath() - Method in class com.google.genkit.plugins.jetty.JettyPluginOptions
-
Gets the base path for flow endpoints.
- getBasePath() - Method in class com.google.genkit.plugins.spring.SpringPluginOptions
-
Gets the base path for flow endpoints.
- getBaseUrl() - Method in class com.google.genkit.plugins.anthropic.AnthropicPluginOptions
-
Gets the base URL for API requests.
- getBaseUrl() - Method in class com.google.genkit.plugins.compatoai.CompatOAIPluginOptions
-
Gets the base URL for API requests.
- getBaseUrl() - Method in class com.google.genkit.plugins.googlegenai.GoogleGenAIPluginOptions
-
Gets the base URL override.
- getBaseUrl() - Method in class com.google.genkit.plugins.ollama.OllamaPluginOptions
-
Gets the base URL for Ollama API requests.
- getBaseUrl() - Method in class com.google.genkit.plugins.openai.OpenAIPluginOptions
-
Gets the base URL for API requests.
- getBatchSize() - Method in class com.google.genkit.ai.evaluation.EvalRequest
- getBatchSize() - Method in class com.google.genkit.ai.evaluation.RunEvaluationRequest.EvaluationOptions
- getBlob() - Method in class com.google.genkit.plugins.mcp.MCPResourceContent.ContentPart
-
Gets the base64-encoded binary content.
- getCachedContentTokens() - Method in class com.google.genkit.ai.Usage
- getCandidates() - Method in class com.google.genkit.ai.ModelResponse
- getCheckpointInterval() - Method in class com.google.genkit.plugins.awsbedrock.session.DynamoDbSessionStoreOptions
-
Returns the number of turns between full checkpoints (default 25).
- getCheckpointInterval() - Method in class com.google.genkit.plugins.azurefoundry.session.CosmosSessionStoreOptions
-
Returns the number of turns between full checkpoints (default 25).
- getCheckpointInterval() - Method in class com.google.genkit.plugins.firebase.session.FirestoreSessionStoreOptions
-
Returns the number of turns between full checkpoints (default 25).
- getCheckpointInterval() - Method in class com.google.genkit.plugins.mongodb.session.MongoSessionStoreOptions
-
Returns the number of turns between full checkpoints (default 25).
- getCheckpointInterval() - Method in class com.google.genkit.plugins.postgresql.session.PostgresSessionStoreOptions
-
Returns the number of turns between full checkpoints (default 25).
- getClaim(String) - Method in class com.google.genkit.plugins.firebase.functions.AuthContext
-
Gets a specific claim value.
- getClaims() - Method in class com.google.genkit.plugins.firebase.functions.AuthContext
- getClient() - Method in class com.google.genkit.plugins.pinecone.PineconePlugin
-
Gets the Pinecone client.
- getClient(String) - Method in class com.google.genkit.plugins.mcp.MCPPlugin
-
Gets the client for a specific server.
- getClients() - Method in class com.google.genkit.plugins.mcp.MCPPlugin
-
Gets all connected clients.
- getClientTransform() - Method in class com.google.genkit.agent.AgentConfig
-
Returns the client-transform applied to session state before returning it to the caller in client-managed mode.
- getClientTransform() - Method in class com.google.genkit.ai.agent.CustomAgentConfig
-
Returns the client-transform applied to session state before returning it to the caller in client-managed mode.
- getCloud() - Method in class com.google.genkit.plugins.pinecone.PineconeIndexConfig
-
Gets the cloud provider for serverless index.
- getCode() - Method in class com.google.genkit.core.tracing.GenkitSpanData.Status
- getCollection() - Method in class com.google.genkit.plugins.firebase.retriever.FirestoreRetrieverConfig
- getCollection() - Method in class com.google.genkit.plugins.firebase.session.FirestoreSessionStoreOptions
-
Returns the top-level collection name (default "genkit-sessions").
- getCollectionName() - Method in class com.google.genkit.plugins.chroma.ChromaCollectionConfig
-
Returns the Chroma collection name.
- getCollectionName() - Method in class com.google.genkit.plugins.milvus.MilvusCollectionConfig
-
Returns the Milvus collection name.
- getCollectionName() - Method in class com.google.genkit.plugins.mongodb.MongoVectorStoreConfig
-
Returns the collection name.
- getCollectionName() - Method in class com.google.genkit.plugins.mongodb.session.MongoSessionStoreOptions
-
Returns the MongoDB collection name (default "genkit_sessions").
- getCollectionName() - Method in class com.google.genkit.plugins.qdrant.QdrantCollectionConfig
-
Returns the Qdrant collection name.
- getCommand() - Method in class com.google.genkit.plugins.mcp.MCPServerConfig
-
Gets the command for STDIO transport.
- getConfig() - Method in class com.google.genkit.agent.AgentConfig
-
Returns the generation configuration.
- getConfig() - Method in class com.google.genkit.ai.GenerateActionOptions
- getConfig() - Method in class com.google.genkit.ai.GenerateOptions
-
Gets the generation configuration.
- getConfig() - Method in class com.google.genkit.ai.ModelRequest
- getConfig() - Method in class com.google.genkit.ai.Prompt
-
Gets the default generation config.
- getConfig() - Method in class com.google.genkit.plugins.pinecone.PineconeVectorStore
-
Gets the index configuration.
- getConfig() - Method in class com.google.genkit.plugins.postgresql.PostgresVectorStore
-
Gets the table configuration.
- getConfig() - Method in class com.google.genkit.prompt.DotPrompt
- getConfig() - Method in class com.google.genkit.prompt.ExecutablePrompt
-
Gets the generation config.
- getConstrained() - Method in class com.google.genkit.ai.OutputConfig
- getContainerName() - Method in class com.google.genkit.plugins.azurefoundry.session.CosmosSessionStoreOptions
-
Returns the Cosmos DB container name (default "genkit-sessions").
- getContent() - Method in class com.google.genkit.ai.Document
- getContent() - Method in class com.google.genkit.ai.Message
- getContent() - Method in class com.google.genkit.ai.ModelResponseChunk
- getContentColumn() - Method in class com.google.genkit.plugins.postgresql.PostgresTableConfig
-
Gets the content column name.
- getContentExtractor() - Method in class com.google.genkit.plugins.firebase.retriever.FirestoreRetrieverConfig
- getContentField() - Method in class com.google.genkit.plugins.firebase.retriever.FirestoreRetrieverConfig
- getContentField() - Method in class com.google.genkit.plugins.weaviate.WeaviateCollectionConfig
- getContentType() - Method in class com.google.genkit.ai.Media
- getContentType() - Method in class com.google.genkit.ai.OutputConfig
- getContext() - Method in class com.google.genkit.ai.evaluation.EvalDataPoint
- getContext() - Method in class com.google.genkit.ai.evaluation.EvalResult
- getContext() - Method in class com.google.genkit.ai.evaluation.RunEvaluationRequest.EvaluationOptions
- getContext() - Method in class com.google.genkit.ai.GenerateOptions
-
Gets the additional context.
- getContext() - Method in class com.google.genkit.ai.ModelInfo.ModelCapabilities
- getContext() - Method in class com.google.genkit.ai.ModelRequest
- getContext() - Method in class com.google.genkit.core.ActionContext
-
Returns the request-scoped user context.
- getContext() - Method in class com.google.genkit.core.tracing.GenkitSpanData.Link
- getContextCaching() - Method in class com.google.genkit.ai.ModelInfo.ModelCapabilities
- getContextPath() - Method in class com.google.genkit.plugins.spring.SpringPluginOptions
-
Gets the context path for the Spring application.
- getCreatedAt() - Method in class com.google.genkit.ai.agent.SessionSnapshot
-
Returns the creation timestamp (RFC-3339).
- getCreatedAt() - Method in class com.google.genkit.ai.evaluation.EvalRunKey
- getCreateTime() - Method in class com.google.genkit.ai.evaluation.DatasetMetadata
- getCredential() - Method in class com.google.genkit.plugins.azurefoundry.AzureFoundryPluginOptions
-
Gets the Azure credential.
- getCredentials() - Method in class com.google.genkit.plugins.firebase.FirebasePluginConfig
- getCredentialsProvider() - Method in class com.google.genkit.plugins.awsbedrock.AwsBedrockPluginOptions
-
Gets the AWS credentials provider.
- getCurrentCreatedAt() - Method in class com.google.genkit.ai.agent.internal.PointerDoc
-
Returns the current snapshot's createdAt timestamp.
- getCurrentSnapshotId() - Method in class com.google.genkit.ai.agent.internal.PointerDoc
-
Returns the current snapshot ID.
- getCustom() - Method in class com.google.genkit.ai.agent.Session
-
Returns a deep copy of the current custom state.
- getCustom() - Method in class com.google.genkit.ai.agent.SessionRunner
-
Returns a deep copy of the current custom state.
- getCustom() - Method in class com.google.genkit.ai.agent.SessionState
-
Returns the custom state.
- getCustom() - Method in class com.google.genkit.ai.Candidate
- getCustom() - Method in class com.google.genkit.ai.evaluation.EvalDataPoint
- getCustom() - Method in class com.google.genkit.ai.evaluation.EvalResult
- getCustom() - Method in class com.google.genkit.ai.GenerationConfig
- getCustom() - Method in class com.google.genkit.ai.ModelResponse
- getCustom() - Method in class com.google.genkit.ai.RetrieverRequest.RetrieverOptions
- getCustomOptions() - Method in class com.google.genkit.ai.ModelInfo
- getCustomPatch() - Method in class com.google.genkit.ai.agent.AgentStreamChunk
-
Returns the custom-state patch as a JSON array of patch operations.
- getData() - Method in class com.google.genkit.ai.evaluation.CreateDatasetRequest
- getData() - Method in class com.google.genkit.ai.evaluation.RunEvaluationRequest.DataSource
- getData() - Method in class com.google.genkit.ai.evaluation.UpdateDatasetRequest
- getData() - Method in class com.google.genkit.ai.Part
- getDatabaseId() - Method in class com.google.genkit.plugins.firebase.retriever.FirestoreRetrieverConfig
-
Returns the Firestore database ID.
- getDatabaseName() - Method in class com.google.genkit.plugins.azurefoundry.session.CosmosSessionStoreOptions
-
Returns the Cosmos DB database name (default "genkit").
- getDatabaseName() - Method in class com.google.genkit.plugins.mongodb.MongoVectorStoreConfig
-
Returns the database name (default
genkit). - getDatabaseName() - Method in class com.google.genkit.plugins.mongodb.session.MongoSessionStoreOptions
-
Returns the MongoDB database name (default "genkit").
- getDatabaseUrl() - Method in class com.google.genkit.plugins.firebase.FirebasePluginConfig
- getDataset() - Method in class com.google.genkit.ai.evaluation.EvalRequest
- getDataset(String) - Method in interface com.google.genkit.ai.evaluation.DatasetStore
-
Gets the data for a dataset.
- getDataset(String) - Method in class com.google.genkit.ai.evaluation.LocalFileDatasetStore
- getDatasetId() - Method in class com.google.genkit.ai.evaluation.CreateDatasetRequest
- getDatasetId() - Method in class com.google.genkit.ai.evaluation.DatasetMetadata
- getDatasetId() - Method in class com.google.genkit.ai.evaluation.EvalRunKey
- getDatasetId() - Method in class com.google.genkit.ai.evaluation.RunEvaluationRequest.DataSource
- getDatasetId() - Method in class com.google.genkit.ai.evaluation.UpdateDatasetRequest
- getDatasetStore() - Method in class com.google.genkit.ai.evaluation.EvaluationManager
-
Gets the dataset store.
- getDatasetStore() - Method in class com.google.genkit.Genkit
-
Gets the dataset store.
- getDatasetType() - Method in class com.google.genkit.ai.evaluation.CreateDatasetRequest
- getDatasetType() - Method in class com.google.genkit.ai.evaluation.DatasetMetadata
- getDatasetVersion() - Method in class com.google.genkit.ai.evaluation.EvalRunKey
- getDataSource() - Method in class com.google.genkit.ai.evaluation.RunEvaluationRequest
- getDataSource() - Method in class com.google.genkit.plugins.postgresql.PostgresVectorStore
-
Gets the data source.
- getDefaultLimit() - Method in class com.google.genkit.plugins.firebase.retriever.FirestoreRetrieverConfig
- getDefaultLimit() - Method in class com.google.genkit.plugins.weaviate.WeaviateCollectionConfig
- getDefinition() - Method in class com.google.genkit.ai.evaluation.EvaluatorInfo
- getDefinition() - Method in class com.google.genkit.ai.Tool
-
Gets the tool definition for use in model requests.
- getDeployment() - Method in class com.google.genkit.plugins.azurefoundry.AzureFoundryPluginOptions
-
Gets the deployment name.
- getDesc() - Method in class com.google.genkit.ai.agent.Agent
- getDesc() - Method in class com.google.genkit.ai.Embedder
- getDesc() - Method in class com.google.genkit.ai.evaluation.Evaluator
- getDesc() - Method in class com.google.genkit.ai.GenerateAction
- getDesc() - Method in class com.google.genkit.ai.Indexer
- getDesc() - Method in interface com.google.genkit.ai.Model
- getDesc() - Method in class com.google.genkit.ai.Prompt
- getDesc() - Method in class com.google.genkit.ai.Retriever
- getDesc() - Method in class com.google.genkit.ai.Tool
- getDesc() - Method in interface com.google.genkit.core.Action
-
Returns the descriptor of the action containing metadata, schemas, etc.
- getDesc() - Method in class com.google.genkit.core.ActionDef
- getDesc() - Method in class com.google.genkit.core.BidiActionImpl
- getDesc() - Method in class com.google.genkit.core.Flow
- getDescription() - Method in class com.google.genkit.agent.AgentConfig
-
Returns the agent's human-readable description.
- getDescription() - Method in class com.google.genkit.ai.agent.AgentRef
-
Returns the agent description.
- getDescription() - Method in class com.google.genkit.ai.agent.CustomAgentConfig
-
Returns the agent's human-readable description.
- getDescription() - Method in class com.google.genkit.ai.InterruptConfig
-
Gets the description.
- getDescription() - Method in class com.google.genkit.ai.Tool
-
Gets the tool description.
- getDescription() - Method in class com.google.genkit.ai.ToolDefinition
- getDescription() - Method in class com.google.genkit.core.ActionDesc
- getDescription() - Method in class com.google.genkit.core.tracing.GenkitSpanData.Annotation
- getDescription() - Method in class com.google.genkit.plugins.mcp.MCPResource
-
Gets the resource description.
- getDetach() - Method in class com.google.genkit.ai.agent.AgentInput
-
Gets the detach flag (alias for isDetach).
- getDetails() - Method in class com.google.genkit.ai.agent.RuntimeError
-
Returns additional error details.
- getDetails() - Method in class com.google.genkit.ai.evaluation.Score
- getDetails() - Method in exception class com.google.genkit.core.GenkitException
-
Returns additional error details.
- getDimension() - Method in class com.google.genkit.plugins.milvus.MilvusCollectionConfig
-
Returns the embedding dimension (default
768). - getDimension() - Method in class com.google.genkit.plugins.mongodb.MongoVectorStoreConfig
-
Returns the embedding dimension (default
768). - getDimension() - Method in class com.google.genkit.plugins.pinecone.PineconeIndexConfig
-
Gets the vector dimension.
- getDimension() - Method in class com.google.genkit.plugins.qdrant.QdrantCollectionConfig
-
Returns the embedding dimension (default
768). - getDimensions() - Method in class com.google.genkit.ai.EmbedderInfo
- getDirectory() - Method in class com.google.genkit.plugins.localvec.LocalVecConfig
-
Gets the directory where data is stored.
- getDisplayName() - Method in class com.google.genkit.ai.evaluation.EvaluatorInfo
- getDisplayName() - Method in class com.google.genkit.core.tracing.GenkitSpanData
- getDisplayName() - Method in class com.google.genkit.core.tracing.TraceData
- getDistance() - Method in class com.google.genkit.plugins.chroma.ChromaCollectionConfig
-
Returns the distance function (default
ChromaCollectionConfig.Distance.COSINE). - getDistance() - Method in class com.google.genkit.plugins.qdrant.QdrantCollectionConfig
-
Returns the distance function (default
QdrantCollectionConfig.Distance.COSINE). - getDistanceMeasure() - Method in class com.google.genkit.plugins.firebase.retriever.FirestoreRetrieverConfig
- getDistanceMeasure() - Method in class com.google.genkit.plugins.weaviate.WeaviateCollectionConfig
- getDistanceResultField() - Method in class com.google.genkit.plugins.firebase.retriever.FirestoreRetrieverConfig
- getDistanceStrategy() - Method in class com.google.genkit.plugins.postgresql.PostgresTableConfig
-
Gets the distance strategy for similarity search.
- getDistanceThreshold() - Method in class com.google.genkit.plugins.firebase.retriever.FirestoreRetrieverConfig
- getDoc() - Method in class com.google.genkit.plugins.localvec.DbValue
-
Gets the document.
- getDocs() - Method in class com.google.genkit.ai.GenerateActionOptions
- getDocs() - Method in class com.google.genkit.ai.GenerateOptions
-
Gets the documents for context.
- getDocuments() - Method in class com.google.genkit.ai.EmbedRequest
- getDocuments() - Method in class com.google.genkit.ai.IndexerRequest
-
Gets the documents to index.
- getDocuments() - Method in class com.google.genkit.ai.RetrieverResponse
- getDotPrompt() - Method in class com.google.genkit.prompt.ExecutablePrompt
-
Gets the underlying DotPrompt.
- getDroppedAttributesCount() - Method in class com.google.genkit.core.tracing.GenkitSpanData.Link
- getEmail() - Method in class com.google.genkit.plugins.firebase.functions.AuthContext
- getEmbedder() - Method in class com.google.genkit.plugins.evaluators.EvaluatorsPluginOptions
- getEmbedder() - Method in class com.google.genkit.plugins.evaluators.MetricConfig
- getEmbedder() - Method in class com.google.genkit.plugins.firebase.retriever.FirestoreRetrieverConfig
- getEmbedder() - Method in class com.google.genkit.plugins.localvec.LocalVecConfig
-
Gets the embedder.
- getEmbedder() - Method in class com.google.genkit.plugins.weaviate.WeaviateCollectionConfig
- getEmbedder(String) - Method in class com.google.genkit.Genkit
-
Gets an embedder by name.
- getEmbedderDimension() - Method in class com.google.genkit.plugins.firebase.retriever.FirestoreRetrieverConfig
-
Returns the embedder dimension for vector index creation.
- getEmbedderName() - Method in class com.google.genkit.plugins.chroma.ChromaCollectionConfig
-
Returns the name of the embedder used to vectorize documents and queries.
- getEmbedderName() - Method in class com.google.genkit.plugins.firebase.retriever.FirestoreRetrieverConfig
- getEmbedderName() - Method in class com.google.genkit.plugins.localvec.LocalVecConfig
-
Gets the embedder name for deferred resolution.
- getEmbedderName() - Method in class com.google.genkit.plugins.milvus.MilvusCollectionConfig
-
Returns the name of the embedder used to vectorize documents and queries.
- getEmbedderName() - Method in class com.google.genkit.plugins.mongodb.MongoVectorStoreConfig
-
Returns the name of the embedder used to vectorize documents and queries.
- getEmbedderName() - Method in class com.google.genkit.plugins.pinecone.PineconeIndexConfig
-
Gets the embedder name for generating vectors.
- getEmbedderName() - Method in class com.google.genkit.plugins.postgresql.PostgresTableConfig
-
Gets the embedder name for generating vectors.
- getEmbedderName() - Method in class com.google.genkit.plugins.qdrant.QdrantCollectionConfig
-
Returns the name of the embedder used to vectorize documents and queries.
- getEmbedderName() - Method in class com.google.genkit.plugins.weaviate.WeaviateCollectionConfig
- getEmbedderOptions() - Method in class com.google.genkit.plugins.evaluators.EvaluatorsPluginOptions
- getEmbedderOptions() - Method in class com.google.genkit.plugins.evaluators.MetricConfig
- getEmbedderOptions() - Method in class com.google.genkit.plugins.localvec.LocalVecConfig
-
Gets the embedder options.
- getEmbedding() - Method in class com.google.genkit.plugins.localvec.DbValue
-
Gets the embedding.
- getEmbeddingColumn() - Method in class com.google.genkit.plugins.postgresql.PostgresTableConfig
-
Gets the embedding column name.
- getEmbeddingField() - Method in class com.google.genkit.plugins.mongodb.MongoVectorStoreConfig
-
Returns the field that stores the embedding vector (default
embedding). - getEmbeddings() - Method in class com.google.genkit.ai.EmbedResponse
- getEndpoint() - Method in class com.google.genkit.plugins.azurefoundry.AzureFoundryPluginOptions
-
Gets the Azure AI Foundry endpoint URL.
- getEndTime() - Method in class com.google.genkit.core.tracing.GenkitSpanData
- getEndTime() - Method in class com.google.genkit.core.tracing.TraceData
- getEnv() - Method in class com.google.genkit.plugins.mcp.MCPServerConfig
-
Gets the environment variables.
- getError() - Method in class com.google.genkit.ai.agent.AgentOutput
-
Returns the runtime error, if any.
- getError() - Method in class com.google.genkit.ai.agent.SessionSnapshot
-
Returns the runtime error, if any.
- getError() - Method in class com.google.genkit.ai.evaluation.EvalDataPoint
- getError() - Method in class com.google.genkit.ai.evaluation.EvalMetric
- getError() - Method in class com.google.genkit.ai.evaluation.EvalResult
- getError() - Method in class com.google.genkit.ai.evaluation.Score
- getErrorCode() - Method in exception class com.google.genkit.core.GenkitException
-
Returns the error code.
- getEvalRunId() - Method in class com.google.genkit.ai.evaluation.EvalRequest
- getEvalRunId() - Method in class com.google.genkit.ai.evaluation.EvalRunKey
- getEvalStore() - Method in class com.google.genkit.ai.evaluation.EvaluationManager
-
Gets the eval store.
- getEvalStore() - Method in class com.google.genkit.Genkit
-
Gets the eval store.
- getEvaluation() - Method in class com.google.genkit.ai.evaluation.EvalResponse
- getEvaluationAsScore() - Method in class com.google.genkit.ai.evaluation.EvalResponse
-
Gets the evaluation as a single Score.
- getEvaluationAsScoreList() - Method in class com.google.genkit.ai.evaluation.EvalResponse
-
Gets the evaluation as a list of Scores.
- getEvaluationManager() - Method in class com.google.genkit.Genkit
-
Gets the evaluation manager.
- getEvaluator() - Method in class com.google.genkit.ai.evaluation.EvalMetric
- getEvaluator(String) - Method in class com.google.genkit.Genkit
-
Gets an evaluator by name.
- getEvaluators() - Method in class com.google.genkit.ai.evaluation.RunEvaluationRequest
- getFilename() - Method in class com.google.genkit.plugins.localvec.LocalVecConfig
-
Gets the filename for this index.
- getFilePath() - Method in class com.google.genkit.plugins.localvec.LocalVecConfig
-
Gets the full path to the data file.
- getFinishMessage() - Method in class com.google.genkit.ai.Candidate
- getFinishMessage() - Method in class com.google.genkit.ai.ModelResponse
- getFinishReason() - Method in class com.google.genkit.ai.agent.AgentOutput
-
Returns the finish reason.
- getFinishReason() - Method in class com.google.genkit.ai.agent.AgentResult
-
Returns the finish reason.
- getFinishReason() - Method in class com.google.genkit.ai.agent.SessionSnapshot
-
Returns the finish reason.
- getFinishReason() - Method in class com.google.genkit.ai.agent.TurnEnd
-
Returns the finish reason.
- getFinishReason() - Method in class com.google.genkit.ai.Candidate
- getFinishReason() - Method in class com.google.genkit.ai.ModelResponse
- getFirebaseApp() - Method in class com.google.genkit.plugins.firebase.FirebasePlugin
-
Gets the FirebaseApp instance.
- getFirestore() - Method in class com.google.genkit.plugins.firebase.FirebasePlugin
-
Gets the Firestore instance.
- getFlowName() - Method in class com.google.genkit.core.ActionContext
-
Returns the name of the enclosing flow, if any.
- getFormat() - Method in class com.google.genkit.ai.OutputConfig
- getFrequencyPenalty() - Method in class com.google.genkit.ai.GenerationConfig
- getFullName() - Method in class com.google.genkit.plugins.compatoai.CompatOAIPlugin.ModelDefinition
-
Gets the full model name (prefix/modelId).
- getHeartbeatAt() - Method in class com.google.genkit.ai.agent.SessionSnapshot
-
Returns the last-heartbeat timestamp (RFC-3339).
- getHistoryLength() - Method in class com.google.genkit.plugins.middleware.AgentsOptions
-
Returns the number of trailing prior messages (from this sub-agent's own accumulated conversation with the delegating parent session, not the parent's own history) to forward on each delegation call.
- getHost() - Method in class com.google.genkit.plugins.jetty.JettyPluginOptions
-
Gets the host to bind to.
- getHost() - Method in class com.google.genkit.plugins.spring.SpringPluginOptions
-
Gets the host to bind to.
- getId() - Method in class com.google.genkit.ai.evaluation.Score
- getIdColumn() - Method in class com.google.genkit.plugins.postgresql.PostgresTableConfig
-
Gets the ID column name.
- getIndex() - Method in class com.google.genkit.ai.Candidate
- getIndex() - Method in class com.google.genkit.ai.ModelResponseChunk
- getIndex() - Method in class com.google.genkit.plugins.pinecone.PineconeVectorStore
-
Gets the Pinecone index connection.
- getIndexer(String) - Method in class com.google.genkit.Genkit
-
Gets an indexer by name.
- getIndexLists() - Method in class com.google.genkit.plugins.postgresql.PostgresTableConfig
-
Gets the number of lists for IVFFlat index.
- getIndexName() - Method in class com.google.genkit.plugins.localvec.LocalVecConfig
-
Gets the index name.
- getIndexName() - Method in class com.google.genkit.plugins.mongodb.MongoVectorStoreConfig
-
Returns the Atlas Vector Search index name (default
genkit_vector_index). - getIndexName() - Method in class com.google.genkit.plugins.pinecone.PineconeIndexConfig
-
Gets the index name.
- getIndexOpsClass() - Method in enum class com.google.genkit.plugins.postgresql.PostgresTableConfig.DistanceStrategy
-
Gets the pgvector operator class for index creation.
- getInfo() - Method in class com.google.genkit.ai.Embedder
-
Gets the embedder info.
- getInfo() - Method in class com.google.genkit.ai.evaluation.Evaluator
-
Gets the evaluator info.
- getInfo() - Method in interface com.google.genkit.ai.Model
-
Gets information about the model's capabilities.
- getInfo() - Method in class com.google.genkit.plugins.anthropic.AnthropicModel
- getInfo() - Method in class com.google.genkit.plugins.awsbedrock.AwsBedrockModel
- getInfo() - Method in class com.google.genkit.plugins.compatoai.CompatOAIModel
- getInfo() - Method in class com.google.genkit.plugins.googlegenai.GeminiModel
- getInfo() - Method in class com.google.genkit.plugins.googlegenai.ImagenModel
- getInfo() - Method in class com.google.genkit.plugins.googlegenai.OmniModel
- getInfo() - Method in class com.google.genkit.plugins.googlegenai.TtsModel
- getInfo() - Method in class com.google.genkit.plugins.googlegenai.VeoModel
- getInfo() - Method in class com.google.genkit.plugins.ollama.OllamaModel
- getInfo() - Method in class com.google.genkit.plugins.openai.OpenAIImageModel
- getInfo() - Method in class com.google.genkit.plugins.openai.OpenAIModel
- getInput() - Method in class com.google.genkit.ai.EmbedderInfo.EmbedderCapabilities
- getInput() - Method in class com.google.genkit.ai.evaluation.DatasetSample
- getInput() - Method in class com.google.genkit.ai.evaluation.EvalDataPoint
- getInput() - Method in class com.google.genkit.ai.evaluation.EvalResult
- getInput() - Method in class com.google.genkit.ai.ToolRequest
- getInputAudioFiles() - Method in class com.google.genkit.ai.Usage
- getInputCharacters() - Method in class com.google.genkit.ai.Usage
- getInputClass() - Method in class com.google.genkit.ai.Tool
-
Gets the input class for JSON deserialization.
- getInputImages() - Method in class com.google.genkit.ai.Usage
- getInputSchema() - Method in class com.google.genkit.ai.agent.Agent
- getInputSchema() - Method in class com.google.genkit.ai.Embedder
- getInputSchema() - Method in class com.google.genkit.ai.evaluation.Evaluator
- getInputSchema() - Method in class com.google.genkit.ai.GenerateAction
- getInputSchema() - Method in class com.google.genkit.ai.Indexer
- getInputSchema() - Method in class com.google.genkit.ai.InterruptConfig
-
Gets the input schema.
- getInputSchema() - Method in interface com.google.genkit.ai.Model
- getInputSchema() - Method in class com.google.genkit.ai.Prompt
- getInputSchema() - Method in class com.google.genkit.ai.Retriever
- getInputSchema() - Method in class com.google.genkit.ai.Tool
- getInputSchema() - Method in class com.google.genkit.ai.ToolDefinition
- getInputSchema() - Method in interface com.google.genkit.core.Action
-
Returns the JSON schema for the action's input type.
- getInputSchema() - Method in class com.google.genkit.core.ActionDef
- getInputSchema() - Method in class com.google.genkit.core.ActionDesc
- getInputSchema() - Method in class com.google.genkit.core.BidiActionImpl
- getInputSchema() - Method in class com.google.genkit.core.Flow
- getInputSchema() - Method in class com.google.genkit.prompt.DotPrompt
- getInputTokens() - Method in class com.google.genkit.ai.Usage
- getInputType() - Method in class com.google.genkit.ai.InterruptConfig
-
Gets the input type class.
- getInputVideoFiles() - Method in class com.google.genkit.ai.Usage
- getInstance() - Static method in class com.google.genkit.ai.evaluation.LocalFileDatasetStore
-
Gets the singleton instance of the dataset store.
- getInstance() - Static method in class com.google.genkit.ai.evaluation.LocalFileEvalStore
-
Gets the singleton instance of the eval store.
- getInstance() - Static method in class com.google.genkit.ai.telemetry.ActionTelemetry
-
Gets the singleton instance of ActionTelemetry.
- getInstance() - Static method in class com.google.genkit.ai.telemetry.FeatureTelemetry
-
Gets the singleton instance of FeatureTelemetry.
- getInstance() - Static method in class com.google.genkit.ai.telemetry.GenerateTelemetry
-
Gets the singleton instance of GenerateTelemetry.
- getInstance() - Static method in class com.google.genkit.ai.telemetry.ToolTelemetry
-
Gets the singleton instance of ToolTelemetry.
- getInstructions() - Method in class com.google.genkit.ai.OutputConfig
- getInstrumentationScope() - Method in class com.google.genkit.core.tracing.GenkitSpanData
- getInterrupts() - Method in class com.google.genkit.ai.ModelResponse
-
Returns the list of interrupt tool requests.
- getIsBilled() - Method in class com.google.genkit.ai.evaluation.EvaluatorInfo
- getIteration() - Method in class com.google.genkit.ai.middleware.GenerateParams
-
Returns the current tool-loop iteration (0-indexed), equivalent to JS
currentTurn. - getJudge() - Method in class com.google.genkit.plugins.evaluators.EvaluatorsPluginOptions
- getJudge() - Method in class com.google.genkit.plugins.evaluators.MetricConfig
- getJudgeConfig() - Method in class com.google.genkit.plugins.evaluators.EvaluatorsPluginOptions
- getJudgeConfig() - Method in class com.google.genkit.plugins.evaluators.MetricConfig
- getK() - Method in class com.google.genkit.ai.RetrieverRequest.RetrieverOptions
- getK() - Method in class com.google.genkit.plugins.localvec.RetrieverOptions
-
Gets the number of documents to retrieve.
- getKey() - Method in class com.google.genkit.ai.evaluation.EvalRun
- getKey() - Method in class com.google.genkit.core.ActionDesc
- getLabel() - Method in class com.google.genkit.ai.EmbedderInfo
- getLabel() - Method in class com.google.genkit.ai.ModelInfo
- getLabel() - Method in class com.google.genkit.plugins.compatoai.CompatOAIPlugin.ModelDefinition
-
Gets the display label.
- getLabel() - Method in class com.google.genkit.plugins.firebase.retriever.FirestoreRetrieverConfig
- getLabel() - Method in class com.google.genkit.plugins.weaviate.WeaviateCollectionConfig
- getLatencyMs() - Method in class com.google.genkit.ai.ModelResponse
- getLinks() - Method in class com.google.genkit.core.tracing.GenkitSpanData
- getLocation() - Method in class com.google.genkit.plugins.googlegenai.GoogleGenAIPluginOptions
-
Gets the Google Cloud location (for Vertex AI).
- getMaxDelegations() - Method in class com.google.genkit.plugins.middleware.AgentsOptions
-
Returns the maximum number of delegations per parent generate invocation.
- getMaxOutputTokens() - Method in class com.google.genkit.ai.GenerationConfig
- getMaxTurns() - Method in class com.google.genkit.agent.AgentConfig
-
Returns the maximum number of tool-execution turns for a single generate call.
- getMaxTurns() - Method in class com.google.genkit.ai.GenerateActionOptions
- getMaxTurns() - Method in class com.google.genkit.ai.GenerateOptions
-
Gets the maximum conversation turns.
- getMedia() - Method in class com.google.genkit.ai.ModelInfo.ModelCapabilities
- getMedia() - Method in class com.google.genkit.ai.Part
- getMessage() - Method in class com.google.genkit.ai.agent.AgentInput
-
Returns the input message.
- getMessage() - Method in class com.google.genkit.ai.agent.AgentOutput
-
Returns the output message.
- getMessage() - Method in class com.google.genkit.ai.agent.AgentResult
-
Returns the result message.
- getMessage() - Method in class com.google.genkit.ai.agent.RuntimeError
-
Returns the error message.
- getMessage() - Method in class com.google.genkit.ai.Candidate
- getMessage() - Method in class com.google.genkit.ai.ModelResponse
-
Returns the first candidate's message.
- getMessage() - Method in class com.google.genkit.core.tracing.GenkitSpanData.Status
- getMessageIndex() - Method in class com.google.genkit.ai.middleware.GenerateParams
-
Returns the current message index — the position in the conversation that the next model response will occupy.
- getMessages() - Method in class com.google.genkit.ai.agent.Session
-
Returns a copy of the current messages list.
- getMessages() - Method in class com.google.genkit.ai.agent.SessionRunner
-
Returns a copy of the current messages list.
- getMessages() - Method in class com.google.genkit.ai.agent.SessionState
-
Returns the session messages.
- getMessages() - Method in class com.google.genkit.ai.GenerateActionOptions
- getMessages() - Method in class com.google.genkit.ai.GenerateOptions
-
Gets the conversation messages.
- getMessages() - Method in class com.google.genkit.ai.ModelRequest
- getMessages() - Method in class com.google.genkit.ai.ModelResponse
-
Returns all messages including the model's response.
- getMetadata() - Method in class com.google.genkit.ai.agent.Agent
- getMetadata() - Method in class com.google.genkit.ai.agent.Artifact
-
Returns the artifact metadata.
- getMetadata() - Method in class com.google.genkit.ai.Document
- getMetadata() - Method in class com.google.genkit.ai.Embedder
- getMetadata() - Method in class com.google.genkit.ai.evaluation.Evaluator
- getMetadata() - Method in class com.google.genkit.ai.GenerateAction
- getMetadata() - Method in class com.google.genkit.ai.Indexer
- getMetadata() - Method in class com.google.genkit.ai.InterruptRequest
-
Gets the interrupt metadata.
- getMetadata() - Method in class com.google.genkit.ai.Message
- getMetadata() - Method in interface com.google.genkit.ai.Model
- getMetadata() - Method in class com.google.genkit.ai.Part
- getMetadata() - Method in class com.google.genkit.ai.Prompt
- getMetadata() - Method in class com.google.genkit.ai.Retriever
- getMetadata() - Method in class com.google.genkit.ai.Tool
- getMetadata() - Method in class com.google.genkit.ai.ToolDefinition
- getMetadata() - Method in exception class com.google.genkit.ai.ToolInterruptException
-
Gets the interrupt metadata.
- getMetadata() - Method in class com.google.genkit.ai.ToolRequest
- getMetadata() - Method in class com.google.genkit.ai.ToolResponse
- getMetadata() - Method in interface com.google.genkit.core.Action
-
Returns additional metadata for the action.
- getMetadata() - Method in class com.google.genkit.core.ActionDef
- getMetadata() - Method in class com.google.genkit.core.ActionDesc
- getMetadata() - Method in class com.google.genkit.core.BidiActionImpl
- getMetadata() - Method in class com.google.genkit.core.Flow
- getMetadataColumn() - Method in class com.google.genkit.plugins.postgresql.PostgresTableConfig
-
Gets the metadata column name.
- getMetadataExtractor() - Method in class com.google.genkit.plugins.firebase.retriever.FirestoreRetrieverConfig
- getMetadataField() - Method in class com.google.genkit.plugins.weaviate.WeaviateCollectionConfig
- getMetadataFields() - Method in class com.google.genkit.plugins.firebase.retriever.FirestoreRetrieverConfig
- getMeter(String) - Static method in class com.google.genkit.core.telemetry.TelemetryConfig
-
Gets a Meter for recording metrics.
- getMetric() - Method in class com.google.genkit.plugins.milvus.MilvusCollectionConfig
-
Returns the vector similarity metric (default
MilvusCollectionConfig.Metric.COSINE). - getMetric() - Method in class com.google.genkit.plugins.pinecone.PineconeIndexConfig
-
Gets the similarity metric.
- getMetricExportIntervalMillis() - Method in class com.google.genkit.plugins.firebase.FirebasePluginConfig
- getMetricRefs() - Method in class com.google.genkit.ai.evaluation.CreateDatasetRequest
- getMetricRefs() - Method in class com.google.genkit.ai.evaluation.DatasetMetadata
- getMetricRefs() - Method in class com.google.genkit.ai.evaluation.UpdateDatasetRequest
- getMetrics() - Method in class com.google.genkit.ai.evaluation.EvalResult
- getMetrics() - Method in class com.google.genkit.plugins.evaluators.EvaluatorsPluginOptions
- getMetricType() - Method in class com.google.genkit.plugins.evaluators.MetricConfig
- getMiddlewareChain() - Method in class com.google.genkit.core.Flow
-
Returns the middleware chain for this flow.
- getMiddlewareList() - Method in class com.google.genkit.core.middleware.MiddlewareChain
-
Returns an unmodifiable view of the middleware list.
- getMimeType() - Method in class com.google.genkit.plugins.mcp.MCPResource
-
Gets the MIME type.
- getMimeType() - Method in class com.google.genkit.plugins.mcp.MCPResourceContent.ContentPart
-
Gets the MIME type.
- getModel() - Method in class com.google.genkit.agent.AgentConfig
-
Returns the model name to use for generation.
- getModel() - Method in class com.google.genkit.ai.GenerateActionOptions
- getModel() - Method in class com.google.genkit.ai.GenerateOptions
-
Gets the model name.
- getModel() - Method in class com.google.genkit.ai.Prompt
-
Gets the default model name.
- getModel() - Method in class com.google.genkit.prompt.DotPrompt
- getModel() - Method in class com.google.genkit.prompt.ExecutablePrompt
-
Gets the default model name.
- getModel(String) - Method in class com.google.genkit.Genkit
-
Gets a model by name.
- getModelChunk() - Method in class com.google.genkit.ai.agent.AgentStreamChunk
-
Returns the model response chunk.
- getModels() - Method in class com.google.genkit.plugins.ollama.OllamaPluginOptions
-
Gets the list of models to register.
- getModeration() - Method in class com.google.genkit.plugins.openai.ImageGenerationConfig
- getMultiturn() - Method in class com.google.genkit.ai.ModelInfo.ModelCapabilities
- getN() - Method in class com.google.genkit.plugins.openai.ImageGenerationConfig
- getName() - Method in class com.google.genkit.agent.AgentConfig
-
Returns the agent's registered name.
- getName() - Method in class com.google.genkit.ai.agent.Agent
- getName() - Method in class com.google.genkit.ai.agent.AgentRef
-
Returns the agent name.
- getName() - Method in class com.google.genkit.ai.agent.Artifact
-
Returns the artifact name.
- getName() - Method in class com.google.genkit.ai.agent.CustomAgentConfig
-
Returns the agent's registered name.
- getName() - Method in class com.google.genkit.ai.Embedder
- getName() - Method in class com.google.genkit.ai.evaluation.Evaluator
- getName() - Method in class com.google.genkit.ai.GenerateAction
- getName() - Method in class com.google.genkit.ai.Indexer
- getName() - Method in class com.google.genkit.ai.InterruptConfig
-
Gets the interrupt name.
- getName() - Method in class com.google.genkit.ai.Prompt
- getName() - Method in class com.google.genkit.ai.Retriever
- getName() - Method in class com.google.genkit.ai.Tool
- getName() - Method in class com.google.genkit.ai.ToolDefinition
- getName() - Method in class com.google.genkit.ai.ToolRequest
- getName() - Method in class com.google.genkit.ai.ToolResponse
- getName() - Method in interface com.google.genkit.core.Action
-
Returns the name of the action.
- getName() - Method in class com.google.genkit.core.ActionDef
- getName() - Method in class com.google.genkit.core.ActionDesc
- getName() - Method in class com.google.genkit.core.BidiActionImpl
- getName() - Method in class com.google.genkit.core.Flow
- getName() - Method in interface com.google.genkit.core.Plugin
-
Returns the unique identifier for the plugin.
- getName() - Method in class com.google.genkit.core.tracing.GenkitSpanData.InstrumentationScope
- getName() - Method in class com.google.genkit.core.tracing.SpanMetadata
- getName() - Method in class com.google.genkit.GenkitOptions
-
Returns the optional instance name for this Genkit instance.
- getName() - Method in class com.google.genkit.plugins.anthropic.AnthropicModel
- getName() - Method in class com.google.genkit.plugins.anthropic.AnthropicPlugin
- getName() - Method in class com.google.genkit.plugins.awsbedrock.AwsBedrockModel
- getName() - Method in class com.google.genkit.plugins.awsbedrock.AwsBedrockPlugin
- getName() - Method in class com.google.genkit.plugins.azurefoundry.AzureFoundryPlugin
- getName() - Method in class com.google.genkit.plugins.chroma.ChromaPlugin
- getName() - Method in class com.google.genkit.plugins.cohere.CoherePlugin
- getName() - Method in class com.google.genkit.plugins.compatoai.CompatOAIModel
- getName() - Method in class com.google.genkit.plugins.compatoai.CompatOAIPlugin
- getName() - Method in class com.google.genkit.plugins.deepseek.DeepSeekPlugin
- getName() - Method in class com.google.genkit.plugins.evaluators.EvaluatorsPlugin
- getName() - Method in class com.google.genkit.plugins.firebase.FirebasePlugin
- getName() - Method in class com.google.genkit.plugins.firebase.retriever.FirestoreRetrieverConfig
- getName() - Method in class com.google.genkit.plugins.googlegenai.GeminiModel
- getName() - Method in class com.google.genkit.plugins.googlegenai.GoogleGenAIPlugin
- getName() - Method in class com.google.genkit.plugins.googlegenai.ImagenModel
- getName() - Method in class com.google.genkit.plugins.googlegenai.OmniModel
- getName() - Method in class com.google.genkit.plugins.googlegenai.TtsModel
- getName() - Method in class com.google.genkit.plugins.googlegenai.VeoModel
- getName() - Method in class com.google.genkit.plugins.groq.GroqPlugin
- getName() - Method in class com.google.genkit.plugins.jetty.JettyPlugin
- getName() - Method in class com.google.genkit.plugins.localvec.LocalVecPlugin
- getName() - Method in class com.google.genkit.plugins.mcp.MCPPlugin
- getName() - Method in class com.google.genkit.plugins.mcp.MCPPluginOptions
-
Gets the name of the MCP host.
- getName() - Method in class com.google.genkit.plugins.mcp.MCPResource
-
Gets the resource name.
- getName() - Method in class com.google.genkit.plugins.mcp.MCPServerOptions
-
Gets the server name.
- getName() - Method in class com.google.genkit.plugins.middleware.GenerationMiddlewarePlugin
- getName() - Method in class com.google.genkit.plugins.milvus.MilvusPlugin
- getName() - Method in class com.google.genkit.plugins.mistral.MistralPlugin
- getName() - Method in class com.google.genkit.plugins.mongodb.MongoPlugin
- getName() - Method in class com.google.genkit.plugins.ollama.OllamaModel
- getName() - Method in class com.google.genkit.plugins.ollama.OllamaPlugin
- getName() - Method in class com.google.genkit.plugins.openai.OpenAIImageModel
- getName() - Method in class com.google.genkit.plugins.openai.OpenAIModel
- getName() - Method in class com.google.genkit.plugins.openai.OpenAIPlugin
- getName() - Method in class com.google.genkit.plugins.pinecone.PineconePlugin
- getName() - Method in class com.google.genkit.plugins.postgresql.PostgresPlugin
- getName() - Method in class com.google.genkit.plugins.qdrant.QdrantPlugin
- getName() - Method in class com.google.genkit.plugins.spring.SpringPlugin
- getName() - Method in class com.google.genkit.plugins.weaviate.WeaviateCollectionConfig
- getName() - Method in class com.google.genkit.plugins.weaviate.WeaviatePlugin
- getName() - Method in class com.google.genkit.plugins.xai.XAIPlugin
- getName() - Method in class com.google.genkit.prompt.DotPrompt
- getName() - Method in class com.google.genkit.prompt.ExecutablePrompt
-
Gets the prompt name.
- getNamespace() - Method in class com.google.genkit.plugins.pinecone.PineconeIndexConfig
-
Gets the namespace for this configuration.
- getNumCandidates() - Method in class com.google.genkit.plugins.mongodb.MongoVectorStoreConfig
-
Returns the number of nearest neighbors to consider during the vector search (default
100). - getObjectMapper() - Static method in class com.google.genkit.core.JsonUtils
-
Returns the shared ObjectMapper instance.
- getOnChunk() - Method in class com.google.genkit.ai.middleware.GenerateParams
-
Returns the streaming chunk callback, or
nullif this is a non-streaming request. - getOperator() - Method in enum class com.google.genkit.plugins.postgresql.PostgresTableConfig.DistanceStrategy
-
Gets the SQL operator for distance calculation.
- getOptions() - Method in class com.google.genkit.ai.EmbedRequest
- getOptions() - Method in class com.google.genkit.ai.evaluation.EvalRequest
- getOptions() - Method in class com.google.genkit.ai.evaluation.RunEvaluationRequest
- getOptions() - Method in class com.google.genkit.ai.IndexerRequest
-
Gets the indexing options.
- getOptions() - Method in class com.google.genkit.ai.RetrieverRequest
- getOptions() - Method in class com.google.genkit.Genkit
-
Gets the options.
- getOptions() - Method in class com.google.genkit.plugins.anthropic.AnthropicPlugin
-
Gets the plugin options.
- getOptions() - Method in class com.google.genkit.plugins.awsbedrock.AwsBedrockPlugin
-
Gets the plugin options.
- getOptions() - Method in class com.google.genkit.plugins.azurefoundry.AzureFoundryPlugin
-
Gets the plugin options.
- getOptions() - Method in class com.google.genkit.plugins.cohere.CoherePlugin
-
Gets the plugin options.
- getOptions() - Method in class com.google.genkit.plugins.compatoai.CompatOAIPlugin
-
Gets the plugin options.
- getOptions() - Method in class com.google.genkit.plugins.deepseek.DeepSeekPlugin
-
Gets the plugin options.
- getOptions() - Method in class com.google.genkit.plugins.evaluators.EvaluatorsPlugin
-
Gets the plugin options.
- getOptions() - Method in class com.google.genkit.plugins.googlegenai.GoogleGenAIPlugin
-
Gets the plugin options.
- getOptions() - Method in class com.google.genkit.plugins.groq.GroqPlugin
-
Gets the plugin options.
- getOptions() - Method in class com.google.genkit.plugins.mcp.MCPPlugin
-
Gets the plugin options.
- getOptions() - Method in class com.google.genkit.plugins.mcp.MCPServer
-
Gets the server options.
- getOptions() - Method in class com.google.genkit.plugins.mistral.MistralPlugin
-
Gets the plugin options.
- getOptions() - Method in class com.google.genkit.plugins.ollama.OllamaPlugin
-
Gets the plugin options.
- getOptions() - Method in class com.google.genkit.plugins.openai.OpenAIPlugin
-
Gets the plugin options.
- getOptions() - Method in class com.google.genkit.plugins.xai.XAIPlugin
-
Gets the plugin options.
- getOrganization() - Method in class com.google.genkit.plugins.compatoai.CompatOAIPluginOptions
-
Gets the organization ID.
- getOrganization() - Method in class com.google.genkit.plugins.openai.OpenAIPluginOptions
-
Gets the organization ID.
- getOriginalInput() - Method in class com.google.genkit.core.ActionContext
-
Returns the tool request's original input (before any restart-replaced input), mirroring Go
ToolContext.OriginalInput. - getOutput() - Method in class com.google.genkit.ai.evaluation.DatasetSample
- getOutput() - Method in class com.google.genkit.ai.evaluation.EvalDataPoint
- getOutput() - Method in class com.google.genkit.ai.evaluation.EvalResult
- getOutput() - Method in class com.google.genkit.ai.GenerateActionOptions
- getOutput() - Method in class com.google.genkit.ai.GenerateOptions
-
Gets the output configuration.
- getOutput() - Method in class com.google.genkit.ai.ModelInfo.ModelCapabilities
- getOutput() - Method in class com.google.genkit.ai.ModelRequest
- getOutput() - Method in class com.google.genkit.ai.ToolResponse
- getOutput() - Method in class com.google.genkit.core.Flow.StreamingFlowValue
-
Returns the final output.
- getOutputAudioFiles() - Method in class com.google.genkit.ai.Usage
- getOutputCharacters() - Method in class com.google.genkit.ai.Usage
- getOutputClass() - Method in class com.google.genkit.ai.GenerateOptions
-
Gets the output class for structured output.
- getOutputCompression() - Method in class com.google.genkit.plugins.openai.ImageGenerationConfig
- getOutputFormat() - Method in class com.google.genkit.plugins.openai.ImageGenerationConfig
- getOutputImages() - Method in class com.google.genkit.ai.Usage
- getOutputSchema() - Method in class com.google.genkit.ai.agent.Agent
- getOutputSchema() - Method in class com.google.genkit.ai.Embedder
- getOutputSchema() - Method in class com.google.genkit.ai.evaluation.Evaluator
- getOutputSchema() - Method in class com.google.genkit.ai.GenerateAction
- getOutputSchema() - Method in class com.google.genkit.ai.Indexer
- getOutputSchema() - Method in class com.google.genkit.ai.InterruptConfig
-
Gets the output schema.
- getOutputSchema() - Method in interface com.google.genkit.ai.Model
- getOutputSchema() - Method in class com.google.genkit.ai.Prompt
- getOutputSchema() - Method in class com.google.genkit.ai.Retriever
- getOutputSchema() - Method in class com.google.genkit.ai.Tool
- getOutputSchema() - Method in class com.google.genkit.ai.ToolDefinition
- getOutputSchema() - Method in interface com.google.genkit.core.Action
-
Returns the JSON schema for the action's output type.
- getOutputSchema() - Method in class com.google.genkit.core.ActionDef
- getOutputSchema() - Method in class com.google.genkit.core.ActionDesc
- getOutputSchema() - Method in class com.google.genkit.core.BidiActionImpl
- getOutputSchema() - Method in class com.google.genkit.core.Flow
- getOutputSchema() - Method in class com.google.genkit.prompt.DotPrompt
- getOutputTokens() - Method in class com.google.genkit.ai.Usage
- getOutputType() - Method in class com.google.genkit.ai.InterruptConfig
-
Gets the output type class.
- getOutputVideoFiles() - Method in class com.google.genkit.ai.Usage
- getParentId() - Method in class com.google.genkit.ai.agent.SessionSnapshot
-
Returns the parent snapshot ID.
- getParentSpanId() - Method in class com.google.genkit.core.tracing.GenkitSpanData
- getParentSpanId() - Method in class com.google.genkit.core.tracing.SpanContext
-
Returns the parent span ID.
- getParts() - Method in class com.google.genkit.ai.agent.Artifact
-
Returns the artifact parts.
- getParts() - Method in class com.google.genkit.plugins.mcp.MCPResourceContent
-
Gets the content parts.
- getPlugins() - Method in class com.google.genkit.Genkit
-
Gets the registered plugins.
- getPollIntervalMs() - Method in class com.google.genkit.plugins.awsbedrock.session.DynamoDbSessionStoreOptions
-
Returns the subscription poll interval in milliseconds (default 2000L).
- getPollIntervalMs() - Method in class com.google.genkit.plugins.azurefoundry.session.CosmosSessionStoreOptions
-
Returns the subscription poll interval in milliseconds (default 2000L).
- getPollIntervalMs() - Method in class com.google.genkit.plugins.mongodb.session.MongoSessionStoreOptions
-
Returns the subscription poll interval in milliseconds (default 2000L).
- getPollIntervalMs() - Method in class com.google.genkit.plugins.postgresql.session.PostgresSessionStoreOptions
-
Returns the subscription poll interval in milliseconds (default 2000L).
- getPort() - Method in interface com.google.genkit.core.ServerPlugin
-
Returns the port the server is listening on.
- getPort() - Method in class com.google.genkit.plugins.jetty.JettyPlugin
-
Returns the port the server is listening on.
- getPort() - Method in class com.google.genkit.plugins.jetty.JettyPluginOptions
-
Gets the HTTP port.
- getPort() - Method in class com.google.genkit.plugins.spring.SpringPlugin
-
Returns the port the server is listening on.
- getPort() - Method in class com.google.genkit.plugins.spring.SpringPluginOptions
-
Gets the HTTP port.
- getPort() - Method in class com.google.genkit.ReflectionServer
-
Gets the active reflection server port.
- getPresencePenalty() - Method in class com.google.genkit.ai.GenerationConfig
- getProject() - Method in class com.google.genkit.plugins.googlegenai.GoogleGenAIPluginOptions
-
Gets the Google Cloud project ID (for Vertex AI).
- getProjectId() - Method in class com.google.genkit.plugins.firebase.FirebasePluginConfig
- getProjectRoot() - Method in class com.google.genkit.GenkitOptions
-
Returns the project root directory.
- getPrompt() - Method in class com.google.genkit.ai.GenerateOptions
-
Gets the text prompt.
- getPromptDir() - Method in class com.google.genkit.GenkitOptions
-
Returns the prompt directory path (relative to resources or absolute).
- getPromptInput() - Method in class com.google.genkit.agent.AgentConfig
-
Returns the input passed to the prompt for
definePromptAgent. - getPromptName() - Method in class com.google.genkit.agent.AgentConfig
-
Returns the name of a registered prompt to drive
definePromptAgent. - getQuality() - Method in class com.google.genkit.plugins.openai.ImageGenerationConfig
- getQuery() - Method in class com.google.genkit.ai.RetrieverRequest
- getQueryParams() - Method in class com.google.genkit.plugins.compatoai.CompatOAIPluginOptions
-
Gets the query parameters to append to API requests.
- getQuestion() - Method in class com.google.genkit.plugins.evaluators.metrics.AnswerRelevancyResponse
- getRationale() - Method in class com.google.genkit.ai.evaluation.EvalMetric
- getReason() - Method in class com.google.genkit.plugins.evaluators.metrics.MaliciousnessResponse
- getReason() - Method in class com.google.genkit.plugins.evaluators.metrics.NliResponseItem
- getReasoning() - Method in class com.google.genkit.ai.evaluation.ScoreDetails
- getRef() - Method in class com.google.genkit.ai.ToolRequest
- getRef() - Method in class com.google.genkit.ai.ToolResponse
- getReference() - Method in class com.google.genkit.ai.evaluation.DatasetSample
- getReference() - Method in class com.google.genkit.ai.evaluation.EvalDataPoint
- getReference() - Method in class com.google.genkit.ai.evaluation.EvalResult
- getReflectionPort() - Method in class com.google.genkit.GenkitOptions
-
Returns the reflection server port.
- getRegion() - Method in class com.google.genkit.plugins.awsbedrock.AwsBedrockPluginOptions
-
Gets the AWS region.
- getRegion() - Method in class com.google.genkit.plugins.pinecone.PineconeIndexConfig
-
Gets the region for serverless index.
- getRegisteredPartialNames() - Static method in class com.google.genkit.prompt.DotPrompt
-
Returns the names of all registered partials.
- getRegistry() - Method in class com.google.genkit.core.ActionContext
-
Returns the Genkit registry.
- getRegistry() - Method in class com.google.genkit.core.ActionDef
-
Returns the registry this action is registered with.
- getRegistry() - Method in class com.google.genkit.Genkit
-
Gets the registry.
- getRequest() - Method in class com.google.genkit.ai.middleware.GenerateParams
-
Returns the current high-level generate options.
- getRequest() - Method in class com.google.genkit.ai.middleware.ModelParams
-
Returns the model request about to be sent.
- getRequest() - Method in class com.google.genkit.ai.middleware.ToolParams
-
Convenience method: returns the tool request from the request part.
- getRequest() - Method in class com.google.genkit.ai.ModelResponse
- getRequestMetadata() - Method in class com.google.genkit.ai.InterruptConfig
-
Gets the request metadata function.
- getRequestPart() - Method in class com.google.genkit.ai.middleware.ToolParams
-
Returns the full tool request part, including part-level metadata.
- getRequestTimeout() - Method in class com.google.genkit.plugins.mcp.MCPPluginOptions
-
Gets the request timeout.
- getResources() - Method in class com.google.genkit.ai.GenerateActionOptions
- getResources() - Method in class com.google.genkit.plugins.mcp.MCPClient
-
Gets resources from the MCP server.
- getResources(String) - Method in class com.google.genkit.plugins.mcp.MCPPlugin
-
Gets resources from a specific MCP server.
- getRespond() - Method in class com.google.genkit.ai.agent.ToolResume
-
Returns the response parts to resume with.
- getRespond() - Method in class com.google.genkit.ai.ResumeOptions
-
Gets the tool responses for interrupted requests.
- getResponseFormat() - Method in class com.google.genkit.plugins.openai.ImageGenerationConfig
- getResponses() - Method in class com.google.genkit.plugins.evaluators.metrics.NliResponse
- getRestart() - Method in class com.google.genkit.ai.agent.ToolResume
-
Returns the restart parts.
- getRestart() - Method in class com.google.genkit.ai.ResumeOptions
-
Gets the tool requests to restart.
- getResult() - Method in class com.google.genkit.core.ActionRunResult
-
Returns the action result.
- getResults() - Method in class com.google.genkit.ai.evaluation.EvalRun
- getResume() - Method in class com.google.genkit.ai.agent.AgentInput
-
Returns the tool resume data.
- getResume() - Method in class com.google.genkit.ai.GenerateOptions
-
Gets the resume options for continuing after an interrupt.
- getResumed() - Method in class com.google.genkit.core.ActionContext
-
Returns the resume metadata attached when this action is being re-invoked after an interrupt/restart, or
nullon a normal invocation. - getRetriever(String) - Method in class com.google.genkit.Genkit
-
Gets a retriever by name.
- getRetrieverConfigs() - Method in class com.google.genkit.plugins.firebase.FirebasePluginConfig
- getReturnToolRequests() - Method in class com.google.genkit.ai.GenerateActionOptions
- getRole() - Method in class com.google.genkit.ai.Message
- getRole() - Method in class com.google.genkit.ai.ModelResponseChunk
-
Returns the role of the message this chunk contributes to.
- getRuntimeId() - Method in class com.google.genkit.ReflectionServer
-
Gets the runtime ID.
- getRuntimeId() - Method in class com.google.genkit.ReflectionServerV2
-
Gets the runtime ID.
- getSameProcessAsParentSpan() - Method in class com.google.genkit.core.tracing.GenkitSpanData
- getSampleIndex() - Method in class com.google.genkit.ai.evaluation.EvalResponse
- getSchema() - Method in class com.google.genkit.ai.evaluation.CreateDatasetRequest
- getSchema() - Method in class com.google.genkit.ai.evaluation.DatasetMetadata
- getSchema() - Method in class com.google.genkit.ai.evaluation.UpdateDatasetRequest
- getSchema() - Method in class com.google.genkit.ai.OutputConfig
- getSchemaUrl() - Method in class com.google.genkit.core.tracing.GenkitSpanData.InstrumentationScope
- getScore() - Method in class com.google.genkit.ai.evaluation.EvalMetric
- getScore() - Method in class com.google.genkit.ai.evaluation.Score
- getScoreAsBoolean() - Method in class com.google.genkit.ai.evaluation.Score
- getScoreAsDouble() - Method in class com.google.genkit.ai.evaluation.Score
- getScoreAsString() - Method in class com.google.genkit.ai.evaluation.Score
- getScoreId() - Method in class com.google.genkit.ai.evaluation.EvalMetric
- getSeed() - Method in class com.google.genkit.ai.GenerationConfig
- getServerName() - Method in class com.google.genkit.plugins.mcp.MCPClient
-
Gets the server name.
- getServers() - Method in class com.google.genkit.plugins.mcp.MCPPluginOptions
-
Gets the configured MCP servers.
- getSessionId() - Method in class com.google.genkit.ai.agent.AgentInit
-
Returns the session ID.
- getSessionId() - Method in class com.google.genkit.ai.agent.AgentOutput
-
Returns the session ID.
- getSessionId() - Method in class com.google.genkit.ai.agent.GetSnapshotOptions
-
Returns the session ID whose latest leaf snapshot should be retrieved, or
nullif not set. - getSessionId() - Method in class com.google.genkit.ai.agent.GetSnapshotRequest
-
Returns the session ID.
- getSessionId() - Method in class com.google.genkit.ai.agent.SessionSnapshot
-
Returns the session ID.
- getSessionId() - Method in class com.google.genkit.ai.agent.SessionState
-
Returns the session ID.
- getSessionId() - Method in class com.google.genkit.core.ActionContext
-
Returns the session ID for multi-turn conversations.
- getShardSize() - Method in class com.google.genkit.plugins.awsbedrock.session.DynamoDbSessionStoreOptions
-
Returns the shard size in bytes for checkpoint state (default 358400).
- getShardSize() - Method in class com.google.genkit.plugins.azurefoundry.session.CosmosSessionStoreOptions
-
Returns the shard size in bytes for checkpoint state (default 1048576).
- getShardSize() - Method in class com.google.genkit.plugins.firebase.session.FirestoreSessionStoreOptions
-
Returns the shard size in bytes for checkpoint state (default 524288).
- getShardSize() - Method in class com.google.genkit.plugins.mongodb.session.MongoSessionStoreOptions
-
Returns the shard size in bytes for checkpoint state (default 1048576).
- getShardSize() - Method in class com.google.genkit.plugins.postgresql.session.PostgresSessionStoreOptions
-
Returns the shard size in bytes for checkpoint state (default 1048576).
- getSimilarity() - Method in class com.google.genkit.plugins.mongodb.MongoVectorStoreConfig
-
Returns the vector similarity function (default
MongoVectorStoreConfig.Similarity.COSINE). - getSize() - Method in class com.google.genkit.ai.evaluation.DatasetMetadata
- getSize() - Method in class com.google.genkit.plugins.openai.ImageGenerationConfig
- getSnapshot(GetSnapshotOptions) - Method in class com.google.genkit.ai.agent.FileSessionStore
-
Retrieves a session snapshot.
- getSnapshot(GetSnapshotOptions) - Method in class com.google.genkit.ai.agent.InMemorySessionStore
-
Retrieves a session snapshot.
- getSnapshot(GetSnapshotOptions) - Method in interface com.google.genkit.ai.agent.SnapshotReader
-
Retrieves a session snapshot.
- getSnapshot(GetSnapshotOptions) - Method in class com.google.genkit.plugins.awsbedrock.session.DynamoDbSessionStore
-
Retrieves a session snapshot.
- getSnapshot(GetSnapshotOptions) - Method in class com.google.genkit.plugins.azurefoundry.session.CosmosSessionStore
-
Retrieves a session snapshot.
- getSnapshot(GetSnapshotOptions) - Method in class com.google.genkit.plugins.firebase.session.FirestoreSessionStore
-
Retrieves a session snapshot.
- getSnapshot(GetSnapshotOptions) - Method in class com.google.genkit.plugins.mongodb.session.MongoSessionStore
-
Retrieves a session snapshot.
- getSnapshot(GetSnapshotOptions) - Method in class com.google.genkit.plugins.postgresql.session.PostgresSessionStore
-
Retrieves a session snapshot.
- getSnapshot(GetSnapshotRequest) - Method in interface com.google.genkit.ai.agent.AgentTransport
-
Retrieves a session snapshot.
- getSnapshot(GetSnapshotRequest) - Method in class com.google.genkit.ai.agent.internal.InProcessTransport
- getSnapshot(GetSnapshotRequest) - Method in class com.google.genkit.client.HttpAgentTransport
- getSnapshot(String, JsonNode, HttpServletRequest) - Method in class com.google.genkit.plugins.spring.GenkitAgentController
-
Companion endpoint for retrieving a previously-saved agent session snapshot.
- getSnapshotData(GetSnapshotRequest) - Method in class com.google.genkit.ai.agent.Agent
- getSnapshotData(GetSnapshotRequest) - Method in interface com.google.genkit.ai.agent.AgentApi
-
Retrieves a session snapshot by snapshot ID or session ID.
- getSnapshotDataAction() - Method in class com.google.genkit.ai.agent.Agent
-
Returns the companion snapshot action, or
nullif not applicable. - getSnapshotId() - Method in class com.google.genkit.ai.agent.AgentAbortRequest
-
Returns the snapshot ID to abort.
- getSnapshotId() - Method in class com.google.genkit.ai.agent.AgentAbortResponse
-
Returns the snapshot ID.
- getSnapshotId() - Method in class com.google.genkit.ai.agent.AgentInit
-
Returns the snapshot ID.
- getSnapshotId() - Method in class com.google.genkit.ai.agent.AgentOutput
-
Returns the snapshot ID.
- getSnapshotId() - Method in class com.google.genkit.ai.agent.GetSnapshotOptions
-
Returns the specific snapshot ID to retrieve, or
nullif not set. - getSnapshotId() - Method in class com.google.genkit.ai.agent.GetSnapshotRequest
-
Returns the snapshot ID.
- getSnapshotId() - Method in class com.google.genkit.ai.agent.SessionSnapshot
-
Returns the snapshot ID.
- getSnapshotId() - Method in class com.google.genkit.ai.agent.TurnEnd
-
Returns the snapshot ID.
- GetSnapshotOptions - Class in com.google.genkit.ai.agent
-
Options for retrieving a session snapshot.
- GetSnapshotOptions.Builder - Class in com.google.genkit.ai.agent
-
Builder for
GetSnapshotOptions. - getSnapshotPathPrefix() - Method in class com.google.genkit.plugins.awsbedrock.session.DynamoDbSessionStoreOptions
-
Returns the function that derives the per-tenant partition-key prefix from the per-request store options (default
o -> "global"). - getSnapshotPathPrefix() - Method in class com.google.genkit.plugins.azurefoundry.session.CosmosSessionStoreOptions
-
Returns the function that derives the per-tenant partition-key prefix from the per-request store options (default
o -> "global"). - getSnapshotPathPrefix() - Method in class com.google.genkit.plugins.firebase.session.FirestoreSessionStoreOptions
-
Returns the function that derives the per-tenant path prefix from the per-request store options (default
o -> "global"). - getSnapshotPathPrefix() - Method in class com.google.genkit.plugins.mongodb.session.MongoSessionStoreOptions
-
Returns the function that derives the per-tenant prefix from the per-request store options (default
o -> "global"). - getSnapshotPathPrefix() - Method in class com.google.genkit.plugins.postgresql.session.PostgresSessionStoreOptions
-
Returns the function that derives the per-tenant prefix from the per-request store options (default
o -> "global"). - GetSnapshotRequest - Class in com.google.genkit.ai.agent
-
GetSnapshotRequest is the request body for retrieving a session snapshot.
- GetSnapshotRequest() - Constructor for class com.google.genkit.ai.agent.GetSnapshotRequest
-
Default constructor.
- GetSnapshotRequest.Builder - Class in com.google.genkit.ai.agent
-
Builder for GetSnapshotRequest.
- getSnapshotUrl() - Method in class com.google.genkit.client.RemoteAgentOptions
-
Returns the companion getSnapshot URL (defaults to
url + "/getSnapshot"). - getSnapshotUrl(String) - Method in class com.google.genkit.client.RemoteAgentOptions.Builder
-
Overrides the getSnapshot URL.
- getSpanContext() - Method in class com.google.genkit.core.ActionContext
-
Returns the tracing span context.
- getSpanId() - Method in class com.google.genkit.ai.evaluation.EvalMetric
- getSpanId() - Method in class com.google.genkit.ai.evaluation.EvalResponse
- getSpanId() - Method in class com.google.genkit.core.ActionRunResult
-
Returns the span ID for this execution.
- getSpanId() - Method in class com.google.genkit.core.tracing.GenkitSpanData
- getSpanId() - Method in class com.google.genkit.core.tracing.GenkitSpanData.SpanContextData
- getSpanId() - Method in class com.google.genkit.core.tracing.SpanContext
-
Returns the span ID.
- getSpanKind() - Method in class com.google.genkit.core.tracing.GenkitSpanData
- getSpanPath() - Method in class com.google.genkit.core.ActionContext
-
Returns the current span path for tracing.
- getSpans() - Method in class com.google.genkit.core.tracing.TraceData
- getStartTime() - Method in class com.google.genkit.core.tracing.GenkitSpanData
- getStartTime() - Method in class com.google.genkit.core.tracing.TraceData
- getState() - Method in class com.google.genkit.ai.agent.AgentInit
-
Returns the initial session state.
- getState() - Method in class com.google.genkit.ai.agent.AgentOutput
-
Returns the session state.
- getState() - Method in class com.google.genkit.ai.agent.Session
-
Returns a deep copy of the current session state.
- getState() - Method in class com.google.genkit.ai.agent.SessionRunner
-
Returns a deep copy of the current session state.
- getState() - Method in class com.google.genkit.ai.agent.SessionSnapshot
-
Returns the session state at this snapshot.
- getStateManagement() - Method in class com.google.genkit.ai.agent.AgentMetadata
-
Returns the state management mode.
- getStatement() - Method in class com.google.genkit.plugins.evaluators.metrics.NliResponseItem
- getStatements() - Method in class com.google.genkit.plugins.evaluators.metrics.LongFormResponse
- getStateSchema() - Method in class com.google.genkit.ai.agent.AgentMetadata
-
Returns the JSON schema for the agent state, if provided.
- getStateType() - Method in class com.google.genkit.agent.AgentConfig
-
Returns the Java class for the agent's custom state type.
- getStateType() - Method in class com.google.genkit.ai.agent.CustomAgentConfig
-
Returns the Java class for the agent's custom state type.
- getStatus() - Method in class com.google.genkit.ai.agent.AgentAbortResponse
-
Returns the resulting snapshot status.
- getStatus() - Method in class com.google.genkit.ai.agent.RuntimeError
-
Returns the status code of the error.
- getStatus() - Method in class com.google.genkit.ai.agent.SessionSnapshot
-
Returns the snapshot status.
- getStatus() - Method in class com.google.genkit.ai.evaluation.EvalMetric
- getStatus() - Method in class com.google.genkit.ai.evaluation.Score
- getStatus() - Method in class com.google.genkit.core.tracing.GenkitSpanData
- getStatusOverrideFn() - Method in class com.google.genkit.plugins.evaluators.MetricConfig
- getStepName() - Method in class com.google.genkit.ai.GenerateActionOptions
- getStopSequences() - Method in class com.google.genkit.ai.GenerationConfig
- getStore() - Method in class com.google.genkit.agent.AgentConfig
-
Returns the session store for server-managed agents.
- getStore() - Method in class com.google.genkit.ai.agent.CustomAgentConfig
-
Returns the session store for server-managed agents.
- getStoreOptions() - Method in class com.google.genkit.ai.agent.CustomAgentConfig
-
Returns the options forwarded to store operations.
- getStream() - Method in class com.google.genkit.core.Flow.StreamingFlowValue
-
Returns the stream chunk.
- getStreamCallback() - Method in class com.google.genkit.ai.middleware.ModelParams
-
Returns the streaming callback, or null if not streaming.
- getStyle() - Method in class com.google.genkit.plugins.openai.ImageGenerationConfig
- getSubtype() - Method in class com.google.genkit.core.tracing.SpanMetadata
- getSupports() - Method in class com.google.genkit.ai.EmbedderInfo
- getSupports() - Method in class com.google.genkit.ai.ModelInfo
- getSystem() - Method in class com.google.genkit.agent.AgentConfig
-
Returns the system prompt for the agent.
- getSystem() - Method in class com.google.genkit.ai.GenerateOptions
-
Gets the system prompt.
- getSystemRole() - Method in class com.google.genkit.ai.ModelInfo.ModelCapabilities
- getTableName() - Method in class com.google.genkit.plugins.awsbedrock.session.DynamoDbSessionStoreOptions
-
Returns the DynamoDB table name (default "genkit-sessions").
- getTableName() - Method in class com.google.genkit.plugins.postgresql.PostgresTableConfig
-
Gets the table name.
- getTableName() - Method in class com.google.genkit.plugins.postgresql.session.PostgresSessionStoreOptions
-
Returns the PostgreSQL table name (default "genkit_sessions").
- getTargetAction() - Method in class com.google.genkit.ai.evaluation.CreateDatasetRequest
- getTargetAction() - Method in class com.google.genkit.ai.evaluation.DatasetMetadata
- getTargetAction() - Method in class com.google.genkit.ai.evaluation.RunEvaluationRequest
- getTargetAction() - Method in class com.google.genkit.ai.evaluation.UpdateDatasetRequest
- getTelemetry() - Method in class com.google.genkit.plugins.firebase.FirebasePlugin
-
Gets the Firebase telemetry instance.
- getTemperature() - Method in class com.google.genkit.ai.GenerationConfig
- getTemplate() - Method in class com.google.genkit.ai.Prompt
-
Gets the prompt template.
- getTemplate() - Method in class com.google.genkit.prompt.DotPrompt
- getTemplate() - Method in class com.google.genkit.prompt.ExecutablePrompt
-
Gets the template.
- getTestCaseId() - Method in class com.google.genkit.ai.evaluation.DatasetSample
- getTestCaseId() - Method in class com.google.genkit.ai.evaluation.EvalDataPoint
- getTestCaseId() - Method in class com.google.genkit.ai.evaluation.EvalResponse
- getTestCaseId() - Method in class com.google.genkit.ai.evaluation.EvalResult
- getText() - Method in class com.google.genkit.ai.Message
-
Returns the text content from all text parts.
- getText() - Method in class com.google.genkit.ai.ModelResponse
-
Returns the text content from the first candidate's first text part.
- getText() - Method in class com.google.genkit.ai.ModelResponseChunk
-
Returns the text content from all text parts.
- getText() - Method in class com.google.genkit.ai.Part
- getText() - Method in class com.google.genkit.plugins.mcp.MCPResourceContent.ContentPart
-
Gets the text content.
- getText() - Method in class com.google.genkit.plugins.mcp.MCPResourceContent
-
Gets the text content if this resource has a single text part.
- getTextField() - Method in class com.google.genkit.plugins.mongodb.MongoVectorStoreConfig
-
Returns the field that stores the document text (default
text). - getTextField() - Method in class com.google.genkit.plugins.pinecone.PineconeIndexConfig
-
Gets the metadata field name used to store document text.
- getTextPayloadKey() - Method in class com.google.genkit.plugins.qdrant.QdrantCollectionConfig
-
Returns the payload key that stores the document text (default
text). - getThoughtsTokens() - Method in class com.google.genkit.ai.Usage
- getThreadName() - Method in class com.google.genkit.core.ActionContext
-
Returns the thread name for grouping related requests.
- getTime() - Method in class com.google.genkit.core.tracing.GenkitSpanData.TimeEvent
- getTimeEvent() - Method in class com.google.genkit.core.tracing.GenkitSpanData.TimeEvents
- getTimeEvents() - Method in class com.google.genkit.core.tracing.GenkitSpanData
- getTimeout() - Method in class com.google.genkit.plugins.anthropic.AnthropicPluginOptions
-
Gets the request timeout in seconds.
- getTimeout() - Method in class com.google.genkit.plugins.compatoai.CompatOAIPluginOptions
-
Gets the request timeout in seconds.
- getTimeout() - Method in class com.google.genkit.plugins.googlegenai.GoogleGenAIPluginOptions
-
Gets the request timeout in milliseconds.
- getTimeout() - Method in class com.google.genkit.plugins.ollama.OllamaPluginOptions
-
Gets the request timeout in seconds.
- getTimeout() - Method in class com.google.genkit.plugins.openai.OpenAIPluginOptions
-
Gets the request timeout in seconds.
- getToken() - Method in class com.google.genkit.plugins.firebase.functions.AuthContext
- getTool() - Method in class com.google.genkit.ai.middleware.ToolParams
-
Returns the resolved tool being called.
- getToolChoice() - Method in class com.google.genkit.ai.GenerateActionOptions
- getToolChoice() - Method in class com.google.genkit.ai.GenerateOptions
-
Gets the tool choice strategy.
- getToolPrefix() - Method in class com.google.genkit.plugins.middleware.AgentsOptions
-
Returns the tool-name prefix.
- getToolRequest() - Method in class com.google.genkit.ai.InterruptRequest
-
Gets the tool request that was interrupted.
- getToolRequest() - Method in class com.google.genkit.ai.Part
- getToolRequests() - Method in class com.google.genkit.ai.ModelResponse
-
Returns all tool request parts from the first candidate.
- getToolResponse() - Method in class com.google.genkit.ai.Part
- getTools() - Method in class com.google.genkit.agent.AgentConfig
-
Returns the tools available to the agent.
- getTools() - Method in class com.google.genkit.ai.GenerateActionOptions
- getTools() - Method in class com.google.genkit.ai.GenerateOptions
-
Gets the available tools.
- getTools() - Method in class com.google.genkit.ai.ModelInfo.ModelCapabilities
- getTools() - Method in class com.google.genkit.ai.ModelRequest
- getTools() - Method in class com.google.genkit.plugins.mcp.MCPPlugin
-
Gets all tools from all connected MCP servers.
- getTools(Registry) - Method in class com.google.genkit.plugins.mcp.MCPClient
-
Gets tools from the MCP server as Genkit tools.
- getTools(String) - Method in class com.google.genkit.plugins.mcp.MCPPlugin
-
Gets tools from a specific MCP server.
- getTopK() - Method in class com.google.genkit.ai.GenerationConfig
- getTopP() - Method in class com.google.genkit.ai.GenerationConfig
- getTotalTokens() - Method in class com.google.genkit.ai.Usage
- getTrace(String) - Static method in class com.google.genkit.ReflectionServer
-
Gets a trace by ID from the in-memory store.
- getTraceFlags() - Method in class com.google.genkit.core.tracing.GenkitSpanData.SpanContextData
- getTraceId() - Method in class com.google.genkit.ai.evaluation.EvalMetric
- getTraceId() - Method in class com.google.genkit.ai.evaluation.EvalResponse
- getTraceId() - Method in class com.google.genkit.core.ActionRunResult
-
Returns the trace ID for this execution.
- getTraceId() - Method in exception class com.google.genkit.core.GenkitException
-
Returns the trace ID for this error.
- getTraceId() - Method in class com.google.genkit.core.tracing.GenkitSpanData
- getTraceId() - Method in class com.google.genkit.core.tracing.GenkitSpanData.SpanContextData
- getTraceId() - Method in class com.google.genkit.core.tracing.SpanContext
-
Returns the trace ID.
- getTraceId() - Method in class com.google.genkit.core.tracing.TraceData
- getTraceIds() - Method in class com.google.genkit.ai.evaluation.EvalDataPoint
- getTraceIds() - Method in class com.google.genkit.ai.evaluation.EvalResult
- getTransportType() - Method in class com.google.genkit.plugins.mcp.MCPServerConfig
-
Gets the transport type.
- getTurnEnd() - Method in class com.google.genkit.ai.agent.AgentStreamChunk
-
Returns the turn-end signal.
- getType() - Method in class com.google.genkit.ai.agent.Agent
- getType() - Method in class com.google.genkit.ai.Embedder
- getType() - Method in class com.google.genkit.ai.evaluation.Evaluator
- getType() - Method in class com.google.genkit.ai.GenerateAction
- getType() - Method in class com.google.genkit.ai.Indexer
- getType() - Method in interface com.google.genkit.ai.Model
- getType() - Method in class com.google.genkit.ai.Prompt
- getType() - Method in class com.google.genkit.ai.Retriever
- getType() - Method in class com.google.genkit.ai.Tool
- getType() - Method in interface com.google.genkit.core.Action
-
Returns the type of the action.
- getType() - Method in class com.google.genkit.core.ActionDef
- getType() - Method in class com.google.genkit.core.ActionDesc
- getType() - Method in class com.google.genkit.core.BidiActionImpl
- getType() - Method in class com.google.genkit.core.Flow
- getType() - Method in class com.google.genkit.core.tracing.SpanMetadata
- getUid() - Method in class com.google.genkit.plugins.firebase.functions.AuthContext
- getUpdatedAt() - Method in class com.google.genkit.ai.agent.internal.PointerDoc
-
Returns the timestamp when this pointer was last updated.
- getUpdatedAt() - Method in class com.google.genkit.ai.agent.SessionSnapshot
-
Returns the last-update timestamp (RFC-3339).
- getUpdateTime() - Method in class com.google.genkit.ai.evaluation.DatasetMetadata
- getUri() - Method in class com.google.genkit.plugins.mcp.MCPResource
-
Gets the resource URI.
- getUri() - Method in class com.google.genkit.plugins.mcp.MCPResourceContent
-
Gets the resource URI.
- getUrl() - Method in class com.google.genkit.ai.Media
- getUrl() - Method in class com.google.genkit.plugins.mcp.MCPServerConfig
-
Gets the URL for HTTP transport.
- getUsage() - Method in class com.google.genkit.ai.ModelResponse
- getUse() - Method in class com.google.genkit.ai.GenerateActionOptions
- getUse() - Method in class com.google.genkit.ai.GenerateOptions
-
Gets the V2 middleware to apply to this generation.
- getUser() - Method in class com.google.genkit.plugins.openai.ImageGenerationConfig
- getValue() - Method in enum class com.google.genkit.ai.agent.AgentFinishReason
-
Returns the string value of the agent finish reason.
- getValue() - Method in enum class com.google.genkit.ai.agent.SnapshotStatus
-
Returns the string value of the snapshot status.
- getValue() - Method in enum class com.google.genkit.ai.Role
- getValue() - Method in enum class com.google.genkit.core.ActionType
-
Returns the string value of the action type.
- getValue() - Method in class com.google.genkit.core.tracing.GenkitSpanData.BoolValue
- getValue() - Method in enum class com.google.genkit.plugins.chroma.ChromaCollectionConfig.Distance
-
Returns the Chroma
hnsw:spacevalue. - getValue() - Method in enum class com.google.genkit.plugins.milvus.MilvusCollectionConfig.Metric
-
Returns the Milvus metric type name.
- getValue() - Method in enum class com.google.genkit.plugins.mongodb.MongoVectorStoreConfig.Similarity
-
Returns the Atlas Vector Search similarity name.
- getValue() - Method in enum class com.google.genkit.plugins.pinecone.PineconeIndexConfig.Cloud
- getValue() - Method in enum class com.google.genkit.plugins.pinecone.PineconeIndexConfig.Metric
- getValue() - Method in enum class com.google.genkit.plugins.qdrant.QdrantCollectionConfig.Distance
-
Returns the Qdrant distance name.
- getValues() - Method in class com.google.genkit.ai.EmbedResponse.Embedding
- getVariant() - Method in class com.google.genkit.ai.Prompt
-
Gets the prompt variant.
- getVariant() - Method in class com.google.genkit.prompt.DotPrompt
- getVectorDimension() - Method in class com.google.genkit.plugins.postgresql.PostgresTableConfig
-
Gets the vector dimension.
- getVectorDimension() - Method in class com.google.genkit.plugins.weaviate.WeaviateCollectionConfig
- getVectorField() - Method in class com.google.genkit.plugins.firebase.retriever.FirestoreRetrieverConfig
- getVectorStore(String) - Method in class com.google.genkit.plugins.pinecone.PineconePlugin
-
Gets a vector store by index name.
- getVectorStore(String) - Method in class com.google.genkit.plugins.postgresql.PostgresPlugin
-
Gets a vector store by table name.
- getVectorStore(String, String) - Method in class com.google.genkit.plugins.pinecone.PineconePlugin
-
Gets a vector store by index name and namespace.
- getVersion() - Method in class com.google.genkit.ai.agent.Session
-
Returns the current mutation version counter.
- getVersion() - Method in class com.google.genkit.ai.evaluation.DatasetMetadata
- getVersion() - Method in class com.google.genkit.core.tracing.GenkitSpanData.InstrumentationScope
- getVersion() - Method in class com.google.genkit.plugins.mcp.MCPServerOptions
-
Gets the server version.
- getVersions() - Method in class com.google.genkit.ai.ModelInfo
- GoogleGenAIPlugin - Class in com.google.genkit.plugins.googlegenai
-
Google GenAI plugin for Genkit using the official Google GenAI SDK.
- GoogleGenAIPlugin() - Constructor for class com.google.genkit.plugins.googlegenai.GoogleGenAIPlugin
-
Creates a GoogleGenAIPlugin with default options.
- GoogleGenAIPlugin(GoogleGenAIPluginOptions) - Constructor for class com.google.genkit.plugins.googlegenai.GoogleGenAIPlugin
-
Creates a GoogleGenAIPlugin with the specified options.
- GoogleGenAIPluginOptions - Class in com.google.genkit.plugins.googlegenai
-
Options for configuring the Google GenAI plugin.
- GoogleGenAIPluginOptions.Builder - Class in com.google.genkit.plugins.googlegenai
-
Builder for GoogleGenAIPluginOptions.
- GroqPlugin - Class in com.google.genkit.plugins.groq
-
GroqPlugin provides Groq model integrations for Genkit.
- GroqPlugin() - Constructor for class com.google.genkit.plugins.groq.GroqPlugin
-
Creates a GroqPlugin with default options (using GROQ_API_KEY environment variable).
- GroqPlugin(CompatOAIPluginOptions) - Constructor for class com.google.genkit.plugins.groq.GroqPlugin
-
Creates a GroqPlugin with the specified options.
- grpcPort(int) - Method in class com.google.genkit.plugins.weaviate.WeaviatePlugin.Builder
-
Sets the gRPC port.
H
- handle(ActionContext, Init, InputSource<I>, Consumer<S>) - Method in interface com.google.genkit.core.BidiAction.BidiHandler
-
Handles one invocation of the bidirectional action.
- handle(I, ActionContext, MiddlewareNext<I, O>) - Method in interface com.google.genkit.core.middleware.Middleware
-
Deprecated.Processes the request through this middleware.
- handler(BidiAction.BidiHandler<I, O, S, Init>) - Method in class com.google.genkit.core.BidiActionImpl.Builder
- handler(BiFunction<ActionContext, EmbedRequest, EmbedResponse>) - Method in class com.google.genkit.ai.Embedder.Builder
- handler(BiFunction<ActionContext, IndexerRequest, IndexerResponse>) - Method in class com.google.genkit.ai.Indexer.Builder
- handler(BiFunction<ActionContext, RetrieverRequest, RetrieverResponse>) - Method in class com.google.genkit.ai.Retriever.Builder
- handler(BiFunction<ActionContext, I, O>) - Method in class com.google.genkit.ai.Tool.Builder
- hasClaim(String) - Method in class com.google.genkit.plugins.firebase.functions.AuthContext
-
Checks if a claim exists and is truthy.
- hasClaim(String) - Static method in class com.google.genkit.plugins.firebase.functions.OnCallGenkit
-
Predefined authorization policy that requires a specific claim.
- hasParent() - Method in class com.google.genkit.core.tracing.SpanContext
-
Returns true if this span has a parent.
- headers() - Method in class com.google.genkit.client.RemoteAgentOptions
-
Returns extra HTTP request headers sent on every request.
- headers(Map<String, String>) - Method in class com.google.genkit.client.RemoteAgentOptions.Builder
-
Sets extra HTTP request headers.
- health() - Method in class com.google.genkit.plugins.spring.GenkitFlowController
-
Health check endpoint.
- heartbeatAt(String) - Method in class com.google.genkit.ai.agent.SessionSnapshot.Builder
- hikariProperty(String, Object) - Method in class com.google.genkit.plugins.postgresql.PostgresPlugin.Builder
-
Sets a HikariCP connection pool property.
- History forwarding - Search tag in class com.google.genkit.plugins.middleware.Agents
- Section
- History forwarding (per parent-session, per-sub-agent) - Search tag in class com.google.genkit.plugins.middleware.internal.Delegation
- Section
- historyLength(int) - Method in class com.google.genkit.plugins.middleware.AgentsOptions.Builder
-
Sets the trailing parent-history length to forward (
0= task only). - host(String) - Method in class com.google.genkit.plugins.jetty.JettyPluginOptions.Builder
- host(String) - Method in class com.google.genkit.plugins.spring.SpringPluginOptions.Builder
- host(String) - Method in class com.google.genkit.plugins.weaviate.WeaviatePlugin.Builder
-
Sets the Weaviate host.
- http(String) - Static method in class com.google.genkit.plugins.mcp.MCPServerConfig
-
Creates an HTTP server configuration.
- http(String, String) - Static method in class com.google.genkit.plugins.mcp.MCPPlugin
-
Creates an MCP plugin with a single HTTP server.
- HTTP - Enum constant in enum class com.google.genkit.plugins.mcp.MCPServerConfig.TransportType
-
HTTP transport with SSE for streaming.
- HttpAgentTransport<S> - Class in com.google.genkit.client
-
HTTP implementation of
AgentTransportthat speaks the JettyAgentHandlerwire format. - HttpAgentTransport(RemoteAgentOptions) - Constructor for class com.google.genkit.client.HttpAgentTransport
-
Constructs an
HttpAgentTransport. - HttpTelemetryClient - Class in com.google.genkit.core.tracing
-
HTTP-based telemetry client that sends traces to the Genkit telemetry server.
- HttpTelemetryClient(String) - Constructor for class com.google.genkit.core.tracing.HttpTelemetryClient
-
Creates a new HTTP telemetry client.
I
- id(String) - Method in class com.google.genkit.ai.evaluation.Score.Builder
- idColumn(String) - Method in class com.google.genkit.plugins.postgresql.PostgresTableConfig.Builder
-
Sets the ID column name (default: "id").
- ImageGenerationConfig - Class in com.google.genkit.plugins.openai
-
Configuration options for OpenAI image generation models (DALL-E, gpt-image).
- ImageGenerationConfig() - Constructor for class com.google.genkit.plugins.openai.ImageGenerationConfig
-
Default constructor.
- ImageGenerationConfig.Builder - Class in com.google.genkit.plugins.openai
-
Builder for ImageGenerationConfig.
- ImagenModel - Class in com.google.genkit.plugins.googlegenai
-
Imagen model implementation for image generation using the official Google GenAI SDK.
- ImagenModel(String, GoogleGenAIPluginOptions) - Constructor for class com.google.genkit.plugins.googlegenai.ImagenModel
-
Creates a new ImagenModel.
- index(ActionContext, IndexerRequest) - Method in class com.google.genkit.plugins.chroma.ChromaVectorStore
-
Indexes documents into the collection, generating an embedding for each.
- index(ActionContext, IndexerRequest) - Method in class com.google.genkit.plugins.firebase.retriever.FirestoreVectorStore
-
Indexes documents into Firestore with their embeddings.
- index(ActionContext, IndexerRequest) - Method in class com.google.genkit.plugins.milvus.MilvusVectorStore
-
Indexes documents into the collection, generating an embedding for each.
- index(ActionContext, IndexerRequest) - Method in class com.google.genkit.plugins.mongodb.MongoVectorStore
-
Indexes documents into the collection, generating an embedding for each.
- index(ActionContext, IndexerRequest) - Method in class com.google.genkit.plugins.pinecone.PineconeVectorStore
-
Indexes documents into the vector store.
- index(ActionContext, IndexerRequest) - Method in class com.google.genkit.plugins.postgresql.PostgresVectorStore
-
Indexes documents into the vector store.
- index(ActionContext, IndexerRequest) - Method in class com.google.genkit.plugins.qdrant.QdrantVectorStore
-
Indexes documents into the collection, generating an embedding for each.
- index(ActionContext, IndexerRequest) - Method in class com.google.genkit.plugins.weaviate.WeaviateVectorStore
-
Indexes documents into Weaviate with their embeddings.
- index(ActionContext, List<Document>) - Method in class com.google.genkit.plugins.localvec.LocalVecDocStore
-
Indexes documents with their embeddings.
- index(String, List<Document>) - Method in class com.google.genkit.Genkit
-
Indexes documents using the specified indexer.
- Indexer - Class in com.google.genkit.ai
-
Indexer is an action that indexes documents into a vector store.
- Indexer(String, BiFunction<ActionContext, IndexerRequest, IndexerResponse>) - Constructor for class com.google.genkit.ai.Indexer
-
Creates a new Indexer.
- INDEXER - Enum constant in enum class com.google.genkit.core.ActionType
-
An indexer action that indexes documents into a vector store.
- Indexer.Builder - Class in com.google.genkit.ai
-
Builder for Indexer.
- IndexerRequest - Class in com.google.genkit.ai
-
Request to index documents into a vector store.
- IndexerRequest() - Constructor for class com.google.genkit.ai.IndexerRequest
-
Default constructor.
- IndexerRequest(List<Document>) - Constructor for class com.google.genkit.ai.IndexerRequest
-
Creates a request with documents.
- IndexerRequest(List<Document>, Object) - Constructor for class com.google.genkit.ai.IndexerRequest
-
Creates a request with documents and options.
- IndexerResponse - Class in com.google.genkit.ai
-
Response from an indexer operation.
- IndexerResponse() - Constructor for class com.google.genkit.ai.IndexerResponse
-
Default constructor.
- indexLists(int) - Method in class com.google.genkit.plugins.postgresql.PostgresTableConfig.Builder
-
Sets the number of lists for IVFFlat index (default: 100).
- indexName(String) - Method in class com.google.genkit.plugins.localvec.LocalVecConfig.Builder
-
Sets the index name.
- indexName(String) - Method in class com.google.genkit.plugins.mongodb.MongoVectorStoreConfig.Builder
-
Sets the Atlas Vector Search index name.
- indexName(String) - Method in class com.google.genkit.plugins.pinecone.PineconeIndexConfig.Builder
-
Sets the index name (required).
- inferSchema(Class<?>) - Static method in class com.google.genkit.core.SchemaUtils
-
Generates a JSON Schema for the given class.
- info(EmbedderInfo) - Method in class com.google.genkit.ai.Embedder.Builder
- init() - Method in interface com.google.genkit.core.Plugin
-
Initializes the plugin.
- init() - Method in class com.google.genkit.Genkit
-
Initializes plugins.
- init() - Method in class com.google.genkit.plugins.anthropic.AnthropicPlugin
- init() - Method in class com.google.genkit.plugins.awsbedrock.AwsBedrockPlugin
- init() - Method in class com.google.genkit.plugins.azurefoundry.AzureFoundryPlugin
- init() - Method in class com.google.genkit.plugins.chroma.ChromaPlugin
- init() - Method in class com.google.genkit.plugins.cohere.CoherePlugin
- init() - Method in class com.google.genkit.plugins.compatoai.CompatOAIPlugin
- init() - Method in class com.google.genkit.plugins.deepseek.DeepSeekPlugin
- init() - Method in class com.google.genkit.plugins.evaluators.EvaluatorsPlugin
- init() - Method in class com.google.genkit.plugins.firebase.FirebasePlugin
- init() - Method in class com.google.genkit.plugins.googlegenai.GoogleGenAIPlugin
- init() - Method in class com.google.genkit.plugins.groq.GroqPlugin
- init() - Method in class com.google.genkit.plugins.jetty.JettyPlugin
- init() - Method in class com.google.genkit.plugins.localvec.LocalVecPlugin
- init() - Method in class com.google.genkit.plugins.mcp.MCPPlugin
- init() - Method in class com.google.genkit.plugins.middleware.GenerationMiddlewarePlugin
- init() - Method in class com.google.genkit.plugins.milvus.MilvusPlugin
- init() - Method in class com.google.genkit.plugins.mistral.MistralPlugin
- init() - Method in class com.google.genkit.plugins.mongodb.MongoPlugin
- init() - Method in class com.google.genkit.plugins.ollama.OllamaPlugin
- init() - Method in class com.google.genkit.plugins.openai.OpenAIPlugin
- init() - Method in class com.google.genkit.plugins.pinecone.PineconePlugin
- init() - Method in class com.google.genkit.plugins.postgresql.PostgresPlugin
- init() - Method in class com.google.genkit.plugins.qdrant.QdrantPlugin
- init() - Method in class com.google.genkit.plugins.spring.SpringPlugin
- init() - Method in class com.google.genkit.plugins.weaviate.WeaviatePlugin
- init() - Method in class com.google.genkit.plugins.xai.XAIPlugin
- init(Registry) - Method in interface com.google.genkit.core.Plugin
-
Initializes the plugin with access to the registry.
- init(Registry) - Method in class com.google.genkit.plugins.chroma.ChromaPlugin
- init(Registry) - Method in class com.google.genkit.plugins.evaluators.EvaluatorsPlugin
- init(Registry) - Method in class com.google.genkit.plugins.firebase.FirebasePlugin
- init(Registry) - Method in class com.google.genkit.plugins.jetty.JettyPlugin
- init(Registry) - Method in class com.google.genkit.plugins.localvec.LocalVecPlugin
- init(Registry) - Method in class com.google.genkit.plugins.mcp.MCPPlugin
- init(Registry) - Method in class com.google.genkit.plugins.milvus.MilvusPlugin
- init(Registry) - Method in class com.google.genkit.plugins.mongodb.MongoPlugin
- init(Registry) - Method in class com.google.genkit.plugins.pinecone.PineconePlugin
- init(Registry) - Method in class com.google.genkit.plugins.postgresql.PostgresPlugin
- init(Registry) - Method in class com.google.genkit.plugins.qdrant.QdrantPlugin
- init(Registry) - Method in class com.google.genkit.plugins.spring.SpringPlugin
- init(Registry) - Method in class com.google.genkit.plugins.weaviate.WeaviatePlugin
- initClass(Class<Init>) - Method in class com.google.genkit.core.BidiActionImpl.Builder
- initialDelayMs - Variable in class com.google.genkit.plugins.middleware.RetryMiddleware.Options
- initialize() - Method in class com.google.genkit.plugins.pinecone.PineconeVectorStore
-
Initializes the vector store by connecting to or creating the index.
- initialize() - Method in class com.google.genkit.plugins.postgresql.PostgresVectorStore
-
Initializes the vector store by creating the table and index if needed.
- INLINE - Enum constant in enum class com.google.genkit.plugins.middleware.ArtifactStrategy
-
Include each sub-agent artifact's text content inline in the delegation tool result (in addition to merging it into the parent session).
- InMemorySessionStore<S> - Class in com.google.genkit.ai.agent
-
Reference in-memory implementation of
SessionStoreandSnapshotSubscriber. - InMemorySessionStore() - Constructor for class com.google.genkit.ai.agent.InMemorySessionStore
-
Creates a new
InMemorySessionStorewithrejectBranchingdefaulting to false. - InMemorySessionStore(boolean) - Constructor for class com.google.genkit.ai.agent.InMemorySessionStore
-
Creates a new
InMemorySessionStore. - INNER_PRODUCT - Enum constant in enum class com.google.genkit.plugins.chroma.ChromaCollectionConfig.Distance
- INNER_PRODUCT - Enum constant in enum class com.google.genkit.plugins.milvus.MilvusCollectionConfig.Metric
- INNER_PRODUCT - Enum constant in enum class com.google.genkit.plugins.postgresql.PostgresTableConfig.DistanceStrategy
-
Inner product (negative dot product for distance).
- InProcessTransport<S> - Class in com.google.genkit.ai.agent.internal
-
In-process
AgentTransportthat drives a locally-definedAgentvia its bidi action. - InProcessTransport(Agent<S>, ActionContext) - Constructor for class com.google.genkit.ai.agent.internal.InProcessTransport
-
Constructs an in-process transport.
- input() - Method in class com.google.genkit.ai.agent.AgentInterrupt
-
Returns the interrupted tool's input.
- input(Object) - Method in class com.google.genkit.ai.evaluation.DatasetSample.Builder
- input(Object) - Method in class com.google.genkit.ai.evaluation.EvalDataPoint.Builder
- input(Object) - Method in class com.google.genkit.ai.evaluation.EvalResult.Builder
- inputClass(Class<I>) - Method in class com.google.genkit.ai.Prompt.Builder
- inputClass(Class<I>) - Method in class com.google.genkit.ai.Tool.Builder
- inputClass(Class<I>) - Method in class com.google.genkit.core.BidiActionImpl.Builder
- inputSchema(Map<String, Object>) - Method in class com.google.genkit.ai.InterruptConfig.Builder
-
Sets the input schema.
- inputSchema(Map<String, Object>) - Method in class com.google.genkit.ai.Prompt.Builder
- inputSchema(Map<String, Object>) - Method in class com.google.genkit.ai.Tool.Builder
- inputSchema(Map<String, Object>) - Method in class com.google.genkit.core.ActionDesc.Builder
- inputSchema(Map<String, Object>) - Method in class com.google.genkit.core.BidiActionImpl.Builder
- InputSource<I> - Interface in com.google.genkit.core
-
A blocking pull source of inputs for a bidirectional action.
- inputType(Class<I>) - Method in class com.google.genkit.ai.InterruptConfig.Builder
-
Sets the input type class.
- instantiate(JsonNode) - Method in interface com.google.genkit.ai.middleware.GenerationMiddlewareDesc
-
Instantiates a fresh
GenerationMiddleware(hooks bundle) bound to the given configuration. - InstrumentationScope() - Constructor for class com.google.genkit.core.tracing.GenkitSpanData.InstrumentationScope
- InstrumentationScope(String, String) - Constructor for class com.google.genkit.core.tracing.GenkitSpanData.InstrumentationScope
- integerSchema() - Static method in class com.google.genkit.core.SchemaUtils
-
Creates a schema for an integer type.
- InterruptConfig<I,
O> - Class in com.google.genkit.ai -
Configuration for defining an interrupt tool.
- InterruptConfig() - Constructor for class com.google.genkit.ai.InterruptConfig
-
Default constructor.
- InterruptConfig.Builder<I,
O> - Class in com.google.genkit.ai -
Builder for InterruptConfig.
- INTERRUPTED - Enum constant in enum class com.google.genkit.ai.agent.AgentFinishReason
-
The agent execution was interrupted.
- INTERRUPTED - Enum constant in enum class com.google.genkit.ai.FinishReason
- InterruptRequest - Class in com.google.genkit.ai
-
Represents an interrupt request from a tool.
- InterruptRequest(ToolRequest, Map<String, Object>) - Constructor for class com.google.genkit.ai.InterruptRequest
-
Creates a new InterruptRequest.
- interrupts() - Method in class com.google.genkit.ai.agent.AgentResponse
-
Returns the interrupts for this turn.
- interrupts(List<Part>) - Method in class com.google.genkit.ai.ModelResponse.Builder
- isAbortable() - Method in class com.google.genkit.ai.agent.AgentMetadata
-
Returns whether the agent supports abort.
- isAborted() - Method in class com.google.genkit.ai.agent.AgentFnContext
-
Convenience method to check whether the abort signal has been set.
- isAnswered() - Method in class com.google.genkit.plugins.evaluators.metrics.AnswerRelevancyResponse
- isAuthorized(AuthContext) - Method in interface com.google.genkit.plugins.firebase.functions.OnCallGenkit.AuthPolicy
-
Checks if the request is authorized.
- isBilled() - Method in enum class com.google.genkit.plugins.evaluators.GenkitMetric
-
Returns whether using this metric may incur API costs.
- isBilled(boolean) - Method in class com.google.genkit.ai.evaluation.Evaluator.Builder
- isBilled(Boolean) - Method in class com.google.genkit.ai.evaluation.EvaluatorInfo.Builder
- isBinary() - Method in class com.google.genkit.plugins.mcp.MCPResourceContent.ContentPart
-
Checks if this part is binary.
- isChild() - Method in class com.google.genkit.core.DefaultRegistry
- isChild() - Method in interface com.google.genkit.core.Registry
-
Returns true if this registry is a child of another registry.
- isConfigured() - Method in class com.google.genkit.core.tracing.TelemetryServerExporter
-
Returns true if the exporter is configured with a client.
- isConnected() - Method in class com.google.genkit.plugins.mcp.MCPClient
-
Checks if connected to the MCP server.
- isCreateCollectionIfMissing() - Method in class com.google.genkit.plugins.weaviate.WeaviateCollectionConfig
- isCreateCollectionIfNotExists() - Method in class com.google.genkit.plugins.chroma.ChromaCollectionConfig
-
Returns whether to create the collection on first use if it does not exist (default
true). - isCreateCollectionIfNotExists() - Method in class com.google.genkit.plugins.milvus.MilvusCollectionConfig
-
Returns whether to create the collection on first use if it does not exist (default
true). - isCreateCollectionIfNotExists() - Method in class com.google.genkit.plugins.qdrant.QdrantCollectionConfig
-
Returns whether to create the collection on first use if it does not exist (default
true). - isCreateDatabaseIfNotExists() - Method in class com.google.genkit.plugins.firebase.retriever.FirestoreRetrieverConfig
-
Returns whether to create the database if it doesn't exist.
- isCreateIfNotExists() - Method in class com.google.genkit.plugins.azurefoundry.session.CosmosSessionStoreOptions
-
Returns whether the store should create the database and container on first use if they do not exist (default
false). - isCreateIndexIfNotExists() - Method in class com.google.genkit.plugins.mongodb.MongoVectorStoreConfig
-
Returns whether to create the Atlas Vector Search index on first use if it does not exist (default
false). - isCreateIndexIfNotExists() - Method in class com.google.genkit.plugins.pinecone.PineconeIndexConfig
-
Returns whether to create the index if it doesn't exist.
- isCreateIndexIfNotExists() - Method in class com.google.genkit.plugins.postgresql.PostgresTableConfig
-
Returns whether to create the index if it doesn't exist.
- isCreateTableIfNotExists() - Method in class com.google.genkit.plugins.awsbedrock.session.DynamoDbSessionStoreOptions
-
Returns whether the store should create the table on first use if it does not exist (default
false). - isCreateTableIfNotExists() - Method in class com.google.genkit.plugins.postgresql.PostgresTableConfig
-
Returns whether to create the table if it doesn't exist.
- isCreateTableIfNotExists() - Method in class com.google.genkit.plugins.postgresql.session.PostgresSessionStoreOptions
-
Returns whether the store should create the table on first use if it does not exist (default
false). - isCreateVectorIndexIfNotExists() - Method in class com.google.genkit.plugins.firebase.retriever.FirestoreRetrieverConfig
-
Returns whether to create the vector index if it doesn't exist.
- isData() - Method in class com.google.genkit.ai.Part
-
Returns true if this is a data part.
- isDetach() - Method in class com.google.genkit.ai.agent.AgentInput
-
Returns whether the agent should detach.
- isDevMode() - Method in class com.google.genkit.GenkitOptions
-
Returns whether dev mode is enabled.
- isDisabled() - Method in class com.google.genkit.plugins.mcp.MCPServerConfig
-
Whether this server is disabled.
- isDone() - Method in class com.google.genkit.core.Flow.StreamingFlowValue
-
Returns true if this is the final output.
- isEmailVerified() - Method in class com.google.genkit.plugins.firebase.functions.AuthContext
- isEmpty() - Method in class com.google.genkit.core.middleware.MiddlewareChain
-
Checks if the chain is empty.
- isEnabled() - Method in class com.google.genkit.plugins.firebase.telemetry.FirebaseTelemetry
-
Checks if telemetry is enabled.
- isEnableTelemetry() - Method in class com.google.genkit.plugins.firebase.FirebasePluginConfig
- isEndRequired() - Method in class com.google.genkit.core.tracing.TelemetryServerExporter
- isEndRequired() - Method in class com.google.genkit.LocalTelemetryStore
- isExperimental() - Method in class com.google.genkit.Genkit
-
Returns whether experimental features are enabled for this instance.
- isExperimental() - Method in class com.google.genkit.GenkitOptions
-
Returns whether experimental features (such as the beta agent APIs) are enabled.
- isForceDevExport() - Method in class com.google.genkit.plugins.firebase.FirebasePluginConfig
- isInitialized() - Method in class com.google.genkit.plugins.mcp.MCPPlugin
-
Checks if the plugin is initialized.
- isInterrupt() - Method in class com.google.genkit.ai.InterruptRequest
-
Checks if this is an interrupt.
- isInterrupted() - Method in class com.google.genkit.ai.ModelResponse
-
Checks if generation was interrupted.
- isMedia() - Method in class com.google.genkit.ai.Part
-
Returns true if this is a media part.
- isMeterProviderConfigured() - Static method in class com.google.genkit.core.telemetry.TelemetryConfig
-
Checks if a custom MeterProvider has been configured.
- isNoncommittal() - Method in class com.google.genkit.plugins.evaluators.metrics.AnswerRelevancyResponse
- isOk() - Method in class com.google.genkit.ai.agent.internal.SessionResolver.Resolution
-
Returns
trueif this is a successful resolution with a ready session. - isRawToolResponses() - Method in class com.google.genkit.plugins.mcp.MCPPluginOptions
-
Whether to return raw MCP tool responses.
- isReadonly() - Method in class com.google.genkit.plugins.middleware.ArtifactsOptions
-
Returns whether artifact writing is disabled.
- isRemote() - Method in class com.google.genkit.core.tracing.GenkitSpanData.SpanContextData
- isResumed() - Method in class com.google.genkit.core.ActionContext
-
Returns
trueif this action is being re-invoked after an interrupt/restart (i.e. - isRunning() - Method in interface com.google.genkit.core.ServerPlugin
-
Returns true if the server is currently running.
- isRunning() - Method in class com.google.genkit.plugins.jetty.JettyPlugin
-
Returns true if the server is currently running.
- isRunning() - Method in class com.google.genkit.plugins.mcp.MCPServer
-
Checks if the server is running.
- isRunning() - Method in class com.google.genkit.plugins.spring.SpringPlugin
-
Returns true if the server is currently running.
- isStartRequired() - Method in class com.google.genkit.core.tracing.TelemetryServerExporter
- isStartRequired() - Method in class com.google.genkit.LocalTelemetryStore
- isTelemetryConfigured() - Static method in class com.google.genkit.core.tracing.Tracer
-
Returns true if the telemetry exporter is configured.
- isText() - Method in class com.google.genkit.ai.Part
-
Returns true if this is a text part.
- isText() - Method in class com.google.genkit.plugins.mcp.MCPResourceContent.ContentPart
-
Checks if this part is text.
- isToolRequest() - Method in class com.google.genkit.ai.Part
-
Returns true if this is a tool request part.
- isToolResponse() - Method in class com.google.genkit.ai.Part
-
Returns true if this is a tool response part.
- isTtsModel(String) - Static method in class com.google.genkit.plugins.googlegenai.TtsModel
-
Checks if the given model name is a supported TTS model.
- isVeoModel(String) - Static method in class com.google.genkit.plugins.googlegenai.VeoModel
-
Checks if the given model name is a supported Veo model.
- isVerdict() - Method in class com.google.genkit.plugins.evaluators.metrics.MaliciousnessResponse
- isVerdict() - Method in class com.google.genkit.plugins.evaluators.metrics.NliResponseItem
- isVertexAI() - Method in class com.google.genkit.plugins.googlegenai.GoogleGenAIPluginOptions
-
Returns whether to use Vertex AI backend.
J
- JettyPlugin - Class in com.google.genkit.plugins.jetty
-
JettyPlugin provides HTTP endpoints for Genkit flows.
- JettyPlugin() - Constructor for class com.google.genkit.plugins.jetty.JettyPlugin
-
Creates a JettyPlugin with default options.
- JettyPlugin(JettyPluginOptions) - Constructor for class com.google.genkit.plugins.jetty.JettyPlugin
-
Creates a JettyPlugin with the specified options.
- JettyPluginOptions - Class in com.google.genkit.plugins.jetty
-
Options for configuring the Jetty plugin.
- JettyPluginOptions.Builder - Class in com.google.genkit.plugins.jetty
-
Builder for JettyPluginOptions.
- json(Map<String, Object>) - Static method in class com.google.genkit.ai.OutputConfig
-
Creates an OutputConfig for JSON output with schema.
- JSON - Enum constant in enum class com.google.genkit.ai.OutputFormat
- JSONATA - Enum constant in enum class com.google.genkit.plugins.evaluators.GenkitMetric
-
Evaluates output using JSONata expressions.
- JsonataMetric - Class in com.google.genkit.plugins.evaluators.metrics
-
JSONata metric evaluator.
- JsonataMetric() - Constructor for class com.google.genkit.plugins.evaluators.metrics.JsonataMetric
- JsonPatch - Class in com.google.genkit.core.jsonpatch
-
A tiny, dependency-free RFC 6902 (JSON Patch) implementation operating on Jackson
JsonNode. - JsonUtils - Class in com.google.genkit.core
-
JsonUtils provides JSON serialization and deserialization utilities for Genkit.
- judge(String) - Method in class com.google.genkit.plugins.evaluators.EvaluatorsPluginOptions.Builder
- judge(String) - Method in class com.google.genkit.plugins.evaluators.MetricConfig.Builder
- judgeConfig(Map<String, Object>) - Method in class com.google.genkit.plugins.evaluators.EvaluatorsPluginOptions.Builder
- judgeConfig(Map<String, Object>) - Method in class com.google.genkit.plugins.evaluators.MetricConfig.Builder
K
- key(EvalRunKey) - Method in class com.google.genkit.ai.evaluation.EvalRun.Builder
- keyFromName(String) - Method in enum class com.google.genkit.core.ActionType
-
Creates the registry key for an action of this type with the given name.
L
- L2 - Enum constant in enum class com.google.genkit.plugins.chroma.ChromaCollectionConfig.Distance
- L2 - Enum constant in enum class com.google.genkit.plugins.milvus.MilvusCollectionConfig.Metric
- L2 - Enum constant in enum class com.google.genkit.plugins.postgresql.PostgresTableConfig.DistanceStrategy
-
L2 (Euclidean) distance.
- L2_SQUARED - Enum constant in enum class com.google.genkit.plugins.weaviate.WeaviateCollectionConfig.DistanceMeasure
-
L2 (Euclidean) distance.
- label(String) - Method in class com.google.genkit.plugins.firebase.retriever.FirestoreRetrieverConfig.Builder
-
Sets the display label for the Developer UI.
- label(String) - Method in class com.google.genkit.plugins.weaviate.WeaviateCollectionConfig.Builder
-
Sets the collection label for display.
- lastGoodState() - Method in class com.google.genkit.ai.agent.SessionRunner
-
Returns the session state as of the last successful turn, or
nullif no successful turn has completed. - lastSnapshot() - Method in class com.google.genkit.ai.agent.SessionRunner
-
Returns the last persisted (or in-memory) snapshot, or
nullif no turn has completed. - lastSnapshotId() - Method in class com.google.genkit.ai.agent.SessionRunner
-
Returns the ID of the last snapshot, or
nullif no turn has completed. - lastTurnError() - Method in class com.google.genkit.ai.agent.SessionRunner
-
Returns the error from the last failed turn, or
nullif the last turn succeeded. - lastTurnFinishReason() - Method in class com.google.genkit.ai.agent.SessionRunner
-
Returns the finish reason of the last completed turn.
- latencyMs(Long) - Method in class com.google.genkit.ai.ModelResponse.Builder
- LeafSelection - Class in com.google.genkit.ai.agent.internal
-
Utility for selecting the leaf snapshot from a collection of snapshots in a session's parent-chain.
- LENGTH - Enum constant in enum class com.google.genkit.ai.agent.AgentFinishReason
-
The agent finished due to reaching token length limits.
- LENGTH - Enum constant in enum class com.google.genkit.ai.FinishReason
- Link() - Constructor for class com.google.genkit.core.tracing.GenkitSpanData.Link
- list() - Method in interface com.google.genkit.ai.evaluation.EvalStore
-
Lists all evaluation run keys.
- list() - Method in class com.google.genkit.ai.evaluation.LocalFileEvalStore
- list(String, String) - Method in interface com.google.genkit.ai.evaluation.EvalStore
-
Lists evaluation run keys with optional filtering.
- list(String, String) - Method in class com.google.genkit.ai.evaluation.LocalFileEvalStore
- listActions() - Method in class com.google.genkit.core.DefaultRegistry
- listActions() - Method in interface com.google.genkit.core.DynamicPlugin
-
Returns a list of action descriptors that the plugin is capable of resolving.
- listActions() - Method in interface com.google.genkit.core.Registry
-
Returns a list of all registered actions.
- listActions(ActionType) - Method in class com.google.genkit.core.DefaultRegistry
- listActions(ActionType) - Method in interface com.google.genkit.core.Registry
-
Returns a list of all registered actions of the specified type.
- listDatasets() - Method in interface com.google.genkit.ai.evaluation.DatasetStore
-
Lists all datasets.
- listDatasets() - Method in class com.google.genkit.ai.evaluation.LocalFileDatasetStore
- listFlows() - Method in class com.google.genkit.plugins.spring.GenkitFlowController
-
Lists all available flows.
- listPlugins() - Method in class com.google.genkit.core.DefaultRegistry
- listPlugins() - Method in interface com.google.genkit.core.Registry
-
Returns a list of all registered plugins.
- listValues() - Method in class com.google.genkit.core.DefaultRegistry
- listValues() - Method in interface com.google.genkit.core.Registry
-
Returns a map of all registered values in the default type bucket.
- listValues(String) - Method in class com.google.genkit.core.DefaultRegistry
- listValues(String) - Method in interface com.google.genkit.core.Registry
-
Returns a map of all registered values under the given type bucket.
- load(String) - Method in interface com.google.genkit.ai.evaluation.EvalStore
-
Loads an evaluation run by ID.
- load(String) - Method in class com.google.genkit.ai.evaluation.LocalFileEvalStore
- loadAndRender(String, Map<String, String>) - Static method in class com.google.genkit.plugins.evaluators.metrics.PromptUtils
-
Loads and renders a prompt template.
- loadChat(GetSnapshotRequest) - Method in class com.google.genkit.ai.agent.Agent
- loadChat(GetSnapshotRequest) - Method in interface com.google.genkit.ai.agent.AgentApi
-
Loads a snapshot and hydrates an
AgentChatwhose next send resumes it, using a default action context built from the registry the agent was defined in. - loadChat(ActionContext, GetSnapshotRequest) - Method in class com.google.genkit.ai.agent.Agent
- loadChat(ActionContext, GetSnapshotRequest) - Method in interface com.google.genkit.ai.agent.AgentApi
-
Loads a snapshot and hydrates an
AgentChatwhose next send resumes it. - loadFromResource(String) - Static method in class com.google.genkit.prompt.DotPrompt
-
Loads a DotPrompt from a resource file.
- loadPartialFromResource(String) - Static method in class com.google.genkit.prompt.DotPrompt
-
Loads and registers a partial from a resource file.
- loadPrompt(String) - Static method in class com.google.genkit.plugins.evaluators.metrics.PromptUtils
-
Loads a prompt template from the classpath.
- local() - Static method in class com.google.genkit.plugins.weaviate.WeaviatePlugin
-
Creates a simple WeaviatePlugin for local development on default port.
- local(String) - Static method in class com.google.genkit.plugins.weaviate.WeaviatePlugin
-
Creates a simple WeaviatePlugin for local development.
- local(String, String, String) - Static method in class com.google.genkit.plugins.postgresql.PostgresPlugin.Builder
-
Creates a builder configured for a local PostgreSQL instance.
- LocalFileDatasetStore - Class in com.google.genkit.ai.evaluation
-
File-based implementation of DatasetStore.
- LocalFileDatasetStore() - Constructor for class com.google.genkit.ai.evaluation.LocalFileDatasetStore
-
Creates a new LocalFileDatasetStore using the default location.
- LocalFileDatasetStore(Path) - Constructor for class com.google.genkit.ai.evaluation.LocalFileDatasetStore
-
Creates a new LocalFileDatasetStore with a custom root path.
- LocalFileEvalStore - Class in com.google.genkit.ai.evaluation
-
File-based implementation of EvalStore.
- LocalFileEvalStore() - Constructor for class com.google.genkit.ai.evaluation.LocalFileEvalStore
-
Creates a new LocalFileEvalStore using the default location.
- LocalFileEvalStore(Path) - Constructor for class com.google.genkit.ai.evaluation.LocalFileEvalStore
-
Creates a new LocalFileEvalStore with a custom root path.
- LocalTelemetryStore - Class in com.google.genkit
-
A SpanProcessor that stores traces locally for the Dev UI to access.
- LocalTelemetryStore() - Constructor for class com.google.genkit.LocalTelemetryStore
- LocalVecConfig - Class in com.google.genkit.plugins.localvec
-
Configuration for a local vector store.
- LocalVecConfig.Builder - Class in com.google.genkit.plugins.localvec
-
Builder for LocalVecConfig.
- LocalVecDocStore - Class in com.google.genkit.plugins.localvec
-
Local file-based document store implementation.
- LocalVecDocStore(LocalVecConfig) - Constructor for class com.google.genkit.plugins.localvec.LocalVecDocStore
-
Creates a new LocalVecDocStore.
- LocalVecPlugin - Class in com.google.genkit.plugins.localvec
-
Local file-based vector store plugin for development and testing.
- LocalVecPlugin.Builder - Class in com.google.genkit.plugins.localvec
-
Builder for LocalVecPlugin.
- location(String) - Method in class com.google.genkit.plugins.googlegenai.GoogleGenAIPluginOptions.Builder
-
Sets the Google Cloud location for Vertex AI.
- logging(String) - Static method in class com.google.genkit.core.middleware.CommonMiddleware
-
Creates a logging middleware that logs requests and responses.
- logging(String, Logger) - Static method in class com.google.genkit.core.middleware.CommonMiddleware
-
Creates a logging middleware with a custom logger.
- LongFormResponse - Class in com.google.genkit.plugins.evaluators.metrics
-
Response schema for the long-form answer extraction in faithfulness evaluation.
- LongFormResponse() - Constructor for class com.google.genkit.plugins.evaluators.metrics.LongFormResponse
- LongFormResponse(List<String>) - Constructor for class com.google.genkit.plugins.evaluators.metrics.LongFormResponse
- lookupAction(ActionType, String) - Method in interface com.google.genkit.core.Registry
-
Returns the action for the given type and name.
- lookupAction(String) - Method in class com.google.genkit.core.DefaultRegistry
- lookupAction(String) - Method in interface com.google.genkit.core.Registry
-
Returns the action for the given key.
- lookupHelper(String) - Method in class com.google.genkit.core.DefaultRegistry
- lookupHelper(String) - Method in interface com.google.genkit.core.Registry
-
Returns a registered helper by name.
- lookupPartial(String) - Method in class com.google.genkit.core.DefaultRegistry
- lookupPartial(String) - Method in interface com.google.genkit.core.Registry
-
Returns a registered partial by name.
- lookupPlugin(String) - Method in class com.google.genkit.core.DefaultRegistry
- lookupPlugin(String) - Method in interface com.google.genkit.core.Registry
-
Returns the plugin for the given name.
- lookupSchema(String) - Method in class com.google.genkit.core.DefaultRegistry
- lookupSchema(String) - Method in interface com.google.genkit.core.Registry
-
Returns a JSON schema for the given name.
- lookupValue(String) - Method in class com.google.genkit.core.DefaultRegistry
- lookupValue(String) - Method in interface com.google.genkit.core.Registry
-
Returns the value for the given name.
- lookupValue(String, String) - Method in class com.google.genkit.core.DefaultRegistry
- lookupValue(String, String) - Method in interface com.google.genkit.core.Registry
-
Returns the value for the given type bucket and name.
M
- MALICIOUSNESS - Enum constant in enum class com.google.genkit.plugins.evaluators.GenkitMetric
-
Measures whether the generated output intends to deceive, harm, or exploit.
- MaliciousnessMetric - Class in com.google.genkit.plugins.evaluators.metrics
-
Maliciousness metric evaluator.
- MaliciousnessMetric(Registry, String, Map<String, Object>) - Constructor for class com.google.genkit.plugins.evaluators.metrics.MaliciousnessMetric
- MaliciousnessResponse - Class in com.google.genkit.plugins.evaluators.metrics
-
Response schema for maliciousness evaluation.
- MaliciousnessResponse() - Constructor for class com.google.genkit.plugins.evaluators.metrics.MaliciousnessResponse
- MaliciousnessResponse(String, boolean) - Constructor for class com.google.genkit.plugins.evaluators.metrics.MaliciousnessResponse
- maxDelayMs - Variable in class com.google.genkit.plugins.middleware.RetryMiddleware.Options
- maxDelegations(int) - Method in class com.google.genkit.plugins.middleware.AgentsOptions.Builder
-
Sets the maximum delegations per parent invocation (
0= unlimited). - maxOutputTokens(Integer) - Method in class com.google.genkit.ai.GenerationConfig.Builder
- maxPersistedChainLength(int) - Method in class com.google.genkit.ai.agent.FileSessionStore.Builder
-
Sets the maximum number of snapshot files to retain in the parent chain.
- maxRetries - Variable in class com.google.genkit.plugins.middleware.RetryMiddleware.Options
- maxTurns(Integer) - Method in class com.google.genkit.agent.AgentConfig.Builder
-
Sets the maximum number of tool-execution turns for a single generate call.
- maxTurns(Integer) - Method in class com.google.genkit.ai.GenerateOptions.Builder
- MCPClient - Class in com.google.genkit.plugins.mcp
-
MCP Client that manages connections to MCP servers and provides access to their tools and resources.
- MCPClient(String, MCPServerConfig, Duration, boolean) - Constructor for class com.google.genkit.plugins.mcp.MCPClient
-
Creates a new MCP client.
- MCPPlugin - Class in com.google.genkit.plugins.mcp
-
MCP Plugin for Genkit.
- MCPPlugin(MCPPluginOptions) - Constructor for class com.google.genkit.plugins.mcp.MCPPlugin
-
Creates a new MCP plugin with the given options.
- MCPPluginOptions - Class in com.google.genkit.plugins.mcp
-
Configuration options for the MCP plugin.
- MCPPluginOptions.Builder - Class in com.google.genkit.plugins.mcp
-
Builder for MCPPluginOptions.
- MCPResource - Class in com.google.genkit.plugins.mcp
-
Represents an MCP resource.
- MCPResource(String, String, String, String) - Constructor for class com.google.genkit.plugins.mcp.MCPResource
-
Creates a new MCP resource.
- MCPResourceContent - Class in com.google.genkit.plugins.mcp
-
Represents the content of an MCP resource.
- MCPResourceContent(String, List<MCPResourceContent.ContentPart>) - Constructor for class com.google.genkit.plugins.mcp.MCPResourceContent
-
Creates a new resource content.
- MCPResourceContent.ContentPart - Class in com.google.genkit.plugins.mcp
-
Represents a single part of resource content.
- MCPServer - Class in com.google.genkit.plugins.mcp
-
MCP Server that exposes Genkit tools, prompts, and flows as MCP endpoints.
- MCPServer(Registry) - Constructor for class com.google.genkit.plugins.mcp.MCPServer
-
Creates a new MCP server with default options.
- MCPServer(Registry, MCPServerOptions) - Constructor for class com.google.genkit.plugins.mcp.MCPServer
-
Creates a new MCP server.
- MCPServerConfig - Class in com.google.genkit.plugins.mcp
-
Configuration for connecting to an MCP server.
- MCPServerConfig.Builder - Class in com.google.genkit.plugins.mcp
-
Builder for MCPServerConfig.
- MCPServerConfig.TransportType - Enum Class in com.google.genkit.plugins.mcp
-
Transport type for MCP communication.
- MCPServerOptions - Class in com.google.genkit.plugins.mcp
-
Configuration options for an MCP server.
- MCPServerOptions.Builder - Class in com.google.genkit.plugins.mcp
-
Builder for MCPServerOptions.
- media(String, String) - Static method in class com.google.genkit.ai.Part
-
Creates a media part.
- Media - Class in com.google.genkit.ai
-
Media represents media content in a message part.
- Media() - Constructor for class com.google.genkit.ai.Media
-
Default constructor.
- Media(String, String) - Constructor for class com.google.genkit.ai.Media
-
Creates a Media with the given content type and URL.
- MEDIA - Enum constant in enum class com.google.genkit.ai.OutputFormat
- message() - Method in class com.google.genkit.ai.agent.AgentResponse
-
Returns the assistant message produced by the turn.
- message(Message) - Method in class com.google.genkit.ai.agent.AgentInput.Builder
- message(Message) - Method in class com.google.genkit.ai.agent.AgentOutput.Builder
- message(Message) - Method in class com.google.genkit.ai.agent.AgentResult.Builder
- message(String) - Method in class com.google.genkit.ai.agent.RuntimeError.Builder
- message(String) - Method in class com.google.genkit.core.GenkitException.Builder
- Message - Class in com.google.genkit.ai
-
Message represents a message in a conversation with a generative AI model.
- Message() - Constructor for class com.google.genkit.ai.Message
-
Default constructor.
- Message(Role, List<Part>) - Constructor for class com.google.genkit.ai.Message
-
Creates a message with the given role and content.
- Message.Builder - Class in com.google.genkit.ai
-
Builder for Message.
- messages() - Method in class com.google.genkit.ai.agent.AgentChat
-
Returns the accumulated conversation messages.
- messages(List<Message>) - Method in class com.google.genkit.ai.agent.SessionState.Builder
- messages(List<Message>) - Method in class com.google.genkit.ai.GenerateOptions.Builder
- messages(List<Message>) - Method in class com.google.genkit.ai.ModelRequest.Builder
- metadata() - Method in interface com.google.genkit.ai.middleware.GenerationMiddlewareDesc
-
Returns arbitrary metadata, or
nullif none. - metadata(Map<String, Object>) - Method in class com.google.genkit.ai.agent.Artifact.Builder
- metadata(Map<String, Object>) - Method in class com.google.genkit.ai.Message.Builder
- metadata(Map<String, Object>) - Method in class com.google.genkit.core.ActionDesc.Builder
- metadata(Map<String, Object>) - Method in class com.google.genkit.core.BidiActionImpl.Builder
- METADATA_KEY_DEFINITION - Static variable in class com.google.genkit.ai.evaluation.Evaluator
- METADATA_KEY_DISPLAY_NAME - Static variable in class com.google.genkit.ai.evaluation.Evaluator
- METADATA_KEY_IS_BILLED - Static variable in class com.google.genkit.ai.evaluation.Evaluator
- metadataColumn(String) - Method in class com.google.genkit.plugins.postgresql.PostgresTableConfig.Builder
-
Sets the metadata column name (default: "metadata").
- metadataExtractor(Function<QueryDocumentSnapshot, Map<String, Object>>) - Method in class com.google.genkit.plugins.firebase.retriever.FirestoreRetrieverConfig.Builder
-
Sets a custom metadata extractor function.
- metadataField(String) - Method in class com.google.genkit.plugins.weaviate.WeaviateCollectionConfig.Builder
-
Sets the field name for document metadata.
- metadataFields(List<String>) - Method in class com.google.genkit.plugins.firebase.retriever.FirestoreRetrieverConfig.Builder
-
Sets the metadata fields to include in results.
- metric(MilvusCollectionConfig.Metric) - Method in class com.google.genkit.plugins.milvus.MilvusCollectionConfig.Builder
-
Sets the vector similarity metric.
- metric(PineconeIndexConfig.Metric) - Method in class com.google.genkit.plugins.pinecone.PineconeIndexConfig.Builder
-
Sets the similarity metric (default: COSINE).
- MetricConfig - Class in com.google.genkit.plugins.evaluators
-
Configuration for a specific evaluation metric.
- MetricConfig.Builder - Class in com.google.genkit.plugins.evaluators
- metricExportIntervalMillis(long) - Method in class com.google.genkit.plugins.firebase.FirebasePlugin.Builder
-
Sets the metric export interval in milliseconds.
- metricExportIntervalMillis(long) - Method in class com.google.genkit.plugins.firebase.FirebasePluginConfig.Builder
- metricExportIntervalMillis(long) - Method in class com.google.genkit.plugins.firebase.telemetry.FirebaseTelemetry.Builder
-
Sets the metric export interval.
- metricRefs(List<String>) - Method in class com.google.genkit.ai.evaluation.CreateDatasetRequest.Builder
- metricRefs(List<String>) - Method in class com.google.genkit.ai.evaluation.DatasetMetadata.Builder
- metricRefs(List<String>) - Method in class com.google.genkit.ai.evaluation.UpdateDatasetRequest.Builder
- metrics(List<EvalMetric>) - Method in class com.google.genkit.ai.evaluation.EvalResult.Builder
- metrics(List<MetricConfig>) - Method in class com.google.genkit.plugins.evaluators.EvaluatorsPluginOptions.Builder
- metricType(GenkitMetric) - Method in class com.google.genkit.plugins.evaluators.MetricConfig.Builder
- metricTypes(List<GenkitMetric>) - Method in class com.google.genkit.plugins.evaluators.EvaluatorsPluginOptions.Builder
-
Sets the metrics from simple metric types (convenience method).
- middleware(GenerationMiddleware...) - Method in class com.google.genkit.Genkit.Builder
-
Optional: pre-registers one or more generation middlewares so they show up in the Genkit Dev UI Middleware panel before any flow has executed.
- middleware(GenerationMiddlewareDesc...) - Method in class com.google.genkit.Genkit.Builder
-
Optional: pre-registers one or more middleware descriptors so they show up in the Genkit Dev UI Middleware panel — including a parameters form derived from each descriptor's
configSchema. - Middleware<I,
O> - Interface in com.google.genkit.core.middleware -
Deprecated.
- MiddlewareCache<V> - Interface in com.google.genkit.core.middleware
-
MiddlewareCache is a simple cache interface for use with caching middleware.
- MiddlewareChain<I,
O> - Class in com.google.genkit.core.middleware -
MiddlewareChain manages a list of middleware and provides execution of the complete chain.
- MiddlewareChain() - Constructor for class com.google.genkit.core.middleware.MiddlewareChain
-
Creates a new MiddlewareChain.
- MiddlewareChain(List<Middleware<I, O>>) - Constructor for class com.google.genkit.core.middleware.MiddlewareChain
-
Creates a new MiddlewareChain with the given middleware.
- MiddlewareNext<I,
O> - Interface in com.google.genkit.core.middleware -
MiddlewareNext represents the next function in the middleware chain.
- MiddlewarePlugin - Interface in com.google.genkit.ai.middleware
-
Implemented by plugins that share reusable generation middleware.
- middlewares(Registry) - Method in interface com.google.genkit.ai.middleware.MiddlewarePlugin
-
Returns the generation middleware this plugin provides.
- middlewares(Registry) - Method in class com.google.genkit.plugins.middleware.GenerationMiddlewarePlugin
- MilvusCollectionConfig - Class in com.google.genkit.plugins.milvus
-
Configuration for a single Milvus collection managed by
MilvusPlugin. - MilvusCollectionConfig.Builder - Class in com.google.genkit.plugins.milvus
-
Builder for
MilvusCollectionConfig. - MilvusCollectionConfig.Metric - Enum Class in com.google.genkit.plugins.milvus
-
Vector similarity metric used by the Milvus index.
- MilvusPlugin - Class in com.google.genkit.plugins.milvus
-
Milvus vector database plugin for Genkit.
- MilvusPlugin.Builder - Class in com.google.genkit.plugins.milvus
-
Builder for
MilvusPlugin. - MilvusVectorStore - Class in com.google.genkit.plugins.milvus
-
Milvus vector store backed by the Milvus v2 REST API.
- MilvusVectorStore(String, String, MilvusCollectionConfig, Embedder) - Constructor for class com.google.genkit.plugins.milvus.MilvusVectorStore
-
Creates a new store.
- MistralPlugin - Class in com.google.genkit.plugins.mistral
-
MistralPlugin provides Mistral AI model integrations for Genkit.
- MistralPlugin() - Constructor for class com.google.genkit.plugins.mistral.MistralPlugin
-
Creates a MistralPlugin with default options (using MISTRAL_API_KEY environment variable).
- MistralPlugin(CompatOAIPluginOptions) - Constructor for class com.google.genkit.plugins.mistral.MistralPlugin
-
Creates a MistralPlugin with the specified options.
- model(String) - Method in class com.google.genkit.agent.AgentConfig.Builder
-
Sets the model name to use for generation.
- model(String) - Method in class com.google.genkit.ai.GenerateOptions.Builder
- model(String) - Static method in class com.google.genkit.ai.Message
-
Creates a model message with text content.
- model(String) - Method in class com.google.genkit.ai.Prompt.Builder
- Model - Interface in com.google.genkit.ai
-
Model is the interface for AI model implementations.
- MODEL - Enum constant in enum class com.google.genkit.ai.evaluation.DatasetType
- MODEL - Enum constant in enum class com.google.genkit.ai.Role
- MODEL - Enum constant in enum class com.google.genkit.core.ActionType
-
A model action for AI model inference.
- ModelCapabilities() - Constructor for class com.google.genkit.ai.ModelInfo.ModelCapabilities
- modelChunk() - Method in class com.google.genkit.ai.agent.AgentChunk
-
Returns the model response chunk.
- modelChunk(ModelResponseChunk) - Method in class com.google.genkit.ai.agent.AgentStreamChunk.Builder
- ModelDefinition(String, String) - Constructor for class com.google.genkit.plugins.compatoai.CompatOAIPlugin.ModelDefinition
-
Creates a model definition with auto-generated label.
- ModelDefinition(String, String, String) - Constructor for class com.google.genkit.plugins.compatoai.CompatOAIPlugin.ModelDefinition
-
Creates a model definition.
- ModelInfo - Class in com.google.genkit.ai
-
ModelInfo contains metadata about a model's capabilities.
- ModelInfo() - Constructor for class com.google.genkit.ai.ModelInfo
-
Default constructor.
- ModelInfo.ModelCapabilities - Class in com.google.genkit.ai
-
ModelCapabilities describes what a model can do.
- ModelNext - Interface in com.google.genkit.ai.middleware
- ModelParams - Class in com.google.genkit.ai.middleware
- ModelParams(ModelRequest, Consumer<ModelResponseChunk>) - Constructor for class com.google.genkit.ai.middleware.ModelParams
-
Creates ModelParams.
- ModelRequest - Class in com.google.genkit.ai
-
ModelRequest represents a request to a generative AI model.
- ModelRequest() - Constructor for class com.google.genkit.ai.ModelRequest
-
Default constructor.
- ModelRequest(List<Message>) - Constructor for class com.google.genkit.ai.ModelRequest
-
Creates a ModelRequest with the given messages.
- ModelRequest.Builder - Class in com.google.genkit.ai
-
Builder for ModelRequest.
- ModelResponse - Class in com.google.genkit.ai
-
ModelResponse represents a response from a generative AI model.
- ModelResponse() - Constructor for class com.google.genkit.ai.ModelResponse
-
Default constructor.
- ModelResponse(List<Candidate>) - Constructor for class com.google.genkit.ai.ModelResponse
-
Creates a ModelResponse with the given candidates.
- ModelResponse.Builder - Class in com.google.genkit.ai
-
Builder for ModelResponse.
- ModelResponseChunk - Class in com.google.genkit.ai
-
ModelResponseChunk represents a streaming chunk from a generative AI model.
- ModelResponseChunk() - Constructor for class com.google.genkit.ai.ModelResponseChunk
-
Default constructor.
- ModelResponseChunk(List<Part>) - Constructor for class com.google.genkit.ai.ModelResponseChunk
-
Creates a ModelResponseChunk with the given content.
- models - Variable in class com.google.genkit.plugins.middleware.FallbackMiddleware.Options
- models(String...) - Method in class com.google.genkit.plugins.ollama.OllamaPluginOptions.Builder
- models(List<String>) - Method in class com.google.genkit.plugins.ollama.OllamaPluginOptions.Builder
- ModelTelemetryHelper - Class in com.google.genkit.ai.telemetry
-
ModelTelemetryHelper provides utilities for recording model telemetry.
- ModelTelemetryHelper() - Constructor for class com.google.genkit.ai.telemetry.ModelTelemetryHelper
- ModelTelemetryHelper.ModelExecutor - Interface in com.google.genkit.ai.telemetry
-
Functional interface for model execution.
- ModelTelemetryHelper.StreamingModelExecutor - Interface in com.google.genkit.ai.telemetry
-
Functional interface for streaming model execution.
- moderation(String) - Method in class com.google.genkit.plugins.openai.ImageGenerationConfig.Builder
- MongoPlugin - Class in com.google.genkit.plugins.mongodb
-
MongoDB Atlas Vector Search plugin for Genkit.
- MongoPlugin.Builder - Class in com.google.genkit.plugins.mongodb
-
Builder for
MongoPlugin. - MongoSessionStore<S> - Class in com.google.genkit.plugins.mongodb.session
-
MongoDB-backed implementation of
SessionStoreandSnapshotSubscriber. - MongoSessionStore(MongoClient) - Constructor for class com.google.genkit.plugins.mongodb.session.MongoSessionStore
-
Creates a store with default options.
- MongoSessionStore(MongoClient, MongoSessionStoreOptions) - Constructor for class com.google.genkit.plugins.mongodb.session.MongoSessionStore
-
Creates a store.
- MongoSessionStoreOptions - Class in com.google.genkit.plugins.mongodb.session
-
Configuration for
MongoSessionStore. - MongoSessionStoreOptions.Builder - Class in com.google.genkit.plugins.mongodb.session
-
Builder for
MongoSessionStoreOptions. - MongoVectorStore - Class in com.google.genkit.plugins.mongodb
-
MongoDB Atlas Vector Search-backed vector store.
- MongoVectorStore(MongoClient, MongoVectorStoreConfig, Embedder) - Constructor for class com.google.genkit.plugins.mongodb.MongoVectorStore
-
Creates a new store.
- MongoVectorStoreConfig - Class in com.google.genkit.plugins.mongodb
-
Configuration for a single MongoDB Atlas Vector Search collection managed by
MongoPlugin. - MongoVectorStoreConfig.Builder - Class in com.google.genkit.plugins.mongodb
-
Builder for
MongoVectorStoreConfig. - MongoVectorStoreConfig.Similarity - Enum Class in com.google.genkit.plugins.mongodb
-
Vector similarity function supported by Atlas Vector Search.
N
- n(Integer) - Method in class com.google.genkit.plugins.openai.ImageGenerationConfig.Builder
- name - Variable in class com.google.genkit.plugins.middleware.Agents.ArtifactRef
- name - Variable in class com.google.genkit.plugins.middleware.Artifacts.ReadInput
- name - Variable in class com.google.genkit.plugins.middleware.Artifacts.ReadOutput
- name - Variable in class com.google.genkit.plugins.middleware.Artifacts.WriteInput
- name - Variable in class com.google.genkit.plugins.middleware.internal.Delegation.NamedArtifact
- name() - Method in class com.google.genkit.ai.agent.AgentInterrupt
-
Returns the interrupted tool's name.
- name() - Method in interface com.google.genkit.ai.middleware.GenerationMiddleware
-
Returns the middleware's unique identifier.
- name() - Method in interface com.google.genkit.ai.middleware.GenerationMiddlewareDesc
-
Returns the middleware's unique name.
- name() - Method in class com.google.genkit.plugins.middleware.FallbackMiddleware
- name() - Method in class com.google.genkit.plugins.middleware.RetryMiddleware
- name() - Method in class com.google.genkit.plugins.middleware.SimulateSystemPromptMiddleware
- name(String) - Method in class com.google.genkit.agent.AgentConfig.Builder
-
Sets the agent's registered name (required).
- name(String) - Method in class com.google.genkit.ai.agent.Artifact.Builder
- name(String) - Method in class com.google.genkit.ai.agent.CustomAgentConfig.Builder
-
Sets the agent's registered name (required).
- name(String) - Method in class com.google.genkit.ai.Embedder.Builder
- name(String) - Method in class com.google.genkit.ai.evaluation.Evaluator.Builder
- name(String) - Method in class com.google.genkit.ai.Indexer.Builder
- name(String) - Method in class com.google.genkit.ai.InterruptConfig.Builder
-
Sets the interrupt name.
- name(String) - Method in class com.google.genkit.ai.Prompt.Builder
- name(String) - Method in class com.google.genkit.ai.Retriever.Builder
- name(String) - Method in class com.google.genkit.ai.Tool.Builder
- name(String) - Method in class com.google.genkit.core.ActionDesc.Builder
- name(String) - Method in class com.google.genkit.core.BidiActionImpl.Builder
- name(String) - Method in class com.google.genkit.core.tracing.SpanMetadata.Builder
- name(String) - Method in class com.google.genkit.GenkitOptions.Builder
- name(String) - Method in class com.google.genkit.plugins.firebase.retriever.FirestoreRetrieverConfig.Builder
-
Sets the name of the retriever (required).
- name(String) - Method in class com.google.genkit.plugins.mcp.MCPPluginOptions.Builder
-
Sets the name of the MCP host.
- name(String) - Method in class com.google.genkit.plugins.mcp.MCPServerOptions.Builder
-
Sets the server name.
- name(String) - Method in class com.google.genkit.plugins.weaviate.WeaviateCollectionConfig.Builder
-
Sets the collection name.
- namespace(String) - Method in class com.google.genkit.plugins.pinecone.PineconeIndexConfig.Builder
-
Sets the namespace (default: "" - default namespace).
- newChild() - Method in class com.google.genkit.core.DefaultRegistry
- newChild() - Method in interface com.google.genkit.core.Registry
-
Creates a new child registry that inherits from this registry.
- newChildSpanContext(SpanContext) - Static method in class com.google.genkit.core.tracing.Tracer
-
Creates a child span context from a parent.
- newInstance() - Method in interface com.google.genkit.ai.middleware.GenerationMiddleware
-
Returns a fresh instance for each
generate()call, enabling per-invocation state. - newInstance() - Method in class com.google.genkit.plugins.middleware.FallbackMiddleware
- newInstance() - Method in class com.google.genkit.plugins.middleware.RetryMiddleware
- newInstance() - Method in class com.google.genkit.plugins.middleware.SimulateSystemPromptMiddleware
- newRootSpanContext() - Static method in class com.google.genkit.core.tracing.Tracer
-
Creates a new root span context.
- next() - Method in class com.google.genkit.core.BufferedInputSource
-
Blocks until the next input is available or the stream ends.
- next() - Method in interface com.google.genkit.core.InputSource
-
Blocks until the next input is available or the stream ends.
- NliResponse - Class in com.google.genkit.plugins.evaluators.metrics
-
Response schema for NLI (Natural Language Inference) evaluation.
- NliResponse() - Constructor for class com.google.genkit.plugins.evaluators.metrics.NliResponse
- NliResponse(List<NliResponseItem>) - Constructor for class com.google.genkit.plugins.evaluators.metrics.NliResponse
- NliResponseItem - Class in com.google.genkit.plugins.evaluators.metrics
-
A single NLI (Natural Language Inference) response item.
- NliResponseItem() - Constructor for class com.google.genkit.plugins.evaluators.metrics.NliResponseItem
- NliResponseItem(String, String, boolean) - Constructor for class com.google.genkit.plugins.evaluators.metrics.NliResponseItem
- numberSchema() - Static method in class com.google.genkit.core.SchemaUtils
-
Creates a schema for a number type.
- numCandidates(int) - Method in class com.google.genkit.plugins.mongodb.MongoVectorStoreConfig.Builder
-
Sets the number of nearest neighbors to consider during the vector search.
O
- objectMapper() - Method in class com.google.genkit.plugins.spring.GenkitSpringApplication
-
Creates an ObjectMapper bean for JSON serialization.
- objectSchema(Map<String, Object>) - Static method in class com.google.genkit.core.SchemaUtils
-
Creates a schema for an object type with the given properties.
- of(GenerationMiddleware) - Static method in class com.google.genkit.ai.middleware.GenerationMiddlewares
-
Wraps an already-instantiated
GenerationMiddlewarein a parameterless descriptor. - of(Middleware<I, O>...) - Static method in class com.google.genkit.core.middleware.MiddlewareChain
-
Creates a new MiddlewareChain with the specified middleware.
- of(GenkitMetric) - Static method in class com.google.genkit.plugins.evaluators.MetricConfig
-
Creates a simple metric configuration with just the metric type.
- offer(I) - Method in class com.google.genkit.core.BufferedInputSource
-
Enqueues one input for the consumer.
- ok(Session<S>) - Static method in class com.google.genkit.ai.agent.internal.SessionResolver.Resolution
-
Creates a successful resolution wrapping the given session.
- ok(Session<S>, String) - Static method in class com.google.genkit.ai.agent.internal.SessionResolver.Resolution
-
Creates a successful resolution wrapping the given session and the id of the snapshot it was resolved (resumed) from.
- OllamaModel - Class in com.google.genkit.plugins.ollama
-
Ollama model implementation for Genkit.
- OllamaModel(String, OllamaPluginOptions) - Constructor for class com.google.genkit.plugins.ollama.OllamaModel
-
Creates a new OllamaModel.
- OllamaPlugin - Class in com.google.genkit.plugins.ollama
-
OllamaPlugin provides local Ollama model integrations for Genkit.
- OllamaPlugin() - Constructor for class com.google.genkit.plugins.ollama.OllamaPlugin
-
Creates an OllamaPlugin with default options.
- OllamaPlugin(OllamaPluginOptions) - Constructor for class com.google.genkit.plugins.ollama.OllamaPlugin
-
Creates an OllamaPlugin with the specified options.
- OllamaPluginOptions - Class in com.google.genkit.plugins.ollama
-
Options for configuring the Ollama plugin.
- OllamaPluginOptions.Builder - Class in com.google.genkit.plugins.ollama
-
Builder for OllamaPluginOptions.
- OmniModel - Class in com.google.genkit.plugins.googlegenai
-
Gemini Omni video generation and editing model using the Gemini Interactions API.
- OmniModel(String, GoogleGenAIPluginOptions) - Constructor for class com.google.genkit.plugins.googlegenai.OmniModel
-
Creates a new OmniModel.
- OnCallGenkit - Class in com.google.genkit.plugins.firebase.functions
-
Firebase Cloud Functions integration for Genkit flows.
- OnCallGenkit.AuthPolicy - Interface in com.google.genkit.plugins.firebase.functions
-
Functional interface for authorization policies.
- On-disk layout - Search tag in class com.google.genkit.ai.agent.FileSessionStore
- Section
- onEnd(ReadableSpan) - Method in class com.google.genkit.core.tracing.TelemetryServerExporter
- onEnd(ReadableSpan) - Method in class com.google.genkit.LocalTelemetryStore
- onSnapshotStateChange(String, Consumer<SessionSnapshot<?>>, SessionStoreOptions) - Method in class com.google.genkit.ai.agent.FileSessionStore
-
Subscribes to status changes for the snapshot identified by
snapshotId. - onSnapshotStateChange(String, Consumer<SessionSnapshot<?>>, SessionStoreOptions) - Method in class com.google.genkit.ai.agent.InMemorySessionStore
-
Subscribes to status changes for the snapshot identified by
snapshotId. - onSnapshotStateChange(String, Consumer<SessionSnapshot<?>>, SessionStoreOptions) - Method in interface com.google.genkit.ai.agent.SnapshotSubscriber
-
Subscribes to status changes for the snapshot identified by
snapshotId. - onSnapshotStateChange(String, Consumer<SessionSnapshot<?>>, SessionStoreOptions) - Method in class com.google.genkit.plugins.awsbedrock.session.DynamoDbSessionStore
-
Subscribes to status changes for the snapshot identified by
snapshotId. - onSnapshotStateChange(String, Consumer<SessionSnapshot<?>>, SessionStoreOptions) - Method in class com.google.genkit.plugins.azurefoundry.session.CosmosSessionStore
-
Subscribes to status changes for the snapshot identified by
snapshotId. - onSnapshotStateChange(String, Consumer<SessionSnapshot<?>>, SessionStoreOptions) - Method in class com.google.genkit.plugins.firebase.session.FirestoreSessionStore
-
Subscribes to status changes for the snapshot identified by
snapshotId. - onSnapshotStateChange(String, Consumer<SessionSnapshot<?>>, SessionStoreOptions) - Method in class com.google.genkit.plugins.mongodb.session.MongoSessionStore
-
Subscribes to status changes for the snapshot identified by
snapshotId. - onSnapshotStateChange(String, Consumer<SessionSnapshot<?>>, SessionStoreOptions) - Method in class com.google.genkit.plugins.postgresql.session.PostgresSessionStore
-
Subscribes to status changes for the snapshot identified by
snapshotId. - onStart(Context, ReadWriteSpan) - Method in class com.google.genkit.core.tracing.TelemetryServerExporter
- onStart(Context, ReadWriteSpan) - Method in class com.google.genkit.LocalTelemetryStore
- OpenAIEmbedder - Class in com.google.genkit.plugins.openai
-
OpenAI embedder implementation for Genkit.
- OpenAIEmbedder(String, OpenAIPluginOptions) - Constructor for class com.google.genkit.plugins.openai.OpenAIEmbedder
-
Creates a new OpenAIEmbedder.
- OpenAIImageModel - Class in com.google.genkit.plugins.openai
-
OpenAI image generation model implementation for Genkit.
- OpenAIImageModel(String, OpenAIPluginOptions) - Constructor for class com.google.genkit.plugins.openai.OpenAIImageModel
-
Creates a new OpenAIImageModel.
- OpenAIModel - Class in com.google.genkit.plugins.openai
-
OpenAI model implementation for Genkit.
- OpenAIModel(String, OpenAIPluginOptions) - Constructor for class com.google.genkit.plugins.openai.OpenAIModel
-
Creates a new OpenAIModel.
- OpenAIPlugin - Class in com.google.genkit.plugins.openai
-
OpenAIPlugin provides OpenAI model integrations for Genkit.
- OpenAIPlugin() - Constructor for class com.google.genkit.plugins.openai.OpenAIPlugin
-
Creates an OpenAIPlugin with default options.
- OpenAIPlugin(OpenAIPluginOptions) - Constructor for class com.google.genkit.plugins.openai.OpenAIPlugin
-
Creates an OpenAIPlugin with the specified options.
- OpenAIPluginOptions - Class in com.google.genkit.plugins.openai
-
Options for configuring the OpenAI plugin.
- OpenAIPluginOptions.Builder - Class in com.google.genkit.plugins.openai
-
Builder for OpenAIPluginOptions.
- options(RunEvaluationRequest.EvaluationOptions) - Method in class com.google.genkit.ai.evaluation.RunEvaluationRequest.Builder
- options(GenkitOptions) - Method in class com.google.genkit.Genkit.Builder
-
Sets the Genkit options.
- options(Object) - Method in class com.google.genkit.ai.evaluation.EvalRequest.Builder
- Options() - Constructor for class com.google.genkit.plugins.middleware.FallbackMiddleware.Options
- Options() - Constructor for class com.google.genkit.plugins.middleware.RetryMiddleware.Options
- Options() - Constructor for class com.google.genkit.plugins.middleware.SimulateSystemPromptMiddleware.Options
- optionsClass(Class<O>) - Method in class com.google.genkit.ai.evaluation.Evaluator.Builder
- organization(String) - Method in class com.google.genkit.plugins.compatoai.CompatOAIPlugin.Builder
-
Sets the organization ID (optional).
- organization(String) - Method in class com.google.genkit.plugins.compatoai.CompatOAIPluginOptions.Builder
-
Sets the organization ID.
- organization(String) - Method in class com.google.genkit.plugins.openai.OpenAIPluginOptions.Builder
- OTHER - Enum constant in enum class com.google.genkit.ai.agent.AgentFinishReason
-
The agent finished for some other reason.
- OTHER - Enum constant in enum class com.google.genkit.ai.FinishReason
- Other limitations (v1) - Search tag in class com.google.genkit.plugins.middleware.Agents
- Section
- output(OutputConfig) - Method in class com.google.genkit.ai.GenerateOptions.Builder
- output(OutputConfig) - Method in class com.google.genkit.ai.ModelRequest.Builder
- output(Object) - Method in class com.google.genkit.ai.evaluation.DatasetSample.Builder
- output(Object) - Method in class com.google.genkit.ai.evaluation.EvalDataPoint.Builder
- output(Object) - Method in class com.google.genkit.ai.evaluation.EvalResult.Builder
- outputClass(Class<O>) - Method in class com.google.genkit.ai.Tool.Builder
-
Sets the output class and automatically generates the output schema.
- outputClass(Class<O>) - Method in class com.google.genkit.core.BidiActionImpl.Builder
- outputClass(Class<U>) - Method in class com.google.genkit.ai.GenerateOptions.Builder
-
Sets the output class for typed structured output.
- outputCompression(Integer) - Method in class com.google.genkit.plugins.openai.ImageGenerationConfig.Builder
- OutputConfig - Class in com.google.genkit.ai
-
OutputConfig contains configuration for model output generation.
- OutputConfig() - Constructor for class com.google.genkit.ai.OutputConfig
-
Default constructor.
- OutputConfig(OutputFormat) - Constructor for class com.google.genkit.ai.OutputConfig
-
Creates an OutputConfig with the given format.
- outputFormat(String) - Method in class com.google.genkit.plugins.openai.ImageGenerationConfig.Builder
- OutputFormat - Enum Class in com.google.genkit.ai
-
OutputFormat specifies the format for model output.
- outputSchema(Map<String, Object>) - Method in class com.google.genkit.ai.InterruptConfig.Builder
-
Sets the output schema.
- outputSchema(Map<String, Object>) - Method in class com.google.genkit.ai.Prompt.Builder
- outputSchema(Map<String, Object>) - Method in class com.google.genkit.ai.Tool.Builder
- outputSchema(Map<String, Object>) - Method in class com.google.genkit.core.ActionDesc.Builder
- outputSchema(Map<String, Object>) - Method in class com.google.genkit.core.BidiActionImpl.Builder
- outputType(Class<O>) - Method in class com.google.genkit.ai.InterruptConfig.Builder
-
Sets the output type class.
- over(AgentTransport<S>, AgentInit<S>) - Static method in class com.google.genkit.ai.agent.AgentChat
-
Creates a chat over any transport.
P
- parentId(String) - Method in class com.google.genkit.ai.agent.SessionSnapshot.Builder
- parentSnapshotId() - Method in class com.google.genkit.ai.agent.TurnContext
-
Returns the parent snapshot ID (ID of the previous turn's snapshot).
- parse(String, String) - Static method in class com.google.genkit.prompt.DotPrompt
-
Parses a DotPrompt from its string content.
- parseJson(String) - Static method in class com.google.genkit.core.JsonUtils
-
Parses a JSON string to a JsonNode.
- part() - Method in class com.google.genkit.ai.agent.AgentInterrupt
-
Returns the originating tool-request part.
- Part - Class in com.google.genkit.ai
-
Part represents a part of a message content, which can be text, media, tool request, or tool response.
- Part() - Constructor for class com.google.genkit.ai.Part
-
Default constructor.
- parts(List<Part>) - Method in class com.google.genkit.ai.agent.Artifact.Builder
- PASS - Enum constant in enum class com.google.genkit.ai.evaluation.EvalStatus
- password(String) - Method in class com.google.genkit.plugins.postgresql.PostgresPlugin.Builder
-
Sets the database password.
- PENDING - Enum constant in enum class com.google.genkit.ai.agent.SnapshotStatus
-
The snapshot is pending.
- PendingAbortRegistry - Class in com.google.genkit.ai.agent.internal
-
Registry mapping a still-
PENDINGdetached turn's snapshot id to the liveAtomicBooleanabort signal handed to that turn'sAgentFnContext. - Pending-leaf decision - Search tag in class com.google.genkit.ai.agent.internal.SessionResolver
- Section
- Picoschema - Class in com.google.genkit.prompt
-
Converts Picoschema (the compact schema dialect used in
.promptfrontmatter) into standard JSON Schema. - PineconeIndexConfig - Class in com.google.genkit.plugins.pinecone
-
Configuration for a Pinecone index used for vector storage.
- PineconeIndexConfig.Builder - Class in com.google.genkit.plugins.pinecone
-
Builder for PineconeIndexConfig.
- PineconeIndexConfig.Cloud - Enum Class in com.google.genkit.plugins.pinecone
-
Cloud providers for serverless indexes.
- PineconeIndexConfig.Metric - Enum Class in com.google.genkit.plugins.pinecone
-
Metric types for vector similarity search.
- PineconePlugin - Class in com.google.genkit.plugins.pinecone
-
Pinecone plugin for Genkit providing vector database functionality.
- PineconePlugin.Builder - Class in com.google.genkit.plugins.pinecone
-
Builder for PineconePlugin.
- PineconeVectorStore - Class in com.google.genkit.plugins.pinecone
-
Pinecone vector store implementation.
- PineconeVectorStore(Pinecone, PineconeIndexConfig, Embedder) - Constructor for class com.google.genkit.plugins.pinecone.PineconeVectorStore
-
Creates a new PineconeVectorStore.
- plugin(Plugin) - Method in class com.google.genkit.Genkit.Builder
-
Adds a plugin.
- Plugin - Interface in com.google.genkit.core
-
Plugin is the interface implemented by types that extend Genkit's functionality.
- PLUGIN_NAME - Static variable in class com.google.genkit.plugins.chroma.ChromaPlugin
-
The plugin name; used as the
chroma/...action prefix. - PLUGIN_NAME - Static variable in class com.google.genkit.plugins.middleware.GenerationMiddlewarePlugin
-
The plugin name.
- PLUGIN_NAME - Static variable in class com.google.genkit.plugins.milvus.MilvusPlugin
-
The plugin name; used as the
milvus/...action prefix. - PLUGIN_NAME - Static variable in class com.google.genkit.plugins.mongodb.MongoPlugin
-
The plugin name; used as the
mongodb/...action prefix. - PLUGIN_NAME - Static variable in class com.google.genkit.plugins.qdrant.QdrantPlugin
-
The plugin name; used as the
qdrant/...action prefix. - pluginName(String) - Method in class com.google.genkit.plugins.compatoai.CompatOAIPlugin.Builder
-
Sets the plugin name.
- PointerDoc - Class in com.google.genkit.ai.agent.internal
-
Tiny POJO representing the contents of a per-session pointer file.
- PointerDoc() - Constructor for class com.google.genkit.ai.agent.internal.PointerDoc
-
Default constructor (required for Jackson deserialization).
- PointerDoc(String, String, String) - Constructor for class com.google.genkit.ai.agent.internal.PointerDoc
-
Creates a new
PointerDoc. - pollIntervalMs(long) - Method in class com.google.genkit.plugins.awsbedrock.session.DynamoDbSessionStoreOptions.Builder
-
Sets the subscription poll interval in milliseconds.
- pollIntervalMs(long) - Method in class com.google.genkit.plugins.azurefoundry.session.CosmosSessionStoreOptions.Builder
-
Sets the subscription poll interval in milliseconds.
- pollIntervalMs(long) - Method in class com.google.genkit.plugins.mongodb.session.MongoSessionStoreOptions.Builder
-
Sets the subscription poll interval in milliseconds.
- pollIntervalMs(long) - Method in class com.google.genkit.plugins.postgresql.session.PostgresSessionStoreOptions.Builder
-
Sets the subscription poll interval in milliseconds.
- port(int) - Method in class com.google.genkit.plugins.jetty.JettyPluginOptions.Builder
- port(int) - Method in class com.google.genkit.plugins.spring.SpringPluginOptions.Builder
- port(int) - Method in class com.google.genkit.plugins.weaviate.WeaviatePlugin.Builder
-
Sets the HTTP port.
- PostgresPlugin - Class in com.google.genkit.plugins.postgresql
-
PostgreSQL plugin for Genkit providing vector database functionality using pgvector.
- PostgresPlugin.Builder - Class in com.google.genkit.plugins.postgresql
-
Builder for PostgresPlugin.
- PostgresSessionStore<S> - Class in com.google.genkit.plugins.postgresql.session
-
PostgreSQL-backed implementation of
SessionStoreandSnapshotSubscriber. - PostgresSessionStore(DataSource) - Constructor for class com.google.genkit.plugins.postgresql.session.PostgresSessionStore
-
Creates a store with default options.
- PostgresSessionStore(DataSource, PostgresSessionStoreOptions) - Constructor for class com.google.genkit.plugins.postgresql.session.PostgresSessionStore
-
Creates a store.
- PostgresSessionStoreOptions - Class in com.google.genkit.plugins.postgresql.session
-
Configuration for
PostgresSessionStore. - PostgresSessionStoreOptions.Builder - Class in com.google.genkit.plugins.postgresql.session
-
Builder for
PostgresSessionStoreOptions. - PostgresTableConfig - Class in com.google.genkit.plugins.postgresql
-
Configuration for a PostgreSQL table used for vector storage.
- PostgresTableConfig.Builder - Class in com.google.genkit.plugins.postgresql
-
Builder for PostgresTableConfig.
- PostgresTableConfig.DistanceStrategy - Enum Class in com.google.genkit.plugins.postgresql
-
Distance strategies for vector similarity search.
- PostgresVectorStore - Class in com.google.genkit.plugins.postgresql
-
PostgreSQL vector store implementation using pgvector extension.
- PostgresVectorStore(DataSource, PostgresTableConfig, Embedder) - Constructor for class com.google.genkit.plugins.postgresql.PostgresVectorStore
-
Creates a new PostgresVectorStore.
- Pragmatic scope decision (tools-factory, not a generate hook) - Search tag in class com.google.genkit.plugins.middleware.Agents
- Section
- preface - Variable in class com.google.genkit.plugins.middleware.SimulateSystemPromptMiddleware.Options
- prefix(String) - Method in class com.google.genkit.ai.agent.FileSessionStore.Builder
-
Sets the prefix sub-directory (default
"global"). - presencePenalty(Double) - Method in class com.google.genkit.ai.GenerationConfig.Builder
- project(String) - Method in class com.google.genkit.plugins.googlegenai.GoogleGenAIPluginOptions.Builder
-
Sets the Google Cloud project ID for Vertex AI.
- projectId(String) - Method in class com.google.genkit.plugins.firebase.FirebasePlugin.Builder
-
Sets the Firebase project ID.
- projectId(String) - Method in class com.google.genkit.plugins.firebase.FirebasePluginConfig.Builder
- projectId(String) - Method in class com.google.genkit.plugins.firebase.telemetry.FirebaseTelemetry.Builder
-
Sets the Firebase/GCP project ID.
- projectRoot(String) - Method in class com.google.genkit.GenkitOptions.Builder
- prompt(String) - Method in class com.google.genkit.ai.GenerateOptions.Builder
- prompt(String) - Method in class com.google.genkit.Genkit
-
Loads a prompt by name using a Map as input type.
- prompt(String, Class<I>) - Method in class com.google.genkit.Genkit
-
Loads a prompt by name from the prompts directory.
- prompt(String, Class<I>, String) - Method in class com.google.genkit.Genkit
-
Loads a prompt by name with an optional variant.
- Prompt<I> - Class in com.google.genkit.ai
-
Prompt is a template that generates ModelRequests from input variables.
- Prompt(String, String, String, String, Map<String, Object>, GenerationConfig, Class<I>, BiFunction<ActionContext, I, ModelRequest>) - Constructor for class com.google.genkit.ai.Prompt
-
Creates a new Prompt.
- Prompt(String, String, String, String, Map<String, Object>, Map<String, Object>, GenerationConfig, Class<I>, BiFunction<ActionContext, I, ModelRequest>) - Constructor for class com.google.genkit.ai.Prompt
-
Creates a new Prompt.
- PROMPT - Enum constant in enum class com.google.genkit.core.ActionType
-
A prompt action that renders templates to generate model requests.
- Prompt.Builder<I> - Class in com.google.genkit.ai
-
Builder for Prompt.
- promptDir(String) - Method in class com.google.genkit.GenkitOptions.Builder
- promptInput(Object) - Method in class com.google.genkit.agent.AgentConfig.Builder
-
Sets the input passed to the prompt for
definePromptAgent. - promptName(String) - Method in class com.google.genkit.agent.AgentConfig.Builder
-
Sets the name of a registered prompt to drive
definePromptAgent. - PromptUtils - Class in com.google.genkit.plugins.evaluators.metrics
-
Utility class for loading and rendering prompt templates.
- PROVIDER - Static variable in class com.google.genkit.plugins.firebase.FirebasePlugin
- PROVIDER - Static variable in class com.google.genkit.plugins.localvec.LocalVecPlugin
- PROVIDER - Static variable in class com.google.genkit.plugins.weaviate.WeaviatePlugin
- put(String, V) - Method in interface com.google.genkit.core.middleware.MiddlewareCache
-
Puts a value in the cache.
- put(String, V) - Method in class com.google.genkit.core.middleware.SimpleCache
Q
- QdrantCollectionConfig - Class in com.google.genkit.plugins.qdrant
-
Configuration for a single Qdrant collection managed by
QdrantPlugin. - QdrantCollectionConfig.Builder - Class in com.google.genkit.plugins.qdrant
-
Builder for
QdrantCollectionConfig. - QdrantCollectionConfig.Distance - Enum Class in com.google.genkit.plugins.qdrant
-
Distance function used by the Qdrant collection.
- QdrantPlugin - Class in com.google.genkit.plugins.qdrant
-
Qdrant vector database plugin for Genkit.
- QdrantPlugin.Builder - Class in com.google.genkit.plugins.qdrant
-
Builder for
QdrantPlugin. - QdrantVectorStore - Class in com.google.genkit.plugins.qdrant
-
Qdrant vector store backed by the Qdrant REST API.
- QdrantVectorStore(String, String, QdrantCollectionConfig, Embedder) - Constructor for class com.google.genkit.plugins.qdrant.QdrantVectorStore
-
Creates a new store.
- quality(String) - Method in class com.google.genkit.plugins.openai.ImageGenerationConfig.Builder
- queryParams(Map<String, String>) - Method in class com.google.genkit.plugins.compatoai.CompatOAIPluginOptions.Builder
-
Sets query parameters to append to API requests.
R
- rateLimit(int, long) - Static method in class com.google.genkit.core.middleware.CommonMiddleware
-
Creates a rate limiting middleware (simple token bucket implementation).
- rationale(String) - Method in class com.google.genkit.ai.evaluation.EvalMetric.Builder
- raw() - Method in class com.google.genkit.ai.agent.AgentChunk
-
Returns the underlying raw stream chunk.
- raw() - Method in class com.google.genkit.ai.agent.AgentResponse
-
Returns the underlying raw agent output.
- rawToolResponses(boolean) - Method in class com.google.genkit.plugins.mcp.MCPPluginOptions.Builder
-
Sets whether to return raw MCP tool responses.
- READ_TOOL - Static variable in class com.google.genkit.plugins.middleware.Artifacts
-
Name of the read tool.
- ReadInput() - Constructor for class com.google.genkit.plugins.middleware.Artifacts.ReadInput
-
Default constructor for JSON deserialization.
- readonly(boolean) - Method in class com.google.genkit.plugins.middleware.ArtifactsOptions.Builder
-
Sets whether artifact writing is disabled.
- ReadOutput() - Constructor for class com.google.genkit.plugins.middleware.Artifacts.ReadOutput
-
Default constructor for JSON deserialization.
- readResource(String) - Method in class com.google.genkit.plugins.mcp.MCPClient
-
Reads a resource by URI.
- readResource(String, String) - Method in class com.google.genkit.plugins.mcp.MCPPlugin
-
Reads a resource from an MCP server.
- reasoning(String) - Method in class com.google.genkit.ai.evaluation.Score.Builder
- reasoning(String) - Method in class com.google.genkit.ai.evaluation.ScoreDetails.Builder
- reassembleShards(List<String>) - Static method in class com.google.genkit.ai.agent.internal.SnapshotSharding
-
Reassembles shards produced by
SnapshotSharding.shardString(java.lang.String, int)back into the original string. - reconstructState(String, List<String>) - Static method in class com.google.genkit.ai.agent.internal.SnapshotSharding
-
Reconstructs a state node from a checkpoint JSON string and a list of RFC-6902 patch JSON strings, applied in order via
JsonPatch.apply(com.fasterxml.jackson.databind.JsonNode, com.fasterxml.jackson.databind.JsonNode). - recordActionMetrics(String, String, String, String, long, String) - Method in class com.google.genkit.ai.telemetry.ActionTelemetry
-
Records metrics for an action execution.
- recordException(Throwable) - Static method in class com.google.genkit.core.tracing.Tracer
-
Records an exception on the current span.
- recordFeatureMetrics(String, String, long, String) - Method in class com.google.genkit.ai.telemetry.FeatureTelemetry
-
Records metrics for a feature (root flow) execution.
- recordGenerateMetrics(String, String, String, ModelResponse, long, String) - Method in class com.google.genkit.ai.telemetry.GenerateTelemetry
-
Records metrics for a generate action.
- recordPathMetrics(String, String, long, String) - Method in class com.google.genkit.ai.telemetry.FeatureTelemetry
-
Records metrics for a path within a flow.
- recordToolMetrics(String, String, String, long, String) - Method in class com.google.genkit.ai.telemetry.ToolTelemetry
-
Records metrics for a tool execution.
- ref() - Method in class com.google.genkit.ai.agent.Agent
- ref() - Method in interface com.google.genkit.ai.agent.AgentApi
-
Returns a lightweight reference to this agent.
- reference(Object) - Method in class com.google.genkit.ai.evaluation.DatasetSample.Builder
- reference(Object) - Method in class com.google.genkit.ai.evaluation.EvalDataPoint.Builder
- reference(Object) - Method in class com.google.genkit.ai.evaluation.EvalResult.Builder
- reflectionPort(int) - Method in class com.google.genkit.Genkit.Builder
-
Sets the reflection port.
- reflectionPort(int) - Method in class com.google.genkit.GenkitOptions.Builder
- ReflectionServer - Class in com.google.genkit
-
ReflectionServer provides an HTTP API for the Genkit Developer UI to interact with.
- ReflectionServer(Registry, int, String) - Constructor for class com.google.genkit.ReflectionServer
-
Creates a new ReflectionServer.
- ReflectionServerV2 - Class in com.google.genkit
-
ReflectionServerV2 implements the Reflection API V2 using WebSockets and JSON-RPC 2.0.
- ReflectionServerV2(Registry, String, String) - Constructor for class com.google.genkit.ReflectionServerV2
-
Creates a new ReflectionServerV2.
- REGEX - Enum constant in enum class com.google.genkit.plugins.evaluators.GenkitMetric
-
Tests output against a provided regular expression pattern.
- RegexMetric - Class in com.google.genkit.plugins.evaluators.metrics
-
Regex metric evaluator.
- RegexMetric() - Constructor for class com.google.genkit.plugins.evaluators.metrics.RegexMetric
- region(String) - Method in class com.google.genkit.plugins.awsbedrock.AwsBedrockPluginOptions.Builder
-
Sets the AWS region by region string.
- region(String) - Method in class com.google.genkit.plugins.pinecone.PineconeIndexConfig.Builder
-
Sets the region for serverless index (default: "us-east-1").
- region(Region) - Method in class com.google.genkit.plugins.awsbedrock.AwsBedrockPluginOptions.Builder
-
Sets the AWS region.
- register() - Method in class com.google.genkit.prompt.ExecutablePrompt
-
Registers this prompt as an action in the registry.
- register(Registry) - Method in class com.google.genkit.ai.agent.Agent
- register(Registry) - Method in class com.google.genkit.ai.Embedder
- register(Registry) - Method in class com.google.genkit.ai.evaluation.Evaluator
- register(Registry) - Method in class com.google.genkit.ai.GenerateAction
- register(Registry) - Method in class com.google.genkit.ai.Indexer
- register(Registry) - Method in interface com.google.genkit.ai.Model
- register(Registry) - Method in class com.google.genkit.ai.Prompt
- register(Registry) - Method in class com.google.genkit.ai.Retriever
- register(Registry) - Method in class com.google.genkit.ai.Tool
- register(Registry) - Method in class com.google.genkit.core.ActionDef
- register(Registry) - Method in class com.google.genkit.core.BidiActionImpl
- register(Registry) - Method in class com.google.genkit.core.Flow
- register(Registry) - Method in interface com.google.genkit.core.Registerable
-
Registers this primitive with the given registry.
- register(Registry, Class<I>) - Method in class com.google.genkit.prompt.DotPrompt
-
Registers this DotPrompt as an action.
- register(String, AtomicBoolean) - Static method in class com.google.genkit.ai.agent.internal.PendingAbortRegistry
-
Registers
signalas the abort flag for the pending detached turn identified bysnapshotId. - Registerable - Interface in com.google.genkit.core
-
Registerable allows a primitive to be registered with a registry.
- registerAction(ActionType, Action<?, ?, ?>) - Method in interface com.google.genkit.core.Registry
-
Registers an action by type and action name.
- registerAction(String, Action<?, ?, ?>) - Method in class com.google.genkit.core.DefaultRegistry
- registerAction(String, Action<?, ?, ?>) - Method in interface com.google.genkit.core.Registry
-
Records the action in the registry.
- registerEmbedder(Embedder) - Method in class com.google.genkit.Genkit
-
Registers an embedder.
- registerHelper(String, Object) - Method in class com.google.genkit.core.DefaultRegistry
- registerHelper(String, Object) - Method in interface com.google.genkit.core.Registry
-
Registers a helper function for use with prompts.
- registerIndexer(Indexer) - Method in class com.google.genkit.Genkit
-
Registers an indexer.
- registerModel(Model) - Method in class com.google.genkit.Genkit
-
Registers a model.
- registerPartial(String, String) - Method in class com.google.genkit.core.DefaultRegistry
- registerPartial(String, String) - Method in interface com.google.genkit.core.Registry
-
Registers a partial template for use with prompts.
- registerPartial(String, String) - Static method in class com.google.genkit.prompt.DotPrompt
-
Registers a partial template that can be included in other prompts.
- registerPlugin(String, Plugin) - Method in class com.google.genkit.core.DefaultRegistry
- registerPlugin(String, Plugin) - Method in interface com.google.genkit.core.Registry
-
Records the plugin in the registry.
- registerRetriever(Retriever) - Method in class com.google.genkit.Genkit
-
Registers a retriever.
- registerSchema(String, Map<String, Object>) - Method in class com.google.genkit.core.DefaultRegistry
- registerSchema(String, Map<String, Object>) - Method in interface com.google.genkit.core.Registry
-
Records a JSON schema in the registry.
- registerSpanProcessor(SpanProcessor) - Static method in class com.google.genkit.core.telemetry.TelemetryConfig
-
Registers a SpanProcessor for exporting traces.
- registerSpanProcessor(SpanProcessor) - Static method in class com.google.genkit.core.tracing.Tracer
-
Registers an additional span processor for exporting traces.
- registerValue(String, Object) - Method in class com.google.genkit.core.DefaultRegistry
- registerValue(String, Object) - Method in interface com.google.genkit.core.Registry
-
Records an arbitrary value in the registry under the default type bucket.
- registerValue(String, String, Object) - Method in class com.google.genkit.core.DefaultRegistry
- registerValue(String, String, Object) - Method in interface com.google.genkit.core.Registry
-
Records an arbitrary value in the registry under the given type bucket.
- registry(Registry) - Method in class com.google.genkit.core.ActionContext.Builder
- Registry - Interface in com.google.genkit.core
-
Registry holds all registered actions and associated types, and provides methods to register, query, and look up actions.
- rejectBranchingSessions(boolean) - Method in class com.google.genkit.ai.agent.FileSessionStore.Builder
-
If
true,LeafSelection.selectLeaf(java.util.List<com.google.genkit.ai.agent.SessionSnapshot<S>>, boolean)throws when more than one leaf exists for a session. - RemoteAgent - Class in com.google.genkit.client
-
Factory for creating a remote agent chat client.
- RemoteAgentOptions - Class in com.google.genkit.client
-
Options for configuring a
RemoteAgentHTTP client. - RemoteAgentOptions.Builder - Class in com.google.genkit.client
-
Builder for
RemoteAgentOptions. - remove(String) - Method in interface com.google.genkit.core.middleware.MiddlewareCache
-
Removes a value from the cache.
- remove(String) - Method in class com.google.genkit.core.middleware.SimpleCache
- removeRuntimeFile(String) - Static method in class com.google.genkit.RuntimeFileWriter
-
Removes the runtime file.
- render(I) - Method in class com.google.genkit.prompt.DotPrompt
-
Renders the prompt with the given input.
- render(I) - Method in class com.google.genkit.prompt.ExecutablePrompt
-
Renders the prompt template without generating.
- renderer(BiFunction<ActionContext, I, ModelRequest>) - Method in class com.google.genkit.ai.Prompt.Builder
- renderPrompt(String, Map<String, String>) - Static method in class com.google.genkit.plugins.evaluators.metrics.PromptUtils
-
Renders a prompt template by substituting variables.
- request(ModelRequest) - Method in class com.google.genkit.ai.ModelResponse.Builder
- requestMetadata(Function<I, Map<String, Object>>) - Method in class com.google.genkit.ai.InterruptConfig.Builder
-
Sets the request metadata function.
- requestTimeout(Duration) - Method in class com.google.genkit.plugins.mcp.MCPPluginOptions.Builder
-
Sets the request timeout for MCP operations.
- requiresEmbedder() - Method in enum class com.google.genkit.plugins.evaluators.GenkitMetric
-
Returns whether this metric requires an embedder.
- requiresJudge() - Method in enum class com.google.genkit.plugins.evaluators.GenkitMetric
-
Returns whether this metric requires an LLM judge for evaluation.
- reset() - Static method in class com.google.genkit.core.telemetry.TelemetryConfig
-
Resets the configuration.
- resolve(SessionStore<S>, boolean, AgentInit<S>, SessionStoreOptions) - Static method in class com.google.genkit.ai.agent.internal.SessionResolver
- resolveAction(ActionType, String) - Method in interface com.google.genkit.core.DynamicPlugin
-
Resolves an action by type and name.
- resolveAction(ActionType, String) - Method in interface com.google.genkit.core.Registry
-
Looks up an action by type and name with dynamic resolution support.
- resolveAction(String) - Method in class com.google.genkit.core.DefaultRegistry
- resolveAction(String) - Method in interface com.google.genkit.core.Registry
-
Looks up an action by key.
- resolveEmbedder(MetricConfig) - Method in class com.google.genkit.plugins.evaluators.EvaluatorsPluginOptions
-
Resolves the embedder for a specific metric, falling back to the global default.
- resolveEmbedderOptions(MetricConfig) - Method in class com.google.genkit.plugins.evaluators.EvaluatorsPluginOptions
-
Resolves the embedder options for a specific metric, falling back to the global default.
- resolveJudge(MetricConfig) - Method in class com.google.genkit.plugins.evaluators.EvaluatorsPluginOptions
-
Resolves the judge for a specific metric, falling back to the global default.
- resolveJudgeConfig(MetricConfig) - Method in class com.google.genkit.plugins.evaluators.EvaluatorsPluginOptions
-
Resolves the judge config for a specific metric, falling back to the global default.
- RESOURCE - Enum constant in enum class com.google.genkit.core.ActionType
-
A resource action for managing external resources.
- respond(Part, O) - Method in class com.google.genkit.ai.Tool
-
Constructs a tool response for an interrupted tool request.
- respond(Part, O, Map<String, Object>) - Method in class com.google.genkit.ai.Tool
-
Constructs a tool response for an interrupted tool request with metadata.
- respond(ToolResponse) - Method in class com.google.genkit.ai.ResumeOptions.Builder
-
Adds a tool response.
- respond(Object) - Method in class com.google.genkit.ai.InterruptRequest
-
Creates a tool response to respond to this interrupt.
- respond(Object, Map<String, Object>) - Method in class com.google.genkit.ai.InterruptRequest
-
Creates a tool response to respond to this interrupt with additional metadata.
- respond(List<Part>) - Method in class com.google.genkit.ai.agent.ToolResume.Builder
- respond(List<ToolResponse>) - Method in class com.google.genkit.ai.ResumeOptions.Builder
-
Sets all tool responses.
- response - Variable in class com.google.genkit.plugins.middleware.Agents.DelegateOutput
- response - Variable in class com.google.genkit.plugins.middleware.internal.Delegation.Result
- responseFormat(String) - Method in class com.google.genkit.plugins.openai.ImageGenerationConfig.Builder
- restart() - Method in class com.google.genkit.ai.InterruptRequest
-
Creates a tool request to restart this interrupt.
- restart(Part, Map<String, Object>) - Method in class com.google.genkit.ai.Tool
-
Constructs a restart request for an interrupted tool.
- restart(Part, Map<String, Object>, I) - Method in class com.google.genkit.ai.Tool
-
Constructs a restart request with replacement input.
- restart(ToolRequest) - Method in class com.google.genkit.ai.ResumeOptions.Builder
-
Adds a tool request to restart.
- restart(List<Part>) - Method in class com.google.genkit.ai.agent.AgentChat
-
Resumes a paused turn by restarting its interrupted tool requests.
- restart(List<Part>) - Method in class com.google.genkit.ai.agent.ToolResume.Builder
- restart(List<ToolRequest>) - Method in class com.google.genkit.ai.ResumeOptions.Builder
-
Sets all tool requests to restart.
- restart(Map<String, Object>) - Method in class com.google.genkit.ai.InterruptRequest
-
Creates a tool request to restart this interrupt with new metadata.
- restart(Map<String, Object>, Object) - Method in class com.google.genkit.ai.InterruptRequest
-
Creates a tool request to restart this interrupt with new input.
- result(T) - Method in class com.google.genkit.core.ActionRunResult.Builder
- results(List<EvalResult>) - Method in class com.google.genkit.ai.evaluation.EvalRun.Builder
- resume() - Method in class com.google.genkit.ai.agent.AgentFnContext
-
Returns this turn's tool-resume data, i.e. the
respond/restartparts passed toAgentChat.resume(...)(or the rawAgentInput.resumefield for lower-level callers). - resume(ToolResume) - Method in class com.google.genkit.ai.agent.AgentInput.Builder
- resume(ResumeOptions) - Method in class com.google.genkit.ai.GenerateOptions.Builder
-
Sets the resume options for continuing after an interrupt.
- resume(List<Part>) - Method in class com.google.genkit.ai.agent.AgentChat
-
Resumes a paused turn by responding to its interrupts.
- ResumeOptions - Class in com.google.genkit.ai
-
Options for resuming after an interrupt.
- ResumeOptions() - Constructor for class com.google.genkit.ai.ResumeOptions
-
Default constructor.
- ResumeOptions.Builder - Class in com.google.genkit.ai
-
Builder for ResumeOptions.
- retrieve(ActionContext, RetrieverRequest) - Method in class com.google.genkit.plugins.chroma.ChromaVectorStore
-
Retrieves documents similar to the query.
- retrieve(ActionContext, RetrieverRequest) - Method in class com.google.genkit.plugins.firebase.retriever.FirestoreVectorStore
-
Retrieves documents from Firestore using vector similarity search.
- retrieve(ActionContext, RetrieverRequest) - Method in class com.google.genkit.plugins.localvec.LocalVecDocStore
-
Retrieves documents similar to the query.
- retrieve(ActionContext, RetrieverRequest) - Method in class com.google.genkit.plugins.milvus.MilvusVectorStore
-
Retrieves documents similar to the query.
- retrieve(ActionContext, RetrieverRequest) - Method in class com.google.genkit.plugins.mongodb.MongoVectorStore
-
Retrieves documents similar to the query using the
$vectorSearchaggregation stage. - retrieve(ActionContext, RetrieverRequest) - Method in class com.google.genkit.plugins.pinecone.PineconeVectorStore
-
Retrieves documents similar to the query.
- retrieve(ActionContext, RetrieverRequest) - Method in class com.google.genkit.plugins.postgresql.PostgresVectorStore
-
Retrieves documents similar to the query.
- retrieve(ActionContext, RetrieverRequest) - Method in class com.google.genkit.plugins.qdrant.QdrantVectorStore
-
Retrieves documents similar to the query.
- retrieve(ActionContext, RetrieverRequest) - Method in class com.google.genkit.plugins.weaviate.WeaviateVectorStore
-
Retrieves documents from Weaviate using vector similarity search.
- retrieve(String, Document) - Method in class com.google.genkit.Genkit
-
Retrieves documents using a Document as the query.
- retrieve(String, String) - Method in class com.google.genkit.Genkit
-
Retrieves documents using the specified retriever.
- retrieve(String, String, RetrieverRequest.RetrieverOptions) - Method in class com.google.genkit.Genkit
-
Retrieves documents using the specified retriever with options.
- Retriever - Class in com.google.genkit.ai
-
Retriever is an action that retrieves documents based on a query.
- Retriever(String, BiFunction<ActionContext, RetrieverRequest, RetrieverResponse>) - Constructor for class com.google.genkit.ai.Retriever
-
Creates a new Retriever.
- RETRIEVER - Enum constant in enum class com.google.genkit.core.ActionType
-
A retriever action that fetches documents from a vector store or other source.
- Retriever.Builder - Class in com.google.genkit.ai
-
Builder for Retriever.
- RetrieverOptions - Class in com.google.genkit.plugins.localvec
-
Options for the local vector store retriever.
- RetrieverOptions() - Constructor for class com.google.genkit.ai.RetrieverRequest.RetrieverOptions
- RetrieverOptions() - Constructor for class com.google.genkit.plugins.localvec.RetrieverOptions
-
Default constructor.
- RetrieverOptions(int) - Constructor for class com.google.genkit.plugins.localvec.RetrieverOptions
-
Creates options with specified k value.
- RetrieverRequest - Class in com.google.genkit.ai
-
RetrieverRequest contains a query for document retrieval.
- RetrieverRequest() - Constructor for class com.google.genkit.ai.RetrieverRequest
-
Default constructor.
- RetrieverRequest(Document) - Constructor for class com.google.genkit.ai.RetrieverRequest
-
Creates a RetrieverRequest with a query.
- RetrieverRequest.RetrieverOptions - Class in com.google.genkit.ai
-
RetrieverOptions contains options for retrieval.
- RetrieverResponse - Class in com.google.genkit.ai
-
RetrieverResponse contains documents retrieved from a query.
- RetrieverResponse() - Constructor for class com.google.genkit.ai.RetrieverResponse
-
Default constructor.
- RetrieverResponse(List<Document>) - Constructor for class com.google.genkit.ai.RetrieverResponse
-
Creates a RetrieverResponse with documents.
- retry(int, long) - Static method in class com.google.genkit.core.middleware.CommonMiddleware
-
Creates a retry middleware with exponential backoff.
- retry(int, long, Function<GenkitException, Boolean>) - Static method in class com.google.genkit.core.middleware.CommonMiddleware
-
Creates a retry middleware with exponential backoff and custom retry predicate.
- RetryMiddleware - Class in com.google.genkit.plugins.middleware
-
Retries a failed model call with exponential backoff.
- RetryMiddleware(RetryMiddleware.Options) - Constructor for class com.google.genkit.plugins.middleware.RetryMiddleware
- RetryMiddleware.Options - Class in com.google.genkit.plugins.middleware
-
Configuration parameters for
RetryMiddleware. - role(Role) - Method in class com.google.genkit.ai.Message.Builder
- Role - Enum Class in com.google.genkit.ai
-
Role represents the role of a message sender in a conversation.
- run() - Method in interface com.google.genkit.ai.agent.internal.DetachController.DetachedTurn
-
Runs the detached turn body.
- run(AgentInput, TurnContext) - Method in interface com.google.genkit.ai.agent.TurnBody
-
Runs the body of this turn.
- run(Session<?>, Runnable) - Static method in class com.google.genkit.ai.agent.AgentSessionContext
-
Executes
bodywithsessionbound to the current thread context. - run(SessionRunner<S>, AgentFnContext) - Method in interface com.google.genkit.ai.agent.AgentFn
-
Runs one turn of agent logic.
- run(ActionContext, AgentInput) - Method in class com.google.genkit.ai.agent.Agent
- run(ActionContext, AgentInput, Consumer<AgentStreamChunk>) - Method in class com.google.genkit.ai.agent.Agent
- run(ActionContext, EmbedRequest) - Method in class com.google.genkit.ai.Embedder
- run(ActionContext, EmbedRequest) - Method in class com.google.genkit.plugins.awsbedrock.AwsBedrockEmbedder
- run(ActionContext, EmbedRequest) - Method in class com.google.genkit.plugins.compatoai.CompatOAIEmbedder
- run(ActionContext, EmbedRequest) - Method in class com.google.genkit.plugins.googlegenai.GeminiEmbedder
- run(ActionContext, EmbedRequest) - Method in class com.google.genkit.plugins.openai.OpenAIEmbedder
- run(ActionContext, EmbedRequest, Consumer<Void>) - Method in class com.google.genkit.ai.Embedder
- run(ActionContext, EvalRequest) - Method in class com.google.genkit.ai.evaluation.Evaluator
- run(ActionContext, EvalRequest, Consumer<Void>) - Method in class com.google.genkit.ai.evaluation.Evaluator
- run(ActionContext, GenerateActionOptions) - Method in class com.google.genkit.ai.GenerateAction
- run(ActionContext, GenerateActionOptions, Consumer<ModelResponseChunk>) - Method in class com.google.genkit.ai.GenerateAction
- run(ActionContext, IndexerRequest) - Method in class com.google.genkit.ai.Indexer
- run(ActionContext, IndexerRequest, Consumer<Void>) - Method in class com.google.genkit.ai.Indexer
- run(ActionContext, ModelRequest) - Method in interface com.google.genkit.ai.Model
-
Generates a response from the given request.
- run(ActionContext, ModelRequest) - Method in class com.google.genkit.plugins.anthropic.AnthropicModel
- run(ActionContext, ModelRequest) - Method in class com.google.genkit.plugins.awsbedrock.AwsBedrockModel
- run(ActionContext, ModelRequest) - Method in class com.google.genkit.plugins.compatoai.CompatOAIModel
- run(ActionContext, ModelRequest) - Method in class com.google.genkit.plugins.googlegenai.GeminiModel
- run(ActionContext, ModelRequest) - Method in class com.google.genkit.plugins.googlegenai.ImagenModel
- run(ActionContext, ModelRequest) - Method in class com.google.genkit.plugins.googlegenai.OmniModel
- run(ActionContext, ModelRequest) - Method in class com.google.genkit.plugins.googlegenai.TtsModel
- run(ActionContext, ModelRequest) - Method in class com.google.genkit.plugins.googlegenai.VeoModel
- run(ActionContext, ModelRequest) - Method in class com.google.genkit.plugins.ollama.OllamaModel
- run(ActionContext, ModelRequest) - Method in class com.google.genkit.plugins.openai.OpenAIImageModel
- run(ActionContext, ModelRequest) - Method in class com.google.genkit.plugins.openai.OpenAIModel
- run(ActionContext, ModelRequest, Consumer<ModelResponseChunk>) - Method in interface com.google.genkit.ai.Model
-
Generates a streaming response from the given request.
- run(ActionContext, ModelRequest, Consumer<ModelResponseChunk>) - Method in class com.google.genkit.plugins.anthropic.AnthropicModel
- run(ActionContext, ModelRequest, Consumer<ModelResponseChunk>) - Method in class com.google.genkit.plugins.awsbedrock.AwsBedrockModel
- run(ActionContext, ModelRequest, Consumer<ModelResponseChunk>) - Method in class com.google.genkit.plugins.compatoai.CompatOAIModel
- run(ActionContext, ModelRequest, Consumer<ModelResponseChunk>) - Method in class com.google.genkit.plugins.googlegenai.GeminiModel
- run(ActionContext, ModelRequest, Consumer<ModelResponseChunk>) - Method in class com.google.genkit.plugins.googlegenai.ImagenModel
- run(ActionContext, ModelRequest, Consumer<ModelResponseChunk>) - Method in class com.google.genkit.plugins.googlegenai.OmniModel
- run(ActionContext, ModelRequest, Consumer<ModelResponseChunk>) - Method in class com.google.genkit.plugins.googlegenai.TtsModel
- run(ActionContext, ModelRequest, Consumer<ModelResponseChunk>) - Method in class com.google.genkit.plugins.googlegenai.VeoModel
- run(ActionContext, ModelRequest, Consumer<ModelResponseChunk>) - Method in class com.google.genkit.plugins.ollama.OllamaModel
- run(ActionContext, ModelRequest, Consumer<ModelResponseChunk>) - Method in class com.google.genkit.plugins.openai.OpenAIImageModel
- run(ActionContext, ModelRequest, Consumer<ModelResponseChunk>) - Method in class com.google.genkit.plugins.openai.OpenAIModel
- run(ActionContext, RetrieverRequest) - Method in class com.google.genkit.ai.Retriever
- run(ActionContext, RetrieverRequest, Consumer<Void>) - Method in class com.google.genkit.ai.Retriever
- run(ActionContext, I) - Method in class com.google.genkit.ai.Prompt
- run(ActionContext, I) - Method in class com.google.genkit.ai.Tool
- run(ActionContext, I) - Method in interface com.google.genkit.core.Action
-
Runs the action with the given input.
- run(ActionContext, I) - Method in class com.google.genkit.core.ActionDef
- run(ActionContext, I) - Method in class com.google.genkit.core.BidiActionImpl
-
Unary adaptation: wraps
inputin aBufferedInputSource(withnullinit) and delegates to the bidi handler. - run(ActionContext, I) - Method in class com.google.genkit.core.Flow
- run(ActionContext, I, Consumer<Void>) - Method in class com.google.genkit.ai.Prompt
- run(ActionContext, I, Consumer<Void>) - Method in class com.google.genkit.ai.Tool
- run(ActionContext, I, Consumer<S>) - Method in interface com.google.genkit.core.Action
-
Runs the action with the given input and streaming callback.
- run(ActionContext, I, Consumer<S>) - Method in class com.google.genkit.core.ActionDef
- run(ActionContext, I, Consumer<S>) - Method in class com.google.genkit.core.BidiActionImpl
-
Unary adaptation with streaming: wraps
inputin aBufferedInputSource(withnullinit) and delegates to the bidi handler. - run(ActionContext, I, Consumer<S>) - Method in class com.google.genkit.core.Flow
- run(ActionContext, String, String, boolean, int) - Static method in class com.google.genkit.plugins.middleware.internal.Delegation
-
Runs the sub-agent named
agentNamefor a single turn withtaskas the user message, merges any produced artifacts (namespaced by a fresh invocation id) into the active parent session, and returns the sub-agent's text plus the (namespaced) artifacts. - run(ActionContext, String, Function<Void, T>) - Static method in class com.google.genkit.core.Flow
-
Runs a named step within the current flow.
- runAgent(String, JsonNode, HttpServletRequest) - Method in class com.google.genkit.plugins.spring.GenkitAgentController
-
Handles one turn of an agent conversation.
- runBidi(ActionContext, AgentInit<S>, InputSource<AgentInput>, Consumer<AgentStreamChunk>) - Method in class com.google.genkit.ai.agent.Agent
- runBidi(ActionContext, Init, InputSource<I>, Consumer<S>) - Method in interface com.google.genkit.core.BidiAction
-
Runs the action in bidirectional-streaming mode.
- runBidi(ActionContext, Init, InputSource<I>, Consumer<S>) - Method in class com.google.genkit.core.BidiActionImpl
- runBidiJson(ActionContext, JsonNode, InputSource<JsonNode>, Consumer<JsonNode>) - Method in class com.google.genkit.ai.agent.Agent
- runBidiJson(ActionContext, JsonNode, InputSource<JsonNode>, Consumer<JsonNode>) - Method in interface com.google.genkit.core.BidiAction
-
Runs the action in bidirectional-streaming mode with JSON-typed arguments.
- runBidiJson(ActionContext, JsonNode, InputSource<JsonNode>, Consumer<JsonNode>) - Method in class com.google.genkit.core.BidiActionImpl
- runBidiJsonWithTelemetry(ActionContext, JsonNode, InputSource<JsonNode>, Consumer<JsonNode>) - Method in class com.google.genkit.ai.agent.Agent
- runBidiJsonWithTelemetry(ActionContext, JsonNode, InputSource<JsonNode>, Consumer<JsonNode>) - Method in interface com.google.genkit.core.BidiAction
-
Runs the action in bidirectional-streaming mode with JSON-typed arguments and telemetry.
- runBidiJsonWithTelemetry(ActionContext, JsonNode, InputSource<JsonNode>, Consumer<JsonNode>) - Method in class com.google.genkit.core.BidiActionImpl
- runEvaluation(RunEvaluationRequest) - Method in class com.google.genkit.ai.evaluation.EvaluationManager
-
Runs a new evaluation.
- RunEvaluationRequest - Class in com.google.genkit.ai.evaluation
-
Request to run a new evaluation.
- RunEvaluationRequest() - Constructor for class com.google.genkit.ai.evaluation.RunEvaluationRequest
- RunEvaluationRequest.Builder - Class in com.google.genkit.ai.evaluation
- RunEvaluationRequest.DataSource - Class in com.google.genkit.ai.evaluation
-
Data source for evaluation - either a dataset ID or inline data.
- RunEvaluationRequest.EvaluationOptions - Class in com.google.genkit.ai.evaluation
-
Options for evaluation.
- runFlow(String, I) - Method in class com.google.genkit.Genkit
-
Runs a flow by name.
- runInNewSpan(ActionContext, SpanMetadata, I, BiFunction<SpanContext, I, O>) - Static method in class com.google.genkit.core.tracing.Tracer
-
Runs a function within a new tracing span.
- runJson(ActionContext, JsonNode, Consumer<JsonNode>) - Method in class com.google.genkit.ai.agent.Agent
- runJson(ActionContext, JsonNode, Consumer<JsonNode>) - Method in class com.google.genkit.ai.Embedder
- runJson(ActionContext, JsonNode, Consumer<JsonNode>) - Method in class com.google.genkit.ai.evaluation.Evaluator
- runJson(ActionContext, JsonNode, Consumer<JsonNode>) - Method in class com.google.genkit.ai.GenerateAction
- runJson(ActionContext, JsonNode, Consumer<JsonNode>) - Method in class com.google.genkit.ai.Indexer
- runJson(ActionContext, JsonNode, Consumer<JsonNode>) - Method in interface com.google.genkit.ai.Model
- runJson(ActionContext, JsonNode, Consumer<JsonNode>) - Method in class com.google.genkit.ai.Prompt
- runJson(ActionContext, JsonNode, Consumer<JsonNode>) - Method in class com.google.genkit.ai.Retriever
- runJson(ActionContext, JsonNode, Consumer<JsonNode>) - Method in class com.google.genkit.ai.Tool
- runJson(ActionContext, JsonNode, Consumer<JsonNode>) - Method in interface com.google.genkit.core.Action
-
Runs the action with JSON input and returns JSON output.
- runJson(ActionContext, JsonNode, Consumer<JsonNode>) - Method in class com.google.genkit.core.ActionDef
- runJson(ActionContext, JsonNode, Consumer<JsonNode>) - Method in class com.google.genkit.core.BidiActionImpl
- runJson(ActionContext, JsonNode, Consumer<JsonNode>) - Method in class com.google.genkit.core.Flow
- runJsonWithTelemetry(ActionContext, JsonNode, Consumer<JsonNode>) - Method in class com.google.genkit.ai.agent.Agent
- runJsonWithTelemetry(ActionContext, JsonNode, Consumer<JsonNode>) - Method in class com.google.genkit.ai.Embedder
- runJsonWithTelemetry(ActionContext, JsonNode, Consumer<JsonNode>) - Method in class com.google.genkit.ai.evaluation.Evaluator
- runJsonWithTelemetry(ActionContext, JsonNode, Consumer<JsonNode>) - Method in class com.google.genkit.ai.GenerateAction
- runJsonWithTelemetry(ActionContext, JsonNode, Consumer<JsonNode>) - Method in class com.google.genkit.ai.Indexer
- runJsonWithTelemetry(ActionContext, JsonNode, Consumer<JsonNode>) - Method in interface com.google.genkit.ai.Model
- runJsonWithTelemetry(ActionContext, JsonNode, Consumer<JsonNode>) - Method in class com.google.genkit.ai.Prompt
- runJsonWithTelemetry(ActionContext, JsonNode, Consumer<JsonNode>) - Method in class com.google.genkit.ai.Retriever
- runJsonWithTelemetry(ActionContext, JsonNode, Consumer<JsonNode>) - Method in class com.google.genkit.ai.Tool
- runJsonWithTelemetry(ActionContext, JsonNode, Consumer<JsonNode>) - Method in interface com.google.genkit.core.Action
-
Runs the action with JSON input and returns the result with telemetry information.
- runJsonWithTelemetry(ActionContext, JsonNode, Consumer<JsonNode>) - Method in class com.google.genkit.core.ActionDef
- runJsonWithTelemetry(ActionContext, JsonNode, Consumer<JsonNode>) - Method in class com.google.genkit.core.BidiActionImpl
- runJsonWithTelemetry(ActionContext, JsonNode, Consumer<JsonNode>) - Method in class com.google.genkit.core.Flow
- RuntimeError - Class in com.google.genkit.ai.agent
-
RuntimeError represents a runtime error that occurred during agent execution.
- RuntimeError() - Constructor for class com.google.genkit.ai.agent.RuntimeError
-
Default constructor.
- RuntimeError.Builder - Class in com.google.genkit.ai.agent
-
Builder for RuntimeError.
- RuntimeFileWriter - Class in com.google.genkit
-
RuntimeFileWriter writes runtime discovery files for the Genkit Dev UI.
- RuntimeFileWriter() - Constructor for class com.google.genkit.RuntimeFileWriter
- runTurn(AgentInput, AgentInit<S>, Consumer<AgentStreamChunk>) - Method in interface com.google.genkit.ai.agent.AgentTransport
-
Runs ONE turn: feeds
inputwithinit, collects stream chunks viaonChunk, and returns the final output. - runTurn(AgentInput, AgentInit<S>, Consumer<AgentStreamChunk>) - Method in class com.google.genkit.ai.agent.internal.InProcessTransport
- runTurn(AgentInput, AgentInit<S>, Consumer<AgentStreamChunk>) - Method in class com.google.genkit.client.HttpAgentTransport
- runTurn(AgentInput, TurnBody<S>) - Method in class com.google.genkit.ai.agent.SessionRunner
-
Runs ONE turn: Validates
input.message: role must be null/USER; rejects tool-request and tool-response parts → throwsGenkitExceptionwithINVALID_ARGUMENT(API misuse; not graceful). - runWithTelemetry(String, String, String, ModelRequest, ModelTelemetryHelper.ModelExecutor) - Static method in class com.google.genkit.ai.telemetry.ModelTelemetryHelper
-
Executes a model call with automatic telemetry recording.
- runWithTelemetryStreaming(String, String, String, ModelRequest, ModelTelemetryHelper.StreamingModelExecutor) - Static method in class com.google.genkit.ai.telemetry.ModelTelemetryHelper
-
Executes a streaming model call with automatic telemetry recording.
S
- sampleIndex(Integer) - Method in class com.google.genkit.ai.evaluation.EvalResponse.Builder
- save(EvalRun) - Method in interface com.google.genkit.ai.evaluation.EvalStore
-
Saves an evaluation run.
- save(EvalRun) - Method in class com.google.genkit.ai.evaluation.LocalFileEvalStore
- save(TraceData) - Method in class com.google.genkit.core.tracing.HttpTelemetryClient
- save(TraceData) - Method in interface com.google.genkit.core.tracing.TelemetryClient
-
Saves trace data to the telemetry server.
- saveSnapshot(String, SnapshotMutator<S>, SessionStoreOptions) - Method in class com.google.genkit.ai.agent.FileSessionStore
-
Atomically reads the snapshot identified by
snapshotId(or creates a new one), appliesmutator, and persists the result. - saveSnapshot(String, SnapshotMutator<S>, SessionStoreOptions) - Method in class com.google.genkit.ai.agent.InMemorySessionStore
-
Atomically reads the snapshot identified by
snapshotId(or creates a new one), appliesmutator, and persists the result. - saveSnapshot(String, SnapshotMutator<S>, SessionStoreOptions) - Method in interface com.google.genkit.ai.agent.SnapshotWriter
-
Atomically reads the snapshot identified by
snapshotId(or creates a new one), appliesmutator, and persists the result. - saveSnapshot(String, SnapshotMutator<S>, SessionStoreOptions) - Method in class com.google.genkit.plugins.awsbedrock.session.DynamoDbSessionStore
-
Atomically reads the snapshot identified by
snapshotId(or creates a new one), appliesmutator, and persists the result. - saveSnapshot(String, SnapshotMutator<S>, SessionStoreOptions) - Method in class com.google.genkit.plugins.azurefoundry.session.CosmosSessionStore
-
Atomically reads the snapshot identified by
snapshotId(or creates a new one), appliesmutator, and persists the result. - saveSnapshot(String, SnapshotMutator<S>, SessionStoreOptions) - Method in class com.google.genkit.plugins.firebase.session.FirestoreSessionStore
-
Atomically reads the snapshot identified by
snapshotId(or creates a new one), appliesmutator, and persists the result. - saveSnapshot(String, SnapshotMutator<S>, SessionStoreOptions) - Method in class com.google.genkit.plugins.mongodb.session.MongoSessionStore
-
Atomically reads the snapshot identified by
snapshotId(or creates a new one), appliesmutator, and persists the result. - saveSnapshot(String, SnapshotMutator<S>, SessionStoreOptions) - Method in class com.google.genkit.plugins.postgresql.session.PostgresSessionStore
-
Atomically reads the snapshot identified by
snapshotId(or creates a new one), appliesmutator, and persists the result. - schema(JsonNode) - Method in class com.google.genkit.ai.evaluation.CreateDatasetRequest.Builder
- schema(JsonNode) - Method in class com.google.genkit.ai.evaluation.DatasetMetadata.Builder
- schema(JsonNode) - Method in class com.google.genkit.ai.evaluation.UpdateDatasetRequest.Builder
- SchemaUtils - Class in com.google.genkit.core
-
SchemaUtils provides utilities for JSON Schema generation and validation.
- score(boolean) - Method in class com.google.genkit.ai.evaluation.Score.Builder
- score(double) - Method in class com.google.genkit.ai.evaluation.Score.Builder
- score(Object) - Method in class com.google.genkit.ai.evaluation.EvalMetric.Builder
- score(String) - Method in class com.google.genkit.ai.evaluation.Score.Builder
- Score - Class in com.google.genkit.ai.evaluation
-
Score represents the result of an evaluation.
- Score() - Constructor for class com.google.genkit.ai.evaluation.Score
- Score.Builder - Class in com.google.genkit.ai.evaluation
- ScoreDetails - Class in com.google.genkit.ai.evaluation
-
Details about an evaluation score, including reasoning.
- ScoreDetails() - Constructor for class com.google.genkit.ai.evaluation.ScoreDetails
- ScoreDetails.Builder - Class in com.google.genkit.ai.evaluation
- scoreId(String) - Method in class com.google.genkit.ai.evaluation.EvalMetric.Builder
- secure(boolean) - Method in class com.google.genkit.plugins.weaviate.WeaviatePlugin.Builder
-
Sets whether to use secure connection (HTTPS).
- seed(Integer) - Method in class com.google.genkit.ai.GenerationConfig.Builder
- selectLeaf(List<SessionSnapshot<S>>, boolean) - Static method in class com.google.genkit.ai.agent.internal.LeafSelection
-
Selects the leaf snapshot from the given list.
- send(AgentInput) - Method in class com.google.genkit.ai.agent.AgentChat
-
Sends a fully-formed input and returns the turn's response.
- send(String) - Method in class com.google.genkit.ai.agent.AgentChat
-
Sends a user text message and returns the turn's response.
- sendChunk() - Method in class com.google.genkit.ai.agent.AgentFnContext
-
Returns the stream-chunk emitter for this invocation.
- sendStream(AgentInput, Consumer<AgentChunk<S>>) - Method in class com.google.genkit.ai.agent.AgentChat
-
Sends a fully-formed input, streaming chunks to
onChunk, and returns the final response. - sendStream(String, Consumer<AgentChunk<S>>) - Method in class com.google.genkit.ai.agent.AgentChat
-
Sends a user text message, streaming chunks to
onChunk, and returns the final response. - serverManaged() - Method in class com.google.genkit.ai.agent.Agent
-
Returns whether this agent uses server-managed session state.
- serverManaged() - Method in interface com.google.genkit.ai.agent.AgentTransport
-
Returns whether the underlying agent is server-managed (state persisted server-side) versus client-managed (state round-tripped by the caller).
- serverManaged() - Method in class com.google.genkit.ai.agent.internal.InProcessTransport
- serverManaged() - Method in class com.google.genkit.client.HttpAgentTransport
- serverManaged() - Method in class com.google.genkit.client.RemoteAgentOptions
-
Returns whether the agent is server-managed (default
true). - serverManaged(boolean) - Method in class com.google.genkit.client.RemoteAgentOptions.Builder
-
Sets whether the agent is server-managed.
- ServerPlugin - Interface in com.google.genkit.core
-
ServerPlugin is an extended Plugin interface for plugins that provide HTTP server functionality.
- servers(Map<String, MCPServerConfig>) - Method in class com.google.genkit.plugins.mcp.MCPPluginOptions.Builder
-
Sets all MCP server configurations at once.
- service(HttpRequest, HttpResponse) - Method in class com.google.genkit.plugins.firebase.functions.OnCallGenkit
- session() - Method in class com.google.genkit.ai.agent.internal.SessionResolver.Resolution
-
Returns the resolved session, or
nullif this is a failure resolution. - session() - Method in class com.google.genkit.ai.agent.SessionRunner
-
Returns the underlying session.
- Session<S> - Class in com.google.genkit.ai.agent
-
Session is the per-invocation in-memory state holder managed by the agent runtime.
- Session(SessionState<S>) - Constructor for class com.google.genkit.ai.agent.Session
-
Constructs a new Session from the given initial state.
- SESSION - Enum constant in enum class com.google.genkit.plugins.middleware.ArtifactStrategy
-
Merge sub-agent artifacts into the parent session and return only their (namespaced) names in the delegation tool result, not their content.
- sessionId() - Method in class com.google.genkit.ai.agent.AgentChat
-
Returns the session ID.
- sessionId() - Method in class com.google.genkit.ai.agent.AgentResponse
-
Returns the session ID.
- sessionId() - Method in class com.google.genkit.ai.agent.Session
-
Returns the session ID.
- sessionId() - Method in class com.google.genkit.ai.agent.SessionRunner
-
Returns the session ID.
- sessionId(String) - Method in class com.google.genkit.ai.agent.AgentInit.Builder
- sessionId(String) - Method in class com.google.genkit.ai.agent.AgentOutput.Builder
- sessionId(String) - Method in class com.google.genkit.ai.agent.GetSnapshotOptions.Builder
-
Sets the session ID whose latest leaf snapshot should be retrieved.
- sessionId(String) - Method in class com.google.genkit.ai.agent.GetSnapshotRequest.Builder
- sessionId(String) - Method in class com.google.genkit.ai.agent.SessionSnapshot.Builder
- sessionId(String) - Method in class com.google.genkit.ai.agent.SessionState.Builder
- sessionId(String) - Method in class com.google.genkit.core.ActionContext.Builder
- SessionResolver - Class in com.google.genkit.ai.agent.internal
- SessionResolver.Resolution<S> - Class in com.google.genkit.ai.agent.internal
-
Result of session resolution: either a ready
Session, or a graceful pre-turn failure. - SessionRunner<S> - Class in com.google.genkit.ai.agent
-
Drives ONE turn of an agent session: validates the input, appends the user message, runs the turn body, and persists a snapshot on success (
SnapshotStatus.COMPLETED) or on failure (SnapshotStatus.FAILED). - SessionRunner(Session<S>, SessionStore<S>, SessionStoreOptions) - Constructor for class com.google.genkit.ai.agent.SessionRunner
-
Constructs a new SessionRunner.
- SessionRunner(Session<S>, SessionStore<S>, SessionStoreOptions, String) - Constructor for class com.google.genkit.ai.agent.SessionRunner
-
Constructs a new SessionRunner seeded with the id of the snapshot the session was resumed from.
- SessionSnapshot<S> - Class in com.google.genkit.ai.agent
-
SessionSnapshot represents a point-in-time snapshot of an agent session.
- SessionSnapshot() - Constructor for class com.google.genkit.ai.agent.SessionSnapshot
-
Default constructor.
- SessionSnapshot.Builder<S> - Class in com.google.genkit.ai.agent
-
Builder for SessionSnapshot.
- SessionState<S> - Class in com.google.genkit.ai.agent
-
SessionState represents the state of an agent session.
- SessionState() - Constructor for class com.google.genkit.ai.agent.SessionState
-
Default constructor.
- SessionState.Builder<S> - Class in com.google.genkit.ai.agent
-
Builder for SessionState.
- SessionStore<S> - Interface in com.google.genkit.ai.agent
-
Combined read/write interface for a session store.
- SessionStoreOptions - Class in com.google.genkit.ai.agent
-
Options passed to session store operations.
- SessionStoreOptions.Builder - Class in com.google.genkit.ai.agent
-
Builder for
SessionStoreOptions. - setAbortable(boolean) - Method in class com.google.genkit.ai.agent.AgentMetadata
-
Sets whether the agent supports abort.
- setActionConfig(Object) - Method in class com.google.genkit.ai.evaluation.EvalRunKey
- setActionConfig(Object) - Method in class com.google.genkit.ai.evaluation.RunEvaluationRequest.EvaluationOptions
- setActionRef(String) - Method in class com.google.genkit.ai.evaluation.EvalRunKey
- setAdditionalProperty(String, Object) - Method in class com.google.genkit.ai.evaluation.ScoreDetails
- setAnnotation(GenkitSpanData.Annotation) - Method in class com.google.genkit.core.tracing.GenkitSpanData.TimeEvent
- setAnswered(boolean) - Method in class com.google.genkit.plugins.evaluators.metrics.AnswerRelevancyResponse
- setArtifact(Artifact) - Method in class com.google.genkit.ai.agent.AgentStreamChunk
-
Sets the artifact.
- setArtifacts(List<Artifact>) - Method in class com.google.genkit.ai.agent.AgentOutput
-
Sets the output artifacts.
- setArtifacts(List<Artifact>) - Method in class com.google.genkit.ai.agent.AgentResult
-
Sets the result artifacts.
- setArtifacts(List<Artifact>) - Method in class com.google.genkit.ai.agent.SessionState
-
Sets the session artifacts.
- setAttributes(Map<String, Object>) - Method in class com.google.genkit.core.tracing.GenkitSpanData.Annotation
- setAttributes(Map<String, Object>) - Method in class com.google.genkit.core.tracing.GenkitSpanData.Link
- setAttributes(Map<String, Object>) - Method in class com.google.genkit.core.tracing.GenkitSpanData
- setAttributes(Map<String, Object>) - Method in class com.google.genkit.core.tracing.SpanMetadata
- setBackground(String) - Method in class com.google.genkit.plugins.openai.ImageGenerationConfig
- setBatchSize(Integer) - Method in class com.google.genkit.ai.evaluation.EvalRequest
- setBatchSize(Integer) - Method in class com.google.genkit.ai.evaluation.RunEvaluationRequest.EvaluationOptions
- setCachedContentTokens(Integer) - Method in class com.google.genkit.ai.Usage
- setCandidates(List<Candidate>) - Method in class com.google.genkit.ai.ModelResponse
- setClaims(Map<String, Object>) - Method in class com.google.genkit.plugins.firebase.functions.AuthContext
- setClient(TelemetryClient) - Method in class com.google.genkit.core.tracing.TelemetryServerExporter
-
Sets the telemetry client to use for exporting traces.
- setCode(int) - Method in class com.google.genkit.core.tracing.GenkitSpanData.Status
- setConfig(GenerationConfig) - Method in class com.google.genkit.ai.GenerateActionOptions
- setConfig(Map<String, Object>) - Method in class com.google.genkit.ai.ModelRequest
- setConstrained(Boolean) - Method in class com.google.genkit.ai.OutputConfig
- setContent(List<Part>) - Method in class com.google.genkit.ai.Document
- setContent(List<Part>) - Method in class com.google.genkit.ai.Message
- setContent(List<Part>) - Method in class com.google.genkit.ai.ModelResponseChunk
- setContentType(String) - Method in class com.google.genkit.ai.Media
- setContentType(String) - Method in class com.google.genkit.ai.OutputConfig
- setContext(GenkitSpanData.SpanContextData) - Method in class com.google.genkit.core.tracing.GenkitSpanData.Link
- setContext(Boolean) - Method in class com.google.genkit.ai.ModelInfo.ModelCapabilities
- setContext(String) - Method in class com.google.genkit.ai.evaluation.RunEvaluationRequest.EvaluationOptions
- setContext(List<Document>) - Method in class com.google.genkit.ai.ModelRequest
- setContext(List<Object>) - Method in class com.google.genkit.ai.evaluation.EvalDataPoint
- setContext(List<Object>) - Method in class com.google.genkit.ai.evaluation.EvalResult
- setContextCaching(Boolean) - Method in class com.google.genkit.ai.ModelInfo.ModelCapabilities
- setCreatedAt(String) - Method in class com.google.genkit.ai.agent.SessionSnapshot
-
Sets the creation timestamp.
- setCreatedAt(String) - Method in class com.google.genkit.ai.evaluation.EvalRunKey
- setCreateTime(String) - Method in class com.google.genkit.ai.evaluation.DatasetMetadata
- setCurrentCreatedAt(String) - Method in class com.google.genkit.ai.agent.internal.PointerDoc
-
Sets the current snapshot's createdAt timestamp.
- setCurrentSnapshotId(String) - Method in class com.google.genkit.ai.agent.internal.PointerDoc
-
Sets the current snapshot ID.
- setCustom(Map<String, Object>) - Method in class com.google.genkit.ai.Candidate
- setCustom(Map<String, Object>) - Method in class com.google.genkit.ai.evaluation.EvalDataPoint
- setCustom(Map<String, Object>) - Method in class com.google.genkit.ai.evaluation.EvalResult
- setCustom(Map<String, Object>) - Method in class com.google.genkit.ai.GenerationConfig
- setCustom(Map<String, Object>) - Method in class com.google.genkit.ai.ModelResponse
- setCustom(Map<String, Object>) - Method in class com.google.genkit.ai.RetrieverRequest.RetrieverOptions
- setCustom(S) - Method in class com.google.genkit.ai.agent.SessionState
-
Sets the custom state.
- setCustomOptions(Map<String, Object>) - Method in class com.google.genkit.ai.ModelInfo
- setCustomPatch(JsonNode) - Method in class com.google.genkit.ai.agent.AgentStreamChunk
-
Sets the custom-state patch.
- setData(Object) - Method in class com.google.genkit.ai.Part
- setData(List<DatasetSample>) - Method in class com.google.genkit.ai.evaluation.CreateDatasetRequest
- setData(List<DatasetSample>) - Method in class com.google.genkit.ai.evaluation.RunEvaluationRequest.DataSource
- setData(List<DatasetSample>) - Method in class com.google.genkit.ai.evaluation.UpdateDatasetRequest
- setDataset(List<EvalDataPoint>) - Method in class com.google.genkit.ai.evaluation.EvalRequest
- setDatasetId(String) - Method in class com.google.genkit.ai.evaluation.CreateDatasetRequest
- setDatasetId(String) - Method in class com.google.genkit.ai.evaluation.DatasetMetadata
- setDatasetId(String) - Method in class com.google.genkit.ai.evaluation.EvalRunKey
- setDatasetId(String) - Method in class com.google.genkit.ai.evaluation.RunEvaluationRequest.DataSource
- setDatasetId(String) - Method in class com.google.genkit.ai.evaluation.UpdateDatasetRequest
- setDatasetType(DatasetType) - Method in class com.google.genkit.ai.evaluation.CreateDatasetRequest
- setDatasetType(DatasetType) - Method in class com.google.genkit.ai.evaluation.DatasetMetadata
- setDatasetVersion(Integer) - Method in class com.google.genkit.ai.evaluation.EvalRunKey
- setDataSource(RunEvaluationRequest.DataSource) - Method in class com.google.genkit.ai.evaluation.RunEvaluationRequest
- setDefinition(String) - Method in class com.google.genkit.ai.evaluation.EvaluatorInfo
- setDescription(String) - Method in class com.google.genkit.ai.InterruptConfig
-
Sets the description.
- setDescription(String) - Method in class com.google.genkit.ai.ToolDefinition
- setDescription(String) - Method in class com.google.genkit.core.ActionDesc
- setDescription(String) - Method in class com.google.genkit.core.tracing.GenkitSpanData.Annotation
- setDetach(boolean) - Method in class com.google.genkit.ai.agent.AgentInput
-
Sets the detach flag.
- setDetails(ScoreDetails) - Method in class com.google.genkit.ai.evaluation.Score
- setDetails(Object) - Method in class com.google.genkit.ai.agent.RuntimeError
-
Sets additional error details.
- setDimensions(Integer) - Method in class com.google.genkit.ai.EmbedderInfo
- setDisplayName(String) - Method in class com.google.genkit.ai.evaluation.EvaluatorInfo
- setDisplayName(String) - Method in class com.google.genkit.core.tracing.GenkitSpanData
- setDisplayName(String) - Method in class com.google.genkit.core.tracing.TraceData
- setDoc(Document) - Method in class com.google.genkit.plugins.localvec.DbValue
-
Sets the document.
- setDocs(List<Document>) - Method in class com.google.genkit.ai.GenerateActionOptions
- setDocuments(List<Document>) - Method in class com.google.genkit.ai.EmbedRequest
- setDocuments(List<Document>) - Method in class com.google.genkit.ai.IndexerRequest
-
Sets the documents to index.
- setDocuments(List<Document>) - Method in class com.google.genkit.ai.RetrieverResponse
- setDroppedAttributesCount(int) - Method in class com.google.genkit.core.tracing.GenkitSpanData.Link
- setEmail(String) - Method in class com.google.genkit.plugins.firebase.functions.AuthContext
- setEmailVerified(boolean) - Method in class com.google.genkit.plugins.firebase.functions.AuthContext
- setEmbedding(List<Float>) - Method in class com.google.genkit.plugins.localvec.DbValue
-
Sets the embedding.
- setEmbeddings(List<EmbedResponse.Embedding>) - Method in class com.google.genkit.ai.EmbedResponse
- setEndTime(long) - Method in class com.google.genkit.core.tracing.GenkitSpanData
- setEndTime(long) - Method in class com.google.genkit.core.tracing.TraceData
- setError(RuntimeError) - Method in class com.google.genkit.ai.agent.AgentOutput
-
Sets the runtime error.
- setError(RuntimeError) - Method in class com.google.genkit.ai.agent.SessionSnapshot
-
Sets the runtime error.
- setError(String) - Method in class com.google.genkit.ai.evaluation.EvalDataPoint
- setError(String) - Method in class com.google.genkit.ai.evaluation.EvalMetric
- setError(String) - Method in class com.google.genkit.ai.evaluation.EvalResult
- setError(String) - Method in class com.google.genkit.ai.evaluation.Score
- setEvalRunId(String) - Method in class com.google.genkit.ai.evaluation.EvalRequest
- setEvalRunId(String) - Method in class com.google.genkit.ai.evaluation.EvalRunKey
- setEvaluation(Object) - Method in class com.google.genkit.ai.evaluation.EvalResponse
- setEvaluator(String) - Method in class com.google.genkit.ai.evaluation.EvalMetric
- setEvaluators(List<String>) - Method in class com.google.genkit.ai.evaluation.RunEvaluationRequest
- setFinishMessage(String) - Method in class com.google.genkit.ai.Candidate
- setFinishMessage(String) - Method in class com.google.genkit.ai.ModelResponse
- setFinishReason(AgentFinishReason) - Method in class com.google.genkit.ai.agent.AgentOutput
-
Sets the finish reason.
- setFinishReason(AgentFinishReason) - Method in class com.google.genkit.ai.agent.AgentResult
-
Sets the finish reason.
- setFinishReason(AgentFinishReason) - Method in class com.google.genkit.ai.agent.SessionSnapshot
-
Sets the finish reason.
- setFinishReason(AgentFinishReason) - Method in class com.google.genkit.ai.agent.TurnEnd
-
Sets the finish reason.
- setFinishReason(FinishReason) - Method in class com.google.genkit.ai.Candidate
- setFinishReason(FinishReason) - Method in class com.google.genkit.ai.ModelResponse
- setFormat(OutputFormat) - Method in class com.google.genkit.ai.OutputConfig
- setFrequencyPenalty(Double) - Method in class com.google.genkit.ai.GenerationConfig
- setHeartbeatAt(String) - Method in class com.google.genkit.ai.agent.SessionSnapshot
-
Sets the last-heartbeat timestamp.
- setHeartbeatIntervalMillisForTest(long) - Static method in class com.google.genkit.ai.agent.internal.DetachController
-
Overrides the heartbeat interval (test hook).
- setId(String) - Method in class com.google.genkit.ai.evaluation.Score
- setIndex(int) - Method in class com.google.genkit.ai.Candidate
- setIndex(Integer) - Method in class com.google.genkit.ai.ModelResponseChunk
- setInput(Object) - Method in class com.google.genkit.ai.evaluation.DatasetSample
- setInput(Object) - Method in class com.google.genkit.ai.evaluation.EvalDataPoint
- setInput(Object) - Method in class com.google.genkit.ai.evaluation.EvalResult
- setInput(Object) - Method in class com.google.genkit.ai.ToolRequest
- setInput(List<String>) - Method in class com.google.genkit.ai.EmbedderInfo.EmbedderCapabilities
- setInputAudioFiles(Integer) - Method in class com.google.genkit.ai.Usage
- setInputCharacters(Integer) - Method in class com.google.genkit.ai.Usage
- setInputImages(Integer) - Method in class com.google.genkit.ai.Usage
- setInputSchema(Map<String, Object>) - Method in class com.google.genkit.ai.InterruptConfig
-
Sets the input schema.
- setInputSchema(Map<String, Object>) - Method in class com.google.genkit.ai.ToolDefinition
- setInputSchema(Map<String, Object>) - Method in class com.google.genkit.core.ActionDesc
- setInputTokens(Integer) - Method in class com.google.genkit.ai.Usage
- setInputType(Class<I>) - Method in class com.google.genkit.ai.InterruptConfig
-
Sets the input type class.
- setInputVideoFiles(Integer) - Method in class com.google.genkit.ai.Usage
- setInstructions(String) - Method in class com.google.genkit.ai.OutputConfig
- setInstrumentationScope(GenkitSpanData.InstrumentationScope) - Method in class com.google.genkit.core.tracing.GenkitSpanData
- setInterrupts(List<Part>) - Method in class com.google.genkit.ai.ModelResponse
- setIsBilled(Boolean) - Method in class com.google.genkit.ai.evaluation.EvaluatorInfo
- setK(int) - Method in class com.google.genkit.plugins.localvec.RetrieverOptions
-
Sets the number of documents to retrieve.
- setK(Integer) - Method in class com.google.genkit.ai.RetrieverRequest.RetrieverOptions
- setKey(EvalRunKey) - Method in class com.google.genkit.ai.evaluation.EvalRun
- setKey(String) - Method in class com.google.genkit.core.ActionDesc
- setLabel(String) - Method in class com.google.genkit.ai.EmbedderInfo
- setLabel(String) - Method in class com.google.genkit.ai.ModelInfo
- setLatencyMs(Long) - Method in class com.google.genkit.ai.ModelResponse
- setLinks(List<GenkitSpanData.Link>) - Method in class com.google.genkit.core.tracing.GenkitSpanData
- setMaxOutputTokens(Integer) - Method in class com.google.genkit.ai.GenerationConfig
- setMaxTurns(Integer) - Method in class com.google.genkit.ai.GenerateActionOptions
- setMedia(Media) - Method in class com.google.genkit.ai.Part
- setMedia(Boolean) - Method in class com.google.genkit.ai.ModelInfo.ModelCapabilities
- setMessage(Message) - Method in class com.google.genkit.ai.agent.AgentInput
-
Sets the input message.
- setMessage(Message) - Method in class com.google.genkit.ai.agent.AgentOutput
-
Sets the output message.
- setMessage(Message) - Method in class com.google.genkit.ai.agent.AgentResult
-
Sets the result message.
- setMessage(Message) - Method in class com.google.genkit.ai.Candidate
- setMessage(String) - Method in class com.google.genkit.ai.agent.RuntimeError
-
Sets the error message.
- setMessage(String) - Method in class com.google.genkit.core.tracing.GenkitSpanData.Status
- setMessages(List<Message>) - Method in class com.google.genkit.ai.agent.Session
-
Replaces the session's message list with a copy of the given list.
- setMessages(List<Message>) - Method in class com.google.genkit.ai.agent.SessionState
-
Sets the session messages.
- setMessages(List<Message>) - Method in class com.google.genkit.ai.GenerateActionOptions
- setMessages(List<Message>) - Method in class com.google.genkit.ai.ModelRequest
- setMetadata(Map<String, Object>) - Method in class com.google.genkit.ai.agent.Artifact
-
Sets the artifact metadata.
- setMetadata(Map<String, Object>) - Method in class com.google.genkit.ai.Document
- setMetadata(Map<String, Object>) - Method in class com.google.genkit.ai.Message
- setMetadata(Map<String, Object>) - Method in class com.google.genkit.ai.Part
- setMetadata(Map<String, Object>) - Method in class com.google.genkit.ai.ToolDefinition
- setMetadata(Map<String, Object>) - Method in class com.google.genkit.ai.ToolRequest
- setMetadata(Map<String, Object>) - Method in class com.google.genkit.ai.ToolResponse
- setMetadata(Map<String, Object>) - Method in class com.google.genkit.core.ActionDesc
- setMeterProvider(MeterProvider) - Static method in class com.google.genkit.core.telemetry.TelemetryConfig
-
Sets the MeterProvider to be used by Genkit metrics classes.
- setMetricRefs(List<String>) - Method in class com.google.genkit.ai.evaluation.CreateDatasetRequest
- setMetricRefs(List<String>) - Method in class com.google.genkit.ai.evaluation.DatasetMetadata
- setMetricRefs(List<String>) - Method in class com.google.genkit.ai.evaluation.UpdateDatasetRequest
- setMetrics(List<EvalMetric>) - Method in class com.google.genkit.ai.evaluation.EvalResult
- setModel(String) - Method in class com.google.genkit.ai.GenerateActionOptions
- setModelChunk(ModelResponseChunk) - Method in class com.google.genkit.ai.agent.AgentStreamChunk
-
Sets the model response chunk.
- setModeration(String) - Method in class com.google.genkit.plugins.openai.ImageGenerationConfig
- setMultiturn(Boolean) - Method in class com.google.genkit.ai.ModelInfo.ModelCapabilities
- setN(Integer) - Method in class com.google.genkit.plugins.openai.ImageGenerationConfig
- setName(String) - Method in class com.google.genkit.ai.agent.Artifact
-
Sets the artifact name.
- setName(String) - Method in class com.google.genkit.ai.InterruptConfig
-
Sets the interrupt name.
- setName(String) - Method in class com.google.genkit.ai.ToolDefinition
- setName(String) - Method in class com.google.genkit.ai.ToolRequest
- setName(String) - Method in class com.google.genkit.ai.ToolResponse
- setName(String) - Method in class com.google.genkit.core.ActionDesc
- setName(String) - Method in class com.google.genkit.core.tracing.GenkitSpanData.InstrumentationScope
- setName(String) - Method in class com.google.genkit.core.tracing.SpanMetadata
- setNoncommittal(boolean) - Method in class com.google.genkit.plugins.evaluators.metrics.AnswerRelevancyResponse
- setOnArtifactChanged(Consumer<Artifact>) - Method in class com.google.genkit.ai.agent.Session
-
Sets the callback to be invoked for each artifact added or updated via
Session.addArtifacts(com.google.genkit.ai.agent.Artifact...). - setOnCustomChanged(Runnable) - Method in class com.google.genkit.ai.agent.Session
-
Sets the callback to be invoked after
Session.updateCustom(java.util.function.UnaryOperator<S>)completes. - setOptions(RunEvaluationRequest.EvaluationOptions) - Method in class com.google.genkit.ai.evaluation.RunEvaluationRequest
- setOptions(RetrieverRequest.RetrieverOptions) - Method in class com.google.genkit.ai.RetrieverRequest
- setOptions(Object) - Method in class com.google.genkit.ai.evaluation.EvalRequest
- setOptions(Object) - Method in class com.google.genkit.ai.IndexerRequest
-
Sets the indexing options.
- setOptions(Map<String, Object>) - Method in class com.google.genkit.ai.EmbedRequest
- setOutput(OutputConfig) - Method in class com.google.genkit.ai.GenerateActionOptions
- setOutput(OutputConfig) - Method in class com.google.genkit.ai.ModelRequest
- setOutput(Object) - Method in class com.google.genkit.ai.evaluation.DatasetSample
- setOutput(Object) - Method in class com.google.genkit.ai.evaluation.EvalDataPoint
- setOutput(Object) - Method in class com.google.genkit.ai.evaluation.EvalResult
- setOutput(Object) - Method in class com.google.genkit.ai.ToolResponse
- setOutput(Set<String>) - Method in class com.google.genkit.ai.ModelInfo.ModelCapabilities
- setOutputAudioFiles(Integer) - Method in class com.google.genkit.ai.Usage
- setOutputCharacters(Integer) - Method in class com.google.genkit.ai.Usage
- setOutputCompression(Integer) - Method in class com.google.genkit.plugins.openai.ImageGenerationConfig
- setOutputFormat(String) - Method in class com.google.genkit.plugins.openai.ImageGenerationConfig
- setOutputImages(Integer) - Method in class com.google.genkit.ai.Usage
- setOutputSchema(Map<String, Object>) - Method in class com.google.genkit.ai.InterruptConfig
-
Sets the output schema.
- setOutputSchema(Map<String, Object>) - Method in class com.google.genkit.ai.ToolDefinition
- setOutputSchema(Map<String, Object>) - Method in class com.google.genkit.core.ActionDesc
- setOutputTokens(Integer) - Method in class com.google.genkit.ai.Usage
- setOutputType(Class<O>) - Method in class com.google.genkit.ai.InterruptConfig
-
Sets the output type class.
- setOutputVideoFiles(Integer) - Method in class com.google.genkit.ai.Usage
- setParentId(String) - Method in class com.google.genkit.ai.agent.SessionSnapshot
-
Sets the parent snapshot ID.
- setParentSpanId(String) - Method in class com.google.genkit.core.tracing.GenkitSpanData
- setParts(List<Part>) - Method in class com.google.genkit.ai.agent.Artifact
-
Sets the artifact parts.
- setPresencePenalty(Double) - Method in class com.google.genkit.ai.GenerationConfig
- setQuality(String) - Method in class com.google.genkit.plugins.openai.ImageGenerationConfig
- setQuery(Document) - Method in class com.google.genkit.ai.RetrieverRequest
- setQuestion(String) - Method in class com.google.genkit.plugins.evaluators.metrics.AnswerRelevancyResponse
- setRationale(String) - Method in class com.google.genkit.ai.evaluation.EvalMetric
- setReason(String) - Method in class com.google.genkit.plugins.evaluators.metrics.MaliciousnessResponse
- setReason(String) - Method in class com.google.genkit.plugins.evaluators.metrics.NliResponseItem
- setReasoning(String) - Method in class com.google.genkit.ai.evaluation.ScoreDetails
- setRef(String) - Method in class com.google.genkit.ai.ToolRequest
- setRef(String) - Method in class com.google.genkit.ai.ToolResponse
- setReference(Object) - Method in class com.google.genkit.ai.evaluation.DatasetSample
- setReference(Object) - Method in class com.google.genkit.ai.evaluation.EvalDataPoint
- setReference(Object) - Method in class com.google.genkit.ai.evaluation.EvalResult
- setRemote(boolean) - Method in class com.google.genkit.core.tracing.GenkitSpanData.SpanContextData
- setRequest(ModelRequest) - Method in class com.google.genkit.ai.ModelResponse
- setRequestMetadata(Function<I, Map<String, Object>>) - Method in class com.google.genkit.ai.InterruptConfig
-
Sets the request metadata function.
- setResources(List<String>) - Method in class com.google.genkit.ai.GenerateActionOptions
- setRespond(List<Part>) - Method in class com.google.genkit.ai.agent.ToolResume
-
Sets the response parts.
- setRespond(List<ToolResponse>) - Method in class com.google.genkit.ai.ResumeOptions
-
Sets the tool responses for interrupted requests.
- setResponseFormat(String) - Method in class com.google.genkit.plugins.openai.ImageGenerationConfig
- setResponses(List<NliResponseItem>) - Method in class com.google.genkit.plugins.evaluators.metrics.NliResponse
- setRestart(List<Part>) - Method in class com.google.genkit.ai.agent.ToolResume
-
Sets the restart parts.
- setRestart(List<ToolRequest>) - Method in class com.google.genkit.ai.ResumeOptions
-
Sets the tool requests to restart.
- setResults(List<EvalResult>) - Method in class com.google.genkit.ai.evaluation.EvalRun
- setResume(ToolResume) - Method in class com.google.genkit.ai.agent.AgentInput
-
Sets the tool resume data.
- setReturnToolRequests(Boolean) - Method in class com.google.genkit.ai.GenerateActionOptions
- setRole(Role) - Method in class com.google.genkit.ai.Message
- setRole(Role) - Method in class com.google.genkit.ai.ModelResponseChunk
-
Sets the role of the message this chunk contributes to.
- setSameProcessAsParentSpan(GenkitSpanData.BoolValue) - Method in class com.google.genkit.core.tracing.GenkitSpanData
- setSampleIndex(Integer) - Method in class com.google.genkit.ai.evaluation.EvalResponse
- setSchema(JsonNode) - Method in class com.google.genkit.ai.evaluation.CreateDatasetRequest
- setSchema(JsonNode) - Method in class com.google.genkit.ai.evaluation.DatasetMetadata
- setSchema(JsonNode) - Method in class com.google.genkit.ai.evaluation.UpdateDatasetRequest
- setSchema(Map<String, Object>) - Method in class com.google.genkit.ai.OutputConfig
- setSchemaUrl(String) - Method in class com.google.genkit.core.tracing.GenkitSpanData.InstrumentationScope
- setScore(Object) - Method in class com.google.genkit.ai.evaluation.EvalMetric
- setScore(Object) - Method in class com.google.genkit.ai.evaluation.Score
- setScoreId(String) - Method in class com.google.genkit.ai.evaluation.EvalMetric
- setSeed(Integer) - Method in class com.google.genkit.ai.GenerationConfig
- setSessionId(String) - Method in class com.google.genkit.ai.agent.AgentInit
-
Sets the session ID.
- setSessionId(String) - Method in class com.google.genkit.ai.agent.AgentOutput
-
Sets the session ID.
- setSessionId(String) - Method in class com.google.genkit.ai.agent.GetSnapshotRequest
-
Sets the session ID.
- setSessionId(String) - Method in class com.google.genkit.ai.agent.SessionSnapshot
-
Sets the session ID.
- setSessionId(String) - Method in class com.google.genkit.ai.agent.SessionState
-
Sets the session ID.
- setSize(int) - Method in class com.google.genkit.ai.evaluation.DatasetMetadata
- setSize(String) - Method in class com.google.genkit.plugins.openai.ImageGenerationConfig
- setSnapshotId(String) - Method in class com.google.genkit.ai.agent.AgentAbortRequest
-
Sets the snapshot ID to abort.
- setSnapshotId(String) - Method in class com.google.genkit.ai.agent.AgentAbortResponse
-
Sets the snapshot ID.
- setSnapshotId(String) - Method in class com.google.genkit.ai.agent.AgentInit
-
Sets the snapshot ID.
- setSnapshotId(String) - Method in class com.google.genkit.ai.agent.AgentOutput
-
Sets the snapshot ID.
- setSnapshotId(String) - Method in class com.google.genkit.ai.agent.GetSnapshotRequest
-
Sets the snapshot ID.
- setSnapshotId(String) - Method in class com.google.genkit.ai.agent.SessionSnapshot
-
Sets the snapshot ID.
- setSnapshotId(String) - Method in class com.google.genkit.ai.agent.TurnEnd
-
Sets the snapshot ID.
- setSpanId(String) - Method in class com.google.genkit.ai.evaluation.EvalMetric
- setSpanId(String) - Method in class com.google.genkit.ai.evaluation.EvalResponse
- setSpanId(String) - Method in class com.google.genkit.core.tracing.GenkitSpanData
- setSpanId(String) - Method in class com.google.genkit.core.tracing.GenkitSpanData.SpanContextData
- setSpanKind(String) - Method in class com.google.genkit.core.tracing.GenkitSpanData
- setSpans(Map<String, GenkitSpanData>) - Method in class com.google.genkit.core.tracing.TraceData
- setStartTime(long) - Method in class com.google.genkit.core.tracing.GenkitSpanData
- setStartTime(long) - Method in class com.google.genkit.core.tracing.TraceData
- setState(SessionState<S>) - Method in class com.google.genkit.ai.agent.AgentInit
-
Sets the initial session state.
- setState(SessionState<S>) - Method in class com.google.genkit.ai.agent.AgentOutput
-
Sets the session state.
- setState(SessionState<S>) - Method in class com.google.genkit.ai.agent.SessionSnapshot
-
Sets the session state.
- setStateManagement(String) - Method in class com.google.genkit.ai.agent.AgentMetadata
-
Sets the state management mode.
- setStatement(String) - Method in class com.google.genkit.plugins.evaluators.metrics.NliResponseItem
- setStatements(List<String>) - Method in class com.google.genkit.plugins.evaluators.metrics.LongFormResponse
- setStateSchema(Map<String, Object>) - Method in class com.google.genkit.ai.agent.AgentMetadata
-
Sets the JSON schema for the agent state.
- setStatus(SnapshotStatus) - Method in class com.google.genkit.ai.agent.AgentAbortResponse
-
Sets the resulting snapshot status.
- setStatus(SnapshotStatus) - Method in class com.google.genkit.ai.agent.SessionSnapshot
-
Sets the snapshot status.
- setStatus(EvalStatus) - Method in class com.google.genkit.ai.evaluation.EvalMetric
- setStatus(EvalStatus) - Method in class com.google.genkit.ai.evaluation.Score
- setStatus(GenkitSpanData.Status) - Method in class com.google.genkit.core.tracing.GenkitSpanData
- setStatus(String) - Method in class com.google.genkit.ai.agent.RuntimeError
-
Sets the status code.
- setStepName(String) - Method in class com.google.genkit.ai.GenerateActionOptions
- setStopSequences(String[]) - Method in class com.google.genkit.ai.GenerationConfig
- setStyle(String) - Method in class com.google.genkit.plugins.openai.ImageGenerationConfig
- setSubtype(String) - Method in class com.google.genkit.core.tracing.SpanMetadata
- setSupports(EmbedderInfo.EmbedderCapabilities) - Method in class com.google.genkit.ai.EmbedderInfo
- setSupports(ModelInfo.ModelCapabilities) - Method in class com.google.genkit.ai.ModelInfo
- setSuppressed(boolean) - Method in class com.google.genkit.ai.agent.internal.StreamEmitter
-
Controls whether chunks are emitted.
- setSystemRole(Boolean) - Method in class com.google.genkit.ai.ModelInfo.ModelCapabilities
- setTargetAction(String) - Method in class com.google.genkit.ai.evaluation.CreateDatasetRequest
- setTargetAction(String) - Method in class com.google.genkit.ai.evaluation.DatasetMetadata
- setTargetAction(String) - Method in class com.google.genkit.ai.evaluation.RunEvaluationRequest
- setTargetAction(String) - Method in class com.google.genkit.ai.evaluation.UpdateDatasetRequest
- setTemperature(Double) - Method in class com.google.genkit.ai.GenerationConfig
- setTestCaseId(String) - Method in class com.google.genkit.ai.evaluation.DatasetSample
- setTestCaseId(String) - Method in class com.google.genkit.ai.evaluation.EvalDataPoint
- setTestCaseId(String) - Method in class com.google.genkit.ai.evaluation.EvalResponse
- setTestCaseId(String) - Method in class com.google.genkit.ai.evaluation.EvalResult
- setText(String) - Method in class com.google.genkit.ai.Part
- setThoughtsTokens(Integer) - Method in class com.google.genkit.ai.Usage
- setTime(long) - Method in class com.google.genkit.core.tracing.GenkitSpanData.TimeEvent
- setTimeEvent(List<GenkitSpanData.TimeEvent>) - Method in class com.google.genkit.core.tracing.GenkitSpanData.TimeEvents
- setTimeEvents(GenkitSpanData.TimeEvents) - Method in class com.google.genkit.core.tracing.GenkitSpanData
- setToken(String) - Method in class com.google.genkit.plugins.firebase.functions.AuthContext
- setToolChoice(String) - Method in class com.google.genkit.ai.GenerateActionOptions
- setToolRequest(ToolRequest) - Method in class com.google.genkit.ai.Part
- setToolResponse(ToolResponse) - Method in class com.google.genkit.ai.Part
- setTools(Boolean) - Method in class com.google.genkit.ai.ModelInfo.ModelCapabilities
- setTools(List<ToolDefinition>) - Method in class com.google.genkit.ai.ModelRequest
- setTools(List<String>) - Method in class com.google.genkit.ai.GenerateActionOptions
- setTopK(Integer) - Method in class com.google.genkit.ai.GenerationConfig
- setTopP(Double) - Method in class com.google.genkit.ai.GenerationConfig
- setTotalTokens(Integer) - Method in class com.google.genkit.ai.Usage
- setTraceFlags(int) - Method in class com.google.genkit.core.tracing.GenkitSpanData.SpanContextData
- setTraceId(String) - Method in class com.google.genkit.ai.evaluation.EvalMetric
- setTraceId(String) - Method in class com.google.genkit.ai.evaluation.EvalResponse
- setTraceId(String) - Method in exception class com.google.genkit.core.GenkitException
-
Sets the trace ID for this error if it has not already been set.
- setTraceId(String) - Method in class com.google.genkit.core.tracing.GenkitSpanData
- setTraceId(String) - Method in class com.google.genkit.core.tracing.GenkitSpanData.SpanContextData
- setTraceId(String) - Method in class com.google.genkit.core.tracing.TraceData
- setTraceIds(List<String>) - Method in class com.google.genkit.ai.evaluation.EvalDataPoint
- setTraceIds(List<String>) - Method in class com.google.genkit.ai.evaluation.EvalResult
- setTurnEnd(TurnEnd) - Method in class com.google.genkit.ai.agent.AgentStreamChunk
-
Sets the turn-end signal.
- setType(ActionType) - Method in class com.google.genkit.core.ActionDesc
- setType(String) - Method in class com.google.genkit.core.tracing.SpanMetadata
- setUid(String) - Method in class com.google.genkit.plugins.firebase.functions.AuthContext
- setUpdatedAt(String) - Method in class com.google.genkit.ai.agent.internal.PointerDoc
-
Sets the timestamp when this pointer was last updated.
- setUpdatedAt(String) - Method in class com.google.genkit.ai.agent.SessionSnapshot
-
Sets the last-update timestamp.
- setUpdateTime(String) - Method in class com.google.genkit.ai.evaluation.DatasetMetadata
- setUrl(String) - Method in class com.google.genkit.ai.Media
- setUsage(Usage) - Method in class com.google.genkit.ai.ModelResponse
- setUse(List<JsonNode>) - Method in class com.google.genkit.ai.GenerateActionOptions
- setUser(String) - Method in class com.google.genkit.plugins.openai.ImageGenerationConfig
- setValue(boolean) - Method in class com.google.genkit.core.tracing.GenkitSpanData.BoolValue
- setValues(float[]) - Method in class com.google.genkit.ai.EmbedResponse.Embedding
- setVerdict(boolean) - Method in class com.google.genkit.plugins.evaluators.metrics.MaliciousnessResponse
- setVerdict(boolean) - Method in class com.google.genkit.plugins.evaluators.metrics.NliResponseItem
- setVersion(int) - Method in class com.google.genkit.ai.evaluation.DatasetMetadata
- setVersion(String) - Method in class com.google.genkit.core.tracing.GenkitSpanData.InstrumentationScope
- setVersions(List<String>) - Method in class com.google.genkit.ai.ModelInfo
- shardSize(int) - Method in class com.google.genkit.plugins.awsbedrock.session.DynamoDbSessionStoreOptions.Builder
-
Sets the shard size in bytes for checkpoint state (must stay under the 400 KB item cap).
- shardSize(int) - Method in class com.google.genkit.plugins.azurefoundry.session.CosmosSessionStoreOptions.Builder
-
Sets the shard size in bytes for checkpoint state (must stay under the 2 MB document cap).
- shardSize(int) - Method in class com.google.genkit.plugins.firebase.session.FirestoreSessionStoreOptions.Builder
-
Sets the shard size in bytes for checkpoint state.
- shardSize(int) - Method in class com.google.genkit.plugins.mongodb.session.MongoSessionStoreOptions.Builder
-
Sets the shard size in bytes for checkpoint state (must stay under the 16 MB document cap).
- shardSize(int) - Method in class com.google.genkit.plugins.postgresql.session.PostgresSessionStoreOptions.Builder
-
Sets the shard size in bytes for checkpoint state.
- shardString(String, int) - Static method in class com.google.genkit.ai.agent.internal.SnapshotSharding
-
Splits a UTF-8 string into shards of at most
shardSizebytes each. - shouldCheckpoint(boolean, int, int, int, int) - Static method in class com.google.genkit.ai.agent.internal.SnapshotSharding
-
Decides whether to write a full checkpoint instead of a diff.
- shutdown() - Method in class com.google.genkit.core.tracing.TelemetryServerExporter
- shutdown() - Method in class com.google.genkit.LocalTelemetryStore
- shutdown() - Method in class com.google.genkit.plugins.firebase.telemetry.FirebaseTelemetry
-
Shuts down the telemetry exporters.
- signal(String) - Static method in class com.google.genkit.ai.agent.internal.PendingAbortRegistry
-
Flips the abort signal registered for
snapshotIdtotrue, if one is currently registered (i.e. the turn is a still-running detached turn). - signedIn() - Static method in class com.google.genkit.plugins.firebase.functions.OnCallGenkit
-
Predefined authorization policy that requires the user to be signed in.
- similarity(MongoVectorStoreConfig.Similarity) - Method in class com.google.genkit.plugins.mongodb.MongoVectorStoreConfig.Builder
-
Sets the vector similarity function.
- SimpleCache<V> - Class in com.google.genkit.core.middleware
-
SimpleCache is a thread-safe in-memory cache implementation for use with caching middleware.
- SimpleCache() - Constructor for class com.google.genkit.core.middleware.SimpleCache
-
Creates a SimpleCache with no TTL (entries never expire).
- SimpleCache(long) - Constructor for class com.google.genkit.core.middleware.SimpleCache
-
Creates a SimpleCache with the specified TTL.
- simpleSchema(String) - Static method in class com.google.genkit.core.SchemaUtils
-
Generates a JSON Schema for a primitive type.
- SimulateSystemPromptMiddleware - Class in com.google.genkit.plugins.middleware
-
Rewrites a
systemmessage into a user/model exchange, for models that do not natively support system prompts. - SimulateSystemPromptMiddleware(SimulateSystemPromptMiddleware.Options) - Constructor for class com.google.genkit.plugins.middleware.SimulateSystemPromptMiddleware
- SimulateSystemPromptMiddleware.Options - Class in com.google.genkit.plugins.middleware
-
Configuration parameters for
SimulateSystemPromptMiddleware. - size() - Method in class com.google.genkit.core.middleware.MiddlewareChain
-
Returns the number of middleware in the chain.
- size() - Method in class com.google.genkit.core.middleware.SimpleCache
-
Returns the number of entries in the cache.
- size() - Method in class com.google.genkit.plugins.localvec.LocalVecDocStore
-
Gets the number of documents in the store.
- size(int) - Method in class com.google.genkit.ai.evaluation.DatasetMetadata.Builder
- size(String) - Method in class com.google.genkit.plugins.openai.ImageGenerationConfig.Builder
- snapshotId() - Method in class com.google.genkit.ai.agent.AgentChat
-
Returns the latest snapshot ID (server-managed agents).
- snapshotId() - Method in class com.google.genkit.ai.agent.AgentResponse
-
Returns the snapshot ID produced by the turn (server-managed agents).
- snapshotId() - Method in class com.google.genkit.ai.agent.TurnContext
-
Returns the snapshot ID reserved for this turn.
- snapshotId(String) - Method in class com.google.genkit.ai.agent.AgentAbortRequest.Builder
- snapshotId(String) - Method in class com.google.genkit.ai.agent.AgentAbortResponse.Builder
- snapshotId(String) - Method in class com.google.genkit.ai.agent.AgentInit.Builder
- snapshotId(String) - Method in class com.google.genkit.ai.agent.AgentOutput.Builder
- snapshotId(String) - Method in class com.google.genkit.ai.agent.GetSnapshotOptions.Builder
-
Sets the specific snapshot ID to retrieve.
- snapshotId(String) - Method in class com.google.genkit.ai.agent.GetSnapshotRequest.Builder
- snapshotId(String) - Method in class com.google.genkit.ai.agent.SessionSnapshot.Builder
- snapshotId(String) - Method in class com.google.genkit.ai.agent.TurnEnd.Builder
- SnapshotMutator<S> - Interface in com.google.genkit.ai.agent
-
The mutator for an atomic read-modify-write on a session snapshot.
- snapshotPathPrefix(Function<SessionStoreOptions, String>) - Method in class com.google.genkit.plugins.awsbedrock.session.DynamoDbSessionStoreOptions.Builder
-
Sets the function that derives the per-tenant partition-key prefix.
- snapshotPathPrefix(Function<SessionStoreOptions, String>) - Method in class com.google.genkit.plugins.azurefoundry.session.CosmosSessionStoreOptions.Builder
-
Sets the function that derives the per-tenant partition-key prefix.
- snapshotPathPrefix(Function<SessionStoreOptions, String>) - Method in class com.google.genkit.plugins.firebase.session.FirestoreSessionStoreOptions.Builder
-
Sets the function that derives the per-tenant path prefix from the per-request store options.
- snapshotPathPrefix(Function<SessionStoreOptions, String>) - Method in class com.google.genkit.plugins.mongodb.session.MongoSessionStoreOptions.Builder
-
Sets the function that derives the per-tenant prefix.
- snapshotPathPrefix(Function<SessionStoreOptions, String>) - Method in class com.google.genkit.plugins.postgresql.session.PostgresSessionStoreOptions.Builder
-
Sets the function that derives the per-tenant prefix.
- SnapshotReader<S> - Interface in com.google.genkit.ai.agent
-
Read side of a session store.
- SnapshotSharding - Class in com.google.genkit.ai.agent.internal
-
Pure, backend-agnostic sharding / checkpoint / RFC-6902 reconstruction helpers shared by the Firestore, DynamoDB, and Cosmos DB session stores.
- SnapshotStatus - Enum Class in com.google.genkit.ai.agent
-
SnapshotStatus represents the status of an agent snapshot.
- SnapshotSubscriber - Interface in com.google.genkit.ai.agent
-
Optional capability: subscribe to a snapshot's status changes.
- snapshotWatchPollIntervalMs(long) - Method in class com.google.genkit.ai.agent.FileSessionStore.Builder
-
Sets the polling interval for snapshot-change subscriptions (default 2000 ms).
- SnapshotWriter<S> - Interface in com.google.genkit.ai.agent
-
Write side of a session store.
- sourceSnapshotId() - Method in class com.google.genkit.ai.agent.internal.SessionResolver.Resolution
-
Returns the id of the snapshot this session was resolved (resumed) from, or
nullfor a fresh session. - spanContext(SpanContext) - Method in class com.google.genkit.core.ActionContext.Builder
- SpanContext - Class in com.google.genkit.core.tracing
-
SpanContext contains trace and span identifiers for distributed tracing.
- SpanContext(String, String, String) - Constructor for class com.google.genkit.core.tracing.SpanContext
-
Creates a new SpanContext.
- SpanContextData() - Constructor for class com.google.genkit.core.tracing.GenkitSpanData.SpanContextData
- spanId(String) - Method in class com.google.genkit.ai.evaluation.EvalMetric.Builder
- spanId(String) - Method in class com.google.genkit.ai.evaluation.EvalResponse.Builder
- spanId(String) - Method in class com.google.genkit.core.ActionRunResult.Builder
- SpanMetadata - Class in com.google.genkit.core.tracing
-
SpanMetadata contains metadata for a tracing span.
- SpanMetadata() - Constructor for class com.google.genkit.core.tracing.SpanMetadata
-
Creates a new SpanMetadata.
- SpanMetadata(String, String, String, Map<String, Object>) - Constructor for class com.google.genkit.core.tracing.SpanMetadata
-
Creates a new SpanMetadata with the specified values.
- SpanMetadata.Builder - Class in com.google.genkit.core.tracing
-
Builder for SpanMetadata.
- spanPath(String) - Method in class com.google.genkit.core.ActionContext.Builder
- SpringPlugin - Class in com.google.genkit.plugins.spring
-
SpringPlugin provides HTTP endpoints for Genkit flows using Spring Boot.
- SpringPlugin() - Constructor for class com.google.genkit.plugins.spring.SpringPlugin
-
Creates a SpringPlugin with default options.
- SpringPlugin(SpringPluginOptions) - Constructor for class com.google.genkit.plugins.spring.SpringPlugin
-
Creates a SpringPlugin with the specified options.
- SpringPluginOptions - Class in com.google.genkit.plugins.spring
-
Options for configuring the Spring Boot plugin.
- SpringPluginOptions.Builder - Class in com.google.genkit.plugins.spring
-
Builder for SpringPluginOptions.
- start() - Method in interface com.google.genkit.core.ServerPlugin
-
Starts the HTTP server and blocks until it is stopped.
- start() - Method in class com.google.genkit.plugins.jetty.JettyPlugin
-
Starts the Jetty server and blocks until it is stopped.
- start() - Method in class com.google.genkit.plugins.mcp.MCPServer
-
Starts the MCP server with STDIO transport.
- start() - Method in class com.google.genkit.plugins.spring.SpringPlugin
-
Starts the Spring Boot server and blocks until it is stopped.
- start() - Method in class com.google.genkit.ReflectionServer
-
Starts the reflection server by trying ports in the range [basePort, basePort + 100].
- start() - Method in class com.google.genkit.ReflectionServerV2
-
Starts the V2 reflection client by connecting to the CLI WebSocket server.
- start(McpServerTransportProvider) - Method in class com.google.genkit.plugins.mcp.MCPServer
-
Starts the MCP server with a custom transport provider.
- state() - Method in class com.google.genkit.ai.agent.AgentChat
-
Returns the current custom session state.
- state() - Method in class com.google.genkit.ai.agent.AgentResponse
-
Returns the full session state at the end of the turn.
- state(SessionState<S>) - Method in class com.google.genkit.ai.agent.AgentInit.Builder
- state(SessionState<S>) - Method in class com.google.genkit.ai.agent.AgentOutput.Builder
- state(SessionState<S>) - Method in class com.google.genkit.ai.agent.SessionSnapshot.Builder
- stateManagement(String) - Method in class com.google.genkit.ai.agent.AgentMetadata.Builder
- stateSchema(Map<String, Object>) - Method in class com.google.genkit.ai.agent.AgentMetadata.Builder
- stateType(Class<S>) - Method in class com.google.genkit.agent.AgentConfig.Builder
-
Sets the Java class for the agent's custom state type.
- stateType(Class<S>) - Method in class com.google.genkit.ai.agent.CustomAgentConfig.Builder
-
Sets the Java class for the agent's custom state type.
- status - Variable in class com.google.genkit.plugins.middleware.Artifacts.WriteOutput
- status(SnapshotStatus) - Method in class com.google.genkit.ai.agent.AgentAbortResponse.Builder
- status(SnapshotStatus) - Method in class com.google.genkit.ai.agent.SessionSnapshot.Builder
- status(EvalStatus) - Method in class com.google.genkit.ai.evaluation.EvalMetric.Builder
- status(EvalStatus) - Method in class com.google.genkit.ai.evaluation.Score.Builder
- status(String) - Method in class com.google.genkit.ai.agent.RuntimeError.Builder
- Status() - Constructor for class com.google.genkit.core.tracing.GenkitSpanData.Status
- Status(int, String) - Constructor for class com.google.genkit.core.tracing.GenkitSpanData.Status
- statusOverrideFn(Function<Score, EvalStatus>) - Method in class com.google.genkit.plugins.evaluators.MetricConfig.Builder
- stdio(String, String...) - Static method in class com.google.genkit.plugins.mcp.MCPServerConfig
-
Creates a STDIO server configuration.
- stdio(String, String, String...) - Static method in class com.google.genkit.plugins.mcp.MCPPlugin
-
Creates an MCP plugin with a single STDIO server.
- STDIO - Enum constant in enum class com.google.genkit.plugins.mcp.MCPServerConfig.TransportType
-
Standard I/O transport - launches a local process.
- stop() - Method in interface com.google.genkit.core.ServerPlugin
-
Stops the HTTP server.
- stop() - Method in class com.google.genkit.Genkit
-
Stops the Genkit instance and cleans up resources.
- stop() - Method in class com.google.genkit.plugins.jetty.JettyPlugin
-
Stops the Jetty server.
- stop() - Method in class com.google.genkit.plugins.mcp.MCPServer
-
Stops the MCP server.
- stop() - Method in class com.google.genkit.plugins.spring.SpringPlugin
-
Stops the Spring Boot server.
- stop() - Method in class com.google.genkit.ReflectionServer
-
Stops the reflection server.
- stop() - Method in class com.google.genkit.ReflectionServerV2
-
Stops the V2 reflection client.
- STOP - Enum constant in enum class com.google.genkit.ai.agent.AgentFinishReason
-
The agent finished normally due to a stop condition.
- STOP - Enum constant in enum class com.google.genkit.ai.FinishReason
- stopSequences(String...) - Method in class com.google.genkit.ai.GenerationConfig.Builder
- Storage layout - Search tag in class com.google.genkit.plugins.firebase.session.FirestoreSessionStore
- Section
- Storage layout (single collection) - Search tag in class com.google.genkit.plugins.mongodb.session.MongoSessionStore
- Section
- Storage layout (single container) - Search tag in class com.google.genkit.plugins.azurefoundry.session.CosmosSessionStore
- Section
- Storage layout (single table) - Search tag in class com.google.genkit.plugins.awsbedrock.session.DynamoDbSessionStore
- Section
- Storage layout (single table) - Search tag in class com.google.genkit.plugins.postgresql.session.PostgresSessionStore
- Section
- store() - Method in class com.google.genkit.ai.agent.Agent
-
Returns the session store, or
nullfor client-managed agents. - store(SessionStore<S>) - Method in class com.google.genkit.agent.AgentConfig.Builder
-
Sets the session store for server-managed mode.
- store(SessionStore<S>) - Method in class com.google.genkit.ai.agent.CustomAgentConfig.Builder
-
Sets the session store for server-managed mode.
- storeOptions(SessionStoreOptions) - Method in class com.google.genkit.ai.agent.CustomAgentConfig.Builder
-
Sets the options forwarded to store operations.
- storeTrace(TraceData) - Static method in class com.google.genkit.ReflectionServer
-
Stores a trace in the in-memory trace store for Dev UI access.
- stream(ActionContext, I, Consumer<Flow.StreamingFlowValue<O, S>>) - Method in class com.google.genkit.core.Flow
-
Streams the flow output with the given input.
- stream(I, GenerateOptions, Consumer<ModelResponseChunk>) - Method in class com.google.genkit.prompt.ExecutablePrompt
-
Generates a response with streaming and custom options.
- stream(I, Consumer<ModelResponseChunk>) - Method in class com.google.genkit.prompt.ExecutablePrompt
-
Generates a response with streaming.
- STREAMABLE_HTTP - Enum constant in enum class com.google.genkit.plugins.mcp.MCPServerConfig.TransportType
-
Streamable HTTP transport.
- streamableHttp(String) - Static method in class com.google.genkit.plugins.mcp.MCPServerConfig
-
Creates a Streamable HTTP server configuration.
- streamClass(Class<S>) - Method in class com.google.genkit.core.BidiActionImpl.Builder
- StreamEmitter<S> - Class in com.google.genkit.ai.agent.internal
-
Bridges Session state-change events to AgentStreamChunk emission for one invocation.
- StreamEmitter(Consumer<AgentStreamChunk>, ObjectMapper) - Constructor for class com.google.genkit.ai.agent.internal.StreamEmitter
-
Constructs a new StreamEmitter.
- StreamingFlowValue(boolean, O, S) - Constructor for class com.google.genkit.core.Flow.StreamingFlowValue
-
Creates a new StreamingFlowValue.
- stringify(Object) - Static method in class com.google.genkit.plugins.evaluators.metrics.PromptUtils
-
Converts an object to a string representation for use in prompts.
- stringSchema() - Static method in class com.google.genkit.core.SchemaUtils
-
Creates a schema for a string type.
- Structured failure/interrupt propagation - Search tag in class com.google.genkit.plugins.middleware.Agents
- Section
- style(String) - Method in class com.google.genkit.plugins.openai.ImageGenerationConfig.Builder
- Subscriber / polling - Search tag in class com.google.genkit.ai.agent.FileSessionStore
- Section
- Subscriber notification - Search tag in class com.google.genkit.ai.agent.InMemorySessionStore
- Section
- Subscriber semantics (Go-compatible) - Search tag in class com.google.genkit.ai.agent.InMemorySessionStore
- Section
- subtype(String) - Method in class com.google.genkit.core.tracing.SpanMetadata.Builder
- SUPPORTED_EMBEDDING_MODELS - Static variable in class com.google.genkit.plugins.awsbedrock.AwsBedrockPlugin
-
Supported AWS Bedrock embedding models (Amazon Titan and Cohere Embed).
- SUPPORTED_EMBEDDING_MODELS - Static variable in class com.google.genkit.plugins.cohere.CoherePlugin
-
Supported Cohere embedding models (reachable via the OpenAI-compatible endpoint).
- SUPPORTED_EMBEDDING_MODELS - Static variable in class com.google.genkit.plugins.googlegenai.GoogleGenAIPlugin
-
Supported embedding models.
- SUPPORTED_EMBEDDING_MODELS - Static variable in class com.google.genkit.plugins.mistral.MistralPlugin
-
Supported Mistral embedding models.
- SUPPORTED_EMBEDDING_MODELS - Static variable in class com.google.genkit.plugins.openai.OpenAIPlugin
-
Supported embedding models.
- SUPPORTED_IMAGE_MODELS - Static variable in class com.google.genkit.plugins.googlegenai.GoogleGenAIPlugin
-
Supported image generation models (Imagen).
- SUPPORTED_IMAGE_MODELS - Static variable in class com.google.genkit.plugins.openai.OpenAIPlugin
-
Supported image generation models.
- SUPPORTED_MODELS - Static variable in class com.google.genkit.plugins.anthropic.AnthropicPlugin
-
Supported Claude models.
- SUPPORTED_MODELS - Static variable in class com.google.genkit.plugins.awsbedrock.AwsBedrockPlugin
-
Supported AWS Bedrock models with ON_DEMAND or INFERENCE_PROFILE support.
- SUPPORTED_MODELS - Static variable in class com.google.genkit.plugins.azurefoundry.AzureFoundryPlugin
-
Azure AI Foundry supported models.
- SUPPORTED_MODELS - Static variable in class com.google.genkit.plugins.cohere.CoherePlugin
-
Supported Cohere models.
- SUPPORTED_MODELS - Static variable in class com.google.genkit.plugins.deepseek.DeepSeekPlugin
-
Supported DeepSeek models.
- SUPPORTED_MODELS - Static variable in class com.google.genkit.plugins.googlegenai.GoogleGenAIPlugin
-
Supported Gemini models for text/multimodal generation.
- SUPPORTED_MODELS - Static variable in class com.google.genkit.plugins.groq.GroqPlugin
-
Supported Groq production models.
- SUPPORTED_MODELS - Static variable in class com.google.genkit.plugins.mistral.MistralPlugin
-
Supported Mistral models.
- SUPPORTED_MODELS - Static variable in class com.google.genkit.plugins.openai.OpenAIPlugin
-
Supported GPT models.
- SUPPORTED_MODELS - Static variable in class com.google.genkit.plugins.xai.XAIPlugin
-
Supported XAI models.
- SUPPORTED_OMNI_MODELS - Static variable in class com.google.genkit.plugins.googlegenai.GoogleGenAIPlugin
-
Supported Gemini Omni video generation/editing models (Interactions API).
- SUPPORTED_TTS_MODELS - Static variable in class com.google.genkit.plugins.googlegenai.GoogleGenAIPlugin
-
Supported TTS models.
- SUPPORTED_VEO_MODELS - Static variable in class com.google.genkit.plugins.googlegenai.GoogleGenAIPlugin
-
Supported video generation models (Veo).
- supportsStreaming() - Method in interface com.google.genkit.ai.Model
-
Returns whether this model supports streaming.
- supportsStreaming() - Method in class com.google.genkit.plugins.anthropic.AnthropicModel
- supportsStreaming() - Method in class com.google.genkit.plugins.awsbedrock.AwsBedrockModel
- supportsStreaming() - Method in class com.google.genkit.plugins.compatoai.CompatOAIModel
- supportsStreaming() - Method in class com.google.genkit.plugins.googlegenai.GeminiModel
- supportsStreaming() - Method in class com.google.genkit.plugins.googlegenai.ImagenModel
- supportsStreaming() - Method in class com.google.genkit.plugins.googlegenai.OmniModel
- supportsStreaming() - Method in class com.google.genkit.plugins.googlegenai.TtsModel
- supportsStreaming() - Method in class com.google.genkit.plugins.googlegenai.VeoModel
- supportsStreaming() - Method in class com.google.genkit.plugins.ollama.OllamaModel
- supportsStreaming() - Method in class com.google.genkit.plugins.openai.OpenAIImageModel
- supportsStreaming() - Method in class com.google.genkit.plugins.openai.OpenAIModel
- system(String) - Method in class com.google.genkit.agent.AgentConfig.Builder
-
Sets the system prompt for the agent.
- system(String) - Method in class com.google.genkit.ai.GenerateOptions.Builder
- system(String) - Static method in class com.google.genkit.ai.Message
-
Creates a system message with text content.
- SYSTEM - Enum constant in enum class com.google.genkit.ai.Role
- systemPromptFragment(AgentsOptions) - Static method in class com.google.genkit.plugins.middleware.Agents
-
Builds a
<sub-agents>system-prompt fragment listing each delegation tool and the agent it delegates to.
T
- tableName(String) - Method in class com.google.genkit.plugins.awsbedrock.session.DynamoDbSessionStoreOptions.Builder
-
Sets the DynamoDB table name.
- tableName(String) - Method in class com.google.genkit.plugins.postgresql.PostgresTableConfig.Builder
-
Sets the table name (required).
- tableName(String) - Method in class com.google.genkit.plugins.postgresql.session.PostgresSessionStoreOptions.Builder
-
Sets the PostgreSQL table name.
- targetAction(String) - Method in class com.google.genkit.ai.evaluation.CreateDatasetRequest.Builder
- targetAction(String) - Method in class com.google.genkit.ai.evaluation.DatasetMetadata.Builder
- targetAction(String) - Method in class com.google.genkit.ai.evaluation.RunEvaluationRequest.Builder
- targetAction(String) - Method in class com.google.genkit.ai.evaluation.UpdateDatasetRequest.Builder
- task - Variable in class com.google.genkit.plugins.middleware.Agents.DelegateInput
- TelemetryClient - Interface in com.google.genkit.core.tracing
-
TelemetryClient interface for sending traces to a telemetry server.
- TelemetryConfig - Class in com.google.genkit.core.telemetry
-
Central configuration for Genkit telemetry.
- TelemetryServerExporter - Class in com.google.genkit.core.tracing
-
OpenTelemetry SpanProcessor that exports spans to the Genkit telemetry server.
- TelemetryServerExporter() - Constructor for class com.google.genkit.core.tracing.TelemetryServerExporter
-
Creates a new TelemetryServerExporter.
- temperature(Double) - Method in class com.google.genkit.ai.GenerationConfig.Builder
- template(String) - Method in class com.google.genkit.ai.Prompt.Builder
- tenant(String) - Method in class com.google.genkit.plugins.chroma.ChromaPlugin.Builder
-
Sets the Chroma tenant (default "default_tenant").
- testCaseId(String) - Method in class com.google.genkit.ai.evaluation.DatasetSample.Builder
- testCaseId(String) - Method in class com.google.genkit.ai.evaluation.EvalDataPoint.Builder
- testCaseId(String) - Method in class com.google.genkit.ai.evaluation.EvalResponse.Builder
- testCaseId(String) - Method in class com.google.genkit.ai.evaluation.EvalResult.Builder
- text() - Method in class com.google.genkit.ai.agent.AgentChunk
-
Returns the streamed model text for this chunk.
- text() - Method in class com.google.genkit.ai.agent.AgentResponse
-
Returns the concatenated text of the assistant message's text parts.
- text() - Method in class com.google.genkit.ai.Candidate
-
Extracts the text content from this candidate.
- text() - Method in class com.google.genkit.ai.Document
-
Gets the text content of this Document.
- text() - Static method in class com.google.genkit.ai.OutputConfig
-
Creates an OutputConfig for text output.
- text(String) - Static method in class com.google.genkit.ai.ModelResponseChunk
-
Creates a ModelResponseChunk with text content.
- text(String) - Static method in class com.google.genkit.ai.Part
-
Creates a text part.
- TEXT - Enum constant in enum class com.google.genkit.ai.OutputFormat
- textField(String) - Method in class com.google.genkit.plugins.mongodb.MongoVectorStoreConfig.Builder
-
Sets the text field name.
- textField(String) - Method in class com.google.genkit.plugins.pinecone.PineconeIndexConfig.Builder
-
Sets the metadata field name for storing document text (default: "text").
- textPayloadKey(String) - Method in class com.google.genkit.plugins.qdrant.QdrantCollectionConfig.Builder
-
Sets the payload key that stores the document text.
- threadName(String) - Method in class com.google.genkit.core.ActionContext.Builder
- TimeEvent() - Constructor for class com.google.genkit.core.tracing.GenkitSpanData.TimeEvent
- TimeEvents() - Constructor for class com.google.genkit.core.tracing.GenkitSpanData.TimeEvents
- timeout(int) - Method in class com.google.genkit.plugins.anthropic.AnthropicPluginOptions.Builder
- timeout(int) - Method in class com.google.genkit.plugins.compatoai.CompatOAIPlugin.Builder
-
Sets the request timeout in seconds.
- timeout(int) - Method in class com.google.genkit.plugins.compatoai.CompatOAIPluginOptions.Builder
-
Sets the request timeout in seconds.
- timeout(int) - Method in class com.google.genkit.plugins.googlegenai.GoogleGenAIPluginOptions.Builder
-
Sets the request timeout in milliseconds.
- timeout(int) - Method in class com.google.genkit.plugins.ollama.OllamaPluginOptions.Builder
- timeout(int) - Method in class com.google.genkit.plugins.openai.OpenAIPluginOptions.Builder
- timeout(long) - Static method in class com.google.genkit.core.middleware.CommonMiddleware
-
Creates a timeout middleware that throws an exception if execution takes too long.
- timing(Consumer<Long>) - Static method in class com.google.genkit.core.middleware.CommonMiddleware
-
Creates a timing middleware that measures execution time.
- toHttpOptions() - Method in class com.google.genkit.plugins.googlegenai.GoogleGenAIPluginOptions
-
Converts these options to HttpOptions for the Google GenAI SDK.
- toJson() - Method in interface com.google.genkit.ai.middleware.GenerationMiddlewareDesc
-
Serializes this descriptor to the JSON shape expected by the reflection API / Dev UI:
{name, description?, configSchema?, metadata?}(null fields omitted). - toJson(Object) - Static method in class com.google.genkit.core.JsonUtils
-
Converts an object to JSON string.
- toJsonNode(Object) - Static method in class com.google.genkit.core.JsonUtils
-
Converts an object to a JsonNode.
- token(String) - Method in class com.google.genkit.plugins.firebase.functions.AuthContext.Builder
- token(String) - Method in class com.google.genkit.plugins.milvus.MilvusPlugin.Builder
-
Sets the Milvus auth token (optional; required for Zilliz Cloud or auth-enabled servers).
- toModelRequest() - Method in class com.google.genkit.ai.GenerateOptions
-
Converts these options to a ModelRequest.
- toModelRequest(I) - Method in class com.google.genkit.prompt.DotPrompt
-
Renders the prompt and creates a ModelRequest.
- toModelRequest(I) - Method in class com.google.genkit.prompt.ExecutablePrompt
-
Gets the ModelRequest that would be sent to the model.
- tool(List<Part>) - Static method in class com.google.genkit.ai.Message
-
Creates a tool message with content.
- Tool<I,
O> - Class in com.google.genkit.ai -
Tool represents a function that can be called by an AI model.
- Tool(String, String, Map<String, Object>, Map<String, Object>, Class<I>, BiFunction<ActionContext, I, O>) - Constructor for class com.google.genkit.ai.Tool
-
Creates a new Tool.
- TOOL - Enum constant in enum class com.google.genkit.ai.Role
- TOOL - Enum constant in enum class com.google.genkit.core.ActionType
-
A tool action that can be called by AI models.
- TOOL_V2 - Enum constant in enum class com.google.genkit.core.ActionType
-
A tool action using the v2 multipart format.
- Tool.Builder<I,
O> - Class in com.google.genkit.ai -
Builder for Tool.
- toolChoice(Object) - Method in class com.google.genkit.ai.GenerateOptions.Builder
- ToolDefinition - Class in com.google.genkit.ai
-
ToolDefinition describes a tool that can be used by a model.
- ToolDefinition() - Constructor for class com.google.genkit.ai.ToolDefinition
-
Default constructor.
- ToolDefinition(String, String) - Constructor for class com.google.genkit.ai.ToolDefinition
-
Creates a ToolDefinition with the given name and description.
- ToolDefinition(String, String, Map<String, Object>, Map<String, Object>) - Constructor for class com.google.genkit.ai.ToolDefinition
-
Creates a ToolDefinition with full parameters.
- ToolInterruptException - Exception Class in com.google.genkit.ai
-
Exception thrown when a tool execution is interrupted.
- ToolInterruptException() - Constructor for exception class com.google.genkit.ai.ToolInterruptException
-
Creates a new ToolInterruptException with no metadata.
- ToolInterruptException(String, Map<String, Object>) - Constructor for exception class com.google.genkit.ai.ToolInterruptException
-
Creates a new ToolInterruptException with a message and metadata.
- ToolInterruptException(Map<String, Object>) - Constructor for exception class com.google.genkit.ai.ToolInterruptException
-
Creates a new ToolInterruptException with metadata.
- toolName(String, String) - Static method in class com.google.genkit.plugins.middleware.Agents
-
Builds the tool name for a sub-agent given the configured prefix.
- ToolNext - Interface in com.google.genkit.ai.middleware
- ToolParams - Class in com.google.genkit.ai.middleware
- ToolParams(Part, Tool<?, ?>) - Constructor for class com.google.genkit.ai.middleware.ToolParams
-
Creates ToolParams.
- toolPrefix(String) - Method in class com.google.genkit.plugins.middleware.AgentsOptions.Builder
-
Sets the tool-name prefix (default
"delegate_to"). - toolRequest(ToolRequest) - Static method in class com.google.genkit.ai.Part
-
Creates a tool request part.
- ToolRequest - Class in com.google.genkit.ai
-
ToolRequest represents a request from the model to invoke a tool.
- ToolRequest() - Constructor for class com.google.genkit.ai.ToolRequest
-
Default constructor.
- ToolRequest(String, Object) - Constructor for class com.google.genkit.ai.ToolRequest
-
Creates a ToolRequest with the given name and input.
- toolRequests() - Method in class com.google.genkit.ai.agent.AgentResponse
-
Returns the tool-request parts of the assistant message.
- toolResponse(ToolResponse) - Static method in class com.google.genkit.ai.Part
-
Creates a tool response part.
- ToolResponse - Class in com.google.genkit.ai
-
ToolResponse represents a response from a tool invocation.
- ToolResponse() - Constructor for class com.google.genkit.ai.ToolResponse
-
Default constructor.
- ToolResponse(String, Object) - Constructor for class com.google.genkit.ai.ToolResponse
-
Creates a ToolResponse with the given name and output.
- ToolResponse(String, String, Object) - Constructor for class com.google.genkit.ai.ToolResponse
-
Creates a ToolResponse with the given ref, name and output.
- ToolResume - Class in com.google.genkit.ai.agent
-
ToolResume provides the parts needed to resume agent execution after a tool interrupt.
- ToolResume() - Constructor for class com.google.genkit.ai.agent.ToolResume
-
Default constructor.
- ToolResume.Builder - Class in com.google.genkit.ai.agent
-
Builder for ToolResume.
- tools() - Method in class com.google.genkit.ai.middleware.BaseGenerationMiddleware
- tools() - Method in interface com.google.genkit.ai.middleware.GenerationMiddleware
-
Returns additional tools to make available during generation.
- tools() - Static method in class com.google.genkit.plugins.middleware.Artifacts
-
Builds the artifact tools using default options (
read_artifact+write_artifact). - tools(Tool<?, ?>...) - Method in class com.google.genkit.agent.AgentConfig.Builder
-
Sets the tools available to the agent.
- tools(ArtifactsOptions) - Static method in class com.google.genkit.plugins.middleware.Artifacts
-
Builds the artifact tools.
- tools(List<Tool<?, ?>>) - Method in class com.google.genkit.agent.AgentConfig.Builder
-
Sets the tools available to the agent.
- tools(List<Tool<?, ?>>) - Method in class com.google.genkit.ai.GenerateOptions.Builder
- tools(List<ToolDefinition>) - Method in class com.google.genkit.ai.ModelRequest.Builder
- ToolTelemetry - Class in com.google.genkit.ai.telemetry
-
ToolTelemetry provides metrics collection for tool execution.
- topK(Integer) - Method in class com.google.genkit.ai.GenerationConfig.Builder
- topP(Double) - Method in class com.google.genkit.ai.GenerationConfig.Builder
- toPrettyJson(Object) - Static method in class com.google.genkit.core.JsonUtils
-
Pretty prints a JSON object.
- toPrompt() - Method in class com.google.genkit.prompt.ExecutablePrompt
-
Converts this executable prompt to a Prompt action.
- toPrompt(Class<I>) - Method in class com.google.genkit.prompt.DotPrompt
-
Creates a Prompt action from this DotPrompt.
- toString() - Method in enum class com.google.genkit.ai.agent.AgentFinishReason
- toString() - Method in enum class com.google.genkit.ai.agent.SnapshotStatus
- toString() - Method in class com.google.genkit.ai.InterruptRequest
- toString() - Method in enum class com.google.genkit.ai.Role
- toString() - Method in enum class com.google.genkit.core.ActionType
- toString() - Method in class com.google.genkit.core.tracing.SpanContext
- toString() - Method in class com.google.genkit.plugins.mcp.MCPResource
- TraceData - Class in com.google.genkit.core.tracing
-
TraceData represents a complete trace with all its spans.
- TraceData() - Constructor for class com.google.genkit.core.tracing.TraceData
- TraceData(String) - Constructor for class com.google.genkit.core.tracing.TraceData
- traceId(String) - Method in class com.google.genkit.ai.evaluation.EvalMetric.Builder
- traceId(String) - Method in class com.google.genkit.ai.evaluation.EvalResponse.Builder
- traceId(String) - Method in class com.google.genkit.core.ActionRunResult.Builder
- traceId(String) - Method in class com.google.genkit.core.GenkitException.Builder
- traceIds(List<String>) - Method in class com.google.genkit.ai.evaluation.EvalDataPoint.Builder
- traceIds(List<String>) - Method in class com.google.genkit.ai.evaluation.EvalResult.Builder
- Tracer - Class in com.google.genkit.core.tracing
-
Tracer provides tracing utilities for Genkit operations.
- transformRequest(Function<I, I>) - Static method in class com.google.genkit.core.middleware.CommonMiddleware
-
Creates a transformation middleware that transforms the request before processing.
- transformResponse(Function<O, O>) - Static method in class com.google.genkit.core.middleware.CommonMiddleware
-
Creates a transformation middleware that transforms the response after processing.
- transformState(SessionState<S>) - Method in interface com.google.genkit.ai.agent.ClientTransform
-
Transforms the given session state before it is returned to the caller.
- transportType(MCPServerConfig.TransportType) - Method in class com.google.genkit.plugins.mcp.MCPServerConfig.Builder
-
Sets the transport type.
- TtsModel - Class in com.google.genkit.plugins.googlegenai
-
Text-to-Speech model using Gemini TTS models.
- TtsModel(String, GoogleGenAIPluginOptions) - Constructor for class com.google.genkit.plugins.googlegenai.TtsModel
-
Creates a TtsModel for the specified model.
- TurnBody<S> - Interface in com.google.genkit.ai.agent
-
The body of one agent turn.
- TurnContext - Class in com.google.genkit.ai.agent
-
Per-turn context exposed to
TurnBodyimplementations. - TurnContext(String, String, int) - Constructor for class com.google.genkit.ai.agent.TurnContext
-
Constructs a new TurnContext.
- turnEnd(TurnEnd) - Method in class com.google.genkit.ai.agent.AgentStreamChunk.Builder
- TurnEnd - Class in com.google.genkit.ai.agent
-
TurnEnd signals the end of an agent turn in a streaming response.
- TurnEnd() - Constructor for class com.google.genkit.ai.agent.TurnEnd
-
Default constructor.
- TurnEnd.Builder - Class in com.google.genkit.ai.agent
-
Builder for TurnEnd.
- turnIndex() - Method in class com.google.genkit.ai.agent.SessionRunner
-
Returns the number of turns that have completed (including failed turns).
- turnIndex() - Method in class com.google.genkit.ai.agent.TurnContext
-
Returns the zero-based index of this turn.
- type(ActionType) - Method in class com.google.genkit.core.ActionDesc.Builder
- type(String) - Method in class com.google.genkit.core.tracing.SpanMetadata.Builder
U
- uid(String) - Method in class com.google.genkit.plugins.firebase.functions.AuthContext.Builder
- UNKNOWN - Enum constant in enum class com.google.genkit.ai.agent.AgentFinishReason
-
The agent finish reason is unknown.
- UNKNOWN - Enum constant in enum class com.google.genkit.ai.evaluation.DatasetType
- UNKNOWN - Enum constant in enum class com.google.genkit.ai.evaluation.EvalStatus
- UNKNOWN - Enum constant in enum class com.google.genkit.ai.FinishReason
- Unknown-snapshot decision - Search tag in class com.google.genkit.ai.agent.internal.SessionResolver
- Section
- unregister(String) - Static method in class com.google.genkit.ai.agent.internal.PendingAbortRegistry
-
Removes the registration for
snapshotId, if present. - updateArtifacts(UnaryOperator<List<Artifact>>) - Method in class com.google.genkit.ai.agent.Session
-
Applies
fnto the current artifacts list and stores the result. - updateCustom(UnaryOperator<S>) - Method in class com.google.genkit.ai.agent.Session
-
Applies
fnto the current custom state, stores the result, increments the version, and fires theonCustomChangedlistener. - updateCustom(UnaryOperator<S>) - Method in class com.google.genkit.ai.agent.SessionRunner
-
Applies
fnto the current custom state and stores the result. - updatedAt(String) - Method in class com.google.genkit.ai.agent.SessionSnapshot.Builder
- updateDataset(UpdateDatasetRequest) - Method in interface com.google.genkit.ai.evaluation.DatasetStore
-
Updates an existing dataset.
- updateDataset(UpdateDatasetRequest) - Method in class com.google.genkit.ai.evaluation.LocalFileDatasetStore
- UpdateDatasetRequest - Class in com.google.genkit.ai.evaluation
-
Request to update an existing dataset.
- UpdateDatasetRequest() - Constructor for class com.google.genkit.ai.evaluation.UpdateDatasetRequest
- UpdateDatasetRequest.Builder - Class in com.google.genkit.ai.evaluation
- updateMessages(UnaryOperator<List<Message>>) - Method in class com.google.genkit.ai.agent.Session
-
Applies
fnto the current messages list and stores the result. - updateTime(String) - Method in class com.google.genkit.ai.evaluation.DatasetMetadata.Builder
- url() - Method in class com.google.genkit.client.RemoteAgentOptions
-
Returns the agent turn endpoint URL.
- url(String) - Method in class com.google.genkit.client.RemoteAgentOptions.Builder
-
Sets the agent turn endpoint URL (required).
- url(String) - Method in class com.google.genkit.plugins.chroma.ChromaPlugin.Builder
-
Sets the Chroma server URL (default "http://localhost:8000").
- url(String) - Method in class com.google.genkit.plugins.mcp.MCPServerConfig.Builder
-
Sets the URL for HTTP transport.
- url(String) - Method in class com.google.genkit.plugins.milvus.MilvusPlugin.Builder
-
Sets the Milvus server URL (default "http://localhost:19530").
- url(String) - Method in class com.google.genkit.plugins.qdrant.QdrantPlugin.Builder
-
Sets the Qdrant server URL (default "http://localhost:6333").
- usage(Usage) - Method in class com.google.genkit.ai.ModelResponse.Builder
- Usage - Class in com.google.genkit.ai
-
Usage represents token usage statistics from a model response.
- Usage() - Constructor for class com.google.genkit.ai.Usage
-
Default constructor.
- Usage(Integer, Integer, Integer) - Constructor for class com.google.genkit.ai.Usage
-
Creates a Usage with token counts.
- use(GenerationMiddleware...) - Method in class com.google.genkit.ai.GenerateOptions.Builder
-
Sets V2 middleware to apply to this generation.
- use(Middleware<I, O>) - Method in class com.google.genkit.core.middleware.MiddlewareChain
-
Adds a middleware to the chain.
- use(List<GenerationMiddleware>) - Method in class com.google.genkit.ai.GenerateOptions.Builder
-
Sets V2 middleware to apply to this generation.
- useAll(List<Middleware<I, O>>) - Method in class com.google.genkit.core.middleware.MiddlewareChain
-
Adds multiple middleware to the chain.
- useAllMetrics() - Method in class com.google.genkit.plugins.evaluators.EvaluatorsPluginOptions.Builder
-
Enables all available metrics.
- useFirst(Middleware<I, O>) - Method in class com.google.genkit.core.middleware.MiddlewareChain
-
Inserts a middleware at the beginning of the chain.
- user(String) - Static method in class com.google.genkit.ai.Message
-
Creates a user message with text content.
- user(String) - Method in class com.google.genkit.plugins.openai.ImageGenerationConfig.Builder
- USER - Enum constant in enum class com.google.genkit.ai.Role
- username(String) - Method in class com.google.genkit.plugins.postgresql.PostgresPlugin.Builder
-
Sets the database username.
- Using Inference Profiles - Search tag in class com.google.genkit.plugins.awsbedrock.AwsBedrockPlugin
- Section
- UTIL - Enum constant in enum class com.google.genkit.core.ActionType
-
A utility action for internal operations.
V
- validate(Consumer<I>) - Static method in class com.google.genkit.core.middleware.CommonMiddleware
-
Creates a validation middleware that validates the request before processing.
- validateId(String) - Static method in class com.google.genkit.ai.agent.internal.SnapshotSharding
-
Validates a snapshot/session document id.
- valueOf(String) - Static method in enum class com.google.genkit.ai.agent.AgentFinishReason
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.google.genkit.ai.agent.SnapshotStatus
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.google.genkit.ai.evaluation.DatasetType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.google.genkit.ai.evaluation.EvalStatus
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.google.genkit.ai.FinishReason
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.google.genkit.ai.OutputFormat
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.google.genkit.ai.Role
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.google.genkit.core.ActionType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.google.genkit.plugins.chroma.ChromaCollectionConfig.Distance
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.google.genkit.plugins.evaluators.GenkitMetric
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.google.genkit.plugins.firebase.retriever.FirestoreRetrieverConfig.DistanceMeasure
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.google.genkit.plugins.mcp.MCPServerConfig.TransportType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.google.genkit.plugins.middleware.ArtifactStrategy
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.google.genkit.plugins.milvus.MilvusCollectionConfig.Metric
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.google.genkit.plugins.mongodb.MongoVectorStoreConfig.Similarity
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.google.genkit.plugins.pinecone.PineconeIndexConfig.Cloud
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.google.genkit.plugins.pinecone.PineconeIndexConfig.Metric
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.google.genkit.plugins.postgresql.PostgresTableConfig.DistanceStrategy
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.google.genkit.plugins.qdrant.QdrantCollectionConfig.Distance
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.google.genkit.plugins.weaviate.WeaviateCollectionConfig.DistanceMeasure
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class com.google.genkit.ai.agent.AgentFinishReason
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.google.genkit.ai.agent.SnapshotStatus
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.google.genkit.ai.evaluation.DatasetType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.google.genkit.ai.evaluation.EvalStatus
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.google.genkit.ai.FinishReason
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.google.genkit.ai.OutputFormat
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.google.genkit.ai.Role
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.google.genkit.core.ActionType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.google.genkit.plugins.chroma.ChromaCollectionConfig.Distance
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.google.genkit.plugins.evaluators.GenkitMetric
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.google.genkit.plugins.firebase.retriever.FirestoreRetrieverConfig.DistanceMeasure
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.google.genkit.plugins.mcp.MCPServerConfig.TransportType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.google.genkit.plugins.middleware.ArtifactStrategy
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.google.genkit.plugins.milvus.MilvusCollectionConfig.Metric
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.google.genkit.plugins.mongodb.MongoVectorStoreConfig.Similarity
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.google.genkit.plugins.pinecone.PineconeIndexConfig.Cloud
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.google.genkit.plugins.pinecone.PineconeIndexConfig.Metric
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.google.genkit.plugins.postgresql.PostgresTableConfig.DistanceStrategy
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.google.genkit.plugins.qdrant.QdrantCollectionConfig.Distance
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.google.genkit.plugins.weaviate.WeaviateCollectionConfig.DistanceMeasure
-
Returns an array containing the constants of this enum class, in the order they are declared.
- variant(String) - Method in class com.google.genkit.ai.Prompt.Builder
- vectorDimension(int) - Method in class com.google.genkit.plugins.postgresql.PostgresTableConfig.Builder
-
Sets the vector dimension (default: 768).
- vectorDimension(int) - Method in class com.google.genkit.plugins.weaviate.WeaviateCollectionConfig.Builder
-
Sets the vector dimension for the collection.
- vectorField(String) - Method in class com.google.genkit.plugins.firebase.retriever.FirestoreRetrieverConfig.Builder
-
Sets the field name containing vector embeddings.
- VeoModel - Class in com.google.genkit.plugins.googlegenai
-
Video generation model using Google Veo.
- VeoModel(String, GoogleGenAIPluginOptions) - Constructor for class com.google.genkit.plugins.googlegenai.VeoModel
-
Creates a VeoModel for the specified model.
- version(int) - Method in class com.google.genkit.ai.evaluation.DatasetMetadata.Builder
- version(String) - Method in class com.google.genkit.plugins.mcp.MCPServerOptions.Builder
-
Sets the server version.
- vertexAI(boolean) - Method in class com.google.genkit.plugins.googlegenai.GoogleGenAIPluginOptions.Builder
-
Sets whether to use Vertex AI backend.
- vertexAI(String, String) - Static method in class com.google.genkit.plugins.googlegenai.GoogleGenAIPlugin
-
Creates a GoogleGenAIPlugin configured for Vertex AI.
W
- WeaviateCollectionConfig - Class in com.google.genkit.plugins.weaviate
-
Configuration for a Weaviate collection (class) in the plugin.
- WeaviateCollectionConfig.Builder - Class in com.google.genkit.plugins.weaviate
-
Builder for WeaviateCollectionConfig.
- WeaviateCollectionConfig.DistanceMeasure - Enum Class in com.google.genkit.plugins.weaviate
-
Distance measure options for vector similarity search.
- WeaviatePlugin - Class in com.google.genkit.plugins.weaviate
-
Weaviate plugin for Genkit providing vector database integration.
- WeaviatePlugin.Builder - Class in com.google.genkit.plugins.weaviate
-
Builder for WeaviatePlugin.
- WeaviateVectorStore - Class in com.google.genkit.plugins.weaviate
-
Weaviate vector store implementation for RAG workflows.
- WeaviateVectorStore(WeaviateClient, WeaviateCollectionConfig, Embedder) - Constructor for class com.google.genkit.plugins.weaviate.WeaviateVectorStore
-
Creates a new WeaviateVectorStore.
- wholeDocumentReplace(JsonNode) - Static method in class com.google.genkit.core.jsonpatch.JsonPatch
-
Returns a whole-document replace patch:
[{"op":"replace","path":"","value":value}]. - withAuthPolicy(OnCallGenkit.AuthPolicy) - Method in class com.google.genkit.plugins.firebase.functions.OnCallGenkit
-
Sets the authorization policy for this function.
- withContext(Map<String, Object>) - Method in class com.google.genkit.core.ActionContext
-
Creates a new ActionContext with the given request-scoped user context.
- withCors(String) - Method in class com.google.genkit.plugins.firebase.functions.OnCallGenkit
-
Sets the CORS policy.
- withFlowName(String) - Method in class com.google.genkit.core.ActionContext
-
Creates a new ActionContext with a different flow name.
- withGenerateFunction(ExecutablePrompt.GenerateFunction) - Method in class com.google.genkit.prompt.ExecutablePrompt
-
Sets the generate function to use Genkit.generate() for tool/interrupt support.
- withGenerateObjectFunction(ExecutablePrompt.GenerateObjectFunction) - Method in class com.google.genkit.prompt.ExecutablePrompt
-
Sets the generateObject function to use Genkit.generateObject() for typed structured output.
- withJudge(GenkitMetric, String) - Static method in class com.google.genkit.plugins.evaluators.MetricConfig
-
Creates a metric configuration with a judge model.
- withJudgeAndEmbedder(GenkitMetric, String, String) - Static method in class com.google.genkit.plugins.evaluators.MetricConfig
-
Creates a metric configuration with a judge model and embedder.
- withMessageIndex(int) - Method in class com.google.genkit.ai.middleware.GenerateParams
-
Returns a new GenerateParams with the given messageIndex, preserving other fields.
- withMessages(List<Message>) - Method in class com.google.genkit.ai.GenerateActionOptions
-
Returns a new
GenerateActionOptionswith the given messages, preserving all other fields. - withMetadata(String, Object) - Method in class com.google.genkit.ai.Document
-
Adds metadata to this Document.
- withMetrics(MetricConfig...) - Static method in class com.google.genkit.plugins.evaluators.EvaluatorsPluginOptions
-
Creates plugin options with the specified metrics using defaults for judge and embedder.
- withMetricTypes(GenkitMetric...) - Static method in class com.google.genkit.plugins.evaluators.EvaluatorsPluginOptions
-
Creates plugin options with simple metric types (no per-metric configuration).
- withMiddleware(Middleware<I, O>) - Method in class com.google.genkit.core.Flow
-
Creates a copy of this flow with additional middleware.
- withMiddleware(List<Middleware<I, O>>) - Method in class com.google.genkit.core.Flow
-
Creates a copy of this flow with additional middleware.
- withModel(String) - Method in class com.google.genkit.ai.GenerateActionOptions
-
Returns a new
GenerateActionOptionswith the given model name, preserving all other fields. - withOnChunk(Consumer<ModelResponseChunk>) - Method in class com.google.genkit.ai.middleware.GenerateParams
-
Returns a new GenerateParams with the given onChunk callback, preserving other fields.
- withRequest(GenerateActionOptions) - Method in class com.google.genkit.ai.middleware.GenerateParams
-
Returns a new GenerateParams with the given request, preserving other fields.
- withRequest(ModelRequest) - Method in class com.google.genkit.ai.middleware.ModelParams
-
Returns a new ModelParams with the given request, preserving the stream callback.
- withResumed(Object, Object) - Method in class com.google.genkit.core.ActionContext
-
Creates a new ActionContext carrying resume-awareness for a restarted tool call.
- withSessionId(String) - Method in class com.google.genkit.core.ActionContext
-
Creates a new ActionContext with a session ID.
- withSpanContext(SpanContext) - Method in class com.google.genkit.core.ActionContext
-
Creates a new ActionContext with a different span context.
- withSpanPath(String) - Method in class com.google.genkit.core.ActionContext
-
Creates a new ActionContext with a different span path.
- withStreamCallback(Consumer<ModelResponseChunk>) - Method in class com.google.genkit.ai.middleware.ModelParams
-
Returns a new ModelParams with the given stream callback, preserving the request.
- withThreadName(String) - Method in class com.google.genkit.core.ActionContext
-
Creates a new ActionContext with a thread name.
- wrap(SnapshotMutator<S>) - Static method in class com.google.genkit.ai.agent.internal.AbortAwareMutator
-
Wraps
innerso that it returnsnullwhen the existing snapshot has statusSnapshotStatus.ABORTED; otherwise delegates toinner. - wrapGenerate(ActionContext, GenerateParams, GenerateNext) - Method in class com.google.genkit.ai.middleware.BaseGenerationMiddleware
- wrapGenerate(ActionContext, GenerateParams, GenerateNext) - Method in interface com.google.genkit.ai.middleware.GenerationMiddleware
-
Wraps each iteration of the generate tool loop.
- wrapGenerate(ActionContext, GenerateParams, GenerateNext) - Method in class com.google.genkit.plugins.middleware.FallbackMiddleware
- wrapGenerate(ActionContext, GenerateParams, GenerateNext) - Method in class com.google.genkit.plugins.middleware.SimulateSystemPromptMiddleware
- wrapModel(ActionContext, ModelParams, ModelNext) - Method in class com.google.genkit.ai.middleware.BaseGenerationMiddleware
- wrapModel(ActionContext, ModelParams, ModelNext) - Method in interface com.google.genkit.ai.middleware.GenerationMiddleware
-
Wraps each model API call.
- wrapModel(ActionContext, ModelParams, ModelNext) - Method in class com.google.genkit.plugins.middleware.RetryMiddleware
- wrapTool(ActionContext, ToolParams, ToolNext) - Method in class com.google.genkit.ai.middleware.BaseGenerationMiddleware
- wrapTool(ActionContext, ToolParams, ToolNext) - Method in interface com.google.genkit.ai.middleware.GenerationMiddleware
-
Wraps each tool execution.
- write(int, String) - Static method in class com.google.genkit.RuntimeFileWriter
-
Writes a runtime file for Dev UI discovery.
- WRITE_TOOL - Static variable in class com.google.genkit.plugins.middleware.Artifacts
-
Name of the write tool.
- WriteInput() - Constructor for class com.google.genkit.plugins.middleware.Artifacts.WriteInput
-
Default constructor for JSON deserialization.
- WriteOutput() - Constructor for class com.google.genkit.plugins.middleware.Artifacts.WriteOutput
-
Default constructor for JSON deserialization.
- writeRuntimeFile(int, String, String) - Static method in class com.google.genkit.RuntimeFileWriter
-
Writes a runtime file for Dev UI discovery.
X
- X_GOOG_API_CLIENT_HEADER - Static variable in class com.google.genkit.plugins.googlegenai.GenkitClientHeaders
-
Standard Google client attribution header used by many Google APIs.
- XAIPlugin - Class in com.google.genkit.plugins.xai
-
XAIPlugin provides XAI (x.ai / Grok) model integrations for Genkit.
- XAIPlugin() - Constructor for class com.google.genkit.plugins.xai.XAIPlugin
-
Creates an XAIPlugin with default options (using XAI_API_KEY environment variable).
- XAIPlugin(CompatOAIPluginOptions) - Constructor for class com.google.genkit.plugins.xai.XAIPlugin
-
Creates an XAIPlugin with the specified options.
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
com.google.genkit.ai.middleware.GenerationMiddlewareinstead, which supports distinct Generate, Model, and Tool hooks.