adk-python の API リファレンス

adk-python (google/adk-python) の公開 API 400 件 —— クラス 162、関数 130、メソッド 108。実際のソースを静的解析して抽出した正確なシグネチャを掲載しています。

種別	件数
クラス	162
関数	130
メソッド	108

API 一覧

funcsrc.google.adk.a2a._compat.a2a_to_dict(obj:Any) -> dict[str, Any]

Serializes an A2A object to a plain dict.

funcsrc.google.adk.a2a._compat.add_activated_extension(context:Any, uri:str) -> None

Activates an extension on the request context if supported.

funcsrc.google.adk.a2a._compat.data_part_blob_bytes(p:Part) -> bytes

Serializes a data Part for embedding as a generic inline blob.

funcsrc.google.adk.a2a._compat.data_part_dict(p:Part) -> dict[str, Any]

Returns the structured data of a data Part as a plain dict.

funcsrc.google.adk.a2a._compat.file_part_mime_type(p:Part) -> Optional[str]

Returns the media type of a file Part.

funcsrc.google.adk.a2a._compat.file_part_name(p:Part) -> Optional[str]

Returns the display name / filename of a file Part.

funcsrc.google.adk.a2a._compat.file_part_uri(p:Part) -> Optional[str]

Returns the URI of a URI-backed file Part, else None.

funcsrc.google.adk.a2a._compat.is_data_part(p:Part) -> bool

Returns True if the Part carries structured data.

funcsrc.google.adk.a2a._compat.is_file_part(p:Part) -> bool

Returns True if the Part carries raw bytes or a URL.

funcsrc.google.adk.a2a._compat.is_text_part(p:Part) -> bool

Returns True if the Part carries text content.

funcsrc.google.adk.a2a._compat.make_api_key_scheme(*name:str, *location:str='header') -> Any

Builds an API-key SecurityScheme.

funcsrc.google.adk.a2a._compat.make_client_config(*httpx_client:Any, **kwargs:Any) -> Any

Builds a version-correct A2A ``ClientConfig``.

funcsrc.google.adk.a2a._compat.make_data_part(*data:dict[str, Any], *metadata:Optional[dict[str, Any]]=None) -> Part

Builds a structured-data Part.

funcsrc.google.adk.a2a._compat.make_file_part_with_bytes(*data:bytes, *mime_type:str='', *name:Optional[str]=None) -> Part

Builds a file Part carrying raw bytes.

funcsrc.google.adk.a2a._compat.make_file_part_with_uri(*uri:str, *mime_type:str='', *name:Optional[str]=None) -> Part

Builds a file Part referencing a URI.

funcsrc.google.adk.a2a._compat.make_text_part(text:str) -> Part

Builds a text Part.

funcsrc.google.adk.a2a._compat.meta_to_dict(metadata:Any) -> dict[str, Any]

Normalizes A2A metadata to a plain dict.

funcsrc.google.adk.a2a._compat.metadata_get(metadata:Any, key:str, default:Any=None) -> Any

Reads a key from A2A metadata.

funcsrc.google.adk.a2a._compat.normalize_message(msg:Any) -> Any

Collapses an empty 1.x proto ``Message`` to ``None``.

funcsrc.google.adk.a2a._compat.parse_agent_card(data:dict[str, Any]) -> AgentCard

Builds an AgentCard from a JSON dict.

funcsrc.google.adk.a2a._compat.part_metadata(p:Part) -> dict[str, Any]

Reads a Part's metadata.

funcsrc.google.adk.a2a._compat.part_text(p:Part) -> str

Reads the text of a text Part.

funcsrc.google.adk.a2a._compat.rebind_client_factory_httpx(factory:Any, httpx_client:Any) -> Any

Returns a client factory bound to ``httpx_client``.

funcsrc.google.adk.a2a._compat.role_to_str(role:Any) -> str

Maps an A2A ``Role`` to the GenAI content role string.

funcsrc.google.adk.a2a._compat.set_event_metadata(event:Any, metadata:dict[str, Any]) -> None

Set metadata on an A2A event.

funcsrc.google.adk.a2a._compat.set_part_metadata(p:Part, metadata:dict[str, Any]) -> None

Writes a Part's metadata.

funcsrc.google.adk.a2a._compat.stream_item_kind(item:Any) -> tuple[str, Any]

Returns ``(kind, payload)`` for a stream item.

classsrc.google.adk.a2a.agent.config.A2aRemoteAgentConfig

Configuration for A2A remote agents.

classsrc.google.adk.a2a.agent.config.CardRequestInterceptor

Interceptor for the remote agent card fetch request.

classsrc.google.adk.a2a.agent.config.RequestInterceptor

Interceptor for A2A requests.

func

src.google.adk.a2a.converters.part_converter.convert_a2a_part_to_genai_part(a2a_part:a2a_types.Part) -> Optional[genai_types.Part]

Convert an A2A Part to a Google GenAI Part.

func

src.google.adk.a2a.converters.part_converter.convert_genai_part_to_a2a_part(part:genai_types.Part) -> Optional[a2a_types.Part]

Convert a Google GenAI Part to an A2A Part.

classsrc.google.adk.a2a.converters.request_converter.AgentRunRequest

Data model for arguments passed to the ADK runner.

classsrc.google.adk.a2a.executor.config.A2aAgentExecutorConfig

Configuration for the A2aAgentExecutor.

classsrc.google.adk.a2a.executor.config.ExecuteInterceptor

Interceptor for the A2aAgentExecutor.

classsrc.google.adk.a2a.executor.executor_context.ExecutorContext

Context for the executor.

funcsrc.google.adk.a2a.logs.log_utils.build_a2a_request_log(req:A2AMessage) -> str

Builds a structured log representation of an A2A request.

funcsrc.google.adk.a2a.logs.log_utils.build_message_part_log(part:A2APart) -> str

Builds a log representation of an A2A message part.

funcsrc.google.adk.a2a.utils.agent_to_a2a.create_runner() -> Runner

Create a runner for the agent or workflow.

classsrc.google.adk.agents._streaming_mode.StreamingMode

Streaming modes for agent execution.

classsrc.google.adk.agents.agent_config.AgentConfig

The config for the YAML schema to create an agent.

funcsrc.google.adk.agents.agent_config.agent_config_discriminator(v:Any) -> str

Discriminator function that returns the tag name for Pydantic.

classsrc.google.adk.agents.base_agent.BaseAgent

Base class for all agents in Agent Development Kit.

methodsrc.google.adk.agents.base_agent.BaseAgent.clone(update:Mapping[str, Any] | None=None) -> SelfAgent

Creates a copy of this agent instance.

methodsrc.google.adk.agents.base_agent.BaseAgent.find_agent(name:str) -> Optional[BaseAgent]

Finds the agent with the given name in this agent and its descendants.

methodsrc.google.adk.agents.base_agent.BaseAgent.find_sub_agent(name:str) -> Optional[BaseAgent]

Finds the agent with the given name in this agent's descendants.

methodsrc.google.adk.agents.base_agent.BaseAgent.from_config(config:BaseAgentConfig, config_abs_path:str) -> SelfAgent

Creates an agent from a config.

methodsrc.google.adk.agents.base_agent.BaseAgent.root_agent() -> BaseAgent

Gets the root agent of this agent.

methodsrc.google.adk.agents.base_agent.BaseAgent.validate_sub_agents_unique_names(value:list[BaseAgent]) -> list[BaseAgent]

Validates that all sub-agents have unique names.

classsrc.google.adk.agents.base_agent.BaseAgentState

Base class for all agent states.

classsrc.google.adk.agents.base_agent_config.BaseAgentConfig

The config for the YAML schema of a BaseAgent.

classsrc.google.adk.agents.common_configs.AgentRefConfig

The config for the reference to another agent.

funcsrc.google.adk.agents.config_agent_utils.from_config(config_path:str) -> BaseAgent

Build agent from a configfile path.

func

src.google.adk.agents.config_agent_utils.resolve_agent_reference(ref_config:AgentRefConfig, referencing_agent_config_abs_path:str) -> BaseAgent

Build an agent from a reference.

funcsrc.google.adk.agents.config_agent_utils.resolve_callbacks(callbacks_config:List[CodeConfig]) -> Any

Resolve callbacks from configuration.

funcsrc.google.adk.agents.config_agent_utils.resolve_code_reference(code_config:CodeConfig) -> Any

Resolve a code reference to actual Python object.

classsrc.google.adk.agents.context.Context

The context within an agent run.

methodsrc.google.adk.agents.context.Context.actions() -> EventActions

The event actions for the current context.

methodsrc.google.adk.agents.context.Context.add_session_to_memory() -> None

Triggers memory generation for the current session.

methodsrc.google.adk.agents.context.Context.attempt_count() -> int

Returns the current attempt number (1-based).

methodsrc.google.adk.agents.context.Context.branch() -> str | None

The branch path of the current invocation context.

methodsrc.google.adk.agents.context.Context.custom_metadata() -> dict[str, Any]

Returns the custom metadata dictionary.

methodsrc.google.adk.agents.context.Context.error() -> Exception | None

The exception raised by the node, if any.

methodsrc.google.adk.agents.context.Context.error_node_path() -> str

The path of the node that failed.

methodsrc.google.adk.agents.context.Context.event_author() -> str

Author name stamped on events emitted by this node.

methodsrc.google.adk.agents.context.Context.function_call_id() -> str | None

The function call id of the current tool call.

method

src.google.adk.agents.context.Context.get_artifact_version(filename:str, version:int | None=None) -> ArtifactVersion | None

Gets artifact version info.

methodsrc.google.adk.agents.context.Context.get_auth_response(auth_config:AuthConfig) -> AuthCredential | None

Gets the auth response credential from session state.

methodsrc.google.adk.agents.context.Context.interrupt_ids() -> set[str]

Interrupt IDs accumulated during this execution.

methodsrc.google.adk.agents.context.Context.load_artifact(filename:str, version:int | None=None) -> types.Part | None

Loads an artifact attached to the current session.

methodsrc.google.adk.agents.context.Context.load_credential(auth_config:AuthConfig) -> AuthCredential | None

Loads a credential from the credential service.

methodsrc.google.adk.agents.context.Context.node() -> BaseNode | None

Returns the node instance of this context.

methodsrc.google.adk.agents.context.Context.output() -> Any

The node's result value.

methodsrc.google.adk.agents.context.Context.parent_ctx() -> Context | None

Returns the parent node's Context.

methodsrc.google.adk.agents.context.Context.request_confirmation(*hint:str | None=None, *payload:Any | None=None) -> None

Requests confirmation for the current tool call.

methodsrc.google.adk.agents.context.Context.request_credential(auth_config:AuthConfig) -> None

Requests a credential for the current tool call.

methodsrc.google.adk.agents.context.Context.route() -> RouteValue | list[RouteValue] | None

Routing value for conditional edges.

methodsrc.google.adk.agents.context.Context.run_id() -> str

Returns the execution ID of the current node.

methodsrc.google.adk.agents.context.Context.save_credential(auth_config:AuthConfig) -> None

Saves a credential to the credential service.

methodsrc.google.adk.agents.context.Context.search_memory(query:str) -> SearchMemoryResponse

Searches the memory of the current user.

methodsrc.google.adk.agents.context.Context.session() -> Session

Returns the current session for this invocation.

methodsrc.google.adk.agents.context.Context.state() -> State

The delta-aware state of the current session.

methodsrc.google.adk.agents.context.Context.telemetry_context() -> TelemetryContext

Returns the telemetry context.

classsrc.google.adk.agents.live_request_queue.LiveRequest

Request send to live agents.

classsrc.google.adk.agents.llm.task._finish_task_tool.FinishTaskTool

Tool for signaling LlmAgent task completion.

method

src.google.adk.agents.llm.task._finish_task_tool.FinishTaskTool.run_async(*args:dict[str, Any], *tool_context:ToolContext) -> str | dict[str, str]

Execute the finish_task tool.

classsrc.google.adk.agents.llm.task._task_models.TaskRequest

A request to delegate a task to a sub-agent.

classsrc.google.adk.agents.llm.task._task_models.TaskResult

The result returned by a task agent upon completion.

classsrc.google.adk.agents.llm_agent.LlmAgent

LLM-based Agent.

methodsrc.google.adk.agents.llm_agent.LlmAgent.canonical_model() -> BaseLlm

The resolved self.model field as BaseLlm.

classsrc.google.adk.agents.llm_agent_config.LlmAgentConfig

The config for the YAML schema of a LlmAgent.

classsrc.google.adk.agents.loop_agent.LoopAgent

A shell agent that run its sub-agents in a loop.

classsrc.google.adk.agents.loop_agent.LoopAgentState

State for LoopAgent.

classsrc.google.adk.agents.loop_agent_config.LoopAgentConfig

The config for the YAML schema of a LoopAgent.

classsrc.google.adk.agents.mcp_instruction_provider.McpInstructionProvider

Fetches agent instructions from an MCP server.

classsrc.google.adk.agents.parallel_agent_config.ParallelAgentConfig

The config for the YAML schema of a ParallelAgent.

classsrc.google.adk.agents.remote_a2a_agent.A2AClientError

Raised when A2A client operations fail.

classsrc.google.adk.agents.remote_a2a_agent.AgentCardResolutionError

Raised when agent card resolution fails.

classsrc.google.adk.agents.run_config.RunConfig

Configs for runtime behavior of agents.

classsrc.google.adk.agents.run_config.ToolThreadPoolConfig

Configuration for the tool thread pool executor.

classsrc.google.adk.agents.sequential_agent.SequentialAgent

A shell agent that runs its sub-agents in sequence.

classsrc.google.adk.agents.sequential_agent.SequentialAgentState

State for SequentialAgent.

classsrc.google.adk.agents.transcription_entry.TranscriptionEntry

Store the data that can be used for transcription.

classsrc.google.adk.apps._configs.EventsCompactionConfig

The config of event compaction for an application.

classsrc.google.adk.apps._configs.ResumabilityConfig

The config of the resumability for an application.

classsrc.google.adk.apps.app.App

Represents an LLM-backed agentic application.

funcsrc.google.adk.apps.app.validate_app_name(name:str) -> None

Ensures the provided application name is safe and intuitive.

classsrc.google.adk.apps.base_events_summarizer.BaseEventsSummarizer

Base interface for compacting events.

method

src.google.adk.apps.base_events_summarizer.BaseEventsSummarizer.maybe_summarize_events(*events:list[Event]) -> Optional[Event]

Compact a list of events into a single event.

classsrc.google.adk.artifacts.artifact_util.ParsedArtifactUri

The result of parsing an artifact URI.

func

src.google.adk.artifacts.artifact_util.get_artifact_uri(app_name:str, user_id:str, filename:str, version:int, session_id:str | None=None) -> str

Constructs an artifact URI.

funcsrc.google.adk.artifacts.artifact_util.is_artifact_ref(artifact:types.Part) -> bool

Checks if an artifact part is an artifact reference.

funcsrc.google.adk.artifacts.artifact_util.parse_artifact_uri(uri:str) -> ParsedArtifactUri | None

Parses an artifact URI.

funcsrc.google.adk.artifacts.artifact_util.validate_path_segment(value:str, field_name:str) -> None

Rejects values that could alter the constructed path.

classsrc.google.adk.artifacts.base_artifact_service.BaseArtifactService

Abstract base class for artifact services.

method

src.google.adk.artifacts.base_artifact_service.BaseArtifactService.delete_artifact(*app_name:str, *user_id:str, *filename:str, *session_id:Optional[str]=None) -> None

Deletes an artifact.

method

src.google.adk.artifacts.base_artifact_service.BaseArtifactService.list_versions(*app_name:str, *user_id:str, *filename:str, *session_id:Optional[str]=None) -> list[int]

Lists all versions of an artifact.

funcsrc.google.adk.artifacts.base_artifact_service.ensure_part(artifact:Union[types.Part, dict[str, Any]]) -> types.Part

Normalizes an artifact to a ``types.Part`` instance.

classsrc.google.adk.auth.auth_credential.AuthCredential

Data class representing an authentication credential.

classsrc.google.adk.auth.auth_credential.AuthCredentialTypes

Represents the type of authentication credential.

classsrc.google.adk.auth.auth_credential.HttpAuth

The credentials and metadata for HTTP authentication.

classsrc.google.adk.auth.auth_credential.ServiceAccount

Represents Google Service Account configuration.

classsrc.google.adk.auth.auth_credential.ServiceAccountCredential

Represents Google Service Account configuration.

classsrc.google.adk.auth.auth_provider_registry.AuthProviderRegistry

Registry for auth provider instances.

classsrc.google.adk.auth.auth_schemes.CustomAuthScheme

A flexible model for custom authentication schemes.

classsrc.google.adk.auth.auth_schemes.OAuthGrantType

Represents the OAuth2 flow (or grant type).

methodsrc.google.adk.auth.auth_schemes.OAuthGrantType.from_flow(flow:OAuthFlows) -> Optional['OAuthGrantType']

Converts an OAuthFlows object to a OAuthGrantType.

classsrc.google.adk.auth.exchanger.base_credential_exchanger.BaseCredentialExchanger

Base interface for credential exchangers.

method

src.google.adk.auth.exchanger.base_credential_exchanger.BaseCredentialExchanger.exchange(auth_credential:AuthCredential, auth_scheme:Optional[AuthScheme]=None) -> ExchangeResult

Exchange credential if needed.

func

src.google.adk.auth.oauth2_credential_util.update_credential_with_tokens(auth_credential:AuthCredential, tokens:OAuth2Token) -> None

Update the credential with new tokens.

classsrc.google.adk.auth.refresher.base_credential_refresher.BaseCredentialRefresher

Base interface for credential refreshers.

method

src.google.adk.auth.refresher.base_credential_refresher.BaseCredentialRefresher.refresh(auth_credential:AuthCredential, auth_scheme:Optional[AuthScheme]=None) -> AuthCredential

Refreshes a credential if needed.

funcsrc.google.adk.cli.api_server.ApiServer.get_adk_app_info(app_name:str) -> AppInfo

Returns the detailed info for a given ADK app.

func

src.google.adk.cli.api_server.ApiServer.save_artifact(app_name:str, user_id:str, session_id:str, req:SaveArtifactRequest) -> ArtifactVersion

Request payload for saving a new artifact.

func

src.google.adk.cli.api_server.ApiServer.update_session(app_name:str, user_id:str, session_id:str, req:UpdateSessionRequest) -> Session

Updates session state without running the agent.

classsrc.google.adk.cli.api_server.SaveArtifactRequest

Request payload for saving a new artifact.

classsrc.google.adk.cli.api_server.UpdateMemoryRequest

Request to add a session to the memory service.

func

src.google.adk.cli.built_in_agents.adk_agent_builder_assistant.AgentBuilderAssistant.add(text:str='', indent:int=0) -> None

Append wrapped text with indentation.

funcsrc.google.adk.cli.built_in_agents.utils.adk_source_utils.clear_schema_cache() -> None

Clear the cached schema data.

funcsrc.google.adk.cli.cli_eval.get_eval_sets_manager(eval_storage_uri:Optional[str], agents_dir:str) -> EvalSetsManager

Returns an instance of EvalSetsManager.

funcsrc.google.adk.cli.cli_eval.get_root_agent(agent_module_file_path:str) -> BaseAgent

Returns root agent given the agent module.

funcsrc.google.adk.cli.cli_eval.pretty_print_eval_result(eval_result:EvalCaseResult) -> None

Pretty prints eval result.

funcsrc.google.adk.cli.cli_tools_click.conformance()

Conformance testing tools for ADK.

funcsrc.google.adk.cli.cli_tools_click.deploy()

Deploys agent to hosted environments.

funcsrc.google.adk.cli.cli_tools_click.eval_set()

Manage Eval Sets.

funcsrc.google.adk.cli.cli_tools_click.main(ctx:Optional[click.Context]=None) -> None

Agent Development Kit CLI tools.

funcsrc.google.adk.cli.cli_tools_click.migrate()

ADK migration commands.

funcsrc.google.adk.cli.cli_tools_click.telemetry() -> None

Manage telemetry settings.

funcsrc.google.adk.cli.cli_tools_click.telemetry_disable() -> None

Disable telemetry collection.

funcsrc.google.adk.cli.cli_tools_click.telemetry_enable() -> None

Enable telemetry collection.

funcsrc.google.adk.cli.cli_tools_click.telemetry_status() -> None

Show telemetry collection status.

func

src.google.adk.cli.conformance._generated_file_utils.load_recorded_session(test_case_dir:Path, streaming_mode:StreamingMode) -> Optional[Session]

Load recorded session data from YAML file.

funcsrc.google.adk.cli.conformance._generated_file_utils.load_test_case(test_case_dir:Path) -> TestSpec

Load TestSpec from spec.yaml file.

func

src.google.adk.cli.conformance._replay_validators.compare_events(actual_events:list[Event], recorded_events:list[Event]) -> ComparisonResult

Compare actual events with recorded events.

funcsrc.google.adk.cli.dev_server.DevServer.create_eval_set_legacy(app_name:str, eval_set_id:str)

Creates an eval set, given the id.

func

src.google.adk.cli.dev_server.DevServer.create_test(app_name:str, test_name:str, req:CreateTestRequest) -> dict[str, str]

Creates or updates a test file from session data.

funcsrc.google.adk.cli.dev_server.DevServer.delete_test(app_name:str, test_name:str) -> dict[str, str]

Deletes a specific test file.

funcsrc.google.adk.cli.dev_server.DevServer.get_eval(app_name:str, eval_set_id:str, eval_case_id:str) -> EvalCase

Gets an eval case in an eval set.

funcsrc.google.adk.cli.dev_server.DevServer.get_eval_result(app_name:str, eval_result_id:str) -> EvalResult

Gets the eval result for the given eval id.

funcsrc.google.adk.cli.dev_server.DevServer.get_test_content(app_name:str, test_name:str) -> dict[str, Any]

Fetches the content of a specific test file.

funcsrc.google.adk.cli.dev_server.DevServer.list_eval_results(app_name:str) -> ListEvalResultsResponse

Lists all eval results for the given app.

funcsrc.google.adk.cli.dev_server.DevServer.list_eval_sets(app_name:str) -> ListEvalSetsResponse

Lists all eval sets for the given app.

funcsrc.google.adk.cli.dev_server.DevServer.list_evals_in_eval_set(app_name:str, eval_set_id:str) -> list[str]

Lists all evals in an eval set.

funcsrc.google.adk.cli.dev_server.DevServer.list_metrics_info(app_name:str) -> ListMetricsInfoResponse

Lists all eval metrics for the given app.

funcsrc.google.adk.cli.dev_server.DevServer.list_tests(app_name:str) -> list[str]

Lists all test JSON files for the given app.

funcsrc.google.adk.cli.dev_server.DevServer.rebuild_app_tests(app_name:str, test_name:Optional[str]=None) -> dict[str, str]

Rebuilds tests for the app.

funcsrc.google.adk.cli.dev_server.DevServer.run_app_tests(app_name:str, test_name:Optional[str]=None) -> StreamingResponse

Runs tests and streams pytest output.

funcsrc.google.adk.cli.dev_server.DevServer.run_eval(app_name:str, eval_set_id:str, req:RunEvalRequest) -> RunEvalResponse

Runs an eval given the details in the eval request.

classsrc.google.adk.cli.dev_server.EvalResult

This class has no field intentionally.

classsrc.google.adk.cli.plugins.recordings_plugin.RecordingsPlugin

Plugin for recording ADK agent interactions.

classsrc.google.adk.cli.plugins.recordings_schema.LlmRecording

Paired LLM request and response.

classsrc.google.adk.cli.plugins.recordings_schema.Recordings

All recordings in chronological order.

classsrc.google.adk.cli.plugins.recordings_schema.ToolRecording

Paired tool call and response.

classsrc.google.adk.cli.plugins.replay_plugin.ReplayVerificationError

Exception raised when replay verification fails.

classsrc.google.adk.cli.service_registry.ServiceFactory

Protocol for service factory functions.

classsrc.google.adk.cli.service_registry.ServiceRegistry

Registry for custom service URI schemes.

classsrc.google.adk.cli.trigger_routes.EventarcTriggerRequest

Eventarc / CloudEvents request format.

classsrc.google.adk.cli.trigger_routes.PubSubMessage

Inner message payload from a Pub/Sub push subscription.

classsrc.google.adk.cli.trigger_routes.PubSubTriggerRequest

Pub/Sub push subscription request format.

classsrc.google.adk.cli.trigger_routes.TriggerResponse

Standard response for Pub/Sub and Eventarc triggers.

funcsrc.google.adk.cli.utils._onboarding.get_gcp_project_from_gcloud() -> str

Uses gcloud to get default project.

funcsrc.google.adk.cli.utils._onboarding.get_gcp_region_from_gcloud() -> str

Uses gcloud to get default region.

funcsrc.google.adk.cli.utils._onboarding.handle_login_with_google() -> VertexAIAuth | ExpressModeAuth

Handles the "Login with Google" flow.

funcsrc.google.adk.cli.utils._onboarding.prompt_for_google_api_key(google_api_key:Optional[str]) -> str

Prompts user for Google API key.

funcsrc.google.adk.cli.utils._onboarding.prompt_for_google_cloud(google_cloud_project:Optional[str]) -> str

Prompts user for Google Cloud project ID.

funcsrc.google.adk.cli.utils._onboarding.prompt_for_google_cloud_region(google_cloud_region:Optional[str]) -> str

Prompts user for Google Cloud region.

classsrc.google.adk.cli.utils.base_agent_loader.BaseAgentLoader

Abstract base class for agent loaders.

methodsrc.google.adk.cli.utils.base_agent_loader.BaseAgentLoader.load_agent(agent_name:str) -> Union[BaseAgent, App]

Loads an instance of an agent with the given name.

func

src.google.adk.cli.utils.envs.load_dotenv_for_agent(agent_name:str, agent_parent_folder:str, filename:str='.env') -> None

Loads the `.env` file for the agent module.

funcsrc.google.adk.cli.utils.evals.convert_session_to_eval_invocations(session:Session) -> list[Invocation]

Converts a session data into a list of Invocation.

funcsrc.google.adk.cli.utils.evals.create_gcs_eval_managers_from_uri(eval_storage_uri:str) -> GcsEvalManagers

Creates GcsEvalManagers from eval_storage_uri.

funcsrc.google.adk.cli.utils.gcp_utils.check_adc() -> bool

Checks if Application Default Credentials exist.

funcsrc.google.adk.cli.utils.gcp_utils.check_express_eligibility(location:str='us-central1') -> bool

Checks if user is eligible for Express Mode.

funcsrc.google.adk.cli.utils.gcp_utils.get_access_token() -> str

Gets the ADC access token.

funcsrc.google.adk.cli.utils.gcp_utils.list_gcp_projects(limit:int=20) -> List[Tuple[str, str]]

Lists GCP projects available to the user.

funcsrc.google.adk.cli.utils.gcp_utils.login_adc() -> None

Prompts user to login via gcloud ADC.

funcsrc.google.adk.cli.utils.gcp_utils.retrieve_express_project(location:str='us-central1') -> Optional[Dict[str, Any]]

Retrieves existing Express project info.

funcsrc.google.adk.cli.utils.gcp_utils.sign_up_express(location:str='us-central1') -> Dict[str, Any]

Signs up for Express Mode.

funcsrc.google.adk.cli.utils.graph_serialization.serialize_agent(agent:BaseAgent) -> dict[str, Any]

Recursively serialize an agent, excluding non-serializable fields.

func

src.google.adk.cli.utils.state.create_empty_state(agent:BaseAgent | BaseNode, initialized_states:Optional[dict[str, Any]]=None) -> dict[str, Any]

Creates empty str for non-initialized states.

classsrc.google.adk.code_executors.base_code_executor.BaseCodeExecutor

Abstract base class for all code executors.

classsrc.google.adk.code_executors.code_execution_utils.CodeExecutionUtils

Utility functions for code execution.

methodsrc.google.adk.code_executors.code_execution_utils.CodeExecutionUtils.build_executable_code_part(code:str) -> types.Part

Builds an executable code part with code string.

methodsrc.google.adk.code_executors.code_execution_utils.CodeExecutionUtils.get_encoded_file_content(data:bytes) -> bytes

Gets the file content as a base64-encoded bytes.

classsrc.google.adk.environment._base_environment.BaseEnvironment

Abstract base class for code execution environments.

methodsrc.google.adk.environment._base_environment.BaseEnvironment.close() -> None

Release resources held by the environment.

methodsrc.google.adk.environment._base_environment.BaseEnvironment.initialize() -> None

Initialize the environment (e.g.

methodsrc.google.adk.environment._base_environment.BaseEnvironment.is_initialized() -> bool

Whether the environment has been initialized.

methodsrc.google.adk.environment._base_environment.BaseEnvironment.read_file(path:Path) -> bytes

Read a file from the environment filesystem.

classsrc.google.adk.environment._base_environment.ExecutionResult

Result of a command execution.

classsrc.google.adk.errors.not_found_error.NotFoundError

Represents an error that occurs when an entity is not found.

classsrc.google.adk.errors.session_not_found_error.SessionNotFoundError

Raised when a session cannot be found.

funcsrc.google.adk.evaluation._audio_utils.resample_pcm16(pcm:bytes, src_rate:int, dst_rate:int) -> bytes

Resamples 16-bit mono PCM via linear interpolation.

func

src.google.adk.evaluation._eval_set_results_manager_utils.parse_eval_set_result_json(eval_set_result_json:str | bytes) -> EvalSetResult

Parses an EvalSetResult from JSON.

funcsrc.google.adk.evaluation._path_validation.validate_path_segment(value:str, field_name:str) -> None

Rejects values that could alter a filesystem path.

classsrc.google.adk.evaluation.app_details.AgentDetails

Details about the individual agent in the App.

classsrc.google.adk.evaluation.app_details.AppDetails

Contains details about the App (the agentic system).

methodsrc.google.adk.evaluation.app_details.AppDetails.get_developer_instructions(agent_name:str) -> str

Returns a string containing the developer instructions.

classsrc.google.adk.evaluation.base_eval_service.BaseEvalService

A service to run Evals for an ADK agent.

classsrc.google.adk.evaluation.base_eval_service.EvaluateConfig

Contains configurations needed to run evaluations.

classsrc.google.adk.evaluation.base_eval_service.InferenceConfig

Contains configurations need to run inferences.

classsrc.google.adk.evaluation.base_eval_service.InferenceResult

Contains inference results for a single eval case.

classsrc.google.adk.evaluation.base_eval_service.InferenceStatus

Status of the inference.

classsrc.google.adk.evaluation.eval_case.EvalCase

An eval case.

classsrc.google.adk.evaluation.eval_case.Invocation

Represents a single invocation.

classsrc.google.adk.evaluation.eval_case.SessionInput

Values that help initialize a Session.

classsrc.google.adk.evaluation.eval_config.CustomMetricConfig

Configuration for a custom metric.

classsrc.google.adk.evaluation.eval_config.EvalConfig

Configurations needed to run an Eval.

classsrc.google.adk.evaluation.eval_metrics.BaseCriterion

Base criterion to use for an Eval Metric.

classsrc.google.adk.evaluation.eval_metrics.EvalMetricResultPerInvocation

Eval metric results per invocation.

classsrc.google.adk.evaluation.eval_metrics.Interval

Represents a range of numeric values, e.g.

classsrc.google.adk.evaluation.eval_metrics.JudgeModelOptions

Options for an eval metric's judge model.

classsrc.google.adk.evaluation.eval_metrics.LlmAsAJudgeCriterion

Criterion when using LLM-As-A-Judge metric.

classsrc.google.adk.evaluation.eval_metrics.MetricInfo

Information about the metric that are used for Evals.

classsrc.google.adk.evaluation.eval_metrics.MetricInfoProvider

Interface for providing MetricInfo.

methodsrc.google.adk.evaluation.eval_metrics.MetricInfoProvider.get_metric_info() -> MetricInfo

Returns MetricInfo for a given metric.

classsrc.google.adk.evaluation.eval_metrics.MetricValueInfo

Information about the type of metric value.

classsrc.google.adk.evaluation.eval_metrics.RubricsBasedCriterion

Criterion when using a rubric based metric.

classsrc.google.adk.evaluation.eval_result.EvalCaseResult

Case level evaluation results.

classsrc.google.adk.evaluation.eval_result.EvalSetResult

Eval set level evaluation results.

classsrc.google.adk.evaluation.eval_rubrics.Rubric

This class represents a single Rubric.

classsrc.google.adk.evaluation.eval_rubrics.RubricContent

The content of a rubric.

classsrc.google.adk.evaluation.eval_set.EvalSet

A set of eval cases.

classsrc.google.adk.evaluation.eval_set_results_manager.EvalSetResultsManager

An interface to manage Eval Set Results.

classsrc.google.adk.evaluation.eval_sets_manager.EvalSetsManager

An interface to manage Eval Sets.

method

src.google.adk.evaluation.eval_sets_manager.EvalSetsManager.get_eval_case(app_name:str, eval_set_id:str, eval_case_id:str) -> Optional[EvalCase]

Returns an EvalCase if found; otherwise, None.

classsrc.google.adk.evaluation.evaluation_constants.EvalConstants

Holds constants for evaluation file constants.

classsrc.google.adk.evaluation.evaluation_generator.EvaluationGenerator

Generates evaluation responses for agents.

classsrc.google.adk.evaluation.evaluator.Evaluator

A metrics evaluator interface.

classsrc.google.adk.evaluation.evaluator.PerInvocationResult

Metric evaluation score per invocation.

classsrc.google.adk.evaluation.llm_as_judge.LlmAsJudge

Evaluator based on a LLM.

classsrc.google.adk.evaluation.llm_as_judge_utils.Label

Labels for auto rater response.

classsrc.google.adk.evaluation.metric_evaluator_registry.MetricEvaluatorRegistry

A registry for metric Evaluators.

method

src.google.adk.evaluation.metric_evaluator_registry.MetricEvaluatorRegistry.get_evaluator(eval_metric:EvalMetric) -> Evaluator

Returns an Evaluator for the given metric.

classsrc.google.adk.evaluation.metric_info_providers.ResponseEvaluatorMetricInfoProvider

Metric info provider for ResponseEvaluator.

classsrc.google.adk.evaluation.metric_info_providers.SafetyEvaluatorV1MetricInfoProvider

Metric info provider for SafetyEvaluatorV1.

classsrc.google.adk.evaluation.response_evaluator.ResponseEvaluator

Evaluates Agent's responses.

classsrc.google.adk.evaluation.rubric_based_evaluator.AutoRaterResponseParser

An interface for parsing auto rater's response.

method

src.google.adk.evaluation.rubric_based_evaluator.AutoRaterResponseParser.parse(auto_rater_response:str) -> list[RubricResponse]

Parses the auto rater's response.

classsrc.google.adk.evaluation.rubric_based_evaluator.RubricBasedEvaluator

A base class for rubric based evaluators.

methodsrc.google.adk.evaluation.rubric_based_evaluator.RubricBasedEvaluator.get_effective_rubrics_list() -> list[Rubric]

Returns the effective rubrics list.

classsrc.google.adk.evaluation.simulation._llm_audio_user_simulator.LlmAudioUserSimulatorConfig

Configuration for _LlmAudioUserSimulator.

classsrc.google.adk.evaluation.simulation.per_turn_user_simulator_quality_v1.PerTurnUserSimulatorQualityV1

Per turn user simulator evaluator.

classsrc.google.adk.evaluation.simulation.user_simulator.Status

The resulting status of get_next_user_message().

classsrc.google.adk.evaluation.simulation.user_simulator_personas.UserBehavior

Container for the behavior of a persona.

classsrc.google.adk.evaluation.simulation.user_simulator_personas.UserPersona

Container for a persona.

classsrc.google.adk.evaluation.simulation.user_simulator_personas.UserPersonaRegistry

A registry for UserPersona instances.

classsrc.google.adk.evaluation.trajectory_evaluator.TrajectoryEvaluator

Evaluates tool use trajectories for accuracy.

classsrc.google.adk.events.event.Event

Represents an event in a conversation between agents and users.

methodsrc.google.adk.events.event.Event.message() -> Any

Alias for content.

methodsrc.google.adk.events.event.Event.model_post_init(__context:Any) -> None

Post initialization logic for the event.

methodsrc.google.adk.events.event.Event.node_name() -> str

The name of the node that generated the event.

classsrc.google.adk.events.event.NodeInfo

Workflow node metadata attached to an Event.

methodsrc.google.adk.events.event.NodeInfo.name() -> str

The clean name of the node (without @run_id).

methodsrc.google.adk.events.event.NodeInfo.run_id() -> str

The run ID of the node that generated the event.

classsrc.google.adk.events.event_actions.EventActions

Represents the actions attached to an event.

classsrc.google.adk.events.event_actions.EventCompaction

The compaction of the events.

classsrc.google.adk.events.request_input.RequestInput

Represents a request for input from the user.

funcsrc.google.adk.features._feature_decorator.experimental(feature_name:FeatureName) -> Callable[[T], T]

Decorator for experimental features.

funcsrc.google.adk.features._feature_decorator.stable(feature_name:FeatureName) -> Callable[[T], T]

Decorator for stable features.

funcsrc.google.adk.features._feature_decorator.working_in_progress(feature_name:FeatureName) -> Callable[[T], T]

Decorator for working in progress features.

classsrc.google.adk.features._feature_registry.FeatureConfig

Feature configuration.

classsrc.google.adk.features._feature_registry.FeatureName

Feature names.

classsrc.google.adk.features._feature_registry.FeatureStage

Feature lifecycle stages.

funcsrc.google.adk.features._feature_registry.is_feature_enabled(feature_name:FeatureName) -> bool

Check if a feature is enabled at runtime.

funcsrc.google.adk.features._feature_registry.override_feature_enabled(feature_name:FeatureName, enabled:bool) -> None

Programmatically override a feature's enabled state.

classsrc.google.adk.flows.llm_flows._base_llm_processor.BaseLlmRequestProcessor

Base class for LLM request processor.

method

src.google.adk.flows.llm_flows._base_llm_processor.BaseLlmRequestProcessor.run_async(invocation_context:InvocationContext, llm_request:LlmRequest) -> AsyncGenerator[Event, None]

Runs the processor.

classsrc.google.adk.flows.llm_flows._base_llm_processor.BaseLlmResponseProcessor

Base class for LLM response processor.

method

src.google.adk.flows.llm_flows._base_llm_processor.BaseLlmResponseProcessor.run_async(invocation_context:InvocationContext, llm_response:LlmResponse) -> AsyncGenerator[Event, None]

Processes the LLM response.

funcsrc.google.adk.flows.llm_flows._code_execution.get_content_as_bytes(output_content:str | bytes) -> bytes

Converts output_content to bytes.

classsrc.google.adk.flows.llm_flows.audio_cache_manager.AudioCacheConfig

Configuration for audio caching behavior.

classsrc.google.adk.flows.llm_flows.auto_flow.AutoFlow

AutoFlow is SingleFlow with agent transfer capability.

funcsrc.google.adk.flows.llm_flows.base_llm_flow.BaseLlmFlow.get_author_for_event(llm_response:LlmResponse) -> str

Get the author of the event.

funcsrc.google.adk.flows.llm_flows.functions.deep_merge_dicts(d1:dict[str, Any], d2:dict[str, Any]) -> dict[str, Any]

Recursively merges d2 into d1.

classsrc.google.adk.flows.llm_flows.single_flow.SingleFlow

SingleFlow is the LLM flows that handles tools calls.

classsrc.google.adk.integrations.agent_registry.agent_registry.Endpoint

Full metadata for a registered Endpoint.

classsrc.google.adk.integrations.agent_registry.agent_registry.Interface

Details for a single connection interface.

func

src.google.adk.integrations.bigquery.client.get_bigquery_client(*project:Optional[str], *credentials:Credentials, *location:Optional[str]=None, *user_agent:Optional[Union[str, List[Optional[str]]]]=None) -> bigquery.Client

Get a BigQuery client.

classsrc.google.adk.integrations.bigquery.config.BigQueryToolConfig

Configuration for BigQuery tools.

method

src.google.adk.integrations.bigquery.config.BigQueryToolConfig.validate_application_name(v:Optional[str]) -> Optional[str]

Validate the application name.

method

src.google.adk.integrations.bigquery.config.BigQueryToolConfig.validate_job_labels(v:Optional[dict[str, str]]) -> Optional[dict[str, str]]

Validate the job labels.

method

src.google.adk.integrations.bigquery.config.BigQueryToolConfig.validate_maximum_bytes_billed(v:Optional[int]) -> Optional[int]

Validate the maximum bytes billed.

func

src.google.adk.integrations.bigquery.metadata_tool.list_table_ids(project_id:str, dataset_id:str, credentials:Credentials, settings:BigQueryToolConfig) -> list[str]

List table ids in a BigQuery dataset.

classsrc.google.adk.integrations.crewai.crewai_tool.CrewaiTool

Use this class to wrap a CrewAI tool.

funcsrc.google.adk.integrations.eventarc._client.cleanup_clients() -> None

Cleans up all cached publisher clients.

func

src.google.adk.integrations.eventarc._client.remove_publisher_client(*credentials:typing.Any, *user_agent:str | None=None, *project_id:str | None=None) -> None

Removes a publisher client from the cache.

classsrc.google.adk.integrations.eventarc._config.EventarcCredentialsConfig

Configuration for Google Cloud credentials.

classsrc.google.adk.integrations.eventarc._config.EventarcToolConfig

Configuration for the Eventarc tool.

func

src.google.adk.integrations.gcs.admin_tool.create_bucket(*project_id:str, *bucket_name:str, *credentials:Credentials, *location:str | None=None) -> dict[str, Any]

Create a new GCS bucket.

funcsrc.google.adk.integrations.gcs.admin_tool.delete_bucket(*bucket_name:str, *credentials:Credentials) -> dict[str, Any]

Delete a GCS bucket.

funcsrc.google.adk.integrations.gcs.admin_tool.get_bucket(*bucket_name:str, *credentials:Credentials) -> dict[str, Any]

Get metadata information about a GCS bucket.

func

src.google.adk.integrations.gcs.client.get_gcs_client(*credentials:Credentials, *project:str | None=None) -> storage.Client

Get a GCS client.

classsrc.google.adk.integrations.gcs.settings.GCSToolSettings

Settings for GCS tools.

funcsrc.google.adk.integrations.gcs.storage_tool.get_bucket(*bucket_name:str, *credentials:Credentials) -> dict[str, Any]

Get metadata information about a GCS bucket.

classsrc.google.adk.integrations.oci._oci_genai_llm.OCIGenAILlm

Integration with OCI Generative AI models.

classsrc.google.adk.integrations.slack.slack_runner.SlackRunner

Runner for ADK agents on Slack.

methodsrc.google.adk.integrations.slack.slack_runner.SlackRunner.start(app_token:str) -> None

Starts the Slack app using Socket Mode.

methodsrc.google.adk.integrations.vmaas.sandbox_client.SandboxClient.click_at(x:int, y:int) -> None

Click at a specific coordinate.

methodsrc.google.adk.integrations.vmaas.sandbox_client.SandboxClient.drag_and_drop(x1:int, y1:int, x2:int, y2:int) -> None

Drag from one coordinate to another.

methodsrc.google.adk.integrations.vmaas.sandbox_client.SandboxClient.get_current_url(max_retries:int=3) -> str | None

Get the URL of the currently active tab.

methodsrc.google.adk.integrations.vmaas.sandbox_client.SandboxClient.get_screenshot(max_retries:int=3) -> bytes

Capture a screenshot of the current page.

methodsrc.google.adk.integrations.vmaas.sandbox_client.SandboxClient.go_back() -> bool

Navigate back in browser history.

methodsrc.google.adk.integrations.vmaas.sandbox_client.SandboxClient.go_forward() -> bool

Navigate forward in browser history.

methodsrc.google.adk.integrations.vmaas.sandbox_client.SandboxClient.health_check() -> bool

Check if the sandbox is healthy.

methodsrc.google.adk.integrations.vmaas.sandbox_client.SandboxClient.hover_at(x:int, y:int) -> None

Hover at a specific coordinate.

methodsrc.google.adk.integrations.vmaas.sandbox_client.SandboxClient.key_combination(keys:list[str]) -> None

Press a combination of keys.

method

src.google.adk.integrations.vmaas.sandbox_client.SandboxClient.make_cdp_batch_request(commands:list[dict[str, Any]], stop_on_error:bool=True) -> list[dict[str, Any]]

Execute multiple CDP commands.

method

src.google.adk.integrations.vmaas.sandbox_client.SandboxClient.make_cdp_request(command:str, params:dict[str, Any] | None=None) -> dict[str, Any]

Make a single CDP request to the sandbox.

methodsrc.google.adk.integrations.vmaas.sandbox_client.SandboxClient.navigate(url:str) -> dict[str, Any]

Navigate to a URL.

method

src.google.adk.integrations.vmaas.sandbox_client.SandboxClient.scroll_at(x:int, y:int, direction:Literal['up', 'down', 'left', 'right'], magnitude:int) -> None

Scroll at a specific coordinate.

method

src.google.adk.integrations.vmaas.sandbox_client.SandboxClient.type_text(text:str, press_enter:bool=False, clear_before_typing:bool=False) -> None

Type text at the currently focused element.

method

src.google.adk.integrations.vmaas.sandbox_client.SandboxClient.type_text_at(x:int, y:int, text:str, press_enter:bool=False, clear_before_typing:bool=False) -> None

Click at a coordinate and type text.

methodsrc.google.adk.integrations.vmaas.sandbox_client.SandboxClient.update_access_token(access_token:str) -> None

Update the access token.

classsrc.google.adk.labs.openai._openai_llm.OpenAILlm

Integration with OpenAI models.

classsrc.google.adk.labs.openai._openai_responses_llm.AzureOpenAIResponsesLlm

Azure OpenAI-compatible Responses API model.

funcsrc.google.adk.memory._utils.format_timestamp(timestamp:float) -> str

Formats the timestamp of the memory entry.

classsrc.google.adk.memory.base_memory_service.BaseMemoryService

Base class for memory services.

methodsrc.google.adk.memory.base_memory_service.BaseMemoryService.add_session_to_memory(session:Session) -> None

Adds a session to the memory service.

method

src.google.adk.memory.base_memory_service.BaseMemoryService.search_memory(*app_name:str, *user_id:str, *query:str) -> SearchMemoryResponse

Searches for sessions that match the query.

classsrc.google.adk.memory.base_memory_service.SearchMemoryResponse

Represents the response from a memory search.

classsrc.google.adk.memory.memory_entry.MemoryEntry

Represent one memory entry.

classsrc.google.adk.models._capabilities.LlmCapabilities

Resolved capabilities for an LLM instance.

funcsrc.google.adk.models._capabilities.gemini_output_schema_and_tools(model_name:str) -> bool

Whether a Gemini model id can pair an output schema with tools.

classsrc.google.adk.models.anthropic_llm.AnthropicLlm

Integration with Claude models via the Anthropic API.

classsrc.google.adk.models.anthropic_llm.Claude

Integration with Claude models served from Vertex AI.

funcsrc.google.adk.models.anthropic_llm.content_block_to_part(content_block:anthropic_types.ContentBlock) -> types.Part

Converts an Anthropic content block to a genai Part.

classsrc.google.adk.models.apigee_llm.ApigeeLlm

A BaseLlm implementation for calling Apigee proxy.

classsrc.google.adk.models.apigee_llm.ApigeeLlm.ApiType

The supported API types for Apigee LLM.

methodsrc.google.adk.models.apigee_llm.ApigeeLlm.api_client() -> Client

Provides the api client.

methodsrc.google.adk.models.apigee_llm.ApigeeLlm.supported_models() -> list[str]

Provides the list of supported models.

classsrc.google.adk.models.base_llm.BaseLlm

The BaseLLM class.

methodsrc.google.adk.models.base_llm.BaseLlm.capabilities() -> LlmCapabilities

The capabilities of this model instance.

methodsrc.google.adk.models.base_llm.BaseLlm.connect(llm_request:LlmRequest) -> AbstractAsyncContextManager[BaseLlmConnection]

Creates a live connection to the LLM.

method

src.google.adk.models.base_llm.BaseLlm.generate_content_async(llm_request:LlmRequest, stream:bool=False) -> AsyncGenerator[LlmResponse, None]

Generates content for a single model turn.

classsrc.google.adk.models.base_llm_connection.BaseLlmConnection

The base class for a live model connection.

methodsrc.google.adk.models.base_llm_connection.BaseLlmConnection.close() -> None

Closes the llm server connection.

methodsrc.google.adk.models.base_llm_connection.BaseLlmConnection.send_content(content:types.Content) -> None

Sends a user content to the model.

methodsrc.google.adk.models.base_llm_connection.BaseLlmConnection.send_history(history:list[types.Content]) -> None

Sends the conversation history to the model.

classsrc.google.adk.models.cache_metadata.CacheMetadata

Metadata for context cache associated with LLM responses.

classsrc.google.adk.models.gemini_llm_connection.GeminiLlmConnection

The Gemini model connection.

methodsrc.google.adk.models.gemini_llm_connection.GeminiLlmConnection.close() -> None

Closes the llm server connection.

methodsrc.google.adk.models.gemini_llm_connection.GeminiLlmConnection.send_content(content:types.Content) -> None

Sends a user content to the gemini model.

methodsrc.google.adk.models.gemini_llm_connection.GeminiLlmConnection.send_history(history:list[types.Content]) -> None

Sends the conversation history to the gemini model.

classsrc.google.adk.models.gemma_llm.Gemma

Integration for Gemma 3 models exposed via the Gemini API.

method

src.google.adk.models.gemma_llm.Gemma.generate_content_async(llm_request:LlmRequest, stream:bool=False) -> AsyncGenerator[LlmResponse, None]

Sends a request to the Gemma model.

methodsrc.google.adk.models.gemma_llm.Gemma.supported_models() -> list[str]

Provides the list of supported models.

classsrc.google.adk.models.google_llm.Gemini

Integration for Gemini models.

methodsrc.google.adk.models.google_llm.Gemini.api_client() -> Client

Provides the api client.

method

src.google.adk.models.google_llm.Gemini.generate_content_async(llm_request:LlmRequest, stream:bool=False) -> AsyncGenerator[LlmResponse, None]

Sends a request to the Gemini model.

methodsrc.google.adk.models.google_llm.Gemini.supported_models() -> list[str]

Provides the list of supported models.

funcsrc.google.adk.models.interactions_utils.build_interactions_response_log(interaction:Interaction) -> str

Build a log string for an interactions API response.

funcsrc.google.adk.models.interactions_utils.convert_interaction_to_llm_response(interaction:Interaction) -> LlmResponse

Convert an Interaction response to an LlmResponse.

funcsrc.google.adk.models.interactions_utils.extract_system_instruction(config:types.GenerateContentConfig) -> str | None

Extract system instruction as a string from config.

classsrc.google.adk.models.lite_llm.LiteLLMClient

Provides acompletion method (for better testability).

method

src.google.adk.models.lite_llm.LiteLLMClient.acompletion(model:Any, messages:Any, tools:Any, **kwargs:Any) -> Union[ModelResponse, CustomStreamWrapper]

Asynchronously calls acompletion.

method

src.google.adk.models.lite_llm.LiteLLMClient.completion(model:Any, messages:Any, tools:Any, stream:bool=False, **kwargs:Any) -> Union[ModelResponse, CustomStreamWrapper]

Synchronously calls completion.

classsrc.google.adk.models.lite_llm.LiteLlm

Wrapper around litellm.

method

src.google.adk.models.lite_llm.LiteLlm.generate_content_async(llm_request:LlmRequest, stream:bool=False) -> AsyncGenerator[LlmResponse, None]

Generates content asynchronously.

methodsrc.google.adk.models.lite_llm.LiteLlm.supported_models() -> list[str]

Provides the list of supported models.

classsrc.google.adk.models.registry.LLMRegistry

Registry for LLMs.

methodsrc.google.adk.models.registry.LLMRegistry.new_llm(model:str) -> BaseLlm

Creates a new LLM instance.

methodsrc.google.adk.models.registry.LLMRegistry.register(llm_cls:type[BaseLlm]) -> None

Registers a new LLM class.

methodsrc.google.adk.models.registry.LLMRegistry.resolve(model:str) -> type[BaseLlm]

Resolves the model to a BaseLlm subclass.

classsrc.google.adk.optimization.agent_optimizer.AgentOptimizer

Base class for agent optimizers.

method

src.google.adk.optimization.agent_optimizer.AgentOptimizer.optimize(initial_agent:Agent, sampler:Sampler[SamplingResultT]) -> OptimizerResult[AgentWithScoresT]

Runs the optimizer.

classsrc.google.adk.optimization.data_types.AgentWithScores

An optimized agent with its scores.

classsrc.google.adk.optimization.data_types.OptimizerResult

Base class for optimizer final results.

classsrc.google.adk.planners.base_planner.BasePlanner

Abstract base class for all planners.

func

src.google.adk.platform.thread.create_thread(target:Callable[..., None], *args:object, **kwargs:object) -> threading.Thread

Creates a thread.

funcsrc.google.adk.platform.time.get_time() -> float

Returns the current time in seconds since the epoch.

funcsrc.google.adk.platform.time.set_time_provider(provider:Callable[[], float]) -> None

Sets the provider for the current time.

funcsrc.google.adk.platform.uuid.new_uuid() -> str

Returns a new unique ID.

funcsrc.google.adk.platform.uuid.reset_id_provider() -> None

Resets the ID provider to its default implementation.

funcsrc.google.adk.platform.uuid.set_id_provider(provider:Callable[[], str]) -> None

Sets the provider for generating unique IDs.

funcsrc.google.adk.plugins._reflect_retry_utils.resolve_scope_key(scope:TrackingScope, invocation_id:str | None) -> str

Returns the scope key for failure tracking.

funcsrc.google.adk.plugins.auto_tracing_helpers.tracer_will_record(tracer:trace_api.Tracer) -> bool

True iff ``tracer`` will record (not a NoOpTracer).

classsrc.google.adk.plugins.base_plugin.BasePlugin

Base class for creating plugins.

method

src.google.adk.plugins.base_plugin.BasePlugin.before_run_callback(*invocation_context:InvocationContext) -> Optional[types.Content]

Callback executed before the ADK runner runs.

methodsrc.google.adk.plugins.base_plugin.BasePlugin.close() -> None

Method executed when the runner is closed.

この情報について

掲載しているシグネチャは google/adk-python の公開ソースコードを Python の ast モジュールで静的解析し、引数名・デフォルト値・型注釈・戻り値型をそのまま抽出したものです。実装コードは保存していません。詳しくは仕組みの解説をご覧ください。

収録ライブラリ一覧（全 805 件）へ戻る