Module generated

Module generated 

Source

Structs§

ActiveStreamingToolParams
The parameters for creating an ActiveStreamingTool.
ActivityEvent
Represents a generic activity or status update.
AgentTool
The configuration of the agent tool.
ApigeeLlmParams
AppendEventRequest
The parameters for appendEvent.
ArtifactVersion
Metadata for a file artifact version.
Auth
The auth config sent by tool asking client to collect auth credentials and adk and client will help to fill in the response.
AuthCredential
Data class representing an authentication credential. To exchange for the actual credential, please use CredentialExchanger.exchangeCredential(). @example // API Key Auth const authCredential: AuthCredential = { authType: AuthCredentialTypes.API_KEY, apiKey: “your_api_key”, }; @example // HTTP Auth const authCredential: AuthCredential = { authType: AuthCredentialTypes.HTTP, http: { scheme: “basic”, credentials: { username: “user”, password: “password”, }, } } @example // OAuth2 Bearer Token in HTTP Header const authCredential: AuthCredential = { authType: AuthCredentialTypes.HTTP, http: { scheme: “bearer”, credentials: { token: “your_access_token”, }, } } @example // OAuth2 Auth with Authorization Code Flow const authCredential: AuthCredential = { authType: AuthCredentialTypes.OAUTH2, oauth2: { clientId: “your_client_id”, clientSecret: “your_client_secret”, } } @example: // Open ID Connect Auth const authCredential: AuthCredential = { authType: AuthCredentialTypes.OPEN_ID_CONNECT, oauth2: { clientId: “1234”, clientSecret: “secret”, redirectUri: “https://example.com”, scopes: [“scope1”, “scope2”], } } @example: // Auth with resource reference const authCredential: AuthCredential = { authType: AuthCredentialTypes.API_KEY, resourceRef: “projects/1234/locations/us-central1/resources/resource1” }
AuthToolArguments
The arguments for the special long running function tool that is used to request end user credentials.
BaseArtifactService
Interface for artifact services.
BaseCredentialExchanger
Base interface for credential exchangers. Credential exchangers are responsible for exchanging credentials from one format or scheme to another.
BaseCredentialService
Abstract class for Service that loads / saves tool credentials from / to the backend credential store.
BaseLlmConnection
The base class for a live model connection.
BaseMemoryService
Base interface for memory services. The service provides functionalities to ingest sessions into memory so that the memory can be used for user queries.
BasePolicyEngine
BaseToolParams
Parameters for the BaseTool constructor.
CallCodeEvent
Represents a request to execute code.
CodeExecutionInput
A structure that contains the input of code execution. */
CodeExecutionResult
CodeGroupMatch
CodeResultEvent
Represents the result of code execution.
ContentEvent
Represents partial content (text delta) intended for the user.
CreateSessionRequest
The parameters for createSession.
DeleteArtifactRequest
The parameters for deleteArtifact.
DeleteSessionRequest
The parameters for deleteSession.
ErrorEvent
Represents a runtime error.
Event
Represents an event in a conversation between agents and users. It is used to store the content of the conversation, as well as the actions taken by the agents like function calls, etc.
EventActions
Represents the actions attached to an event.
Example
A few-shot example.
ExecuteCodeParams
The parameters for executing code. */
ExecutorContext
The A2A Agent Executor context.
File
A structure that contains a file name and its content
FileArtifactVersion
Metadata for a file artifact version.
FinishedEvent
Represents the final completion of the agent’s task.
GeminiParams
The parameters for creating a Gemini instance.
GetSessionConfig
The configuration of getting a session.
GetSessionRequest
The parameters for getSession.
HttpAuth
The credentials and metadata for HTTP authentication.
HttpCredentials
Represents the secret token value for HTTP authentication, like user name, password, oauth token, etc.
InvocationContextParams
The parameters for creating an invocation context.
ListArtifactKeysRequest
The parameters for listArtifactKeys.
ListSessionsRequest
The parameters for listSessions.
ListSessionsResponse
The response of listing sessions. The events and states are not set within each Session object.
ListVersionsRequest
The parameters for listVersions.
LiveRequest
Request sent to live agents.
LlmAgent
LlmAgentBuilder
LlmAgentConfig
The configuration options for creating an LLM-based agent. (Inherits fields from BaseAgent)
LlmRequest
LLM request class that allows passing in tools, output schema and system instructions to the model.
LlmResponse
LLM response class that provides the first candidate response from the model if available. Otherwise, returns error code and message.
LoadArtifactRequest
The parameters for loadArtifact.
Logger
Logger interface for ADK.
LoopAgent
LoopAgentBuilder
LoopAgentConfig
The configuration options for creating a loop agent. (Inherits fields from BaseAgent)
MemoryEntry
Represents one memory entry.
OAuth2Auth
Represents credential value and its metadata for a OAuth2 credential.
OTelHooks
Configuration hooks for OpenTelemetry setup. This interface defines the structure for configuring OpenTelemetry components including span processors, metric readers, and log record processors.
OtelExportersConfig
ParsedVersion
PolicyCheckResult
RunAsyncToolRequest
The parameters for runAsync.
RunConfig
Configs for runtime behavior of agents.
RunnerConfig
The configuration parameters for the Runner.
SaveArtifactRequest
The parameters for saveArtifact.
SearchMemoryRequest
The parameters for searchMemory.
SearchMemoryResponse
Represents the response from a memory search.
ServiceAccount
Represents Google Service Account configuration.
ServiceAccountCredential
Represents Google Service Account configuration. @example config = { type: “service_account”, projectId: “your_project_id”, privateKeyId: “your_private_key_id”, privateKey: “—–BEGIN PRIVATE KEY—–…”, clientEmail: “…@….iam.gserviceaccount.com”, clientId: “your_client_id”, authUri: “https://accounts.google.com/o/oauth2/auth”, tokenUri: “https://oauth2.googleapis.com/token”, authProviderX509CertUrl: “https://www.googleapis.com/oauth2/v1/certs”, clientX509CertUrl: “https://www.googleapis.com/robot/v1/metadata/x509/…”, universeDomain: “googleapis.com”, }
Session
Represents a session in a conversation between agents and users.
StdioConnectionParams
Defines the parameters for establishing a connection to an MCP server using standard input/output (stdio). This is typically used for running MCP servers as local child processes.
StreamableHTTPConnectionParams
Defines the parameters for establishing a connection to an MCP server over HTTP using Server-Sent Events (SSE) for streaming. Usage: const connectionParams: StreamableHTTPConnectionParams = { type: ‘StreamableHTTPConnectionParams’, url: ‘http://localhost:8788/mcp’ };
ThoughtEvent
Represents a reasoning trace (thought) from the agent.
ToolCallEvent
Represents a request to execute a tool.
ToolCallPolicyContext
ToolConfirmationEvent
Represents a request for tool confirmation.
ToolProcessLlmRequest
The parameters for processLlmRequest.
ToolResultEvent
Represents the result of a tool execution.
TraceAgentInvocationParams
TraceCallLlmParams
TraceMergedToolCallsParams
TraceSendDataParams
TraceToolCallParams
TranscriptionEntry
Store the data that can be used for transcription.
UpdateCodeExecutionResultParams
The parameters for updating the code execution result. */

Enums§

A2AMetadataKeys
DataPartType
The types of data parts.
EventType
The types of events that can be parsed from a raw Event.
LogLevel
Log levels for the logger.
MetadataKeys
OAuthGrantType
Represents the OAuth2 flow (or grant type).
StreamingMode
The streaming mode for the run config.