Package 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.

Related Packages

Package	Description
com.google.genkit.ai
com.google.genkit.ai.agent.internal
com.google.genkit.ai.evaluation
com.google.genkit.ai.middleware
com.google.genkit.ai.telemetry	Telemetry module for Genkit Java SDK.

Class	Description
Agent<S>	Agent is a bidirectional streaming agent action that manages session state and provides typed facades for snapshot retrieval and abort.
AgentAbortRequest	AgentAbortRequest is the request body for aborting an agent execution.
AgentAbortRequest.Builder	Builder for AgentAbortRequest.
AgentAbortResponse	AgentAbortResponse is the response body for an agent abort operation.
AgentAbortResponse.Builder	Builder for AgentAbortResponse.
AgentApi<S>	AgentApi is the typed facade interface exposed by an agent, providing snapshot retrieval, abort, identification, and chat-client creation.
AgentChat<S>	AgentChat is the ergonomic programmatic client for driving an agent across multiple turns while carrying session state automatically.
AgentChunk<S>	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.
AgentFinishReason	AgentFinishReason indicates why an agent finished execution.
AgentFn<S>	Custom agent handler: runs one invocation's turn loop body for ONE turn at a time via the runner.
AgentFnContext	Context handed to an AgentFn for one invocation.
AgentInit<S>	AgentInit represents the initialization data for an agent session.
AgentInit.Builder<S>	Builder for AgentInit.
AgentInput	AgentInput represents the input to an agent turn.
AgentInput.Builder	Builder for AgentInput.
AgentInterrupt	AgentInterrupt represents a tool request that paused agent execution awaiting a caller response.
AgentMetadata	AgentMetadata describes the capabilities and configuration of an agent endpoint.
AgentMetadata.Builder	Builder for AgentMetadata.
AgentOutput<S>	AgentOutput represents the output of an agent turn.
AgentOutput.Builder<S>	Builder for AgentOutput.
AgentRef	AgentRef is a lightweight reference to an agent, carrying only its name and description.
AgentResponse<S>	AgentResponse is the ergonomic wrapper AgentChat.send(java.lang.String) returns for one completed turn.
AgentResult	AgentResult represents the final result of an agent execution.
AgentResult.Builder	Builder for AgentResult.
AgentSessionContext	AgentSessionContext binds a Session to the current thread so that prompts, middleware, and tools can access the active session without passing it through every call frame.
AgentStreamChunk	AgentStreamChunk represents a streaming chunk from an agent execution.
AgentStreamChunk.Builder	Builder for AgentStreamChunk.
AgentTransport<S>	AgentTransport abstracts how a single agent turn is executed.
Artifact	Artifact represents a named collection of content parts produced during agent execution.
Artifact.Builder	Builder for Artifact.
ArtifactStore	ArtifactStore is a state-agnostic view of artifact storage used by middleware and tools that do not need to know the custom state type S of the session.
ClientTransform<S>	ClientTransform allows a client-managed agent to transform session state before returning it to the caller.
CustomAgentConfig<S>	Configuration for defining a custom agent via AgentActions.defineCustomAgent.
CustomAgentConfig.Builder<S>	Builder for CustomAgentConfig.
FileSessionStore<S>	Disk-backed implementation of SessionStore and SnapshotSubscriber.
FileSessionStore.Builder<S>	Builder for FileSessionStore.
GetSnapshotOptions	Options for retrieving a session snapshot.
GetSnapshotOptions.Builder	Builder for GetSnapshotOptions.
GetSnapshotRequest	GetSnapshotRequest is the request body for retrieving a session snapshot.
GetSnapshotRequest.Builder	Builder for GetSnapshotRequest.
InMemorySessionStore<S>	Reference in-memory implementation of SessionStore and SnapshotSubscriber.
RuntimeError	RuntimeError represents a runtime error that occurred during agent execution.
RuntimeError.Builder	Builder for RuntimeError.
Session<S>	Session is the per-invocation in-memory state holder managed by the agent runtime.
SessionRunner<S>	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).
SessionSnapshot<S>	SessionSnapshot represents a point-in-time snapshot of an agent session.
SessionSnapshot.Builder<S>	Builder for SessionSnapshot.
SessionState<S>	SessionState represents the state of an agent session.
SessionState.Builder<S>	Builder for SessionState.
SessionStore<S>	Combined read/write interface for a session store.
SessionStoreOptions	Options passed to session store operations.
SessionStoreOptions.Builder	Builder for SessionStoreOptions.
SnapshotMutator<S>	The mutator for an atomic read-modify-write on a session snapshot.
SnapshotReader<S>	Read side of a session store.
SnapshotStatus	SnapshotStatus represents the status of an agent snapshot.
SnapshotSubscriber	Optional capability: subscribe to a snapshot's status changes.
SnapshotWriter<S>	Write side of a session store.
ToolResume	ToolResume provides the parts needed to resume agent execution after a tool interrupt.
ToolResume.Builder	Builder for ToolResume.
TurnBody<S>	The body of one agent turn.
TurnContext	Per-turn context exposed to TurnBody implementations.
TurnEnd	TurnEnd signals the end of an agent turn in a streaming response.
TurnEnd.Builder	Builder for TurnEnd.