Submodules

google.adk.a2a module

google.adk.agents module

google.adk.agents.Agent

alias of LlmAgent

pydantic model google.adk.agents.BaseAgent

Bases: BaseModel

Base class for all agents in Agent Development Kit.

Show JSON schema

{
   "$defs": {
      "BaseAgent": {
         "additionalProperties": false,
         "description": "Base class for all agents in Agent Development Kit.",
         "properties": {
            "name": {
               "title": "Name",
               "type": "string"
            },
            "description": {
               "default": "",
               "title": "Description",
               "type": "string"
            },
            "parent_agent": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/BaseAgent"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "sub_agents": {
               "items": {
                  "$ref": "#/$defs/BaseAgent"
               },
               "title": "Sub Agents",
               "type": "array"
            },
            "before_agent_callback": {
               "default": null,
               "title": "Before Agent Callback",
               "type": "null"
            },
            "after_agent_callback": {
               "default": null,
               "title": "After Agent Callback",
               "type": "null"
            }
         },
         "required": [
            "name"
         ],
         "title": "BaseAgent",
         "type": "object"
      }
   },
   "$ref": "#/$defs/BaseAgent"
}

Fields:

• after_agent_callback (Callable[[google.adk.agents.callback_context.CallbackContext], Awaitable[google.genai.types.Content | None] | google.genai.types.Content | None] | list[Callable[[google.adk.agents.callback_context.CallbackContext], Awaitable[google.genai.types.Content | None] | google.genai.types.Content | None]] | None)

• before_agent_callback (Callable[[google.adk.agents.callback_context.CallbackContext], Awaitable[google.genai.types.Content | None] | google.genai.types.Content | None] | list[Callable[[google.adk.agents.callback_context.CallbackContext], Awaitable[google.genai.types.Content | None] | google.genai.types.Content | None]] | None)

• description (str)

• name (str)

• parent_agent (google.adk.agents.base_agent.BaseAgent | None)

• sub_agents (list[google.adk.agents.base_agent.BaseAgent])

Validators:

• validate_name » name

field after_agent_callback: Optional[AfterAgentCallback] = None

Callback or list of callbacks to be invoked after the agent run.

When a list of callbacks is provided, the callbacks will be called in the order they are listed until a callback does not return None.

Parameters:

callback_context – MUST be named ‘callback_context’ (enforced).

Returns:

The content to return to the user.

When the content is present, an additional event with the provided content will be appended to event history as an additional agent response.

Return type:

Optional[types.Content]

field before_agent_callback: Optional[BeforeAgentCallback] = None

Callback or list of callbacks to be invoked before the agent run.

When a list of callbacks is provided, the callbacks will be called in the order they are listed until a callback does not return None.

Parameters:

callback_context – MUST be named ‘callback_context’ (enforced).

Returns:

The content to return to the user.

When the content is present, the agent run will be skipped and the provided content will be returned to user.

Return type:

Optional[types.Content]

field description: str = ''

Description about the agent’s capability.

The model uses this to determine whether to delegate control to the agent. One-line description is enough and preferred.

field name: str [Required]

The agent’s name.

Agent name must be a Python identifier and unique within the agent tree. Agent name cannot be “user”, since it’s reserved for end-user’s input.

Validated by:

• validate_name

field parent_agent: Optional[BaseAgent] = None

The parent agent of this agent.

Note that an agent can ONLY be added as sub-agent once.

If you want to add one agent twice as sub-agent, consider to create two agent instances with identical config, but with different name and add them to the agent tree.

field sub_agents: list[BaseAgent] [Optional]

The sub-agents of this agent.

config_type

alias of BaseAgentConfig

classmethod from_config(cls, config, config_abs_path)

Creates an agent from a config.

If sub-classes uses a custom agent config, override _from_config_kwargs method to return an updated kwargs for agent constructor.

Return type:

TypeVar(SelfAgent, bound= BaseAgent)

Parameters:

• config – The config to create the agent from.

• config_abs_path – The absolute path to the config file that contains the agent config.

Returns:

The created agent.

validator validate_name  »  name

clone(update=None)

Creates a copy of this agent instance.

Return type:

TypeVar(SelfAgent, bound= BaseAgent)

Parameters:

update – Optional mapping of new values for the fields of the cloned agent. The keys of the mapping are the names of the fields to be updated, and the values are the new values for those fields. For example: {“name”: “cloned_agent”}

Returns:

A new agent instance with identical configuration as the original agent except for the fields specified in the update.

find_agent(name)

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

Return type:

Optional[BaseAgent]

Parameters:

name – The name of the agent to find.

Returns:

The agent with the matching name, or None if no such agent is found.

find_sub_agent(name)

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

Return type:

Optional[BaseAgent]

Parameters:

name – The name of the agent to find.

Returns:

The agent with the matching name, or None if no such agent is found.

model_post_init(_BaseAgent__context)

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:

None

async run_async(parent_context)

Entry method to run an agent via text-based conversation.

Return type:

AsyncGenerator[Event, None]

Parameters:

parent_context – InvocationContext, the invocation context of the parent agent.

Yields:

Event – the events generated by the agent.

async run_live(parent_context)

Entry method to run an agent via video/audio-based conversation.

Return type:

AsyncGenerator[Event, None]

Parameters:

parent_context – InvocationContext, the invocation context of the parent agent.

Yields:

Event – the events generated by the agent.

property canonical_after_agent_callbacks: list[Callable[[CallbackContext], Awaitable[Content | None] | Content | None]]

The resolved self.after_agent_callback field as a list of _SingleAgentCallback.

This method is only for use by Agent Development Kit.

property canonical_before_agent_callbacks: list[Callable[[CallbackContext], Awaitable[Content | None] | Content | None]]

The resolved self.before_agent_callback field as a list of _SingleAgentCallback.

This method is only for use by Agent Development Kit.

property root_agent: BaseAgent

Gets the root agent of this agent.

pydantic model google.adk.agents.InvocationContext

Bases: BaseModel

An invocation context represents the data of a single invocation of an agent.

An invocation:

1. Starts with a user message and ends with a final response.

2. Can contain one or multiple agent calls.

3. Is handled by runner.run_async().

An invocation runs an agent until it does not request to transfer to another agent.

An agent call:

1. Is handled by agent.run().

2. Ends when agent.run() ends.

An LLM agent call is an agent with a BaseLLMFlow. An LLM agent call can contain one or multiple steps.

An LLM agent runs steps in a loop until:

1. A final response is generated.

2. The agent transfers to another agent.

3. The end_invocation is set to true by any callbacks or tools.

A step:

1. Calls the LLM only once and yields its response.

2. Calls the tools and yields their responses if requested.

The summarization of the function response is considered another step, since it is another llm call. A step ends when it’s done calling llm and tools, or if the end_invocation is set to true at any time.

```

┌─────────────────────── invocation ──────────────────────────┐ ┌──────────── llm_agent_call_1 ────────────┐ ┌─ agent_call_2 ─┐ ┌──── step_1 ────────┐ ┌───── step_2 ──────┐ [call_llm] [call_tool] [call_llm] [transfer]

```

Show JSON schema

{
   "title": "InvocationContext",
   "type": "object",
   "properties": {
      "artifact_service": {
         "default": null,
         "title": "Artifact Service"
      },
      "session_service": {
         "default": null,
         "title": "Session Service"
      },
      "memory_service": {
         "default": null,
         "title": "Memory Service"
      },
      "credential_service": {
         "default": null,
         "title": "Credential Service"
      },
      "context_cache_config": {
         "anyOf": [
            {
               "$ref": "#/$defs/ContextCacheConfig"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "invocation_id": {
         "title": "Invocation Id",
         "type": "string"
      },
      "branch": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Branch"
      },
      "agent": {
         "$ref": "#/$defs/BaseAgent"
      },
      "user_content": {
         "anyOf": [
            {
               "$ref": "#/$defs/Content"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "session": {
         "$ref": "#/$defs/Session"
      },
      "agent_states": {
         "additionalProperties": {
            "additionalProperties": true,
            "type": "object"
         },
         "title": "Agent States",
         "type": "object"
      },
      "end_of_agents": {
         "additionalProperties": {
            "type": "boolean"
         },
         "title": "End Of Agents",
         "type": "object"
      },
      "end_invocation": {
         "default": false,
         "title": "End Invocation",
         "type": "boolean"
      },
      "live_request_queue": {
         "default": null,
         "title": "Live Request Queue"
      },
      "active_streaming_tools": {
         "default": null,
         "title": "Active Streaming Tools"
      },
      "transcription_cache": {
         "anyOf": [
            {
               "items": {
                  "$ref": "#/$defs/TranscriptionEntry"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Transcription Cache"
      },
      "live_session_resumption_handle": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Live Session Resumption Handle"
      },
      "input_realtime_cache": {
         "anyOf": [
            {
               "items": {
                  "$ref": "#/$defs/RealtimeCacheEntry"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Input Realtime Cache"
      },
      "output_realtime_cache": {
         "anyOf": [
            {
               "items": {
                  "$ref": "#/$defs/RealtimeCacheEntry"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Output Realtime Cache"
      },
      "run_config": {
         "anyOf": [
            {
               "$ref": "#/$defs/RunConfig"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "resumability_config": {
         "anyOf": [
            {
               "$ref": "#/$defs/ResumabilityConfig"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "plugin_manager": {
         "default": null,
         "title": "Plugin Manager"
      },
      "canonical_tools_cache": {
         "default": null,
         "title": "Canonical Tools Cache"
      }
   },
   "$defs": {
      "APIKey": {
         "additionalProperties": true,
         "properties": {
            "type": {
               "$ref": "#/$defs/SecuritySchemeType",
               "default": "apiKey"
            },
            "description": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Description"
            },
            "in": {
               "$ref": "#/$defs/APIKeyIn"
            },
            "name": {
               "title": "Name",
               "type": "string"
            }
         },
         "required": [
            "in",
            "name"
         ],
         "title": "APIKey",
         "type": "object"
      },
      "APIKeyIn": {
         "enum": [
            "query",
            "header",
            "cookie"
         ],
         "title": "APIKeyIn",
         "type": "string"
      },
      "ActivityHandling": {
         "description": "The different ways of handling user activity.",
         "enum": [
            "ACTIVITY_HANDLING_UNSPECIFIED",
            "START_OF_ACTIVITY_INTERRUPTS",
            "NO_INTERRUPTION"
         ],
         "title": "ActivityHandling",
         "type": "string"
      },
      "AudioTranscriptionConfig": {
         "additionalProperties": false,
         "description": "The audio transcription configuration in Setup.",
         "properties": {},
         "title": "AudioTranscriptionConfig",
         "type": "object"
      },
      "AuthConfig": {
         "additionalProperties": true,
         "description": "The auth config sent by tool asking client to collect auth credentials and\n\nadk and client will help to fill in the response",
         "properties": {
            "authScheme": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/APIKey"
                  },
                  {
                     "$ref": "#/$defs/HTTPBase"
                  },
                  {
                     "$ref": "#/$defs/OAuth2"
                  },
                  {
                     "$ref": "#/$defs/OpenIdConnect"
                  },
                  {
                     "$ref": "#/$defs/HTTPBearer"
                  },
                  {
                     "$ref": "#/$defs/OpenIdConnectWithConfig"
                  }
               ],
               "title": "Authscheme"
            },
            "rawAuthCredential": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/AuthCredential"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "exchangedAuthCredential": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/AuthCredential"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "credentialKey": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Credentialkey"
            }
         },
         "required": [
            "authScheme"
         ],
         "title": "AuthConfig",
         "type": "object"
      },
      "AuthCredential": {
         "additionalProperties": true,
         "description": "Data class representing an authentication credential.\n\nTo exchange for the actual credential, please use\nCredentialExchanger.exchange_credential().\n\nExamples: API Key Auth\nAuthCredential(\n    auth_type=AuthCredentialTypes.API_KEY,\n    api_key=\"1234\",\n)\n\nExample: HTTP Auth\nAuthCredential(\n    auth_type=AuthCredentialTypes.HTTP,\n    http=HttpAuth(\n        scheme=\"basic\",\n        credentials=HttpCredentials(username=\"user\", password=\"password\"),\n    ),\n)\n\nExample: OAuth2 Bearer Token in HTTP Header\nAuthCredential(\n    auth_type=AuthCredentialTypes.HTTP,\n    http=HttpAuth(\n        scheme=\"bearer\",\n        credentials=HttpCredentials(token=\"eyAkaknabna....\"),\n    ),\n)\n\nExample: OAuth2 Auth with Authorization Code Flow\nAuthCredential(\n    auth_type=AuthCredentialTypes.OAUTH2,\n    oauth2=OAuth2Auth(\n        client_id=\"1234\",\n        client_secret=\"secret\",\n    ),\n)\n\nExample: OpenID Connect Auth\nAuthCredential(\n    auth_type=AuthCredentialTypes.OPEN_ID_CONNECT,\n    oauth2=OAuth2Auth(\n        client_id=\"1234\",\n        client_secret=\"secret\",\n        redirect_uri=\"https://example.com\",\n        scopes=[\"scope1\", \"scope2\"],\n    ),\n)\n\nExample: Auth with resource reference\nAuthCredential(\n    auth_type=AuthCredentialTypes.API_KEY,\n    resource_ref=\"projects/1234/locations/us-central1/resources/resource1\",\n)",
         "properties": {
            "authType": {
               "$ref": "#/$defs/AuthCredentialTypes"
            },
            "resourceRef": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Resourceref"
            },
            "apiKey": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Apikey"
            },
            "http": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/HttpAuth"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "serviceAccount": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/ServiceAccount"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "oauth2": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/OAuth2Auth"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            }
         },
         "required": [
            "authType"
         ],
         "title": "AuthCredential",
         "type": "object"
      },
      "AuthCredentialTypes": {
         "description": "Represents the type of authentication credential.",
         "enum": [
            "apiKey",
            "http",
            "oauth2",
            "openIdConnect",
            "serviceAccount"
         ],
         "title": "AuthCredentialTypes",
         "type": "string"
      },
      "AutomaticActivityDetection": {
         "additionalProperties": false,
         "description": "Configures automatic detection of activity.",
         "properties": {
            "disabled": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "If enabled, detected voice and text input count as activity. If disabled, the client must send activity signals.",
               "title": "Disabled"
            },
            "startOfSpeechSensitivity": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/StartSensitivity"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Determines how likely speech is to be detected."
            },
            "endOfSpeechSensitivity": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/EndSensitivity"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Determines how likely detected speech is ended."
            },
            "prefixPaddingMs": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The required duration of detected speech before start-of-speech is committed. The lower this value the more sensitive the start-of-speech detection is and the shorter speech can be recognized. However, this also increases the probability of false positives.",
               "title": "Prefixpaddingms"
            },
            "silenceDurationMs": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The required duration of detected non-speech (e.g. silence) before end-of-speech is committed. The larger this value, the longer speech gaps can be without interrupting the user's activity but this will increase the model's latency.",
               "title": "Silencedurationms"
            }
         },
         "title": "AutomaticActivityDetection",
         "type": "object"
      },
      "BaseAgent": {
         "additionalProperties": false,
         "description": "Base class for all agents in Agent Development Kit.",
         "properties": {
            "name": {
               "title": "Name",
               "type": "string"
            },
            "description": {
               "default": "",
               "title": "Description",
               "type": "string"
            },
            "parent_agent": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/BaseAgent"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "sub_agents": {
               "items": {
                  "$ref": "#/$defs/BaseAgent"
               },
               "title": "Sub Agents",
               "type": "array"
            },
            "before_agent_callback": {
               "default": null,
               "title": "Before Agent Callback",
               "type": "null"
            },
            "after_agent_callback": {
               "default": null,
               "title": "After Agent Callback",
               "type": "null"
            }
         },
         "required": [
            "name"
         ],
         "title": "BaseAgent",
         "type": "object"
      },
      "Blob": {
         "additionalProperties": false,
         "description": "Content blob.",
         "properties": {
            "displayName": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is not currently used in the Gemini GenerateContent calls.",
               "title": "Displayname"
            },
            "data": {
               "anyOf": [
                  {
                     "format": "base64url",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. Raw bytes.",
               "title": "Data"
            },
            "mimeType": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. The IANA standard MIME type of the source data.",
               "title": "Mimetype"
            }
         },
         "title": "Blob",
         "type": "object"
      },
      "CacheMetadata": {
         "additionalProperties": false,
         "description": "Metadata for context cache associated with LLM responses.\n\nThis class stores cache identification, usage tracking, and lifecycle\ninformation for a particular cache instance. It can be in two states:\n\n1. Active cache state: cache_name is set, all fields populated\n2. Fingerprint-only state: cache_name is None, only fingerprint and\n   contents_count are set for prefix matching\n\nToken counts (cached and total) are available in the LlmResponse.usage_metadata\nand should be accessed from there to avoid duplication.\n\nAttributes:\n    cache_name: The full resource name of the cached content (e.g.,\n        'projects/123/locations/us-central1/cachedContents/456').\n        None when no active cache exists (fingerprint-only state).\n    expire_time: Unix timestamp when the cache expires. None when no\n        active cache exists.\n    fingerprint: Hash of cacheable contents (instruction + tools + contents).\n        Always present for prefix matching.\n    invocations_used: Number of invocations this cache has been used for.\n        None when no active cache exists.\n    contents_count: Number of contents. When active cache exists, this is\n        the count of cached contents. When no active cache exists, this is\n        the total count of contents in the request.\n    created_at: Unix timestamp when the cache was created. None when\n        no active cache exists.",
         "properties": {
            "cache_name": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Full resource name of the cached content (None if no active cache)",
               "title": "Cache Name"
            },
            "expire_time": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Unix timestamp when cache expires (None if no active cache)",
               "title": "Expire Time"
            },
            "fingerprint": {
               "description": "Hash of cacheable contents used to detect changes",
               "title": "Fingerprint",
               "type": "string"
            },
            "invocations_used": {
               "anyOf": [
                  {
                     "minimum": 0,
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Number of invocations this cache has been used for (None if no active cache)",
               "title": "Invocations Used"
            },
            "contents_count": {
               "description": "Number of contents (cached contents when active cache exists, total contents in request when no active cache)",
               "minimum": 0,
               "title": "Contents Count",
               "type": "integer"
            },
            "created_at": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Unix timestamp when cache was created (None if no active cache)",
               "title": "Created At"
            }
         },
         "required": [
            "fingerprint",
            "contents_count"
         ],
         "title": "CacheMetadata",
         "type": "object"
      },
      "Citation": {
         "additionalProperties": false,
         "description": "Source attributions for content.",
         "properties": {
            "endIndex": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Output only. End index into the content.",
               "title": "Endindex"
            },
            "license": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Output only. License of the attribution.",
               "title": "License"
            },
            "publicationDate": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/GoogleTypeDate"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Output only. Publication date of the attribution."
            },
            "startIndex": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Output only. Start index into the content.",
               "title": "Startindex"
            },
            "title": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Output only. Title of the attribution.",
               "title": "Title"
            },
            "uri": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Output only. Url reference of the attribution.",
               "title": "Uri"
            }
         },
         "title": "Citation",
         "type": "object"
      },
      "CitationMetadata": {
         "additionalProperties": false,
         "description": "Citation information when the model quotes another source.",
         "properties": {
            "citations": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/Citation"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Contains citation information when the model directly quotes, at\n      length, from another source. Can include traditional websites and code\n      repositories.\n      ",
               "title": "Citations"
            }
         },
         "title": "CitationMetadata",
         "type": "object"
      },
      "CodeExecutionResult": {
         "additionalProperties": false,
         "description": "Result of executing the [ExecutableCode].\n\nOnly generated when using the [CodeExecution] tool, and always follows a\n`part` containing the [ExecutableCode].",
         "properties": {
            "outcome": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/Outcome"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. Outcome of the code execution."
            },
            "output": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Contains stdout when code execution is successful, stderr or other description otherwise.",
               "title": "Output"
            }
         },
         "title": "CodeExecutionResult",
         "type": "object"
      },
      "Content": {
         "additionalProperties": false,
         "description": "Contains the multi-part content of a message.",
         "properties": {
            "parts": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/Part"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "List of parts that constitute a single message. Each part may have\n      a different IANA MIME type.",
               "title": "Parts"
            },
            "role": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. The producer of the content. Must be either 'user' or\n      'model'. Useful to set for multi-turn conversations, otherwise can be\n      empty. If role is not specified, SDK will determine the role.",
               "title": "Role"
            }
         },
         "title": "Content",
         "type": "object"
      },
      "ContextCacheConfig": {
         "additionalProperties": false,
         "description": "Configuration for context caching across all agents in an app.\n\nThis configuration enables and controls context caching behavior for\nall LLM agents in an app. When this config is present on an app, context\ncaching is enabled for all agents. When absent (None), context caching\nis disabled.\n\nContext caching can significantly reduce costs and improve response times\nby reusing previously processed context across multiple requests.\n\nAttributes:\n    cache_intervals: Maximum number of invocations to reuse the same cache before refreshing it\n    ttl_seconds: Time-to-live for cache in seconds\n    min_tokens: Minimum tokens required to enable caching",
         "properties": {
            "cache_intervals": {
               "default": 10,
               "description": "Maximum number of invocations to reuse the same cache before refreshing it",
               "maximum": 100,
               "minimum": 1,
               "title": "Cache Intervals",
               "type": "integer"
            },
            "ttl_seconds": {
               "default": 1800,
               "description": "Time-to-live for cache in seconds",
               "exclusiveMinimum": 0,
               "title": "Ttl Seconds",
               "type": "integer"
            },
            "min_tokens": {
               "default": 0,
               "description": "Minimum estimated request tokens required to enable caching. This compares against the estimated total tokens of the request (system instruction + tools + contents). Context cache storage may have cost. Set higher to avoid caching small requests where overhead may exceed benefits.",
               "minimum": 0,
               "title": "Min Tokens",
               "type": "integer"
            }
         },
         "title": "ContextCacheConfig",
         "type": "object"
      },
      "ContextWindowCompressionConfig": {
         "additionalProperties": false,
         "description": "Enables context window compression -- mechanism managing model context window so it does not exceed given length.",
         "properties": {
            "triggerTokens": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Number of tokens (before running turn) that triggers context window compression mechanism.",
               "title": "Triggertokens"
            },
            "slidingWindow": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/SlidingWindow"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Sliding window compression mechanism."
            }
         },
         "title": "ContextWindowCompressionConfig",
         "type": "object"
      },
      "EndSensitivity": {
         "description": "End of speech sensitivity.",
         "enum": [
            "END_SENSITIVITY_UNSPECIFIED",
            "END_SENSITIVITY_HIGH",
            "END_SENSITIVITY_LOW"
         ],
         "title": "EndSensitivity",
         "type": "string"
      },
      "Event": {
         "additionalProperties": false,
         "description": "Represents an event in a conversation between agents and users.\n\nIt is used to store the content of the conversation, as well as the actions\ntaken by the agents like function calls, etc.",
         "properties": {
            "modelVersion": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Modelversion"
            },
            "content": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/Content"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "groundingMetadata": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/GroundingMetadata"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "partial": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Partial"
            },
            "turnComplete": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Turncomplete"
            },
            "finishReason": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/FinishReason"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "errorCode": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Errorcode"
            },
            "errorMessage": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Errormessage"
            },
            "interrupted": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Interrupted"
            },
            "customMetadata": {
               "anyOf": [
                  {
                     "additionalProperties": true,
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Custommetadata"
            },
            "usageMetadata": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/GenerateContentResponseUsageMetadata"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "liveSessionResumptionUpdate": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/LiveServerSessionResumptionUpdate"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "inputTranscription": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/Transcription"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "outputTranscription": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/Transcription"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "avgLogprobs": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Avglogprobs"
            },
            "logprobsResult": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/LogprobsResult"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "cacheMetadata": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/CacheMetadata"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "citationMetadata": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/CitationMetadata"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "invocationId": {
               "default": "",
               "title": "Invocationid",
               "type": "string"
            },
            "author": {
               "title": "Author",
               "type": "string"
            },
            "actions": {
               "$ref": "#/$defs/EventActions"
            },
            "longRunningToolIds": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array",
                     "uniqueItems": true
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Longrunningtoolids"
            },
            "branch": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Branch"
            },
            "id": {
               "default": "",
               "title": "Id",
               "type": "string"
            },
            "timestamp": {
               "title": "Timestamp",
               "type": "number"
            }
         },
         "required": [
            "author"
         ],
         "title": "Event",
         "type": "object"
      },
      "EventActions": {
         "additionalProperties": false,
         "description": "Represents the actions attached to an event.",
         "properties": {
            "skipSummarization": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Skipsummarization"
            },
            "stateDelta": {
               "additionalProperties": true,
               "title": "Statedelta",
               "type": "object"
            },
            "artifactDelta": {
               "additionalProperties": {
                  "type": "integer"
               },
               "title": "Artifactdelta",
               "type": "object"
            },
            "transferToAgent": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Transfertoagent"
            },
            "escalate": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Escalate"
            },
            "requestedAuthConfigs": {
               "additionalProperties": {
                  "$ref": "#/$defs/AuthConfig"
               },
               "title": "Requestedauthconfigs",
               "type": "object"
            },
            "requestedToolConfirmations": {
               "additionalProperties": {
                  "$ref": "#/$defs/ToolConfirmation"
               },
               "title": "Requestedtoolconfirmations",
               "type": "object"
            },
            "compaction": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/EventCompaction"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "endOfAgent": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Endofagent"
            },
            "agentState": {
               "anyOf": [
                  {
                     "additionalProperties": true,
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Agentstate"
            },
            "rewindBeforeInvocationId": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Rewindbeforeinvocationid"
            }
         },
         "title": "EventActions",
         "type": "object"
      },
      "EventCompaction": {
         "additionalProperties": false,
         "description": "The compaction of the events.",
         "properties": {
            "startTimestamp": {
               "title": "Starttimestamp",
               "type": "number"
            },
            "endTimestamp": {
               "title": "Endtimestamp",
               "type": "number"
            },
            "compactedContent": {
               "$ref": "#/$defs/Content"
            }
         },
         "required": [
            "startTimestamp",
            "endTimestamp",
            "compactedContent"
         ],
         "title": "EventCompaction",
         "type": "object"
      },
      "ExecutableCode": {
         "additionalProperties": false,
         "description": "Code generated by the model that is meant to be executed, and the result returned to the model.\n\nGenerated when using the [CodeExecution] tool, in which the code will be\nautomatically executed, and a corresponding [CodeExecutionResult] will also be\ngenerated.",
         "properties": {
            "code": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. The code to be executed.",
               "title": "Code"
            },
            "language": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/Language"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. Programming language of the `code`."
            }
         },
         "title": "ExecutableCode",
         "type": "object"
      },
      "FileData": {
         "additionalProperties": false,
         "description": "URI based data.",
         "properties": {
            "displayName": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. It is not currently used in the Gemini GenerateContent calls.",
               "title": "Displayname"
            },
            "fileUri": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. URI.",
               "title": "Fileuri"
            },
            "mimeType": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. The IANA standard MIME type of the source data.",
               "title": "Mimetype"
            }
         },
         "title": "FileData",
         "type": "object"
      },
      "FinishReason": {
         "description": "Output only. The reason why the model stopped generating tokens.\n\nIf empty, the model has not stopped generating the tokens.",
         "enum": [
            "FINISH_REASON_UNSPECIFIED",
            "STOP",
            "MAX_TOKENS",
            "SAFETY",
            "RECITATION",
            "LANGUAGE",
            "OTHER",
            "BLOCKLIST",
            "PROHIBITED_CONTENT",
            "SPII",
            "MALFORMED_FUNCTION_CALL",
            "IMAGE_SAFETY",
            "UNEXPECTED_TOOL_CALL",
            "IMAGE_PROHIBITED_CONTENT",
            "NO_IMAGE"
         ],
         "title": "FinishReason",
         "type": "string"
      },
      "FunctionCall": {
         "additionalProperties": false,
         "description": "A function call.",
         "properties": {
            "id": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The unique id of the function call. If populated, the client to execute the\n   `function_call` and return the response with the matching `id`.",
               "title": "Id"
            },
            "args": {
               "anyOf": [
                  {
                     "additionalProperties": true,
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.",
               "title": "Args"
            },
            "name": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. The name of the function to call. Matches [FunctionDeclaration.name].",
               "title": "Name"
            }
         },
         "title": "FunctionCall",
         "type": "object"
      },
      "FunctionResponse": {
         "additionalProperties": false,
         "description": "A function response.",
         "properties": {
            "willContinue": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Signals that function call continues, and more responses will be returned, turning the function call into a generator. Is only applicable to NON_BLOCKING function calls (see FunctionDeclaration.behavior for details), ignored otherwise. If false, the default, future responses will not be considered. Is only applicable to NON_BLOCKING function calls, is ignored otherwise. If set to false, future responses will not be considered. It is allowed to return empty `response` with `will_continue=False` to signal that the function call is finished.",
               "title": "Willcontinue"
            },
            "scheduling": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/FunctionResponseScheduling"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE."
            },
            "parts": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/FunctionResponsePart"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "List of parts that constitute a function response. Each part may\n      have a different IANA MIME type.",
               "title": "Parts"
            },
            "id": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`.",
               "title": "Id"
            },
            "name": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].",
               "title": "Name"
            },
            "response": {
               "anyOf": [
                  {
                     "additionalProperties": true,
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. The function response in JSON object format. Use \"output\" key to specify function output and \"error\" key to specify error details (if any). If \"output\" and \"error\" keys are not specified, then whole \"response\" is treated as function output.",
               "title": "Response"
            }
         },
         "title": "FunctionResponse",
         "type": "object"
      },
      "FunctionResponseBlob": {
         "additionalProperties": false,
         "description": "Raw media bytes for function response.\n\nText should not be sent as raw bytes, use the FunctionResponse.response\nfield.",
         "properties": {
            "mimeType": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. The IANA standard MIME type of the source data.",
               "title": "Mimetype"
            },
            "data": {
               "anyOf": [
                  {
                     "format": "base64url",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. Inline media bytes.",
               "title": "Data"
            }
         },
         "title": "FunctionResponseBlob",
         "type": "object"
      },
      "FunctionResponseFileData": {
         "additionalProperties": false,
         "description": "URI based data for function response.",
         "properties": {
            "fileUri": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. URI.",
               "title": "Fileuri"
            },
            "mimeType": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. The IANA standard MIME type of the source data.",
               "title": "Mimetype"
            }
         },
         "title": "FunctionResponseFileData",
         "type": "object"
      },
      "FunctionResponsePart": {
         "additionalProperties": false,
         "description": "A datatype containing media that is part of a `FunctionResponse` message.\n\nA `FunctionResponsePart` consists of data which has an associated datatype. A\n`FunctionResponsePart` can only contain one of the accepted types in\n`FunctionResponsePart.data`.\n\nA `FunctionResponsePart` must have a fixed IANA MIME type identifying the\ntype and subtype of the media if the `inline_data` field is filled with raw\nbytes.",
         "properties": {
            "inlineData": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/FunctionResponseBlob"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Inline media bytes."
            },
            "fileData": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/FunctionResponseFileData"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. URI based data."
            }
         },
         "title": "FunctionResponsePart",
         "type": "object"
      },
      "FunctionResponseScheduling": {
         "description": "Specifies how the response should be scheduled in the conversation.",
         "enum": [
            "SCHEDULING_UNSPECIFIED",
            "SILENT",
            "WHEN_IDLE",
            "INTERRUPT"
         ],
         "title": "FunctionResponseScheduling",
         "type": "string"
      },
      "GenerateContentResponseUsageMetadata": {
         "additionalProperties": false,
         "description": "Usage metadata about response(s).",
         "properties": {
            "cacheTokensDetails": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/ModalityTokenCount"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Output only. List of modalities of the cached content in the request input.",
               "title": "Cachetokensdetails"
            },
            "cachedContentTokenCount": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Output only. Number of tokens in the cached part in the input (the cached content).",
               "title": "Cachedcontenttokencount"
            },
            "candidatesTokenCount": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Number of tokens in the response(s).",
               "title": "Candidatestokencount"
            },
            "candidatesTokensDetails": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/ModalityTokenCount"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Output only. List of modalities that were returned in the response.",
               "title": "Candidatestokensdetails"
            },
            "promptTokenCount": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Number of tokens in the request. When `cached_content` is set, this is still the total effective prompt size meaning this includes the number of tokens in the cached content.",
               "title": "Prompttokencount"
            },
            "promptTokensDetails": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/ModalityTokenCount"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Output only. List of modalities that were processed in the request input.",
               "title": "Prompttokensdetails"
            },
            "thoughtsTokenCount": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Output only. Number of tokens present in thoughts output.",
               "title": "Thoughtstokencount"
            },
            "toolUsePromptTokenCount": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Output only. Number of tokens present in tool-use prompt(s).",
               "title": "Tooluseprompttokencount"
            },
            "toolUsePromptTokensDetails": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/ModalityTokenCount"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Output only. List of modalities that were processed for tool-use request inputs.",
               "title": "Tooluseprompttokensdetails"
            },
            "totalTokenCount": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Total token count for prompt, response candidates, and tool-use prompts (if present).",
               "title": "Totaltokencount"
            },
            "trafficType": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/TrafficType"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Output only. Traffic type. This shows whether a request consumes Pay-As-You-Go or Provisioned Throughput quota."
            }
         },
         "title": "GenerateContentResponseUsageMetadata",
         "type": "object"
      },
      "GoogleTypeDate": {
         "additionalProperties": false,
         "description": "Represents a whole or partial calendar date, such as a birthday.\n\nThe time of day and time zone are either specified elsewhere or are\ninsignificant. The date is relative to the Gregorian Calendar. This can\nrepresent one of the following: * A full date, with non-zero year, month, and\nday values. * A month and day, with a zero year (for example, an anniversary).\n* A year on its own, with a zero month and a zero day. * A year and month,\nwith a zero day (for example, a credit card expiration date). Related types: *\ngoogle.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp",
         "properties": {
            "day": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.",
               "title": "Day"
            },
            "month": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.",
               "title": "Month"
            },
            "year": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.",
               "title": "Year"
            }
         },
         "title": "GoogleTypeDate",
         "type": "object"
      },
      "GroundingChunk": {
         "additionalProperties": false,
         "description": "Grounding chunk.",
         "properties": {
            "maps": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/GroundingChunkMaps"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Grounding chunk from Google Maps."
            },
            "retrievedContext": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/GroundingChunkRetrievedContext"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Grounding chunk from context retrieved by the retrieval tools."
            },
            "web": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/GroundingChunkWeb"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Grounding chunk from the web."
            }
         },
         "title": "GroundingChunk",
         "type": "object"
      },
      "GroundingChunkMaps": {
         "additionalProperties": false,
         "description": "Chunk from Google Maps.",
         "properties": {
            "placeAnswerSources": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/GroundingChunkMapsPlaceAnswerSources"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Sources used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as uris to flag content."
            },
            "placeId": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "This Place's resource name, in `places/{place_id}` format. Can be used to look up the Place.",
               "title": "Placeid"
            },
            "text": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Text of the chunk.",
               "title": "Text"
            },
            "title": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Title of the chunk.",
               "title": "Title"
            },
            "uri": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "URI reference of the chunk.",
               "title": "Uri"
            }
         },
         "title": "GroundingChunkMaps",
         "type": "object"
      },
      "GroundingChunkMapsPlaceAnswerSources": {
         "additionalProperties": false,
         "description": "Sources used to generate the place answer.",
         "properties": {
            "flagContentUri": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "A link where users can flag a problem with the generated answer.",
               "title": "Flagcontenturi"
            },
            "reviewSnippets": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/GroundingChunkMapsPlaceAnswerSourcesReviewSnippet"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Snippets of reviews that are used to generate the answer.",
               "title": "Reviewsnippets"
            }
         },
         "title": "GroundingChunkMapsPlaceAnswerSources",
         "type": "object"
      },
      "GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution": {
         "additionalProperties": false,
         "description": "Author attribution for a photo or review.",
         "properties": {
            "displayName": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Name of the author of the Photo or Review.",
               "title": "Displayname"
            },
            "photoUri": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Profile photo URI of the author of the Photo or Review.",
               "title": "Photouri"
            },
            "uri": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "URI of the author of the Photo or Review.",
               "title": "Uri"
            }
         },
         "title": "GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution",
         "type": "object"
      },
      "GroundingChunkMapsPlaceAnswerSourcesReviewSnippet": {
         "additionalProperties": false,
         "description": "Encapsulates a review snippet.",
         "properties": {
            "authorAttribution": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "This review's author."
            },
            "flagContentUri": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "A link where users can flag a problem with the review.",
               "title": "Flagcontenturi"
            },
            "googleMapsUri": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "A link to show the review on Google Maps.",
               "title": "Googlemapsuri"
            },
            "relativePublishTimeDescription": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "A string of formatted recent time, expressing the review time relative to the current time in a form appropriate for the language and country.",
               "title": "Relativepublishtimedescription"
            },
            "review": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "A reference representing this place review which may be used to look up this place review again.",
               "title": "Review"
            },
            "reviewId": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Id of the review referencing the place.",
               "title": "Reviewid"
            },
            "title": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Title of the review.",
               "title": "Title"
            }
         },
         "title": "GroundingChunkMapsPlaceAnswerSourcesReviewSnippet",
         "type": "object"
      },
      "GroundingChunkRetrievedContext": {
         "additionalProperties": false,
         "description": "Chunk from context retrieved by the retrieval tools.",
         "properties": {
            "documentName": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Output only. The full document name for the referenced Vertex AI Search document.",
               "title": "Documentname"
            },
            "ragChunk": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/RagChunk"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Additional context for the RAG retrieval result. This is only populated when using the RAG retrieval tool."
            },
            "text": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Text of the attribution.",
               "title": "Text"
            },
            "title": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Title of the attribution.",
               "title": "Title"
            },
            "uri": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "URI reference of the attribution.",
               "title": "Uri"
            }
         },
         "title": "GroundingChunkRetrievedContext",
         "type": "object"
      },
      "GroundingChunkWeb": {
         "additionalProperties": false,
         "description": "Chunk from the web.",
         "properties": {
            "domain": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Domain of the (original) URI.",
               "title": "Domain"
            },
            "title": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Title of the chunk.",
               "title": "Title"
            },
            "uri": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "URI reference of the chunk.",
               "title": "Uri"
            }
         },
         "title": "GroundingChunkWeb",
         "type": "object"
      },
      "GroundingMetadata": {
         "additionalProperties": false,
         "description": "Metadata returned to client when grounding is enabled.",
         "properties": {
            "googleMapsWidgetContextToken": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Output only. Resource name of the Google Maps widget context token to be used with the PlacesContextElement widget to render contextual data. This is populated only for Google Maps grounding.",
               "title": "Googlemapswidgetcontexttoken"
            },
            "groundingChunks": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/GroundingChunk"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "List of supporting references retrieved from specified grounding source.",
               "title": "Groundingchunks"
            },
            "groundingSupports": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/GroundingSupport"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. List of grounding support.",
               "title": "Groundingsupports"
            },
            "retrievalMetadata": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/RetrievalMetadata"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Output only. Retrieval metadata."
            },
            "retrievalQueries": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Queries executed by the retrieval tools.",
               "title": "Retrievalqueries"
            },
            "searchEntryPoint": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/SearchEntryPoint"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Google search entry for the following-up web searches."
            },
            "sourceFlaggingUris": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/GroundingMetadataSourceFlaggingUri"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Output only. List of source flagging uris. This is currently populated only for Google Maps grounding.",
               "title": "Sourceflagginguris"
            },
            "webSearchQueries": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Web search queries for the following-up web search.",
               "title": "Websearchqueries"
            }
         },
         "title": "GroundingMetadata",
         "type": "object"
      },
      "GroundingMetadataSourceFlaggingUri": {
         "additionalProperties": false,
         "description": "Source content flagging uri for a place or review.\n\nThis is currently populated only for Google Maps grounding.",
         "properties": {
            "flagContentUri": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "A link where users can flag a problem with the source (place or review).",
               "title": "Flagcontenturi"
            },
            "sourceId": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Id of the place or review.",
               "title": "Sourceid"
            }
         },
         "title": "GroundingMetadataSourceFlaggingUri",
         "type": "object"
      },
      "GroundingSupport": {
         "additionalProperties": false,
         "description": "Grounding support.",
         "properties": {
            "confidenceScores": {
               "anyOf": [
                  {
                     "items": {
                        "type": "number"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Confidence score of the support references. Ranges from 0 to 1. 1 is the most confident. For Gemini 2.0 and before, this list must have the same size as the grounding_chunk_indices. For Gemini 2.5 and after, this list will be empty and should be ignored.",
               "title": "Confidencescores"
            },
            "groundingChunkIndices": {
               "anyOf": [
                  {
                     "items": {
                        "type": "integer"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "A list of indices (into 'grounding_chunk') specifying the citations associated with the claim. For instance [1,3,4] means that grounding_chunk[1], grounding_chunk[3], grounding_chunk[4] are the retrieved content attributed to the claim.",
               "title": "Groundingchunkindices"
            },
            "segment": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/Segment"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Segment of the content this support belongs to."
            }
         },
         "title": "GroundingSupport",
         "type": "object"
      },
      "HTTPBase": {
         "additionalProperties": true,
         "properties": {
            "type": {
               "$ref": "#/$defs/SecuritySchemeType",
               "default": "http"
            },
            "description": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Description"
            },
            "scheme": {
               "title": "Scheme",
               "type": "string"
            }
         },
         "required": [
            "scheme"
         ],
         "title": "HTTPBase",
         "type": "object"
      },
      "HTTPBearer": {
         "additionalProperties": true,
         "properties": {
            "type": {
               "$ref": "#/$defs/SecuritySchemeType",
               "default": "http"
            },
            "description": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Description"
            },
            "scheme": {
               "const": "bearer",
               "default": "bearer",
               "title": "Scheme",
               "type": "string"
            },
            "bearerFormat": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Bearerformat"
            }
         },
         "title": "HTTPBearer",
         "type": "object"
      },
      "HttpAuth": {
         "additionalProperties": true,
         "description": "The credentials and metadata for HTTP authentication.",
         "properties": {
            "scheme": {
               "title": "Scheme",
               "type": "string"
            },
            "credentials": {
               "$ref": "#/$defs/HttpCredentials"
            }
         },
         "required": [
            "scheme",
            "credentials"
         ],
         "title": "HttpAuth",
         "type": "object"
      },
      "HttpCredentials": {
         "additionalProperties": true,
         "description": "Represents the secret token value for HTTP authentication, like user name, password, oauth token, etc.",
         "properties": {
            "username": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Username"
            },
            "password": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Password"
            },
            "token": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Token"
            }
         },
         "title": "HttpCredentials",
         "type": "object"
      },
      "Language": {
         "description": "Required. Programming language of the `code`.",
         "enum": [
            "LANGUAGE_UNSPECIFIED",
            "PYTHON"
         ],
         "title": "Language",
         "type": "string"
      },
      "LiveServerSessionResumptionUpdate": {
         "additionalProperties": false,
         "description": "Update of the session resumption state.\n\nOnly sent if `session_resumption` was set in the connection config.",
         "properties": {
            "newHandle": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "New handle that represents state that can be resumed. Empty if `resumable`=false.",
               "title": "Newhandle"
            },
            "resumable": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "True if session can be resumed at this point. It might be not possible to resume session at some points. In that case we send update empty new_handle and resumable=false. Example of such case could be model executing function calls or just generating. Resuming session (using previous session token) in such state will result in some data loss.",
               "title": "Resumable"
            },
            "lastConsumedClientMessageIndex": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Index of last message sent by client that is included in state represented by this SessionResumptionToken. Only sent when `SessionResumptionConfig.transparent` is set.\n\nPresence of this index allows users to transparently reconnect and avoid issue of losing some part of realtime audio input/video. If client wishes to temporarily disconnect (for example as result of receiving GoAway) they can do it without losing state by buffering messages sent since last `SessionResmumptionTokenUpdate`. This field will enable them to limit buffering (avoid keeping all requests in RAM).\n\nNote: This should not be used for when resuming a session at some time later -- in those cases partial audio and video frames arelikely not needed.",
               "title": "Lastconsumedclientmessageindex"
            }
         },
         "title": "LiveServerSessionResumptionUpdate",
         "type": "object"
      },
      "LogprobsResult": {
         "additionalProperties": false,
         "description": "Logprobs Result",
         "properties": {
            "chosenCandidates": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/LogprobsResultCandidate"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Length = total number of decoding steps. The chosen candidates may or may not be in top_candidates.",
               "title": "Chosencandidates"
            },
            "topCandidates": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/LogprobsResultTopCandidates"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Length = total number of decoding steps.",
               "title": "Topcandidates"
            }
         },
         "title": "LogprobsResult",
         "type": "object"
      },
      "LogprobsResultCandidate": {
         "additionalProperties": false,
         "description": "Candidate for the logprobs token and score.",
         "properties": {
            "logProbability": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The candidate's log probability.",
               "title": "Logprobability"
            },
            "token": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The candidate's token string value.",
               "title": "Token"
            },
            "tokenId": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The candidate's token id value.",
               "title": "Tokenid"
            }
         },
         "title": "LogprobsResultCandidate",
         "type": "object"
      },
      "LogprobsResultTopCandidates": {
         "additionalProperties": false,
         "description": "Candidates with top log probabilities at each decoding step.",
         "properties": {
            "candidates": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/LogprobsResultCandidate"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Sorted by log probability in descending order.",
               "title": "Candidates"
            }
         },
         "title": "LogprobsResultTopCandidates",
         "type": "object"
      },
      "MediaModality": {
         "description": "Server content modalities.",
         "enum": [
            "MODALITY_UNSPECIFIED",
            "TEXT",
            "IMAGE",
            "VIDEO",
            "AUDIO",
            "DOCUMENT"
         ],
         "title": "MediaModality",
         "type": "string"
      },
      "ModalityTokenCount": {
         "additionalProperties": false,
         "description": "Represents token counting info for a single modality.",
         "properties": {
            "modality": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/MediaModality"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The modality associated with this token count."
            },
            "tokenCount": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Number of tokens.",
               "title": "Tokencount"
            }
         },
         "title": "ModalityTokenCount",
         "type": "object"
      },
      "MultiSpeakerVoiceConfig": {
         "additionalProperties": false,
         "description": "The configuration for the multi-speaker setup.",
         "properties": {
            "speakerVoiceConfigs": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/SpeakerVoiceConfig"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The configuration for the speaker to use.",
               "title": "Speakervoiceconfigs"
            }
         },
         "title": "MultiSpeakerVoiceConfig",
         "type": "object"
      },
      "OAuth2": {
         "additionalProperties": true,
         "properties": {
            "type": {
               "$ref": "#/$defs/SecuritySchemeType",
               "default": "oauth2"
            },
            "description": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Description"
            },
            "flows": {
               "$ref": "#/$defs/OAuthFlows"
            }
         },
         "required": [
            "flows"
         ],
         "title": "OAuth2",
         "type": "object"
      },
      "OAuth2Auth": {
         "additionalProperties": true,
         "description": "Represents credential value and its metadata for a OAuth2 credential.",
         "properties": {
            "clientId": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Clientid"
            },
            "clientSecret": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Clientsecret"
            },
            "authUri": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Authuri"
            },
            "state": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "State"
            },
            "redirectUri": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Redirecturi"
            },
            "authResponseUri": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Authresponseuri"
            },
            "authCode": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Authcode"
            },
            "accessToken": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Accesstoken"
            },
            "refreshToken": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Refreshtoken"
            },
            "expiresAt": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Expiresat"
            },
            "expiresIn": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Expiresin"
            },
            "audience": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Audience"
            }
         },
         "title": "OAuth2Auth",
         "type": "object"
      },
      "OAuthFlowAuthorizationCode": {
         "additionalProperties": true,
         "properties": {
            "refreshUrl": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Refreshurl"
            },
            "scopes": {
               "additionalProperties": {
                  "type": "string"
               },
               "default": {},
               "title": "Scopes",
               "type": "object"
            },
            "authorizationUrl": {
               "title": "Authorizationurl",
               "type": "string"
            },
            "tokenUrl": {
               "title": "Tokenurl",
               "type": "string"
            }
         },
         "required": [
            "authorizationUrl",
            "tokenUrl"
         ],
         "title": "OAuthFlowAuthorizationCode",
         "type": "object"
      },
      "OAuthFlowClientCredentials": {
         "additionalProperties": true,
         "properties": {
            "refreshUrl": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Refreshurl"
            },
            "scopes": {
               "additionalProperties": {
                  "type": "string"
               },
               "default": {},
               "title": "Scopes",
               "type": "object"
            },
            "tokenUrl": {
               "title": "Tokenurl",
               "type": "string"
            }
         },
         "required": [
            "tokenUrl"
         ],
         "title": "OAuthFlowClientCredentials",
         "type": "object"
      },
      "OAuthFlowImplicit": {
         "additionalProperties": true,
         "properties": {
            "refreshUrl": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Refreshurl"
            },
            "scopes": {
               "additionalProperties": {
                  "type": "string"
               },
               "default": {},
               "title": "Scopes",
               "type": "object"
            },
            "authorizationUrl": {
               "title": "Authorizationurl",
               "type": "string"
            }
         },
         "required": [
            "authorizationUrl"
         ],
         "title": "OAuthFlowImplicit",
         "type": "object"
      },
      "OAuthFlowPassword": {
         "additionalProperties": true,
         "properties": {
            "refreshUrl": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Refreshurl"
            },
            "scopes": {
               "additionalProperties": {
                  "type": "string"
               },
               "default": {},
               "title": "Scopes",
               "type": "object"
            },
            "tokenUrl": {
               "title": "Tokenurl",
               "type": "string"
            }
         },
         "required": [
            "tokenUrl"
         ],
         "title": "OAuthFlowPassword",
         "type": "object"
      },
      "OAuthFlows": {
         "additionalProperties": true,
         "properties": {
            "implicit": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/OAuthFlowImplicit"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "password": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/OAuthFlowPassword"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "clientCredentials": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/OAuthFlowClientCredentials"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "authorizationCode": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/OAuthFlowAuthorizationCode"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            }
         },
         "title": "OAuthFlows",
         "type": "object"
      },
      "OpenIdConnect": {
         "additionalProperties": true,
         "properties": {
            "type": {
               "$ref": "#/$defs/SecuritySchemeType",
               "default": "openIdConnect"
            },
            "description": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Description"
            },
            "openIdConnectUrl": {
               "title": "Openidconnecturl",
               "type": "string"
            }
         },
         "required": [
            "openIdConnectUrl"
         ],
         "title": "OpenIdConnect",
         "type": "object"
      },
      "OpenIdConnectWithConfig": {
         "additionalProperties": true,
         "properties": {
            "type": {
               "$ref": "#/$defs/SecuritySchemeType",
               "default": "openIdConnect"
            },
            "description": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Description"
            },
            "authorization_endpoint": {
               "title": "Authorization Endpoint",
               "type": "string"
            },
            "token_endpoint": {
               "title": "Token Endpoint",
               "type": "string"
            },
            "userinfo_endpoint": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Userinfo Endpoint"
            },
            "revocation_endpoint": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Revocation Endpoint"
            },
            "token_endpoint_auth_methods_supported": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Token Endpoint Auth Methods Supported"
            },
            "grant_types_supported": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Grant Types Supported"
            },
            "scopes": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Scopes"
            }
         },
         "required": [
            "authorization_endpoint",
            "token_endpoint"
         ],
         "title": "OpenIdConnectWithConfig",
         "type": "object"
      },
      "Outcome": {
         "description": "Required. Outcome of the code execution.",
         "enum": [
            "OUTCOME_UNSPECIFIED",
            "OUTCOME_OK",
            "OUTCOME_FAILED",
            "OUTCOME_DEADLINE_EXCEEDED"
         ],
         "title": "Outcome",
         "type": "string"
      },
      "Part": {
         "additionalProperties": false,
         "description": "A datatype containing media content.\n\nExactly one field within a Part should be set, representing the specific type\nof content being conveyed. Using multiple fields within the same `Part`\ninstance is considered invalid.",
         "properties": {
            "videoMetadata": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/VideoMetadata"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Metadata for a given video."
            },
            "thought": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Indicates if the part is thought from the model.",
               "title": "Thought"
            },
            "inlineData": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/Blob"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Inlined bytes data."
            },
            "fileData": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/FileData"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. URI based data."
            },
            "thoughtSignature": {
               "anyOf": [
                  {
                     "format": "base64url",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "An opaque signature for the thought so it can be reused in subsequent requests.",
               "title": "Thoughtsignature"
            },
            "functionCall": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/FunctionCall"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "A predicted [FunctionCall] returned from the model that contains a string\n      representing the [FunctionDeclaration.name] and a structured JSON object\n      containing the parameters and their values."
            },
            "codeExecutionResult": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/CodeExecutionResult"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Result of executing the [ExecutableCode]."
            },
            "executableCode": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/ExecutableCode"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Code generated by the model that is meant to be executed."
            },
            "functionResponse": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/FunctionResponse"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model."
            },
            "text": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Text part (can be code).",
               "title": "Text"
            }
         },
         "title": "Part",
         "type": "object"
      },
      "PrebuiltVoiceConfig": {
         "additionalProperties": false,
         "description": "The configuration for the prebuilt speaker to use.",
         "properties": {
            "voiceName": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The name of the prebuilt voice to use.",
               "title": "Voicename"
            }
         },
         "title": "PrebuiltVoiceConfig",
         "type": "object"
      },
      "ProactivityConfig": {
         "additionalProperties": false,
         "description": "Config for proactivity features.",
         "properties": {
            "proactiveAudio": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "If enabled, the model can reject responding to the last prompt. For\n        example, this allows the model to ignore out of context speech or to stay\n        silent if the user did not make a request, yet.",
               "title": "Proactiveaudio"
            }
         },
         "title": "ProactivityConfig",
         "type": "object"
      },
      "RagChunk": {
         "additionalProperties": false,
         "description": "A RagChunk includes the content of a chunk of a RagFile, and associated metadata.",
         "properties": {
            "pageSpan": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/RagChunkPageSpan"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "If populated, represents where the chunk starts and ends in the document."
            },
            "text": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The content of the chunk.",
               "title": "Text"
            }
         },
         "title": "RagChunk",
         "type": "object"
      },
      "RagChunkPageSpan": {
         "additionalProperties": false,
         "description": "Represents where the chunk starts and ends in the document.",
         "properties": {
            "firstPage": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Page where chunk starts in the document. Inclusive. 1-indexed.",
               "title": "Firstpage"
            },
            "lastPage": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Page where chunk ends in the document. Inclusive. 1-indexed.",
               "title": "Lastpage"
            }
         },
         "title": "RagChunkPageSpan",
         "type": "object"
      },
      "RealtimeCacheEntry": {
         "additionalProperties": false,
         "description": "Store audio data chunks for caching before flushing.",
         "properties": {
            "role": {
               "title": "Role",
               "type": "string"
            },
            "data": {
               "$ref": "#/$defs/Blob"
            },
            "timestamp": {
               "title": "Timestamp",
               "type": "number"
            }
         },
         "required": [
            "role",
            "data",
            "timestamp"
         ],
         "title": "RealtimeCacheEntry",
         "type": "object"
      },
      "RealtimeInputConfig": {
         "additionalProperties": false,
         "description": "Marks the end of user activity.\n\nThis can only be sent if automatic (i.e. server-side) activity detection is\ndisabled.",
         "properties": {
            "automaticActivityDetection": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/AutomaticActivityDetection"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "If not set, automatic activity detection is enabled by default. If automatic voice detection is disabled, the client must send activity signals."
            },
            "activityHandling": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/ActivityHandling"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Defines what effect activity has."
            },
            "turnCoverage": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/TurnCoverage"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Defines which input is included in the user's turn."
            }
         },
         "title": "RealtimeInputConfig",
         "type": "object"
      },
      "ResumabilityConfig": {
         "description": "The config of the resumability for an application.\n\nThe \"resumability\" in ADK refers to the ability to:\n1. pause an invocation upon a long running function call.\n2. resume an invocation from the last event, if it's paused or failed midway\nthrough.\n\nNote: ADK resumes the invocation in a best-effort manner:\n1. Tool call to resume needs to be idempotent because we only guarantee\nan at-least-once behavior once resumed.\n2. Any temporary / in-memory state will be lost upon resumption.",
         "properties": {
            "is_resumable": {
               "default": false,
               "title": "Is Resumable",
               "type": "boolean"
            }
         },
         "title": "ResumabilityConfig",
         "type": "object"
      },
      "RetrievalMetadata": {
         "additionalProperties": false,
         "description": "Metadata related to retrieval in the grounding flow.",
         "properties": {
            "googleSearchDynamicRetrievalScore": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Score indicating how likely information from Google Search could help answer the prompt. The score is in the range `[0, 1]`, where 0 is the least likely and 1 is the most likely. This score is only populated when Google Search grounding and dynamic retrieval is enabled. It will be compared to the threshold to determine whether to trigger Google Search.",
               "title": "Googlesearchdynamicretrievalscore"
            }
         },
         "title": "RetrievalMetadata",
         "type": "object"
      },
      "RunConfig": {
         "additionalProperties": false,
         "description": "Configs for runtime behavior of agents.\n\nThe configs here will be overridden by agent-specific configurations.",
         "properties": {
            "speech_config": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/SpeechConfig"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "response_modalities": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Response Modalities"
            },
            "save_input_blobs_as_artifacts": {
               "default": false,
               "deprecated": true,
               "description": "Whether or not to save the input blobs as artifacts. DEPRECATED: Use SaveFilesAsArtifactsPlugin instead for better control and flexibility. See google.adk.plugins.SaveFilesAsArtifactsPlugin.",
               "title": "Save Input Blobs As Artifacts",
               "type": "boolean"
            },
            "support_cfc": {
               "default": false,
               "title": "Support Cfc",
               "type": "boolean"
            },
            "streaming_mode": {
               "$ref": "#/$defs/StreamingMode",
               "default": null
            },
            "output_audio_transcription": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/AudioTranscriptionConfig"
                  },
                  {
                     "type": "null"
                  }
               ]
            },
            "input_audio_transcription": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/AudioTranscriptionConfig"
                  },
                  {
                     "type": "null"
                  }
               ]
            },
            "realtime_input_config": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/RealtimeInputConfig"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "enable_affective_dialog": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Enable Affective Dialog"
            },
            "proactivity": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/ProactivityConfig"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "session_resumption": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/SessionResumptionConfig"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "context_window_compression": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/ContextWindowCompressionConfig"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "save_live_blob": {
               "default": false,
               "title": "Save Live Blob",
               "type": "boolean"
            },
            "save_live_audio": {
               "default": false,
               "deprecated": true,
               "description": "DEPRECATED: Use save_live_blob instead. If set to True, it saves live video and audio data to session and artifact service.",
               "title": "Save Live Audio",
               "type": "boolean"
            },
            "max_llm_calls": {
               "default": 500,
               "title": "Max Llm Calls",
               "type": "integer"
            },
            "custom_metadata": {
               "anyOf": [
                  {
                     "additionalProperties": true,
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Custom Metadata"
            }
         },
         "title": "RunConfig",
         "type": "object"
      },
      "SearchEntryPoint": {
         "additionalProperties": false,
         "description": "Google search entry point.",
         "properties": {
            "renderedContent": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Web content snippet that can be embedded in a web page or an app webview.",
               "title": "Renderedcontent"
            },
            "sdkBlob": {
               "anyOf": [
                  {
                     "format": "base64url",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Base64 encoded JSON representing array of tuple.",
               "title": "Sdkblob"
            }
         },
         "title": "SearchEntryPoint",
         "type": "object"
      },
      "SecuritySchemeType": {
         "enum": [
            "apiKey",
            "http",
            "oauth2",
            "openIdConnect"
         ],
         "title": "SecuritySchemeType",
         "type": "string"
      },
      "Segment": {
         "additionalProperties": false,
         "description": "Segment of the content.",
         "properties": {
            "endIndex": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Output only. End index in the given Part, measured in bytes. Offset from the start of the Part, exclusive, starting at zero.",
               "title": "Endindex"
            },
            "partIndex": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Output only. The index of a Part object within its parent Content object.",
               "title": "Partindex"
            },
            "startIndex": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Output only. Start index in the given Part, measured in bytes. Offset from the start of the Part, inclusive, starting at zero.",
               "title": "Startindex"
            },
            "text": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Output only. The text corresponding to the segment from the response.",
               "title": "Text"
            }
         },
         "title": "Segment",
         "type": "object"
      },
      "ServiceAccount": {
         "additionalProperties": true,
         "description": "Represents Google Service Account configuration.",
         "properties": {
            "serviceAccountCredential": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/ServiceAccountCredential"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "scopes": {
               "items": {
                  "type": "string"
               },
               "title": "Scopes",
               "type": "array"
            },
            "useDefaultCredential": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": false,
               "title": "Usedefaultcredential"
            }
         },
         "required": [
            "scopes"
         ],
         "title": "ServiceAccount",
         "type": "object"
      },
      "ServiceAccountCredential": {
         "additionalProperties": true,
         "description": "Represents Google Service Account configuration.\n\nAttributes:\n  type: The type should be \"service_account\".\n  project_id: The project ID.\n  private_key_id: The ID of the private key.\n  private_key: The private key.\n  client_email: The client email.\n  client_id: The client ID.\n  auth_uri: The authorization URI.\n  token_uri: The token URI.\n  auth_provider_x509_cert_url: URL for auth provider's X.509 cert.\n  client_x509_cert_url: URL for the client's X.509 cert.\n  universe_domain: The universe domain.\n\nExample:\n\n    config = ServiceAccountCredential(\n        type_=\"service_account\",\n        project_id=\"your_project_id\",\n        private_key_id=\"your_private_key_id\",\n        private_key=\"-----BEGIN PRIVATE KEY-----...\",\n        client_email=\"...@....iam.gserviceaccount.com\",\n        client_id=\"your_client_id\",\n        auth_uri=\"https://accounts.google.com/o/oauth2/auth\",\n        token_uri=\"https://oauth2.googleapis.com/token\",\n        auth_provider_x509_cert_url=\"https://www.googleapis.com/oauth2/v1/certs\",\n        client_x509_cert_url=\"https://www.googleapis.com/robot/v1/metadata/x509/...\",\n        universe_domain=\"googleapis.com\"\n    )\n\n\n    config = ServiceAccountConfig.model_construct(**{\n        ...service account config dict\n    })",
         "properties": {
            "type": {
               "default": "",
               "title": "Type",
               "type": "string"
            },
            "projectId": {
               "title": "Projectid",
               "type": "string"
            },
            "privateKeyId": {
               "title": "Privatekeyid",
               "type": "string"
            },
            "privateKey": {
               "title": "Privatekey",
               "type": "string"
            },
            "clientEmail": {
               "title": "Clientemail",
               "type": "string"
            },
            "clientId": {
               "title": "Clientid",
               "type": "string"
            },
            "authUri": {
               "title": "Authuri",
               "type": "string"
            },
            "tokenUri": {
               "title": "Tokenuri",
               "type": "string"
            },
            "authProviderX509CertUrl": {
               "title": "Authproviderx509Certurl",
               "type": "string"
            },
            "clientX509CertUrl": {
               "title": "Clientx509Certurl",
               "type": "string"
            },
            "universeDomain": {
               "title": "Universedomain",
               "type": "string"
            }
         },
         "required": [
            "projectId",
            "privateKeyId",
            "privateKey",
            "clientEmail",
            "clientId",
            "authUri",
            "tokenUri",
            "authProviderX509CertUrl",
            "clientX509CertUrl",
            "universeDomain"
         ],
         "title": "ServiceAccountCredential",
         "type": "object"
      },
      "Session": {
         "additionalProperties": false,
         "description": "Represents a series of interactions between a user and agents.",
         "properties": {
            "id": {
               "title": "Id",
               "type": "string"
            },
            "appName": {
               "title": "Appname",
               "type": "string"
            },
            "userId": {
               "title": "Userid",
               "type": "string"
            },
            "state": {
               "additionalProperties": true,
               "title": "State",
               "type": "object"
            },
            "events": {
               "items": {
                  "$ref": "#/$defs/Event"
               },
               "title": "Events",
               "type": "array"
            },
            "lastUpdateTime": {
               "default": 0.0,
               "title": "Lastupdatetime",
               "type": "number"
            }
         },
         "required": [
            "id",
            "appName",
            "userId"
         ],
         "title": "Session",
         "type": "object"
      },
      "SessionResumptionConfig": {
         "additionalProperties": false,
         "description": "Configuration of session resumption mechanism.\n\nIncluded in `LiveConnectConfig.session_resumption`. If included server\nwill send `LiveServerSessionResumptionUpdate` messages.",
         "properties": {
            "handle": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Session resumption handle of previous session (session to restore).\n\nIf not present new session will be started.",
               "title": "Handle"
            },
            "transparent": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "If set the server will send `last_consumed_client_message_index` in the `session_resumption_update` messages to allow for transparent reconnections.",
               "title": "Transparent"
            }
         },
         "title": "SessionResumptionConfig",
         "type": "object"
      },
      "SlidingWindow": {
         "additionalProperties": false,
         "description": "Context window will be truncated by keeping only suffix of it.\n\nContext window will always be cut at start of USER role turn. System\ninstructions and `BidiGenerateContentSetup.prefix_turns` will not be\nsubject to the sliding window mechanism, they will always stay at the\nbeginning of context window.",
         "properties": {
            "targetTokens": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Session reduction target -- how many tokens we should keep. Window shortening operation has some latency costs, so we should avoid running it on every turn. Should be < trigger_tokens. If not set, trigger_tokens/2 is assumed.",
               "title": "Targettokens"
            }
         },
         "title": "SlidingWindow",
         "type": "object"
      },
      "SpeakerVoiceConfig": {
         "additionalProperties": false,
         "description": "The configuration for the speaker to use.",
         "properties": {
            "speaker": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The name of the speaker to use. Should be the same as in the\n          prompt.",
               "title": "Speaker"
            },
            "voiceConfig": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/VoiceConfig"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The configuration for the voice to use."
            }
         },
         "title": "SpeakerVoiceConfig",
         "type": "object"
      },
      "SpeechConfig": {
         "additionalProperties": false,
         "description": "The speech generation configuration.",
         "properties": {
            "voiceConfig": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/VoiceConfig"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The configuration for the speaker to use.\n      "
            },
            "multiSpeakerVoiceConfig": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/MultiSpeakerVoiceConfig"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The configuration for the multi-speaker setup.\n          It is mutually exclusive with the voice_config field.\n          "
            },
            "languageCode": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Language code (ISO 639. e.g. en-US) for the speech synthesization.\n      Only available for Live API.\n      ",
               "title": "Languagecode"
            }
         },
         "title": "SpeechConfig",
         "type": "object"
      },
      "StartSensitivity": {
         "description": "Start of speech sensitivity.",
         "enum": [
            "START_SENSITIVITY_UNSPECIFIED",
            "START_SENSITIVITY_HIGH",
            "START_SENSITIVITY_LOW"
         ],
         "title": "StartSensitivity",
         "type": "string"
      },
      "StreamingMode": {
         "enum": [
            null,
            "sse",
            "bidi"
         ],
         "title": "StreamingMode"
      },
      "ToolConfirmation": {
         "additionalProperties": false,
         "description": "Represents a tool confirmation configuration.",
         "properties": {
            "hint": {
               "default": "",
               "title": "Hint",
               "type": "string"
            },
            "confirmed": {
               "default": false,
               "title": "Confirmed",
               "type": "boolean"
            },
            "payload": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Payload"
            }
         },
         "title": "ToolConfirmation",
         "type": "object"
      },
      "TrafficType": {
         "description": "Output only.\n\nTraffic type. This shows whether a request consumes Pay-As-You-Go or\nProvisioned Throughput quota.",
         "enum": [
            "TRAFFIC_TYPE_UNSPECIFIED",
            "ON_DEMAND",
            "PROVISIONED_THROUGHPUT"
         ],
         "title": "TrafficType",
         "type": "string"
      },
      "Transcription": {
         "additionalProperties": false,
         "description": "Audio transcription in Server Conent.",
         "properties": {
            "text": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Transcription text.\n      ",
               "title": "Text"
            },
            "finished": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The bool indicates the end of the transcription.\n      ",
               "title": "Finished"
            }
         },
         "title": "Transcription",
         "type": "object"
      },
      "TranscriptionEntry": {
         "additionalProperties": false,
         "description": "Store the data that can be used for transcription.",
         "properties": {
            "role": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Role"
            },
            "data": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/Blob"
                  },
                  {
                     "$ref": "#/$defs/Content"
                  }
               ],
               "title": "Data"
            }
         },
         "required": [
            "data"
         ],
         "title": "TranscriptionEntry",
         "type": "object"
      },
      "TurnCoverage": {
         "description": "Options about which input is included in the user's turn.",
         "enum": [
            "TURN_COVERAGE_UNSPECIFIED",
            "TURN_INCLUDES_ONLY_ACTIVITY",
            "TURN_INCLUDES_ALL_INPUT"
         ],
         "title": "TurnCoverage",
         "type": "string"
      },
      "VideoMetadata": {
         "additionalProperties": false,
         "description": "Describes how the video in the Part should be used by the model.",
         "properties": {
            "fps": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The frame rate of the video sent to the model. If not specified, the\n        default value will be 1.0. The fps range is (0.0, 24.0].",
               "title": "Fps"
            },
            "endOffset": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. The end offset of the video.",
               "title": "Endoffset"
            },
            "startOffset": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. The start offset of the video.",
               "title": "Startoffset"
            }
         },
         "title": "VideoMetadata",
         "type": "object"
      },
      "VoiceConfig": {
         "additionalProperties": false,
         "description": "The configuration for the voice to use.",
         "properties": {
            "prebuiltVoiceConfig": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/PrebuiltVoiceConfig"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The configuration for the speaker to use.\n      "
            }
         },
         "title": "VoiceConfig",
         "type": "object"
      }
   },
   "additionalProperties": false,
   "required": [
      "invocation_id",
      "agent",
      "session"
   ]
}

Fields:

• active_streaming_tools (dict[str, google.adk.agents.active_streaming_tool.ActiveStreamingTool] | None)

• agent (google.adk.agents.base_agent.BaseAgent)

• agent_states (dict[str, dict[str, Any]])

• artifact_service (google.adk.artifacts.base_artifact_service.BaseArtifactService | None)

• branch (str | None)

• canonical_tools_cache (list[google.adk.tools.base_tool.BaseTool] | None)

• context_cache_config (google.adk.agents.context_cache_config.ContextCacheConfig | None)

• credential_service (google.adk.auth.credential_service.base_credential_service.BaseCredentialService | None)

• end_invocation (bool)

• end_of_agents (dict[str, bool])

• input_realtime_cache (list[google.adk.agents.invocation_context.RealtimeCacheEntry] | None)

• invocation_id (str)

• live_request_queue (google.adk.agents.live_request_queue.LiveRequestQueue | None)

• live_session_resumption_handle (str | None)

• memory_service (google.adk.memory.base_memory_service.BaseMemoryService | None)

• output_realtime_cache (list[google.adk.agents.invocation_context.RealtimeCacheEntry] | None)

• plugin_manager (google.adk.plugins.plugin_manager.PluginManager)

• resumability_config (google.adk.apps.app.ResumabilityConfig | None)

• run_config (google.adk.agents.run_config.RunConfig | None)

• session (google.adk.sessions.session.Session)

• session_service (google.adk.sessions.base_session_service.BaseSessionService)

• transcription_cache (list[google.adk.agents.transcription_entry.TranscriptionEntry] | None)

• user_content (google.genai.types.Content | None)

field active_streaming_tools: Optional[dict[str, ActiveStreamingTool]] = None

The running streaming tools of this invocation.

field agent: BaseAgent [Required]

The current agent of this invocation context. Readonly.

field agent_states: dict[str, dict[str, Any]] [Optional]

The state of the agent for this invocation.

field artifact_service: Optional[BaseArtifactService] = None

field branch: Optional[str] = None

The branch of the invocation context.

The format is like agent_1.agent_2.agent_3, where agent_1 is the parent of agent_2, and agent_2 is the parent of agent_3.

Branch is used when multiple sub-agents shouldn’t see their peer agents’ conversation history.

field canonical_tools_cache: Optional[list[BaseTool]] = None

The cache of canonical tools for this invocation.

field context_cache_config: Optional[ContextCacheConfig] = None

field credential_service: Optional[BaseCredentialService] = None

field end_invocation: bool = False

Whether to end this invocation.

Set to True in callbacks or tools to terminate this invocation.

field end_of_agents: dict[str, bool] [Optional]

The end of agent status for each agent in this invocation.

field input_realtime_cache: Optional[list[RealtimeCacheEntry]] = None

Caches input audio chunks before flushing to session and artifact services.

field invocation_id: str [Required]

The id of this invocation context. Readonly.

field live_request_queue: Optional[LiveRequestQueue] = None

The queue to receive live requests.

field live_session_resumption_handle: Optional[str] = None

The handle for live session resumption.

field memory_service: Optional[BaseMemoryService] = None

field output_realtime_cache: Optional[list[RealtimeCacheEntry]] = None

Caches output audio chunks before flushing to session and artifact services.

field plugin_manager: PluginManager [Optional]

The manager for keeping track of plugins in this invocation.

field resumability_config: Optional[ResumabilityConfig] = None

The resumability config that applies to all agents under this invocation.

field run_config: Optional[RunConfig] = None

Configurations for live agents under this invocation.

field session: Session [Required]

The current session of this invocation context. Readonly.

field session_service: BaseSessionService [Required]

field transcription_cache: Optional[list[TranscriptionEntry]] = None

Caches necessary data, audio or contents, that are needed by transcription.

field user_content: Optional[types.Content] = None

The user content that started this invocation. Readonly.

increment_llm_call_count()

Tracks number of llm calls made.

Raises:

LlmCallsLimitExceededError – If number of llm calls made exceed the set threshold.

model_post_init(context, /)

This function is meant to behave like a BaseModel method to initialise private attributes.

It takes context as an argument since that’s what pydantic-core passes when calling it.

Return type:

None

Parameters:

• self – The BaseModel instance.

• context – The context.

populate_invocation_agent_states()

Populates agent states for the current invocation if it is resumable.

For history events that contain agent state information, set the agent_state and end_of_agent of the agent that generated the event.

For non-workflow agents, also set an initial agent_state if it has already generated some contents.

Return type:

None

reset_sub_agent_states(agent_name)

Resets the state of all sub-agents of the given agent in this invocation.

Return type:

None

Parameters:

agent_name – The name of the agent whose sub-agent states need to be reset.

set_agent_state(agent_name, *, agent_state=None, end_of_agent=False)

Sets the state of an agent in this invocation.

• If end_of_agent is True, will set the end_of_agent flag to True and clear the agent_state.

• Otherwise, if agent_state is not None, will set the agent_state and reset the end_of_agent flag to False.

• Otherwise, will clear the agent_state and end_of_agent flag, to allow the agent to re-run.

Parameters:

• agent_name – The name of the agent.

• agent_state – The state of the agent. Will be ignored if end_of_agent is True.

• end_of_agent – Whether the agent has finished running.

Return type:

None

should_pause_invocation(event)

Returns whether to pause the invocation right after this event.

“Pausing” an invocation is different from “ending” an invocation. A paused invocation can be resumed later, while an ended invocation cannot.

Pausing the current agent’s run will also pause all the agents that depend on its execution, i.e. the subsequent agents in a workflow, and the current agent’s ancestors, etc.

Note that parallel sibling agents won’t be affected, but their common ancestors will be paused after all the non-blocking sub-agents finished running.

Return type:

bool

Should meet all following conditions to pause an invocation:

1. The app is resumable.

2. The current event has a long running function call.

Parameters:

event – The current event.

Returns:

Whether to pause the invocation right after this event.

property app_name: str

property is_resumable: bool

Returns whether the current invocation is resumable.

property user_id: str

pydantic model google.adk.agents.LiveRequest

Bases: BaseModel

Request send to live agents.

Show JSON schema

{
   "title": "LiveRequest",
   "description": "Request send to live agents.",
   "type": "object",
   "properties": {
      "content": {
         "anyOf": [
            {
               "$ref": "#/$defs/Content"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "blob": {
         "anyOf": [
            {
               "$ref": "#/$defs/Blob"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "activity_start": {
         "anyOf": [
            {
               "$ref": "#/$defs/ActivityStart"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "activity_end": {
         "anyOf": [
            {
               "$ref": "#/$defs/ActivityEnd"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "close": {
         "default": false,
         "title": "Close",
         "type": "boolean"
      }
   },
   "$defs": {
      "ActivityEnd": {
         "additionalProperties": false,
         "description": "Marks the end of user activity.\n\nThis can only be sent if automatic (i.e. server-side) activity detection is\ndisabled.",
         "properties": {},
         "title": "ActivityEnd",
         "type": "object"
      },
      "ActivityStart": {
         "additionalProperties": false,
         "description": "Marks the start of user activity.\n\nThis can only be sent if automatic (i.e. server-side) activity detection is\ndisabled.",
         "properties": {},
         "title": "ActivityStart",
         "type": "object"
      },
      "Blob": {
         "additionalProperties": false,
         "description": "Content blob.",
         "properties": {
            "displayName": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is not currently used in the Gemini GenerateContent calls.",
               "title": "Displayname"
            },
            "data": {
               "anyOf": [
                  {
                     "format": "base64url",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. Raw bytes.",
               "title": "Data"
            },
            "mimeType": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. The IANA standard MIME type of the source data.",
               "title": "Mimetype"
            }
         },
         "title": "Blob",
         "type": "object"
      },
      "CodeExecutionResult": {
         "additionalProperties": false,
         "description": "Result of executing the [ExecutableCode].\n\nOnly generated when using the [CodeExecution] tool, and always follows a\n`part` containing the [ExecutableCode].",
         "properties": {
            "outcome": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/Outcome"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. Outcome of the code execution."
            },
            "output": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Contains stdout when code execution is successful, stderr or other description otherwise.",
               "title": "Output"
            }
         },
         "title": "CodeExecutionResult",
         "type": "object"
      },
      "Content": {
         "additionalProperties": false,
         "description": "Contains the multi-part content of a message.",
         "properties": {
            "parts": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/Part"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "List of parts that constitute a single message. Each part may have\n      a different IANA MIME type.",
               "title": "Parts"
            },
            "role": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. The producer of the content. Must be either 'user' or\n      'model'. Useful to set for multi-turn conversations, otherwise can be\n      empty. If role is not specified, SDK will determine the role.",
               "title": "Role"
            }
         },
         "title": "Content",
         "type": "object"
      },
      "ExecutableCode": {
         "additionalProperties": false,
         "description": "Code generated by the model that is meant to be executed, and the result returned to the model.\n\nGenerated when using the [CodeExecution] tool, in which the code will be\nautomatically executed, and a corresponding [CodeExecutionResult] will also be\ngenerated.",
         "properties": {
            "code": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. The code to be executed.",
               "title": "Code"
            },
            "language": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/Language"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. Programming language of the `code`."
            }
         },
         "title": "ExecutableCode",
         "type": "object"
      },
      "FileData": {
         "additionalProperties": false,
         "description": "URI based data.",
         "properties": {
            "displayName": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. It is not currently used in the Gemini GenerateContent calls.",
               "title": "Displayname"
            },
            "fileUri": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. URI.",
               "title": "Fileuri"
            },
            "mimeType": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. The IANA standard MIME type of the source data.",
               "title": "Mimetype"
            }
         },
         "title": "FileData",
         "type": "object"
      },
      "FunctionCall": {
         "additionalProperties": false,
         "description": "A function call.",
         "properties": {
            "id": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The unique id of the function call. If populated, the client to execute the\n   `function_call` and return the response with the matching `id`.",
               "title": "Id"
            },
            "args": {
               "anyOf": [
                  {
                     "additionalProperties": true,
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.",
               "title": "Args"
            },
            "name": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. The name of the function to call. Matches [FunctionDeclaration.name].",
               "title": "Name"
            }
         },
         "title": "FunctionCall",
         "type": "object"
      },
      "FunctionResponse": {
         "additionalProperties": false,
         "description": "A function response.",
         "properties": {
            "willContinue": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Signals that function call continues, and more responses will be returned, turning the function call into a generator. Is only applicable to NON_BLOCKING function calls (see FunctionDeclaration.behavior for details), ignored otherwise. If false, the default, future responses will not be considered. Is only applicable to NON_BLOCKING function calls, is ignored otherwise. If set to false, future responses will not be considered. It is allowed to return empty `response` with `will_continue=False` to signal that the function call is finished.",
               "title": "Willcontinue"
            },
            "scheduling": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/FunctionResponseScheduling"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE."
            },
            "parts": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/FunctionResponsePart"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "List of parts that constitute a function response. Each part may\n      have a different IANA MIME type.",
               "title": "Parts"
            },
            "id": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`.",
               "title": "Id"
            },
            "name": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].",
               "title": "Name"
            },
            "response": {
               "anyOf": [
                  {
                     "additionalProperties": true,
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. The function response in JSON object format. Use \"output\" key to specify function output and \"error\" key to specify error details (if any). If \"output\" and \"error\" keys are not specified, then whole \"response\" is treated as function output.",
               "title": "Response"
            }
         },
         "title": "FunctionResponse",
         "type": "object"
      },
      "FunctionResponseBlob": {
         "additionalProperties": false,
         "description": "Raw media bytes for function response.\n\nText should not be sent as raw bytes, use the FunctionResponse.response\nfield.",
         "properties": {
            "mimeType": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. The IANA standard MIME type of the source data.",
               "title": "Mimetype"
            },
            "data": {
               "anyOf": [
                  {
                     "format": "base64url",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. Inline media bytes.",
               "title": "Data"
            }
         },
         "title": "FunctionResponseBlob",
         "type": "object"
      },
      "FunctionResponseFileData": {
         "additionalProperties": false,
         "description": "URI based data for function response.",
         "properties": {
            "fileUri": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. URI.",
               "title": "Fileuri"
            },
            "mimeType": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. The IANA standard MIME type of the source data.",
               "title": "Mimetype"
            }
         },
         "title": "FunctionResponseFileData",
         "type": "object"
      },
      "FunctionResponsePart": {
         "additionalProperties": false,
         "description": "A datatype containing media that is part of a `FunctionResponse` message.\n\nA `FunctionResponsePart` consists of data which has an associated datatype. A\n`FunctionResponsePart` can only contain one of the accepted types in\n`FunctionResponsePart.data`.\n\nA `FunctionResponsePart` must have a fixed IANA MIME type identifying the\ntype and subtype of the media if the `inline_data` field is filled with raw\nbytes.",
         "properties": {
            "inlineData": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/FunctionResponseBlob"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Inline media bytes."
            },
            "fileData": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/FunctionResponseFileData"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. URI based data."
            }
         },
         "title": "FunctionResponsePart",
         "type": "object"
      },
      "FunctionResponseScheduling": {
         "description": "Specifies how the response should be scheduled in the conversation.",
         "enum": [
            "SCHEDULING_UNSPECIFIED",
            "SILENT",
            "WHEN_IDLE",
            "INTERRUPT"
         ],
         "title": "FunctionResponseScheduling",
         "type": "string"
      },
      "Language": {
         "description": "Required. Programming language of the `code`.",
         "enum": [
            "LANGUAGE_UNSPECIFIED",
            "PYTHON"
         ],
         "title": "Language",
         "type": "string"
      },
      "Outcome": {
         "description": "Required. Outcome of the code execution.",
         "enum": [
            "OUTCOME_UNSPECIFIED",
            "OUTCOME_OK",
            "OUTCOME_FAILED",
            "OUTCOME_DEADLINE_EXCEEDED"
         ],
         "title": "Outcome",
         "type": "string"
      },
      "Part": {
         "additionalProperties": false,
         "description": "A datatype containing media content.\n\nExactly one field within a Part should be set, representing the specific type\nof content being conveyed. Using multiple fields within the same `Part`\ninstance is considered invalid.",
         "properties": {
            "videoMetadata": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/VideoMetadata"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Metadata for a given video."
            },
            "thought": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Indicates if the part is thought from the model.",
               "title": "Thought"
            },
            "inlineData": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/Blob"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Inlined bytes data."
            },
            "fileData": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/FileData"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. URI based data."
            },
            "thoughtSignature": {
               "anyOf": [
                  {
                     "format": "base64url",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "An opaque signature for the thought so it can be reused in subsequent requests.",
               "title": "Thoughtsignature"
            },
            "functionCall": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/FunctionCall"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "A predicted [FunctionCall] returned from the model that contains a string\n      representing the [FunctionDeclaration.name] and a structured JSON object\n      containing the parameters and their values."
            },
            "codeExecutionResult": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/CodeExecutionResult"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Result of executing the [ExecutableCode]."
            },
            "executableCode": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/ExecutableCode"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Code generated by the model that is meant to be executed."
            },
            "functionResponse": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/FunctionResponse"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model."
            },
            "text": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Text part (can be code).",
               "title": "Text"
            }
         },
         "title": "Part",
         "type": "object"
      },
      "VideoMetadata": {
         "additionalProperties": false,
         "description": "Describes how the video in the Part should be used by the model.",
         "properties": {
            "fps": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The frame rate of the video sent to the model. If not specified, the\n        default value will be 1.0. The fps range is (0.0, 24.0].",
               "title": "Fps"
            },
            "endOffset": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. The end offset of the video.",
               "title": "Endoffset"
            },
            "startOffset": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. The start offset of the video.",
               "title": "Startoffset"
            }
         },
         "title": "VideoMetadata",
         "type": "object"
      }
   }
}

Fields:

• activity_end (google.genai.types.ActivityEnd | None)

• activity_start (google.genai.types.ActivityStart | None)

• blob (google.genai.types.Blob | None)

• close (bool)

• content (google.genai.types.Content | None)

field activity_end: Optional[types.ActivityEnd] = None

If set, signal the end of user activity to the model.

field activity_start: Optional[types.ActivityStart] = None

If set, signal the start of user activity to the model.

field blob: Optional[types.Blob] = None

If set, send the blob to the model in realtime mode.

field close: bool = False

If set, close the queue. queue.shutdown() is only supported in Python 3.13+.

field content: Optional[types.Content] = None

If set, send the content to the model in turn-by-turn mode.

class google.adk.agents.LiveRequestQueue

Bases: object

Queue used to send LiveRequest in a live(bidirectional streaming) way.

close()

async get()

Return type:

LiveRequest

send(req)

send_activity_end()

Sends an activity end signal to mark the end of user input.

send_activity_start()

Sends an activity start signal to mark the beginning of user input.

send_content(content)

send_realtime(blob)

pydantic model google.adk.agents.LlmAgent

Bases: BaseAgent

LLM-based Agent.

Show JSON schema

{
   "title": "LlmAgent",
   "type": "object",
   "properties": {
      "name": {
         "title": "Name",
         "type": "string"
      },
      "description": {
         "default": "",
         "title": "Description",
         "type": "string"
      },
      "parent_agent": {
         "anyOf": [
            {
               "$ref": "#/$defs/BaseAgent"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "sub_agents": {
         "items": {
            "$ref": "#/$defs/BaseAgent"
         },
         "title": "Sub Agents",
         "type": "array"
      },
      "before_agent_callback": {
         "default": null,
         "title": "Before Agent Callback",
         "type": "null"
      },
      "after_agent_callback": {
         "default": null,
         "title": "After Agent Callback",
         "type": "null"
      },
      "model": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "$ref": "#/$defs/BaseLlm"
            }
         ],
         "default": "",
         "title": "Model"
      },
      "instruction": {
         "default": "",
         "title": "Instruction",
         "type": "string"
      },
      "global_instruction": {
         "default": "",
         "title": "Global Instruction",
         "type": "string"
      },
      "static_instruction": {
         "anyOf": [
            {
               "$ref": "#/$defs/Content"
            },
            {
               "type": "string"
            },
            {
               "$ref": "#/$defs/File"
            },
            {
               "$ref": "#/$defs/Part"
            },
            {
               "items": {
                  "anyOf": [
                     {
                        "type": "string"
                     },
                     {
                        "$ref": "#/$defs/File"
                     },
                     {
                        "$ref": "#/$defs/Part"
                     }
                  ]
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Static Instruction"
      },
      "tools": {
         "items": {
            "anyOf": []
         },
         "title": "Tools",
         "type": "array"
      },
      "generate_content_config": {
         "default": null,
         "title": "Generate Content Config"
      },
      "disallow_transfer_to_parent": {
         "default": false,
         "title": "Disallow Transfer To Parent",
         "type": "boolean"
      },
      "disallow_transfer_to_peers": {
         "default": false,
         "title": "Disallow Transfer To Peers",
         "type": "boolean"
      },
      "include_contents": {
         "default": "default",
         "enum": [
            "default",
            "none"
         ],
         "title": "Include Contents",
         "type": "string"
      },
      "input_schema": {
         "anyOf": [
            {},
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Input Schema"
      },
      "output_schema": {
         "anyOf": [
            {},
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Output Schema"
      },
      "output_key": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Output Key"
      },
      "planner": {
         "default": null,
         "title": "Planner"
      },
      "code_executor": {
         "anyOf": [
            {
               "$ref": "#/$defs/BaseCodeExecutor"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "before_model_callback": {
         "default": null,
         "title": "Before Model Callback",
         "type": "null"
      },
      "after_model_callback": {
         "default": null,
         "title": "After Model Callback",
         "type": "null"
      },
      "on_model_error_callback": {
         "default": null,
         "title": "On Model Error Callback",
         "type": "null"
      },
      "before_tool_callback": {
         "default": null,
         "title": "Before Tool Callback",
         "type": "null"
      },
      "after_tool_callback": {
         "default": null,
         "title": "After Tool Callback",
         "type": "null"
      },
      "on_tool_error_callback": {
         "default": null,
         "title": "On Tool Error Callback",
         "type": "null"
      }
   },
   "$defs": {
      "BaseAgent": {
         "additionalProperties": false,
         "description": "Base class for all agents in Agent Development Kit.",
         "properties": {
            "name": {
               "title": "Name",
               "type": "string"
            },
            "description": {
               "default": "",
               "title": "Description",
               "type": "string"
            },
            "parent_agent": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/BaseAgent"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "sub_agents": {
               "items": {
                  "$ref": "#/$defs/BaseAgent"
               },
               "title": "Sub Agents",
               "type": "array"
            },
            "before_agent_callback": {
               "default": null,
               "title": "Before Agent Callback",
               "type": "null"
            },
            "after_agent_callback": {
               "default": null,
               "title": "After Agent Callback",
               "type": "null"
            }
         },
         "required": [
            "name"
         ],
         "title": "BaseAgent",
         "type": "object"
      },
      "BaseCodeExecutor": {
         "description": "Abstract base class for all code executors.\n\nThe code executor allows the agent to execute code blocks from model responses\nand incorporate the execution results into the final response.\n\nAttributes:\n  optimize_data_file: If true, extract and process data files from the model\n    request and attach them to the code executor. Supported data file\n    MimeTypes are [text/csv]. Default to False.\n  stateful: Whether the code executor is stateful. Default to False.\n  error_retry_attempts: The number of attempts to retry on consecutive code\n    execution errors. Default to 2.\n  code_block_delimiters: The list of the enclosing delimiters to identify the\n    code blocks.\n  execution_result_delimiters: The delimiters to format the code execution\n    result.",
         "properties": {
            "optimize_data_file": {
               "default": false,
               "title": "Optimize Data File",
               "type": "boolean"
            },
            "stateful": {
               "default": false,
               "title": "Stateful",
               "type": "boolean"
            },
            "error_retry_attempts": {
               "default": 2,
               "title": "Error Retry Attempts",
               "type": "integer"
            },
            "code_block_delimiters": {
               "default": [
                  [
                     "```tool_code\n",
                     "\n```"
                  ],
                  [
                     "```python\n",
                     "\n```"
                  ]
               ],
               "items": {
                  "maxItems": 2,
                  "minItems": 2,
                  "prefixItems": [
                     {
                        "type": "string"
                     },
                     {
                        "type": "string"
                     }
                  ],
                  "type": "array"
               },
               "title": "Code Block Delimiters",
               "type": "array"
            },
            "execution_result_delimiters": {
               "default": [
                  "```tool_output\n",
                  "\n```"
               ],
               "maxItems": 2,
               "minItems": 2,
               "prefixItems": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "string"
                  }
               ],
               "title": "Execution Result Delimiters",
               "type": "array"
            }
         },
         "title": "BaseCodeExecutor",
         "type": "object"
      },
      "BaseLlm": {
         "description": "The BaseLLM class.",
         "properties": {
            "model": {
               "title": "Model",
               "type": "string"
            }
         },
         "required": [
            "model"
         ],
         "title": "BaseLlm",
         "type": "object"
      },
      "Blob": {
         "additionalProperties": false,
         "description": "Content blob.",
         "properties": {
            "displayName": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is not currently used in the Gemini GenerateContent calls.",
               "title": "Displayname"
            },
            "data": {
               "anyOf": [
                  {
                     "format": "base64url",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. Raw bytes.",
               "title": "Data"
            },
            "mimeType": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. The IANA standard MIME type of the source data.",
               "title": "Mimetype"
            }
         },
         "title": "Blob",
         "type": "object"
      },
      "CodeExecutionResult": {
         "additionalProperties": false,
         "description": "Result of executing the [ExecutableCode].\n\nOnly generated when using the [CodeExecution] tool, and always follows a\n`part` containing the [ExecutableCode].",
         "properties": {
            "outcome": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/Outcome"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. Outcome of the code execution."
            },
            "output": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Contains stdout when code execution is successful, stderr or other description otherwise.",
               "title": "Output"
            }
         },
         "title": "CodeExecutionResult",
         "type": "object"
      },
      "Content": {
         "additionalProperties": false,
         "description": "Contains the multi-part content of a message.",
         "properties": {
            "parts": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/Part"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "List of parts that constitute a single message. Each part may have\n      a different IANA MIME type.",
               "title": "Parts"
            },
            "role": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. The producer of the content. Must be either 'user' or\n      'model'. Useful to set for multi-turn conversations, otherwise can be\n      empty. If role is not specified, SDK will determine the role.",
               "title": "Role"
            }
         },
         "title": "Content",
         "type": "object"
      },
      "ExecutableCode": {
         "additionalProperties": false,
         "description": "Code generated by the model that is meant to be executed, and the result returned to the model.\n\nGenerated when using the [CodeExecution] tool, in which the code will be\nautomatically executed, and a corresponding [CodeExecutionResult] will also be\ngenerated.",
         "properties": {
            "code": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. The code to be executed.",
               "title": "Code"
            },
            "language": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/Language"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. Programming language of the `code`."
            }
         },
         "title": "ExecutableCode",
         "type": "object"
      },
      "File": {
         "additionalProperties": false,
         "description": "A file uploaded to the API.",
         "properties": {
            "name": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The `File` resource name. The ID (name excluding the \"files/\" prefix) can contain up to 40 characters that are lowercase alphanumeric or dashes (-). The ID cannot start or end with a dash. If the name is empty on create, a unique name will be generated. Example: `files/123-456`",
               "title": "Name"
            },
            "displayName": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. The human-readable display name for the `File`. The display name must be no more than 512 characters in length, including spaces. Example: 'Welcome Image'",
               "title": "Displayname"
            },
            "mimeType": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Output only. MIME type of the file.",
               "title": "Mimetype"
            },
            "sizeBytes": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Output only. Size of the file in bytes.",
               "title": "Sizebytes"
            },
            "createTime": {
               "anyOf": [
                  {
                     "format": "date-time",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Output only. The timestamp of when the `File` was created.",
               "title": "Createtime"
            },
            "expirationTime": {
               "anyOf": [
                  {
                     "format": "date-time",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Output only. The timestamp of when the `File` will be deleted. Only set if the `File` is scheduled to expire.",
               "title": "Expirationtime"
            },
            "updateTime": {
               "anyOf": [
                  {
                     "format": "date-time",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Output only. The timestamp of when the `File` was last updated.",
               "title": "Updatetime"
            },
            "sha256Hash": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Output only. SHA-256 hash of the uploaded bytes. The hash value is encoded in base64 format.",
               "title": "Sha256Hash"
            },
            "uri": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Output only. The URI of the `File`.",
               "title": "Uri"
            },
            "downloadUri": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Output only. The URI of the `File`, only set for downloadable (generated) files.",
               "title": "Downloaduri"
            },
            "state": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/FileState"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Output only. Processing state of the File."
            },
            "source": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/FileSource"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Output only. The source of the `File`."
            },
            "videoMetadata": {
               "anyOf": [
                  {
                     "additionalProperties": true,
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Output only. Metadata for a video.",
               "title": "Videometadata"
            },
            "error": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/FileStatus"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Output only. Error status if File processing failed."
            }
         },
         "title": "File",
         "type": "object"
      },
      "FileData": {
         "additionalProperties": false,
         "description": "URI based data.",
         "properties": {
            "displayName": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. It is not currently used in the Gemini GenerateContent calls.",
               "title": "Displayname"
            },
            "fileUri": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. URI.",
               "title": "Fileuri"
            },
            "mimeType": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. The IANA standard MIME type of the source data.",
               "title": "Mimetype"
            }
         },
         "title": "FileData",
         "type": "object"
      },
      "FileSource": {
         "description": "Source of the File.",
         "enum": [
            "SOURCE_UNSPECIFIED",
            "UPLOADED",
            "GENERATED"
         ],
         "title": "FileSource",
         "type": "string"
      },
      "FileState": {
         "description": "State for the lifecycle of a File.",
         "enum": [
            "STATE_UNSPECIFIED",
            "PROCESSING",
            "ACTIVE",
            "FAILED"
         ],
         "title": "FileState",
         "type": "string"
      },
      "FileStatus": {
         "additionalProperties": false,
         "description": "Status of a File that uses a common error model.",
         "properties": {
            "details": {
               "anyOf": [
                  {
                     "items": {
                        "additionalProperties": true,
                        "type": "object"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
               "title": "Details"
            },
            "message": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
               "title": "Message"
            },
            "code": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The status code. 0 for OK, 1 for CANCELLED",
               "title": "Code"
            }
         },
         "title": "FileStatus",
         "type": "object"
      },
      "FunctionCall": {
         "additionalProperties": false,
         "description": "A function call.",
         "properties": {
            "id": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The unique id of the function call. If populated, the client to execute the\n   `function_call` and return the response with the matching `id`.",
               "title": "Id"
            },
            "args": {
               "anyOf": [
                  {
                     "additionalProperties": true,
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.",
               "title": "Args"
            },
            "name": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. The name of the function to call. Matches [FunctionDeclaration.name].",
               "title": "Name"
            }
         },
         "title": "FunctionCall",
         "type": "object"
      },
      "FunctionResponse": {
         "additionalProperties": false,
         "description": "A function response.",
         "properties": {
            "willContinue": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Signals that function call continues, and more responses will be returned, turning the function call into a generator. Is only applicable to NON_BLOCKING function calls (see FunctionDeclaration.behavior for details), ignored otherwise. If false, the default, future responses will not be considered. Is only applicable to NON_BLOCKING function calls, is ignored otherwise. If set to false, future responses will not be considered. It is allowed to return empty `response` with `will_continue=False` to signal that the function call is finished.",
               "title": "Willcontinue"
            },
            "scheduling": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/FunctionResponseScheduling"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE."
            },
            "parts": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/FunctionResponsePart"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "List of parts that constitute a function response. Each part may\n      have a different IANA MIME type.",
               "title": "Parts"
            },
            "id": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`.",
               "title": "Id"
            },
            "name": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].",
               "title": "Name"
            },
            "response": {
               "anyOf": [
                  {
                     "additionalProperties": true,
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. The function response in JSON object format. Use \"output\" key to specify function output and \"error\" key to specify error details (if any). If \"output\" and \"error\" keys are not specified, then whole \"response\" is treated as function output.",
               "title": "Response"
            }
         },
         "title": "FunctionResponse",
         "type": "object"
      },
      "FunctionResponseBlob": {
         "additionalProperties": false,
         "description": "Raw media bytes for function response.\n\nText should not be sent as raw bytes, use the FunctionResponse.response\nfield.",
         "properties": {
            "mimeType": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. The IANA standard MIME type of the source data.",
               "title": "Mimetype"
            },
            "data": {
               "anyOf": [
                  {
                     "format": "base64url",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. Inline media bytes.",
               "title": "Data"
            }
         },
         "title": "FunctionResponseBlob",
         "type": "object"
      },
      "FunctionResponseFileData": {
         "additionalProperties": false,
         "description": "URI based data for function response.",
         "properties": {
            "fileUri": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. URI.",
               "title": "Fileuri"
            },
            "mimeType": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. The IANA standard MIME type of the source data.",
               "title": "Mimetype"
            }
         },
         "title": "FunctionResponseFileData",
         "type": "object"
      },
      "FunctionResponsePart": {
         "additionalProperties": false,
         "description": "A datatype containing media that is part of a `FunctionResponse` message.\n\nA `FunctionResponsePart` consists of data which has an associated datatype. A\n`FunctionResponsePart` can only contain one of the accepted types in\n`FunctionResponsePart.data`.\n\nA `FunctionResponsePart` must have a fixed IANA MIME type identifying the\ntype and subtype of the media if the `inline_data` field is filled with raw\nbytes.",
         "properties": {
            "inlineData": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/FunctionResponseBlob"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Inline media bytes."
            },
            "fileData": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/FunctionResponseFileData"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. URI based data."
            }
         },
         "title": "FunctionResponsePart",
         "type": "object"
      },
      "FunctionResponseScheduling": {
         "description": "Specifies how the response should be scheduled in the conversation.",
         "enum": [
            "SCHEDULING_UNSPECIFIED",
            "SILENT",
            "WHEN_IDLE",
            "INTERRUPT"
         ],
         "title": "FunctionResponseScheduling",
         "type": "string"
      },
      "Language": {
         "description": "Required. Programming language of the `code`.",
         "enum": [
            "LANGUAGE_UNSPECIFIED",
            "PYTHON"
         ],
         "title": "Language",
         "type": "string"
      },
      "Outcome": {
         "description": "Required. Outcome of the code execution.",
         "enum": [
            "OUTCOME_UNSPECIFIED",
            "OUTCOME_OK",
            "OUTCOME_FAILED",
            "OUTCOME_DEADLINE_EXCEEDED"
         ],
         "title": "Outcome",
         "type": "string"
      },
      "Part": {
         "additionalProperties": false,
         "description": "A datatype containing media content.\n\nExactly one field within a Part should be set, representing the specific type\nof content being conveyed. Using multiple fields within the same `Part`\ninstance is considered invalid.",
         "properties": {
            "videoMetadata": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/VideoMetadata"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Metadata for a given video."
            },
            "thought": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Indicates if the part is thought from the model.",
               "title": "Thought"
            },
            "inlineData": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/Blob"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Inlined bytes data."
            },
            "fileData": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/FileData"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. URI based data."
            },
            "thoughtSignature": {
               "anyOf": [
                  {
                     "format": "base64url",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "An opaque signature for the thought so it can be reused in subsequent requests.",
               "title": "Thoughtsignature"
            },
            "functionCall": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/FunctionCall"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "A predicted [FunctionCall] returned from the model that contains a string\n      representing the [FunctionDeclaration.name] and a structured JSON object\n      containing the parameters and their values."
            },
            "codeExecutionResult": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/CodeExecutionResult"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Result of executing the [ExecutableCode]."
            },
            "executableCode": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/ExecutableCode"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Code generated by the model that is meant to be executed."
            },
            "functionResponse": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/FunctionResponse"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model."
            },
            "text": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Text part (can be code).",
               "title": "Text"
            }
         },
         "title": "Part",
         "type": "object"
      },
      "VideoMetadata": {
         "additionalProperties": false,
         "description": "Describes how the video in the Part should be used by the model.",
         "properties": {
            "fps": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The frame rate of the video sent to the model. If not specified, the\n        default value will be 1.0. The fps range is (0.0, 24.0].",
               "title": "Fps"
            },
            "endOffset": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. The end offset of the video.",
               "title": "Endoffset"
            },
            "startOffset": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. The start offset of the video.",
               "title": "Startoffset"
            }
         },
         "title": "VideoMetadata",
         "type": "object"
      }
   },
   "additionalProperties": false,
   "required": [
      "name"
   ]
}

Fields:

• after_model_callback (Optional[AfterModelCallback])

• after_tool_callback (Optional[AfterToolCallback])

• before_model_callback (Optional[BeforeModelCallback])

• before_tool_callback (Optional[BeforeToolCallback])

• code_executor (Optional[BaseCodeExecutor])

• disallow_transfer_to_parent (bool)

• disallow_transfer_to_peers (bool)

• generate_content_config (Optional[types.GenerateContentConfig])

• global_instruction (Union[str, InstructionProvider])

• include_contents (Literal['default', 'none'])

• input_schema (Optional[type[BaseModel]])

• instruction (Union[str, InstructionProvider])

• model (Union[str, BaseLlm])

• on_model_error_callback (Optional[OnModelErrorCallback])

• on_tool_error_callback (Optional[OnToolErrorCallback])

• output_key (Optional[str])

• output_schema (Optional[type[BaseModel]])

• planner (Optional[BasePlanner])

• static_instruction (Optional[types.ContentUnion])

• tools (list[ToolUnion])

Validators:

• __model_validator_after » all fields

• validate_generate_content_config » generate_content_config

field after_model_callback: Optional[AfterModelCallback] = None

Callback or list of callbacks to be called after calling the LLM.

When a list of callbacks is provided, the callbacks will be called in the order they are listed until a callback does not return None.

Parameters:

• callback_context – CallbackContext,

• llm_response – LlmResponse, the actual model response.

Returns:

The content to return to the user. When present, the actual model response will be ignored and the provided content will be returned to user.

Validated by:

• __model_validator_after

field after_tool_callback: Optional[AfterToolCallback] = None

Callback or list of callbacks to be called after calling the tool.

When a list of callbacks is provided, the callbacks will be called in the order they are listed until a callback does not return None.

Parameters:

• tool – The tool to be called.

• args – The arguments to the tool.

• tool_context – ToolContext,

• tool_response – The response from the tool.

Returns:

When present, the returned dict will be used as tool result.

Validated by:

• __model_validator_after

field before_model_callback: Optional[BeforeModelCallback] = None

Callback or list of callbacks to be called before calling the LLM.

When a list of callbacks is provided, the callbacks will be called in the order they are listed until a callback does not return None.

Parameters:

• callback_context – CallbackContext,

• llm_request – LlmRequest, The raw model request. Callback can mutate the

• request.

Returns:

The content to return to the user. When present, the model call will be skipped and the provided content will be returned to user.

Validated by:

• __model_validator_after

field before_tool_callback: Optional[BeforeToolCallback] = None

Callback or list of callbacks to be called before calling the tool.

When a list of callbacks is provided, the callbacks will be called in the order they are listed until a callback does not return None.

Parameters:

• tool – The tool to be called.

• args – The arguments to the tool.

• tool_context – ToolContext,

Returns:

The tool response. When present, the returned tool response will be used and the framework will skip calling the actual tool.

Validated by:

• __model_validator_after

field code_executor: Optional[BaseCodeExecutor] = None

Allow agent to execute code blocks from model responses using the provided CodeExecutor.

Check out available code executions in google.adk.code_executor package.

Note

To use model’s built-in code executor, use the BuiltInCodeExecutor.

Validated by:

• __model_validator_after

field disallow_transfer_to_parent: bool = False

Disallows LLM-controlled transferring to the parent agent.

NOTE: Setting this as True also prevents this agent from continuing to reply to the end-user, and will transfer control back to the parent agent in the next turn. This behavior prevents one-way transfer, in which end-user may be stuck with one agent that cannot transfer to other agents in the agent tree.

Validated by:

• __model_validator_after

field disallow_transfer_to_peers: bool = False

Disallows LLM-controlled transferring to the peer agents.

Validated by:

• __model_validator_after

field generate_content_config: Optional[types.GenerateContentConfig] = None

The additional content generation configurations.

NOTE: not all fields are usable, e.g. tools must be configured via tools, thinking_config must be configured via planner in LlmAgent.

For example: use this config to adjust model temperature, configure safety settings, etc.

Validated by:

• __model_validator_after

• validate_generate_content_config

field global_instruction: Union[str, InstructionProvider] = ''

Instructions for all the agents in the entire agent tree.

DEPRECATED: This field is deprecated and will be removed in a future version. Use GlobalInstructionPlugin instead, which provides the same functionality at the App level. See migration guide for details.

ONLY the global_instruction in root agent will take effect.

For example: use global_instruction to make all agents have a stable identity or personality.

Validated by:

• __model_validator_after

field include_contents: Literal['default', 'none'] = 'default'

Controls content inclusion in model requests.

Options:

default: Model receives relevant conversation history none: Model receives no prior history, operates solely on current instruction and input

Validated by:

• __model_validator_after

field input_schema: Optional[type[BaseModel]] = None

The input schema when agent is used as a tool.

Validated by:

• __model_validator_after

field instruction: Union[str, InstructionProvider] = ''

Dynamic instructions for the LLM model, guiding the agent’s behavior.

These instructions can contain placeholders like {variable_name} that will be resolved at runtime using session state and context.

Behavior depends on static_instruction: - If static_instruction is None: instruction goes to system_instruction - If static_instruction is set: instruction goes to user content in the request

This allows for context caching optimization where static content (static_instruction) comes first in the prompt, followed by dynamic content (instruction).

Validated by:

• __model_validator_after

field model: Union[str, BaseLlm] = ''

The model to use for the agent.

When not set, the agent will inherit the model from its ancestor.

Validated by:

• __model_validator_after

field on_model_error_callback: Optional[OnModelErrorCallback] = None

Callback or list of callbacks to be called when a model call encounters an error.

When a list of callbacks is provided, the callbacks will be called in the order they are listed until a callback does not return None.

Parameters:

• callback_context – CallbackContext,

• llm_request – LlmRequest, The raw model request.

• error – The error from the model call.

Returns:

The content to return to the user. When present, the error will be ignored and the provided content will be returned to user.

Validated by:

• __model_validator_after

field on_tool_error_callback: Optional[OnToolErrorCallback] = None

Callback or list of callbacks to be called when a tool call encounters an error.

When a list of callbacks is provided, the callbacks will be called in the order they are listed until a callback does not return None.

Parameters:

• tool – The tool to be called.

• args – The arguments to the tool.

• tool_context – ToolContext,

• error – The error from the tool call.

Returns:

When present, the returned dict will be used as tool result.

Validated by:

• __model_validator_after

field output_key: Optional[str] = None

The key in session state to store the output of the agent.

Typically use cases: - Extracts agent reply for later use, such as in tools, callbacks, etc. - Connects agents to coordinate with each other.

Validated by:

• __model_validator_after

field output_schema: Optional[type[BaseModel]] = None

The output schema when agent replies.

Note

When this is set, agent can ONLY reply and CANNOT use any tools, such as function tools, RAGs, agent transfer, etc.

Validated by:

• __model_validator_after

field planner: Optional[BasePlanner] = None

Instructs the agent to make a plan and execute it step by step.

Note

To use model’s built-in thinking features, set the thinking_config field in google.adk.planners.built_in_planner.

Validated by:

• __model_validator_after

field static_instruction: Optional[types.ContentUnion] = None

Static instruction content sent literally as system instruction at the beginning.

This field is for content that never changes and doesn’t contain placeholders. It’s sent directly to the model without any processing or variable substitution.

This field is primarily for context caching optimization. Static instructions are sent as system instruction at the beginning of the request, allowing for improved performance when the static portion remains unchanged. Live API has its own cache mechanism, thus this field doesn’t work with Live API.

Impact on instruction field: - When static_instruction is None: instruction → system_instruction - When static_instruction is set: instruction → user content (after static content)

Context Caching: - Implicit Cache: Automatic caching by model providers (no config needed) - Explicit Cache: Cache explicitly created by user for instructions, tools and contents

See below for more information of Implicit Cache and Explicit Cache Gemini API: https://ai.google.dev/gemini-api/docs/caching?lang=python Vertex API: https://cloud.google.com/vertex-ai/generative-ai/docs/context-cache/context-cache-overview

Setting static_instruction alone does NOT enable caching automatically. For explicit caching control, configure context_cache_config at App level.

Content Support: Accepts types.ContentUnion which includes: - str: Simple text instruction - types.Content: Rich content object - types.Part: Single part (text, inline_data, file_data, etc.) - PIL.Image.Image: Image object - types.File: File reference - list[PartUnion]: List of parts

Examples: ```python # Simple string instruction static_instruction = “You are a helpful assistant.”

# Rich content with files static_instruction = types.Content(

role=’user’, parts=[

types.Part(text=’You are a helpful assistant.’), types.Part(file_data=types.FileData(…))

]

)

Validated by:

• __model_validator_after

field tools: list[ToolUnion] [Optional]

Tools available to this agent.

Validated by:

• __model_validator_after

config_type

alias of LlmAgentConfig

validator validate_generate_content_config  »  generate_content_config

Return type:

GenerateContentConfig

async canonical_global_instruction(ctx)

The resolved self.instruction field to construct global instruction.

This method is only for use by Agent Development Kit.

Return type:

tuple[str, bool]

Parameters:

ctx – The context to retrieve the session state.

Returns:

A tuple of (instruction, bypass_state_injection). instruction: The resolved self.global_instruction field. bypass_state_injection: Whether the instruction is based on InstructionProvider.

async canonical_instruction(ctx)

The resolved self.instruction field to construct instruction for this agent.

This method is only for use by Agent Development Kit.

Return type:

tuple[str, bool]

Parameters:

ctx – The context to retrieve the session state.

Returns:

A tuple of (instruction, bypass_state_injection). instruction: The resolved self.instruction field. bypass_state_injection: Whether the instruction is based on InstructionProvider.

async canonical_tools(ctx=None)

The resolved self.tools field as a list of BaseTool based on the context.

This method is only for use by Agent Development Kit.

Return type:

list[BaseTool]

property canonical_after_model_callbacks: list[Callable[[CallbackContext, LlmResponse], Awaitable[LlmResponse | None] | LlmResponse | None]]

The resolved self.after_model_callback field as a list of _SingleAfterModelCallback.

This method is only for use by Agent Development Kit.

property canonical_after_tool_callbacks: list[Callable[[BaseTool, dict[str, Any], ToolContext, dict], Awaitable[dict | None] | dict | None] | list[Callable[[BaseTool, dict[str, Any], ToolContext, dict], Awaitable[dict | None] | dict | None]]]

The resolved self.after_tool_callback field as a list of AfterToolCallback.

This method is only for use by Agent Development Kit.

property canonical_before_model_callbacks: list[Callable[[CallbackContext, LlmRequest], Awaitable[LlmResponse | None] | LlmResponse | None]]

The resolved self.before_model_callback field as a list of _SingleBeforeModelCallback.

This method is only for use by Agent Development Kit.

property canonical_before_tool_callbacks: list[Callable[[BaseTool, dict[str, Any], ToolContext], Awaitable[dict | None] | dict | None] | list[Callable[[BaseTool, dict[str, Any], ToolContext], Awaitable[dict | None] | dict | None]]]

The resolved self.before_tool_callback field as a list of BeforeToolCallback.

This method is only for use by Agent Development Kit.

property canonical_model: BaseLlm

The resolved self.model field as BaseLlm.

This method is only for use by Agent Development Kit.

property canonical_on_model_error_callbacks: list[Callable[[CallbackContext, LlmRequest, Exception], Awaitable[LlmResponse | None] | LlmResponse | None]]

The resolved self.on_model_error_callback field as a list of _SingleOnModelErrorCallback.

This method is only for use by Agent Development Kit.

property canonical_on_tool_error_callbacks: list[Callable[[BaseTool, dict[str, Any], ToolContext, Exception], Awaitable[dict | None] | dict | None] | list[Callable[[BaseTool, dict[str, Any], ToolContext, Exception], Awaitable[dict | None] | dict | None]]]

The resolved self.on_tool_error_callback field as a list of OnToolErrorCallback.

This method is only for use by Agent Development Kit.

pydantic model google.adk.agents.LoopAgent

Bases: BaseAgent

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

When sub-agent generates an event with escalate or max_iterations are reached, the loop agent will stop.

Show JSON schema

{
   "title": "LoopAgent",
   "description": "A shell agent that run its sub-agents in a loop.\n\nWhen sub-agent generates an event with escalate or max_iterations are\nreached, the loop agent will stop.",
   "type": "object",
   "properties": {
      "name": {
         "title": "Name",
         "type": "string"
      },
      "description": {
         "default": "",
         "title": "Description",
         "type": "string"
      },
      "parent_agent": {
         "anyOf": [
            {
               "$ref": "#/$defs/BaseAgent"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "sub_agents": {
         "items": {
            "$ref": "#/$defs/BaseAgent"
         },
         "title": "Sub Agents",
         "type": "array"
      },
      "before_agent_callback": {
         "default": null,
         "title": "Before Agent Callback",
         "type": "null"
      },
      "after_agent_callback": {
         "default": null,
         "title": "After Agent Callback",
         "type": "null"
      },
      "max_iterations": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Max Iterations"
      }
   },
   "$defs": {
      "BaseAgent": {
         "additionalProperties": false,
         "description": "Base class for all agents in Agent Development Kit.",
         "properties": {
            "name": {
               "title": "Name",
               "type": "string"
            },
            "description": {
               "default": "",
               "title": "Description",
               "type": "string"
            },
            "parent_agent": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/BaseAgent"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "sub_agents": {
               "items": {
                  "$ref": "#/$defs/BaseAgent"
               },
               "title": "Sub Agents",
               "type": "array"
            },
            "before_agent_callback": {
               "default": null,
               "title": "Before Agent Callback",
               "type": "null"
            },
            "after_agent_callback": {
               "default": null,
               "title": "After Agent Callback",
               "type": "null"
            }
         },
         "required": [
            "name"
         ],
         "title": "BaseAgent",
         "type": "object"
      }
   },
   "additionalProperties": false,
   "required": [
      "name"
   ]
}

Fields:

• max_iterations (Optional[int])

Validators:

field max_iterations: Optional[int] = None

The maximum number of iterations to run the loop agent.

If not set, the loop agent will run indefinitely until a sub-agent escalates.

config_type

alias of LoopAgentConfig

class google.adk.agents.McpInstructionProvider(connection_params, prompt_name, errlog=<_io.TextIOWrapper name='<stderr>' mode='w' encoding='utf-8'>)

Bases: Callable[[ReadonlyContext], str | Awaitable[str]]

Fetches agent instructions from an MCP server.

Initializes the McpInstructionProvider.

Parameters:

• connection_params – Parameters for connecting to the MCP server.

• prompt_name – The name of the MCP Prompt to fetch.

• errlog – TextIO stream for error logging.

pydantic model google.adk.agents.ParallelAgent

Bases: BaseAgent

A shell agent that runs its sub-agents in parallel in an isolated manner.

This approach is beneficial for scenarios requiring multiple perspectives or attempts on a single task, such as:

• Running different algorithms simultaneously.

• Generating multiple responses for review by a subsequent evaluation agent.

Show JSON schema

{
   "title": "ParallelAgent",
   "description": "A shell agent that runs its sub-agents in parallel in an isolated manner.\n\nThis approach is beneficial for scenarios requiring multiple perspectives or\nattempts on a single task, such as:\n\n- Running different algorithms simultaneously.\n- Generating multiple responses for review by a subsequent evaluation agent.",
   "type": "object",
   "properties": {
      "name": {
         "title": "Name",
         "type": "string"
      },
      "description": {
         "default": "",
         "title": "Description",
         "type": "string"
      },
      "parent_agent": {
         "anyOf": [
            {
               "$ref": "#/$defs/BaseAgent"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "sub_agents": {
         "items": {
            "$ref": "#/$defs/BaseAgent"
         },
         "title": "Sub Agents",
         "type": "array"
      },
      "before_agent_callback": {
         "default": null,
         "title": "Before Agent Callback",
         "type": "null"
      },
      "after_agent_callback": {
         "default": null,
         "title": "After Agent Callback",
         "type": "null"
      }
   },
   "$defs": {
      "BaseAgent": {
         "additionalProperties": false,
         "description": "Base class for all agents in Agent Development Kit.",
         "properties": {
            "name": {
               "title": "Name",
               "type": "string"
            },
            "description": {
               "default": "",
               "title": "Description",
               "type": "string"
            },
            "parent_agent": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/BaseAgent"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "sub_agents": {
               "items": {
                  "$ref": "#/$defs/BaseAgent"
               },
               "title": "Sub Agents",
               "type": "array"
            },
            "before_agent_callback": {
               "default": null,
               "title": "Before Agent Callback",
               "type": "null"
            },
            "after_agent_callback": {
               "default": null,
               "title": "After Agent Callback",
               "type": "null"
            }
         },
         "required": [
            "name"
         ],
         "title": "BaseAgent",
         "type": "object"
      }
   },
   "additionalProperties": false,
   "required": [
      "name"
   ]
}

Fields:

Validators:

config_type

alias of ParallelAgentConfig

pydantic model google.adk.agents.RunConfig

Bases: BaseModel

Configs for runtime behavior of agents.

The configs here will be overridden by agent-specific configurations.

Show JSON schema

{
   "title": "RunConfig",
   "description": "Configs for runtime behavior of agents.\n\nThe configs here will be overridden by agent-specific configurations.",
   "type": "object",
   "properties": {
      "speech_config": {
         "anyOf": [
            {
               "$ref": "#/$defs/SpeechConfig"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "response_modalities": {
         "anyOf": [
            {
               "items": {
                  "type": "string"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Response Modalities"
      },
      "save_input_blobs_as_artifacts": {
         "default": false,
         "deprecated": true,
         "description": "Whether or not to save the input blobs as artifacts. DEPRECATED: Use SaveFilesAsArtifactsPlugin instead for better control and flexibility. See google.adk.plugins.SaveFilesAsArtifactsPlugin.",
         "title": "Save Input Blobs As Artifacts",
         "type": "boolean"
      },
      "support_cfc": {
         "default": false,
         "title": "Support Cfc",
         "type": "boolean"
      },
      "streaming_mode": {
         "$ref": "#/$defs/StreamingMode",
         "default": null
      },
      "output_audio_transcription": {
         "anyOf": [
            {
               "$ref": "#/$defs/AudioTranscriptionConfig"
            },
            {
               "type": "null"
            }
         ]
      },
      "input_audio_transcription": {
         "anyOf": [
            {
               "$ref": "#/$defs/AudioTranscriptionConfig"
            },
            {
               "type": "null"
            }
         ]
      },
      "realtime_input_config": {
         "anyOf": [
            {
               "$ref": "#/$defs/RealtimeInputConfig"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "enable_affective_dialog": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Enable Affective Dialog"
      },
      "proactivity": {
         "anyOf": [
            {
               "$ref": "#/$defs/ProactivityConfig"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "session_resumption": {
         "anyOf": [
            {
               "$ref": "#/$defs/SessionResumptionConfig"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "context_window_compression": {
         "anyOf": [
            {
               "$ref": "#/$defs/ContextWindowCompressionConfig"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "save_live_blob": {
         "default": false,
         "title": "Save Live Blob",
         "type": "boolean"
      },
      "save_live_audio": {
         "default": false,
         "deprecated": true,
         "description": "DEPRECATED: Use save_live_blob instead. If set to True, it saves live video and audio data to session and artifact service.",
         "title": "Save Live Audio",
         "type": "boolean"
      },
      "max_llm_calls": {
         "default": 500,
         "title": "Max Llm Calls",
         "type": "integer"
      },
      "custom_metadata": {
         "anyOf": [
            {
               "additionalProperties": true,
               "type": "object"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Custom Metadata"
      }
   },
   "$defs": {
      "ActivityHandling": {
         "description": "The different ways of handling user activity.",
         "enum": [
            "ACTIVITY_HANDLING_UNSPECIFIED",
            "START_OF_ACTIVITY_INTERRUPTS",
            "NO_INTERRUPTION"
         ],
         "title": "ActivityHandling",
         "type": "string"
      },
      "AudioTranscriptionConfig": {
         "additionalProperties": false,
         "description": "The audio transcription configuration in Setup.",
         "properties": {},
         "title": "AudioTranscriptionConfig",
         "type": "object"
      },
      "AutomaticActivityDetection": {
         "additionalProperties": false,
         "description": "Configures automatic detection of activity.",
         "properties": {
            "disabled": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "If enabled, detected voice and text input count as activity. If disabled, the client must send activity signals.",
               "title": "Disabled"
            },
            "startOfSpeechSensitivity": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/StartSensitivity"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Determines how likely speech is to be detected."
            },
            "endOfSpeechSensitivity": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/EndSensitivity"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Determines how likely detected speech is ended."
            },
            "prefixPaddingMs": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The required duration of detected speech before start-of-speech is committed. The lower this value the more sensitive the start-of-speech detection is and the shorter speech can be recognized. However, this also increases the probability of false positives.",
               "title": "Prefixpaddingms"
            },
            "silenceDurationMs": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The required duration of detected non-speech (e.g. silence) before end-of-speech is committed. The larger this value, the longer speech gaps can be without interrupting the user's activity but this will increase the model's latency.",
               "title": "Silencedurationms"
            }
         },
         "title": "AutomaticActivityDetection",
         "type": "object"
      },
      "ContextWindowCompressionConfig": {
         "additionalProperties": false,
         "description": "Enables context window compression -- mechanism managing model context window so it does not exceed given length.",
         "properties": {
            "triggerTokens": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Number of tokens (before running turn) that triggers context window compression mechanism.",
               "title": "Triggertokens"
            },
            "slidingWindow": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/SlidingWindow"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Sliding window compression mechanism."
            }
         },
         "title": "ContextWindowCompressionConfig",
         "type": "object"
      },
      "EndSensitivity": {
         "description": "End of speech sensitivity.",
         "enum": [
            "END_SENSITIVITY_UNSPECIFIED",
            "END_SENSITIVITY_HIGH",
            "END_SENSITIVITY_LOW"
         ],
         "title": "EndSensitivity",
         "type": "string"
      },
      "MultiSpeakerVoiceConfig": {
         "additionalProperties": false,
         "description": "The configuration for the multi-speaker setup.",
         "properties": {
            "speakerVoiceConfigs": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/SpeakerVoiceConfig"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The configuration for the speaker to use.",
               "title": "Speakervoiceconfigs"
            }
         },
         "title": "MultiSpeakerVoiceConfig",
         "type": "object"
      },
      "PrebuiltVoiceConfig": {
         "additionalProperties": false,
         "description": "The configuration for the prebuilt speaker to use.",
         "properties": {
            "voiceName": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The name of the prebuilt voice to use.",
               "title": "Voicename"
            }
         },
         "title": "PrebuiltVoiceConfig",
         "type": "object"
      },
      "ProactivityConfig": {
         "additionalProperties": false,
         "description": "Config for proactivity features.",
         "properties": {
            "proactiveAudio": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "If enabled, the model can reject responding to the last prompt. For\n        example, this allows the model to ignore out of context speech or to stay\n        silent if the user did not make a request, yet.",
               "title": "Proactiveaudio"
            }
         },
         "title": "ProactivityConfig",
         "type": "object"
      },
      "RealtimeInputConfig": {
         "additionalProperties": false,
         "description": "Marks the end of user activity.\n\nThis can only be sent if automatic (i.e. server-side) activity detection is\ndisabled.",
         "properties": {
            "automaticActivityDetection": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/AutomaticActivityDetection"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "If not set, automatic activity detection is enabled by default. If automatic voice detection is disabled, the client must send activity signals."
            },
            "activityHandling": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/ActivityHandling"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Defines what effect activity has."
            },
            "turnCoverage": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/TurnCoverage"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Defines which input is included in the user's turn."
            }
         },
         "title": "RealtimeInputConfig",
         "type": "object"
      },
      "SessionResumptionConfig": {
         "additionalProperties": false,
         "description": "Configuration of session resumption mechanism.\n\nIncluded in `LiveConnectConfig.session_resumption`. If included server\nwill send `LiveServerSessionResumptionUpdate` messages.",
         "properties": {
            "handle": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Session resumption handle of previous session (session to restore).\n\nIf not present new session will be started.",
               "title": "Handle"
            },
            "transparent": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "If set the server will send `last_consumed_client_message_index` in the `session_resumption_update` messages to allow for transparent reconnections.",
               "title": "Transparent"
            }
         },
         "title": "SessionResumptionConfig",
         "type": "object"
      },
      "SlidingWindow": {
         "additionalProperties": false,
         "description": "Context window will be truncated by keeping only suffix of it.\n\nContext window will always be cut at start of USER role turn. System\ninstructions and `BidiGenerateContentSetup.prefix_turns` will not be\nsubject to the sliding window mechanism, they will always stay at the\nbeginning of context window.",
         "properties": {
            "targetTokens": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Session reduction target -- how many tokens we should keep. Window shortening operation has some latency costs, so we should avoid running it on every turn. Should be < trigger_tokens. If not set, trigger_tokens/2 is assumed.",
               "title": "Targettokens"
            }
         },
         "title": "SlidingWindow",
         "type": "object"
      },
      "SpeakerVoiceConfig": {
         "additionalProperties": false,
         "description": "The configuration for the speaker to use.",
         "properties": {
            "speaker": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The name of the speaker to use. Should be the same as in the\n          prompt.",
               "title": "Speaker"
            },
            "voiceConfig": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/VoiceConfig"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The configuration for the voice to use."
            }
         },
         "title": "SpeakerVoiceConfig",
         "type": "object"
      },
      "SpeechConfig": {
         "additionalProperties": false,
         "description": "The speech generation configuration.",
         "properties": {
            "voiceConfig": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/VoiceConfig"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The configuration for the speaker to use.\n      "
            },
            "multiSpeakerVoiceConfig": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/MultiSpeakerVoiceConfig"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The configuration for the multi-speaker setup.\n          It is mutually exclusive with the voice_config field.\n          "
            },
            "languageCode": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Language code (ISO 639. e.g. en-US) for the speech synthesization.\n      Only available for Live API.\n      ",
               "title": "Languagecode"
            }
         },
         "title": "SpeechConfig",
         "type": "object"
      },
      "StartSensitivity": {
         "description": "Start of speech sensitivity.",
         "enum": [
            "START_SENSITIVITY_UNSPECIFIED",
            "START_SENSITIVITY_HIGH",
            "START_SENSITIVITY_LOW"
         ],
         "title": "StartSensitivity",
         "type": "string"
      },
      "StreamingMode": {
         "enum": [
            null,
            "sse",
            "bidi"
         ],
         "title": "StreamingMode"
      },
      "TurnCoverage": {
         "description": "Options about which input is included in the user's turn.",
         "enum": [
            "TURN_COVERAGE_UNSPECIFIED",
            "TURN_INCLUDES_ONLY_ACTIVITY",
            "TURN_INCLUDES_ALL_INPUT"
         ],
         "title": "TurnCoverage",
         "type": "string"
      },
      "VoiceConfig": {
         "additionalProperties": false,
         "description": "The configuration for the voice to use.",
         "properties": {
            "prebuiltVoiceConfig": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/PrebuiltVoiceConfig"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The configuration for the speaker to use.\n      "
            }
         },
         "title": "VoiceConfig",
         "type": "object"
      }
   },
   "additionalProperties": false
}

Fields:

• context_window_compression (google.genai.types.ContextWindowCompressionConfig | None)

• custom_metadata (dict[str, Any] | None)

• enable_affective_dialog (bool | None)

• input_audio_transcription (google.genai.types.AudioTranscriptionConfig | None)

• max_llm_calls (int)

• output_audio_transcription (google.genai.types.AudioTranscriptionConfig | None)

• proactivity (google.genai.types.ProactivityConfig | None)

• realtime_input_config (google.genai.types.RealtimeInputConfig | None)

• response_modalities (list[str] | None)

• save_input_blobs_as_artifacts (bool)

• save_live_audio (bool)

• save_live_blob (bool)

• session_resumption (google.genai.types.SessionResumptionConfig | None)

• speech_config (google.genai.types.SpeechConfig | None)

• streaming_mode (google.adk.agents.run_config.StreamingMode)

• support_cfc (bool)

Validators:

• check_for_deprecated_save_live_audio » all fields

• validate_max_llm_calls » max_llm_calls

field context_window_compression: Optional[types.ContextWindowCompressionConfig] = None

Configuration for context window compression. If set, this will enable context window compression for LLM input.

Validated by:

• check_for_deprecated_save_live_audio

field custom_metadata: Optional[dict[str, Any]] = None

Custom metadata for the current invocation.

Validated by:

• check_for_deprecated_save_live_audio

field enable_affective_dialog: Optional[bool] = None

If enabled, the model will detect emotions and adapt its responses accordingly.

Validated by:

• check_for_deprecated_save_live_audio

field input_audio_transcription: Optional[types.AudioTranscriptionConfig] [Optional]

Input transcription for live agents with audio input from user.

Validated by:

• check_for_deprecated_save_live_audio

field max_llm_calls: int = 500

A limit on the total number of llm calls for a given run.

Valid Values:

• More than 0 and less than sys.maxsize: The bound on the number of llm calls is enforced, if the value is set in this range.

• Less than or equal to 0: This allows for unbounded number of llm calls.

Validated by:

• check_for_deprecated_save_live_audio

• validate_max_llm_calls

field output_audio_transcription: Optional[types.AudioTranscriptionConfig] [Optional]

Output transcription for live agents with audio response.

Validated by:

• check_for_deprecated_save_live_audio

field proactivity: Optional[types.ProactivityConfig] = None

Configures the proactivity of the model. This allows the model to respond proactively to the input and to ignore irrelevant input.

Validated by:

• check_for_deprecated_save_live_audio

field realtime_input_config: Optional[types.RealtimeInputConfig] = None

Realtime input config for live agents with audio input from user.

Validated by:

• check_for_deprecated_save_live_audio

field response_modalities: Optional[list[str]] = None

The output modalities. If not set, it’s default to AUDIO.

Validated by:

• check_for_deprecated_save_live_audio

field save_live_blob: bool = False

Saves live video and audio data to session and artifact service.

Validated by:

• check_for_deprecated_save_live_audio

field session_resumption: Optional[types.SessionResumptionConfig] = None

Configures session resumption mechanism. Only support transparent session resumption mode now.

Validated by:

• check_for_deprecated_save_live_audio

field speech_config: Optional[types.SpeechConfig] = None

Speech configuration for the live agent.

Validated by:

• check_for_deprecated_save_live_audio

field streaming_mode: StreamingMode = StreamingMode.NONE

Streaming mode, None or StreamingMode.SSE or StreamingMode.BIDI.

Validated by:

• check_for_deprecated_save_live_audio

field support_cfc: bool = False

Whether to support CFC (Compositional Function Calling). Only applicable for StreamingMode.SSE. If it’s true. the LIVE API will be invoked. Since only LIVE API supports CFC

Warning

This feature is experimental and its API or behavior may change in future releases.

Validated by:

• check_for_deprecated_save_live_audio

validator check_for_deprecated_save_live_audio  »  all fields

If save_live_audio is passed, use it to set save_live_blob.

Return type:

Any

validator validate_max_llm_calls  »  max_llm_calls

Return type:

int

save_input_blobs_as_artifacts: bool

Read-only data descriptor used to emit a runtime deprecation warning before accessing a deprecated field.

msg

The deprecation message to be emitted.

wrapped_property

The property instance if the deprecated field is a computed field, or None.

field_name

The name of the field being deprecated.

save_live_audio: bool

Read-only data descriptor used to emit a runtime deprecation warning before accessing a deprecated field.

msg

The deprecation message to be emitted.

wrapped_property

The property instance if the deprecated field is a computed field, or None.

field_name

The name of the field being deprecated.

pydantic model google.adk.agents.SequentialAgent

Bases: BaseAgent

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

Show JSON schema

{
   "title": "SequentialAgent",
   "description": "A shell agent that runs its sub-agents in sequence.",
   "type": "object",
   "properties": {
      "name": {
         "title": "Name",
         "type": "string"
      },
      "description": {
         "default": "",
         "title": "Description",
         "type": "string"
      },
      "parent_agent": {
         "anyOf": [
            {
               "$ref": "#/$defs/BaseAgent"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "sub_agents": {
         "items": {
            "$ref": "#/$defs/BaseAgent"
         },
         "title": "Sub Agents",
         "type": "array"
      },
      "before_agent_callback": {
         "default": null,
         "title": "Before Agent Callback",
         "type": "null"
      },
      "after_agent_callback": {
         "default": null,
         "title": "After Agent Callback",
         "type": "null"
      }
   },
   "$defs": {
      "BaseAgent": {
         "additionalProperties": false,
         "description": "Base class for all agents in Agent Development Kit.",
         "properties": {
            "name": {
               "title": "Name",
               "type": "string"
            },
            "description": {
               "default": "",
               "title": "Description",
               "type": "string"
            },
            "parent_agent": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/BaseAgent"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "sub_agents": {
               "items": {
                  "$ref": "#/$defs/BaseAgent"
               },
               "title": "Sub Agents",
               "type": "array"
            },
            "before_agent_callback": {
               "default": null,
               "title": "Before Agent Callback",
               "type": "null"
            },
            "after_agent_callback": {
               "default": null,
               "title": "After Agent Callback",
               "type": "null"
            }
         },
         "required": [
            "name"
         ],
         "title": "BaseAgent",
         "type": "object"
      }
   },
   "additionalProperties": false,
   "required": [
      "name"
   ]
}

Fields:

Validators:

config_type

alias of SequentialAgentConfig

google.adk.artifacts module

class google.adk.artifacts.BaseArtifactService

Bases: ABC

Abstract base class for artifact services.

abstractmethod async delete_artifact(*, app_name, user_id, filename, session_id=None)

Deletes an artifact.

Return type:

None

Parameters:

• app_name – The name of the application.

• user_id – The ID of the user.

• filename – The name of the artifact file.

• session_id – The ID of the session. If None, delete the user-scoped artifact.

abstractmethod async get_artifact_version(*, app_name, user_id, filename, session_id=None, version=None)

Gets the metadata for a specific version of an artifact.

Return type:

Optional[ArtifactVersion]

Parameters:

• app_name – The name of the application.

• user_id – The ID of the user.

• filename – The name of the artifact file.

• session_id – The ID of the session. If None, the artifact will be fetched from the user-scoped artifacts. Otherwise, it will be fetched from the specified session.

• version – The version number of the artifact to retrieve. If None, the latest version will be returned.

Returns:

An ArtifactVersion object containing the metadata of the specified artifact version, or None if the artifact version is not found.

abstractmethod async list_artifact_keys(*, app_name, user_id, session_id=None)

Lists all the artifact filenames within a session.

Return type:

list[str]

Parameters:

• app_name – The name of the application.

• user_id – The ID of the user.

• session_id – The ID of the session.

Returns:

A list of artifact filenames. If session_id is provided, returns both session-scoped and user-scoped artifact filenames. If session_id is None, returns user-scoped artifact filenames.

abstractmethod async list_artifact_versions(*, app_name, user_id, filename, session_id=None)

Lists all versions and their metadata for a specific artifact.

Return type:

list[ArtifactVersion]

Parameters:

• app_name – The name of the application.

• user_id – The ID of the user.

• filename – The name of the artifact file.

• session_id – The ID of the session. If None, lists versions of the user-scoped artifact. Otherwise, lists versions of the artifact within the specified session.

Returns:

A list of ArtifactVersion objects, each representing a version of the artifact and its associated metadata.

abstractmethod async list_versions(*, app_name, user_id, filename, session_id=None)

Lists all versions of an artifact.

Return type:

list[int]

Parameters:

• app_name – The name of the application.

• user_id – The ID of the user.

• filename – The name of the artifact file.

• session_id – The ID of the session. If None, only list the user-scoped artifacts versions.

Returns:

A list of all available versions of the artifact.

abstractmethod async load_artifact(*, app_name, user_id, filename, session_id=None, version=None)

Gets an artifact from the artifact service storage.

The artifact is a file identified by the app name, user ID, session ID, and filename.

Return type:

Optional[Part]

Parameters:

• app_name – The app name.

• user_id – The user ID.

• filename – The filename of the artifact.

• session_id – The session ID. If None, load the user-scoped artifact.

• version – The version of the artifact. If None, the latest version will be returned.

Returns:

The artifact or None if not found.

abstractmethod async save_artifact(*, app_name, user_id, filename, artifact, session_id=None, custom_metadata=None)

Saves an artifact to the artifact service storage.

The artifact is a file identified by the app name, user ID, session ID, and filename. After saving the artifact, a revision ID is returned to identify the artifact version.

Return type:

int

Parameters:

• app_name – The app name.

• user_id – The user ID.

• filename – The filename of the artifact.

• artifact – The artifact to save. If the artifact consists of file_data, the artifact service assumes its content has been uploaded separately, and this method will associate the file_data with the artifact if necessary.

• session_id – The session ID. If None, the artifact is user-scoped.

• custom_metadata – custom metadata to associate with the artifact.

Returns:

The revision ID. The first version of the artifact has a revision ID of 0. This is incremented by 1 after each successful save.

class google.adk.artifacts.FileArtifactService(root_dir)

Bases: BaseArtifactService

Stores filesystem-backed artifacts beneath a configurable root directory.

Initializes the file-based artifact service.

Parameters:

root_dir – The directory that will contain artifact data.

async delete_artifact(*, app_name, user_id, filename, session_id=None)

Deletes an artifact.

Return type:

None

Parameters:

• app_name – The name of the application.

• user_id – The ID of the user.

• filename – The name of the artifact file.

• session_id – The ID of the session. Leave unset for user-scoped artifacts.

async get_artifact_version(*, app_name, user_id, filename, session_id=None, version=None)

Gets metadata for a specific artifact version.

Return type:

Optional[ArtifactVersion]

async list_artifact_keys(*, app_name, user_id, session_id=None)

Lists all the artifact filenames within a session.

Return type:

list[str]

Parameters:

• app_name – The name of the application.

• user_id – The ID of the user.

• session_id – The ID of the session.

Returns:

A list of artifact filenames. If session_id is provided, returns both session-scoped and user-scoped artifact filenames. If session_id is None, returns user-scoped artifact filenames.

async list_artifact_versions(*, app_name, user_id, filename, session_id=None)

Lists metadata for each artifact version on disk.

Return type:

list[ArtifactVersion]

async list_versions(*, app_name, user_id, filename, session_id=None)

Lists all versions stored for an artifact.

Return type:

list[int]

async load_artifact(*, app_name, user_id, filename, session_id=None, version=None)

Gets an artifact from the artifact service storage.

The artifact is a file identified by the app name, user ID, session ID, and filename.

Return type:

Optional[Part]

Parameters:

• app_name – The app name.

• user_id – The user ID.

• filename – The filename of the artifact.

• session_id – The session ID. If None, load the user-scoped artifact.

• version – The version of the artifact. If None, the latest version will be returned.

Returns:

The artifact or None if not found.

async save_artifact(*, app_name, user_id, filename, artifact, session_id=None, custom_metadata=None)

Persists an artifact to disk.

Filenames may be simple ("report.txt"), nested ("images/photo.png"), or explicitly user-scoped ("user:shared/diagram.png"). All values are interpreted relative to the computed scope root; absolute paths or inputs that traverse outside that root (for example "../../secret.txt") raise ValueError.

Return type:

int

class google.adk.artifacts.GcsArtifactService(bucket_name, **kwargs)

Bases: BaseArtifactService

An artifact service implementation using Google Cloud Storage (GCS).

Initializes the GcsArtifactService.

Parameters:

• bucket_name – The name of the bucket to use.

• **kwargs – Keyword arguments to pass to the Google Cloud Storage client.

async delete_artifact(*, app_name, user_id, filename, session_id=None)

Deletes an artifact.

Return type:

None

Parameters:

• app_name – The name of the application.

• user_id – The ID of the user.

• filename – The name of the artifact file.

• session_id – The ID of the session. If None, delete the user-scoped artifact.

async get_artifact_version(*, app_name, user_id, filename, session_id=None, version=None)

Gets the metadata for a specific version of an artifact.

Return type:

Optional[ArtifactVersion]

Parameters:

• app_name – The name of the application.

• user_id – The ID of the user.

• filename – The name of the artifact file.

• session_id – The ID of the session. If None, the artifact will be fetched from the user-scoped artifacts. Otherwise, it will be fetched from the specified session.

• version – The version number of the artifact to retrieve. If None, the latest version will be returned.

Returns:

An ArtifactVersion object containing the metadata of the specified artifact version, or None if the artifact version is not found.

async list_artifact_keys(*, app_name, user_id, session_id=None)

Lists all the artifact filenames within a session.

Return type:

list[str]

Parameters:

• app_name – The name of the application.

• user_id – The ID of the user.

• session_id – The ID of the session.

Returns:

A list of artifact filenames. If session_id is provided, returns both session-scoped and user-scoped artifact filenames. If session_id is None, returns user-scoped artifact filenames.

async list_artifact_versions(*, app_name, user_id, filename, session_id=None)

Lists all versions and their metadata for a specific artifact.

Return type:

list[ArtifactVersion]

Parameters:

• app_name – The name of the application.

• user_id – The ID of the user.

• filename – The name of the artifact file.

• session_id – The ID of the session. If None, lists versions of the user-scoped artifact. Otherwise, lists versions of the artifact within the specified session.

Returns:

A list of ArtifactVersion objects, each representing a version of the artifact and its associated metadata.

async list_versions(*, app_name, user_id, filename, session_id=None)

Lists all versions of an artifact.

Return type:

list[int]

Parameters:

• app_name – The name of the application.

• user_id – The ID of the user.

• filename – The name of the artifact file.

• session_id – The ID of the session. If None, only list the user-scoped artifacts versions.

Returns:

A list of all available versions of the artifact.

async load_artifact(*, app_name, user_id, filename, session_id=None, version=None)

Gets an artifact from the artifact service storage.

The artifact is a file identified by the app name, user ID, session ID, and filename.

Return type:

Optional[Part]

Parameters:

• app_name – The app name.

• user_id – The user ID.

• filename – The filename of the artifact.

• session_id – The session ID. If None, load the user-scoped artifact.

• version – The version of the artifact. If None, the latest version will be returned.

Returns:

The artifact or None if not found.

async save_artifact(*, app_name, user_id, filename, artifact, session_id=None, custom_metadata=None)

Saves an artifact to the artifact service storage.

The artifact is a file identified by the app name, user ID, session ID, and filename. After saving the artifact, a revision ID is returned to identify the artifact version.

Return type:

int

Parameters:

• app_name – The app name.

• user_id – The user ID.

• filename – The filename of the artifact.

• artifact – The artifact to save. If the artifact consists of file_data, the artifact service assumes its content has been uploaded separately, and this method will associate the file_data with the artifact if necessary.

• session_id – The session ID. If None, the artifact is user-scoped.

• custom_metadata – custom metadata to associate with the artifact.

Returns:

The revision ID. The first version of the artifact has a revision ID of 0. This is incremented by 1 after each successful save.

pydantic model google.adk.artifacts.InMemoryArtifactService

Bases: BaseArtifactService, BaseModel

An in-memory implementation of the artifact service.

It is not suitable for multi-threaded production environments. Use it for testing and development only.

Show JSON schema

{
   "title": "InMemoryArtifactService",
   "description": "An in-memory implementation of the artifact service.\n\nIt is not suitable for multi-threaded production environments. Use it for\ntesting and development only.",
   "type": "object",
   "properties": {
      "artifacts": {
         "additionalProperties": {
            "items": {
               "$ref": "#/$defs/_ArtifactEntry"
            },
            "type": "array"
         },
         "title": "Artifacts",
         "type": "object"
      }
   },
   "$defs": {
      "ArtifactVersion": {
         "description": "Metadata describing a specific version of an artifact.",
         "properties": {
            "version": {
               "description": "Monotonically increasing identifier for the artifact version.",
               "title": "Version",
               "type": "integer"
            },
            "canonicalUri": {
               "description": "Canonical URI referencing the persisted artifact payload.",
               "title": "Canonicaluri",
               "type": "string"
            },
            "customMetadata": {
               "additionalProperties": true,
               "description": "Optional user-supplied metadata stored with the artifact.",
               "title": "Custommetadata",
               "type": "object"
            },
            "createTime": {
               "description": "Unix timestamp (seconds) when the version record was created.",
               "title": "Createtime",
               "type": "number"
            },
            "mimeType": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "MIME type when the artifact payload is stored as binary data.",
               "title": "Mimetype"
            }
         },
         "required": [
            "version",
            "canonicalUri"
         ],
         "title": "ArtifactVersion",
         "type": "object"
      },
      "Blob": {
         "additionalProperties": false,
         "description": "Content blob.",
         "properties": {
            "displayName": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is not currently used in the Gemini GenerateContent calls.",
               "title": "Displayname"
            },
            "data": {
               "anyOf": [
                  {
                     "format": "base64url",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. Raw bytes.",
               "title": "Data"
            },
            "mimeType": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. The IANA standard MIME type of the source data.",
               "title": "Mimetype"
            }
         },
         "title": "Blob",
         "type": "object"
      },
      "CodeExecutionResult": {
         "additionalProperties": false,
         "description": "Result of executing the [ExecutableCode].\n\nOnly generated when using the [CodeExecution] tool, and always follows a\n`part` containing the [ExecutableCode].",
         "properties": {
            "outcome": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/Outcome"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. Outcome of the code execution."
            },
            "output": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Contains stdout when code execution is successful, stderr or other description otherwise.",
               "title": "Output"
            }
         },
         "title": "CodeExecutionResult",
         "type": "object"
      },
      "ExecutableCode": {
         "additionalProperties": false,
         "description": "Code generated by the model that is meant to be executed, and the result returned to the model.\n\nGenerated when using the [CodeExecution] tool, in which the code will be\nautomatically executed, and a corresponding [CodeExecutionResult] will also be\ngenerated.",
         "properties": {
            "code": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. The code to be executed.",
               "title": "Code"
            },
            "language": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/Language"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. Programming language of the `code`."
            }
         },
         "title": "ExecutableCode",
         "type": "object"
      },
      "FileData": {
         "additionalProperties": false,
         "description": "URI based data.",
         "properties": {
            "displayName": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. It is not currently used in the Gemini GenerateContent calls.",
               "title": "Displayname"
            },
            "fileUri": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. URI.",
               "title": "Fileuri"
            },
            "mimeType": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. The IANA standard MIME type of the source data.",
               "title": "Mimetype"
            }
         },
         "title": "FileData",
         "type": "object"
      },
      "FunctionCall": {
         "additionalProperties": false,
         "description": "A function call.",
         "properties": {
            "id": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The unique id of the function call. If populated, the client to execute the\n   `function_call` and return the response with the matching `id`.",
               "title": "Id"
            },
            "args": {
               "anyOf": [
                  {
                     "additionalProperties": true,
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.",
               "title": "Args"
            },
            "name": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. The name of the function to call. Matches [FunctionDeclaration.name].",
               "title": "Name"
            }
         },
         "title": "FunctionCall",
         "type": "object"
      },
      "FunctionResponse": {
         "additionalProperties": false,
         "description": "A function response.",
         "properties": {
            "willContinue": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Signals that function call continues, and more responses will be returned, turning the function call into a generator. Is only applicable to NON_BLOCKING function calls (see FunctionDeclaration.behavior for details), ignored otherwise. If false, the default, future responses will not be considered. Is only applicable to NON_BLOCKING function calls, is ignored otherwise. If set to false, future responses will not be considered. It is allowed to return empty `response` with `will_continue=False` to signal that the function call is finished.",
               "title": "Willcontinue"
            },
            "scheduling": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/FunctionResponseScheduling"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE."
            },
            "parts": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/FunctionResponsePart"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "List of parts that constitute a function response. Each part may\n      have a different IANA MIME type.",
               "title": "Parts"
            },
            "id": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`.",
               "title": "Id"
            },
            "name": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].",
               "title": "Name"
            },
            "response": {
               "anyOf": [
                  {
                     "additionalProperties": true,
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. The function response in JSON object format. Use \"output\" key to specify function output and \"error\" key to specify error details (if any). If \"output\" and \"error\" keys are not specified, then whole \"response\" is treated as function output.",
               "title": "Response"
            }
         },
         "title": "FunctionResponse",
         "type": "object"
      },
      "FunctionResponseBlob": {
         "additionalProperties": false,
         "description": "Raw media bytes for function response.\n\nText should not be sent as raw bytes, use the FunctionResponse.response\nfield.",
         "properties": {
            "mimeType": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. The IANA standard MIME type of the source data.",
               "title": "Mimetype"
            },
            "data": {
               "anyOf": [
                  {
                     "format": "base64url",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. Inline media bytes.",
               "title": "Data"
            }
         },
         "title": "FunctionResponseBlob",
         "type": "object"
      },
      "FunctionResponseFileData": {
         "additionalProperties": false,
         "description": "URI based data for function response.",
         "properties": {
            "fileUri": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. URI.",
               "title": "Fileuri"
            },
            "mimeType": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. The IANA standard MIME type of the source data.",
               "title": "Mimetype"
            }
         },
         "title": "FunctionResponseFileData",
         "type": "object"
      },
      "FunctionResponsePart": {
         "additionalProperties": false,
         "description": "A datatype containing media that is part of a `FunctionResponse` message.\n\nA `FunctionResponsePart` consists of data which has an associated datatype. A\n`FunctionResponsePart` can only contain one of the accepted types in\n`FunctionResponsePart.data`.\n\nA `FunctionResponsePart` must have a fixed IANA MIME type identifying the\ntype and subtype of the media if the `inline_data` field is filled with raw\nbytes.",
         "properties": {
            "inlineData": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/FunctionResponseBlob"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Inline media bytes."
            },
            "fileData": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/FunctionResponseFileData"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. URI based data."
            }
         },
         "title": "FunctionResponsePart",
         "type": "object"
      },
      "FunctionResponseScheduling": {
         "description": "Specifies how the response should be scheduled in the conversation.",
         "enum": [
            "SCHEDULING_UNSPECIFIED",
            "SILENT",
            "WHEN_IDLE",
            "INTERRUPT"
         ],
         "title": "FunctionResponseScheduling",
         "type": "string"
      },
      "Language": {
         "description": "Required. Programming language of the `code`.",
         "enum": [
            "LANGUAGE_UNSPECIFIED",
            "PYTHON"
         ],
         "title": "Language",
         "type": "string"
      },
      "Outcome": {
         "description": "Required. Outcome of the code execution.",
         "enum": [
            "OUTCOME_UNSPECIFIED",
            "OUTCOME_OK",
            "OUTCOME_FAILED",
            "OUTCOME_DEADLINE_EXCEEDED"
         ],
         "title": "Outcome",
         "type": "string"
      },
      "Part": {
         "additionalProperties": false,
         "description": "A datatype containing media content.\n\nExactly one field within a Part should be set, representing the specific type\nof content being conveyed. Using multiple fields within the same `Part`\ninstance is considered invalid.",
         "properties": {
            "videoMetadata": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/VideoMetadata"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Metadata for a given video."
            },
            "thought": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Indicates if the part is thought from the model.",
               "title": "Thought"
            },
            "inlineData": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/Blob"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Inlined bytes data."
            },
            "fileData": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/FileData"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. URI based data."
            },
            "thoughtSignature": {
               "anyOf": [
                  {
                     "format": "base64url",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "An opaque signature for the thought so it can be reused in subsequent requests.",
               "title": "Thoughtsignature"
            },
            "functionCall": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/FunctionCall"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "A predicted [FunctionCall] returned from the model that contains a string\n      representing the [FunctionDeclaration.name] and a structured JSON object\n      containing the parameters and their values."
            },
            "codeExecutionResult": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/CodeExecutionResult"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Result of executing the [ExecutableCode]."
            },
            "executableCode": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/ExecutableCode"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Code generated by the model that is meant to be executed."
            },
            "functionResponse": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/FunctionResponse"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model."
            },
            "text": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Text part (can be code).",
               "title": "Text"
            }
         },
         "title": "Part",
         "type": "object"
      },
      "VideoMetadata": {
         "additionalProperties": false,
         "description": "Describes how the video in the Part should be used by the model.",
         "properties": {
            "fps": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The frame rate of the video sent to the model. If not specified, the\n        default value will be 1.0. The fps range is (0.0, 24.0].",
               "title": "Fps"
            },
            "endOffset": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. The end offset of the video.",
               "title": "Endoffset"
            },
            "startOffset": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. The start offset of the video.",
               "title": "Startoffset"
            }
         },
         "title": "VideoMetadata",
         "type": "object"
      },
      "_ArtifactEntry": {
         "properties": {
            "data": {
               "$ref": "#/$defs/Part"
            },
            "artifact_version": {
               "$ref": "#/$defs/ArtifactVersion"
            }
         },
         "required": [
            "data",
            "artifact_version"
         ],
         "title": "_ArtifactEntry",
         "type": "object"
      }
   }
}

Fields:

• artifacts (dict[str, list[google.adk.artifacts.in_memory_artifact_service._ArtifactEntry]])

field artifacts: dict[str, list[_ArtifactEntry]] [Optional]

async delete_artifact(*, app_name, user_id, filename, session_id=None)

Deletes an artifact.

Return type:

None

Parameters:

• app_name – The name of the application.

• user_id – The ID of the user.

• filename – The name of the artifact file.

• session_id – The ID of the session. If None, delete the user-scoped artifact.

async get_artifact_version(*, app_name, user_id, filename, session_id=None, version=None)

Gets the metadata for a specific version of an artifact.

Return type:

Optional[ArtifactVersion]

Parameters:

• app_name – The name of the application.

• user_id – The ID of the user.

• filename – The name of the artifact file.

• session_id – The ID of the session. If None, the artifact will be fetched from the user-scoped artifacts. Otherwise, it will be fetched from the specified session.

• version – The version number of the artifact to retrieve. If None, the latest version will be returned.

Returns:

An ArtifactVersion object containing the metadata of the specified artifact version, or None if the artifact version is not found.

async list_artifact_keys(*, app_name, user_id, session_id=None)

Lists all the artifact filenames within a session.

Return type:

list[str]

Parameters:

• app_name – The name of the application.

• user_id – The ID of the user.

• session_id – The ID of the session.

Returns:

A list of artifact filenames. If session_id is provided, returns both session-scoped and user-scoped artifact filenames. If session_id is None, returns user-scoped artifact filenames.

async list_artifact_versions(*, app_name, user_id, filename, session_id=None)

Lists all versions and their metadata for a specific artifact.

Return type:

list[ArtifactVersion]

Parameters:

• app_name – The name of the application.

• user_id – The ID of the user.

• filename – The name of the artifact file.

• session_id – The ID of the session. If None, lists versions of the user-scoped artifact. Otherwise, lists versions of the artifact within the specified session.

Returns:

A list of ArtifactVersion objects, each representing a version of the artifact and its associated metadata.

async list_versions(*, app_name, user_id, filename, session_id=None)

Lists all versions of an artifact.

Return type:

list[int]

Parameters:

• app_name – The name of the application.

• user_id – The ID of the user.

• filename – The name of the artifact file.

• session_id – The ID of the session. If None, only list the user-scoped artifacts versions.

Returns:

A list of all available versions of the artifact.

async load_artifact(*, app_name, user_id, filename, session_id=None, version=None)

Gets an artifact from the artifact service storage.

The artifact is a file identified by the app name, user ID, session ID, and filename.

Return type:

Optional[Part]

Parameters:

• app_name – The app name.

• user_id – The user ID.

• filename – The filename of the artifact.

• session_id – The session ID. If None, load the user-scoped artifact.

• version – The version of the artifact. If None, the latest version will be returned.

Returns:

The artifact or None if not found.

async save_artifact(*, app_name, user_id, filename, artifact, session_id=None, custom_metadata=None)

Saves an artifact to the artifact service storage.

The artifact is a file identified by the app name, user ID, session ID, and filename. After saving the artifact, a revision ID is returned to identify the artifact version.

Return type:

int

Parameters:

• app_name – The app name.

• user_id – The user ID.

• filename – The filename of the artifact.

• artifact – The artifact to save. If the artifact consists of file_data, the artifact service assumes its content has been uploaded separately, and this method will associate the file_data with the artifact if necessary.

• session_id – The session ID. If None, the artifact is user-scoped.

• custom_metadata – custom metadata to associate with the artifact.

Returns:

The revision ID. The first version of the artifact has a revision ID of 0. This is incremented by 1 after each successful save.

google.adk.apps package

pydantic model google.adk.apps.App

Bases: BaseModel

Represents an LLM-backed agentic application.

An App is the top-level container for an agentic system powered by LLMs. It manages a root agent (root_agent), which serves as the root of an agent tree, enabling coordination and communication across all agents in the hierarchy. The plugins are application-wide components that provide shared capabilities and services to the entire system.

Show JSON schema

{
   "title": "App",
   "type": "object",
   "properties": {
      "name": {
         "title": "Name",
         "type": "string"
      },
      "root_agent": {
         "$ref": "#/$defs/BaseAgent"
      },
      "plugins": {
         "default": null,
         "title": "Plugins"
      },
      "events_compaction_config": {
         "default": null,
         "title": "Events Compaction Config"
      },
      "context_cache_config": {
         "anyOf": [
            {
               "$ref": "#/$defs/ContextCacheConfig"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "resumability_config": {
         "anyOf": [
            {
               "$ref": "#/$defs/ResumabilityConfig"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      }
   },
   "$defs": {
      "BaseAgent": {
         "additionalProperties": false,
         "description": "Base class for all agents in Agent Development Kit.",
         "properties": {
            "name": {
               "title": "Name",
               "type": "string"
            },
            "description": {
               "default": "",
               "title": "Description",
               "type": "string"
            },
            "parent_agent": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/BaseAgent"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "sub_agents": {
               "items": {
                  "$ref": "#/$defs/BaseAgent"
               },
               "title": "Sub Agents",
               "type": "array"
            },
            "before_agent_callback": {
               "default": null,
               "title": "Before Agent Callback",
               "type": "null"
            },
            "after_agent_callback": {
               "default": null,
               "title": "After Agent Callback",
               "type": "null"
            }
         },
         "required": [
            "name"
         ],
         "title": "BaseAgent",
         "type": "object"
      },
      "ContextCacheConfig": {
         "additionalProperties": false,
         "description": "Configuration for context caching across all agents in an app.\n\nThis configuration enables and controls context caching behavior for\nall LLM agents in an app. When this config is present on an app, context\ncaching is enabled for all agents. When absent (None), context caching\nis disabled.\n\nContext caching can significantly reduce costs and improve response times\nby reusing previously processed context across multiple requests.\n\nAttributes:\n    cache_intervals: Maximum number of invocations to reuse the same cache before refreshing it\n    ttl_seconds: Time-to-live for cache in seconds\n    min_tokens: Minimum tokens required to enable caching",
         "properties": {
            "cache_intervals": {
               "default": 10,
               "description": "Maximum number of invocations to reuse the same cache before refreshing it",
               "maximum": 100,
               "minimum": 1,
               "title": "Cache Intervals",
               "type": "integer"
            },
            "ttl_seconds": {
               "default": 1800,
               "description": "Time-to-live for cache in seconds",
               "exclusiveMinimum": 0,
               "title": "Ttl Seconds",
               "type": "integer"
            },
            "min_tokens": {
               "default": 0,
               "description": "Minimum estimated request tokens required to enable caching. This compares against the estimated total tokens of the request (system instruction + tools + contents). Context cache storage may have cost. Set higher to avoid caching small requests where overhead may exceed benefits.",
               "minimum": 0,
               "title": "Min Tokens",
               "type": "integer"
            }
         },
         "title": "ContextCacheConfig",
         "type": "object"
      },
      "ResumabilityConfig": {
         "description": "The config of the resumability for an application.\n\nThe \"resumability\" in ADK refers to the ability to:\n1. pause an invocation upon a long running function call.\n2. resume an invocation from the last event, if it's paused or failed midway\nthrough.\n\nNote: ADK resumes the invocation in a best-effort manner:\n1. Tool call to resume needs to be idempotent because we only guarantee\nan at-least-once behavior once resumed.\n2. Any temporary / in-memory state will be lost upon resumption.",
         "properties": {
            "is_resumable": {
               "default": false,
               "title": "Is Resumable",
               "type": "boolean"
            }
         },
         "title": "ResumabilityConfig",
         "type": "object"
      }
   },
   "additionalProperties": false,
   "required": [
      "name",
      "root_agent"
   ]
}

Fields:

• context_cache_config (google.adk.agents.context_cache_config.ContextCacheConfig | None)

• events_compaction_config (google.adk.apps.app.EventsCompactionConfig | None)

• name (str)

• plugins (list[google.adk.plugins.base_plugin.BasePlugin])

• resumability_config (google.adk.apps.app.ResumabilityConfig | None)

• root_agent (google.adk.agents.base_agent.BaseAgent)

Validators:

• _validate_name » all fields

field context_cache_config: Optional[ContextCacheConfig] = None

Context cache configuration that applies to all LLM agents in the app.

Validated by:

• _validate_name

field events_compaction_config: Optional[EventsCompactionConfig] = None

The config of event compaction for the application.

Validated by:

• _validate_name

field name: str [Required]

The name of the application.

Validated by:

• _validate_name

field plugins: list[BasePlugin] [Optional]

The plugins in the application.

Validated by:

• _validate_name

field resumability_config: Optional[ResumabilityConfig] = None

The config of the resumability for the application. If configured, will be applied to all agents in the app.

Validated by:

• _validate_name

field root_agent: BaseAgent [Required]

The root agent in the application. One app can only have one root agent.

Validated by:

• _validate_name

pydantic model google.adk.apps.ResumabilityConfig

Bases: BaseModel

The config of the resumability for an application.

The “resumability” in ADK refers to the ability to: 1. pause an invocation upon a long running function call. 2. resume an invocation from the last event, if it’s paused or failed midway through.

Note: ADK resumes the invocation in a best-effort manner: 1. Tool call to resume needs to be idempotent because we only guarantee an at-least-once behavior once resumed. 2. Any temporary / in-memory state will be lost upon resumption.

Show JSON schema

{
   "title": "ResumabilityConfig",
   "description": "The config of the resumability for an application.\n\nThe \"resumability\" in ADK refers to the ability to:\n1. pause an invocation upon a long running function call.\n2. resume an invocation from the last event, if it's paused or failed midway\nthrough.\n\nNote: ADK resumes the invocation in a best-effort manner:\n1. Tool call to resume needs to be idempotent because we only guarantee\nan at-least-once behavior once resumed.\n2. Any temporary / in-memory state will be lost upon resumption.",
   "type": "object",
   "properties": {
      "is_resumable": {
         "default": false,
         "title": "Is Resumable",
         "type": "boolean"
      }
   }
}

Fields:

• is_resumable (bool)

field is_resumable: bool = False

Whether the app supports agent resumption. If enabled, the feature will be enabled for all agents in the app.

google.adk.auth module

google.adk.cli module

google.adk.code_executors module

pydantic model google.adk.code_executors.BaseCodeExecutor

Bases: BaseModel

Abstract base class for all code executors.

The code executor allows the agent to execute code blocks from model responses and incorporate the execution results into the final response.

optimize_data_file

If true, extract and process data files from the model request and attach them to the code executor. Supported data file MimeTypes are [text/csv]. Default to False.

stateful

Whether the code executor is stateful. Default to False.

error_retry_attempts

The number of attempts to retry on consecutive code execution errors. Default to 2.

code_block_delimiters

The list of the enclosing delimiters to identify the code blocks.

execution_result_delimiters

The delimiters to format the code execution result.

Show JSON schema

{
   "title": "BaseCodeExecutor",
   "description": "Abstract base class for all code executors.\n\nThe code executor allows the agent to execute code blocks from model responses\nand incorporate the execution results into the final response.\n\nAttributes:\n  optimize_data_file: If true, extract and process data files from the model\n    request and attach them to the code executor. Supported data file\n    MimeTypes are [text/csv]. Default to False.\n  stateful: Whether the code executor is stateful. Default to False.\n  error_retry_attempts: The number of attempts to retry on consecutive code\n    execution errors. Default to 2.\n  code_block_delimiters: The list of the enclosing delimiters to identify the\n    code blocks.\n  execution_result_delimiters: The delimiters to format the code execution\n    result.",
   "type": "object",
   "properties": {
      "optimize_data_file": {
         "default": false,
         "title": "Optimize Data File",
         "type": "boolean"
      },
      "stateful": {
         "default": false,
         "title": "Stateful",
         "type": "boolean"
      },
      "error_retry_attempts": {
         "default": 2,
         "title": "Error Retry Attempts",
         "type": "integer"
      },
      "code_block_delimiters": {
         "default": [
            [
               "```tool_code\n",
               "\n```"
            ],
            [
               "```python\n",
               "\n```"
            ]
         ],
         "items": {
            "maxItems": 2,
            "minItems": 2,
            "prefixItems": [
               {
                  "type": "string"
               },
               {
                  "type": "string"
               }
            ],
            "type": "array"
         },
         "title": "Code Block Delimiters",
         "type": "array"
      },
      "execution_result_delimiters": {
         "default": [
            "```tool_output\n",
            "\n```"
         ],
         "maxItems": 2,
         "minItems": 2,
         "prefixItems": [
            {
               "type": "string"
            },
            {
               "type": "string"
            }
         ],
         "title": "Execution Result Delimiters",
         "type": "array"
      }
   }
}

Fields:

• code_block_delimiters (List[tuple[str, str]])

• error_retry_attempts (int)

• execution_result_delimiters (tuple[str, str])

• optimize_data_file (bool)

• stateful (bool)

field code_block_delimiters: List[tuple[str, str]] = [('```tool_code\n', '\n```'), ('```python\n', '\n```')]

The list of the enclosing delimiters to identify the code blocks.

For example, the delimiter (’`python\n', '\n`’) can be used to identify code blocks with the following format:

```python
print("hello")
```

field error_retry_attempts: int = 2

The number of attempts to retry on consecutive code execution errors. Default to 2.

field execution_result_delimiters: tuple[str, str] = ('```tool_output\n', '\n```')

The delimiters to format the code execution result.

field optimize_data_file: bool = False

If true, extract and process data files from the model request and attach them to the code executor.

Supported data file MimeTypes are [text/csv]. Default to False.

field stateful: bool = False

Whether the code executor is stateful. Default to False.

abstractmethod execute_code(invocation_context, code_execution_input)

Executes code and return the code execution result.

Return type:

CodeExecutionResult

Parameters:

• invocation_context – The invocation context of the code execution.

• code_execution_input – The code execution input.

Returns:

The code execution result.

pydantic model google.adk.code_executors.BuiltInCodeExecutor

Bases: BaseCodeExecutor

A code executor that uses the Model’s built-in code executor.

Currently only supports Gemini 2.0+ models, but will be expanded to other models.

Show JSON schema

{
   "title": "BuiltInCodeExecutor",
   "description": "A code executor that uses the Model's built-in code executor.\n\nCurrently only supports Gemini 2.0+ models, but will be expanded to\nother models.",
   "type": "object",
   "properties": {
      "optimize_data_file": {
         "default": false,
         "title": "Optimize Data File",
         "type": "boolean"
      },
      "stateful": {
         "default": false,
         "title": "Stateful",
         "type": "boolean"
      },
      "error_retry_attempts": {
         "default": 2,
         "title": "Error Retry Attempts",
         "type": "integer"
      },
      "code_block_delimiters": {
         "default": [
            [
               "```tool_code\n",
               "\n```"
            ],
            [
               "```python\n",
               "\n```"
            ]
         ],
         "items": {
            "maxItems": 2,
            "minItems": 2,
            "prefixItems": [
               {
                  "type": "string"
               },
               {
                  "type": "string"
               }
            ],
            "type": "array"
         },
         "title": "Code Block Delimiters",
         "type": "array"
      },
      "execution_result_delimiters": {
         "default": [
            "```tool_output\n",
            "\n```"
         ],
         "maxItems": 2,
         "minItems": 2,
         "prefixItems": [
            {
               "type": "string"
            },
            {
               "type": "string"
            }
         ],
         "title": "Execution Result Delimiters",
         "type": "array"
      }
   }
}

Fields:

execute_code(invocation_context, code_execution_input)

Executes code and return the code execution result.

Return type:

CodeExecutionResult

Parameters:

• invocation_context – The invocation context of the code execution.

• code_execution_input – The code execution input.

Returns:

The code execution result.

process_llm_request(llm_request)

Pre-process the LLM request for Gemini 2.0+ models to use the code execution tool.

Return type:

None

class google.adk.code_executors.CodeExecutorContext(session_state)

Bases: object

The persistent context used to configure the code executor.

Initializes the code executor context.

Parameters:

session_state – The session state to get the code executor context from.

add_input_files(input_files)

Adds the input files to the code executor context.

Parameters:

input_files – The input files to add to the code executor context.

add_processed_file_names(file_names)

Adds the processed file name to the session state.

Parameters:

file_names – The processed file names to add to the session state.

clear_input_files()

Removes the input files and processed file names to the code executor context.

get_error_count(invocation_id)

Gets the error count from the session state.

Return type:

int

Parameters:

invocation_id – The invocation ID to get the error count for.

Returns:

The error count for the given invocation ID.

get_execution_id()

Gets the session ID for the code executor.

Return type:

Optional[str]

Returns:

The session ID for the code executor context.

get_input_files()

Gets the code executor input file names from the session state.

Return type:

list[File]

Returns:

A list of input files in the code executor context.

get_processed_file_names()

Gets the processed file names from the session state.

Return type:

list[str]

Returns:

A list of processed file names in the code executor context.

get_state_delta()

Gets the state delta to update in the persistent session state.

Return type:

dict[str, Any]

Returns:

The state delta to update in the persistent session state.

increment_error_count(invocation_id)

Increments the error count from the session state.

Parameters:

invocation_id – The invocation ID to increment the error count for.

reset_error_count(invocation_id)

Resets the error count from the session state.

Parameters:

invocation_id – The invocation ID to reset the error count for.

set_execution_id(session_id)

Sets the session ID for the code executor.

Parameters:

session_id – The session ID for the code executor.

update_code_execution_result(invocation_id, code, result_stdout, result_stderr)

Updates the code execution result.

Parameters:

• invocation_id – The invocation ID to update the code execution result for.

• code – The code to execute.

• result_stdout – The standard output of the code execution.

• result_stderr – The standard error of the code execution.

pydantic model google.adk.code_executors.UnsafeLocalCodeExecutor

Bases: BaseCodeExecutor

A code executor that unsafely execute code in the current local context.

Initializes the UnsafeLocalCodeExecutor.

Show JSON schema

{
   "title": "UnsafeLocalCodeExecutor",
   "description": "A code executor that unsafely execute code in the current local context.",
   "type": "object",
   "properties": {
      "optimize_data_file": {
         "default": false,
         "title": "Optimize Data File",
         "type": "boolean"
      },
      "stateful": {
         "default": false,
         "title": "Stateful",
         "type": "boolean"
      },
      "error_retry_attempts": {
         "default": 2,
         "title": "Error Retry Attempts",
         "type": "integer"
      },
      "code_block_delimiters": {
         "default": [
            [
               "```tool_code\n",
               "\n```"
            ],
            [
               "```python\n",
               "\n```"
            ]
         ],
         "items": {
            "maxItems": 2,
            "minItems": 2,
            "prefixItems": [
               {
                  "type": "string"
               },
               {
                  "type": "string"
               }
            ],
            "type": "array"
         },
         "title": "Code Block Delimiters",
         "type": "array"
      },
      "execution_result_delimiters": {
         "default": [
            "```tool_output\n",
            "\n```"
         ],
         "maxItems": 2,
         "minItems": 2,
         "prefixItems": [
            {
               "type": "string"
            },
            {
               "type": "string"
            }
         ],
         "title": "Execution Result Delimiters",
         "type": "array"
      }
   }
}

Fields:

• optimize_data_file (bool)

• stateful (bool)

field optimize_data_file: bool = False

If true, extract and process data files from the model request and attach them to the code executor.

Supported data file MimeTypes are [text/csv]. Default to False.

field stateful: bool = False

Whether the code executor is stateful. Default to False.

execute_code(invocation_context, code_execution_input)

Executes code and return the code execution result.

Return type:

CodeExecutionResult

Parameters:

• invocation_context – The invocation context of the code execution.

• code_execution_input – The code execution input.

Returns:

The code execution result.

google.adk.errors module

google.adk.evaluation module

class google.adk.evaluation.AgentEvaluator

Bases: object

An evaluator for Agents, mainly intended for helping with test cases.

async static evaluate(agent_module, eval_dataset_file_path_or_dir, num_runs=2, agent_name=None, initial_session_file=None, print_detailed_results=True)

Evaluates an Agent given eval data.

Parameters:

• agent_module – The path to python module that contains the definition of the agent. There is convention in place here, where the code is going to look for ‘root_agent’ or ‘get_agent_async’ in the loaded module.

• eval_dataset_file_path_or_dir – The eval data set. This can be either a string representing full path to the file containing eval dataset, or a directory that is recursively explored for all files that have a .test.json suffix.

• num_runs – Number of times all entries in the eval dataset should be assessed.

• agent_name – The name of the agent.

• initial_session_file – File that contains initial session state that is needed by all the evals in the eval dataset.

• print_detailed_results – Whether to print detailed results for each metric evaluation.

async static evaluate_eval_set(agent_module, eval_set, criteria=None, eval_config=None, num_runs=2, agent_name=None, print_detailed_results=True)

Evaluates an agent using the given EvalSet.

Parameters:

• agent_module – The path to python module that contains the definition of the agent. There is convention in place here, where the code is going to look for ‘root_agent’ or get_agent_async in the loaded module.

• eval_set – The eval set.

• criteria – Evaluation criteria, a dictionary of metric names to their respective thresholds. This field is deprecated.

• eval_config – The evaluation config.

• num_runs – Number of times all entries in the eval dataset should be assessed.

• agent_name – The name of the agent, if trying to evaluate something other than root agent. If left empty or none, then root agent is evaluated.

• print_detailed_results – Whether to print detailed results for each metric evaluation.

static find_config_for_test_file(test_file)

Find the test_config.json file in the same folder as the test file.

Return type:

EvalConfig

static migrate_eval_data_to_new_schema(old_eval_data_file, new_eval_data_file, initial_session_file=None)

A utility for migrating eval data to new schema backed by EvalSet.

google.adk.events module

pydantic model google.adk.events.Event

Bases: LlmResponse

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.

Show JSON schema

{
   "title": "Event",
   "description": "Represents an event in a conversation between agents and users.\n\nIt is used to store the content of the conversation, as well as the actions\ntaken by the agents like function calls, etc.",
   "type": "object",
   "properties": {
      "modelVersion": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Modelversion"
      },
      "content": {
         "anyOf": [
            {
               "$ref": "#/$defs/Content"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "groundingMetadata": {
         "anyOf": [
            {
               "$ref": "#/$defs/GroundingMetadata"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "partial": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Partial"
      },
      "turnComplete": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Turncomplete"
      },
      "finishReason": {
         "anyOf": [
            {
               "$ref": "#/$defs/FinishReason"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "errorCode": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Errorcode"
      },
      "errorMessage": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Errormessage"
      },
      "interrupted": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Interrupted"
      },
      "customMetadata": {
         "anyOf": [
            {
               "additionalProperties": true,
               "type": "object"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Custommetadata"
      },
      "usageMetadata": {
         "anyOf": [
            {
               "$ref": "#/$defs/GenerateContentResponseUsageMetadata"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "liveSessionResumptionUpdate": {
         "anyOf": [
            {
               "$ref": "#/$defs/LiveServerSessionResumptionUpdate"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "inputTranscription": {
         "anyOf": [
            {
               "$ref": "#/$defs/Transcription"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "outputTranscription": {
         "anyOf": [
            {
               "$ref": "#/$defs/Transcription"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "avgLogprobs": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Avglogprobs"
      },
      "logprobsResult": {
         "anyOf": [
            {
               "$ref": "#/$defs/LogprobsResult"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "cacheMetadata": {
         "anyOf": [
            {
               "$ref": "#/$defs/CacheMetadata"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "citationMetadata": {
         "anyOf": [
            {
               "$ref": "#/$defs/CitationMetadata"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "invocationId": {
         "default": "",
         "title": "Invocationid",
         "type": "string"
      },
      "author": {
         "title": "Author",
         "type": "string"
      },
      "actions": {
         "$ref": "#/$defs/EventActions"
      },
      "longRunningToolIds": {
         "anyOf": [
            {
               "items": {
                  "type": "string"
               },
               "type": "array",
               "uniqueItems": true
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Longrunningtoolids"
      },
      "branch": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Branch"
      },
      "id": {
         "default": "",
         "title": "Id",
         "type": "string"
      },
      "timestamp": {
         "title": "Timestamp",
         "type": "number"
      }
   },
   "$defs": {
      "APIKey": {
         "additionalProperties": true,
         "properties": {
            "type": {
               "$ref": "#/$defs/SecuritySchemeType",
               "default": "apiKey"
            },
            "description": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Description"
            },
            "in": {
               "$ref": "#/$defs/APIKeyIn"
            },
            "name": {
               "title": "Name",
               "type": "string"
            }
         },
         "required": [
            "in",
            "name"
         ],
         "title": "APIKey",
         "type": "object"
      },
      "APIKeyIn": {
         "enum": [
            "query",
            "header",
            "cookie"
         ],
         "title": "APIKeyIn",
         "type": "string"
      },
      "AuthConfig": {
         "additionalProperties": true,
         "description": "The auth config sent by tool asking client to collect auth credentials and\n\nadk and client will help to fill in the response",
         "properties": {
            "authScheme": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/APIKey"
                  },
                  {
                     "$ref": "#/$defs/HTTPBase"
                  },
                  {
                     "$ref": "#/$defs/OAuth2"
                  },
                  {
                     "$ref": "#/$defs/OpenIdConnect"
                  },
                  {
                     "$ref": "#/$defs/HTTPBearer"
                  },
                  {
                     "$ref": "#/$defs/OpenIdConnectWithConfig"
                  }
               ],
               "title": "Authscheme"
            },
            "rawAuthCredential": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/AuthCredential"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "exchangedAuthCredential": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/AuthCredential"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "credentialKey": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Credentialkey"
            }
         },
         "required": [
            "authScheme"
         ],
         "title": "AuthConfig",
         "type": "object"
      },
      "AuthCredential": {
         "additionalProperties": true,
         "description": "Data class representing an authentication credential.\n\nTo exchange for the actual credential, please use\nCredentialExchanger.exchange_credential().\n\nExamples: API Key Auth\nAuthCredential(\n    auth_type=AuthCredentialTypes.API_KEY,\n    api_key=\"1234\",\n)\n\nExample: HTTP Auth\nAuthCredential(\n    auth_type=AuthCredentialTypes.HTTP,\n    http=HttpAuth(\n        scheme=\"basic\",\n        credentials=HttpCredentials(username=\"user\", password=\"password\"),\n    ),\n)\n\nExample: OAuth2 Bearer Token in HTTP Header\nAuthCredential(\n    auth_type=AuthCredentialTypes.HTTP,\n    http=HttpAuth(\n        scheme=\"bearer\",\n        credentials=HttpCredentials(token=\"eyAkaknabna....\"),\n    ),\n)\n\nExample: OAuth2 Auth with Authorization Code Flow\nAuthCredential(\n    auth_type=AuthCredentialTypes.OAUTH2,\n    oauth2=OAuth2Auth(\n        client_id=\"1234\",\n        client_secret=\"secret\",\n    ),\n)\n\nExample: OpenID Connect Auth\nAuthCredential(\n    auth_type=AuthCredentialTypes.OPEN_ID_CONNECT,\n    oauth2=OAuth2Auth(\n        client_id=\"1234\",\n        client_secret=\"secret\",\n        redirect_uri=\"https://example.com\",\n        scopes=[\"scope1\", \"scope2\"],\n    ),\n)\n\nExample: Auth with resource reference\nAuthCredential(\n    auth_type=AuthCredentialTypes.API_KEY,\n    resource_ref=\"projects/1234/locations/us-central1/resources/resource1\",\n)",
         "properties": {
            "authType": {
               "$ref": "#/$defs/AuthCredentialTypes"
            },
            "resourceRef": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Resourceref"
            },
            "apiKey": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Apikey"
            },
            "http": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/HttpAuth"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "serviceAccount": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/ServiceAccount"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "oauth2": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/OAuth2Auth"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            }
         },
         "required": [
            "authType"
         ],
         "title": "AuthCredential",
         "type": "object"
      },
      "AuthCredentialTypes": {
         "description": "Represents the type of authentication credential.",
         "enum": [
            "apiKey",
            "http",
            "oauth2",
            "openIdConnect",
            "serviceAccount"
         ],
         "title": "AuthCredentialTypes",
         "type": "string"
      },
      "Blob": {
         "additionalProperties": false,
         "description": "Content blob.",
         "properties": {
            "displayName": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is not currently used in the Gemini GenerateContent calls.",
               "title": "Displayname"
            },
            "data": {
               "anyOf": [
                  {
                     "format": "base64url",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. Raw bytes.",
               "title": "Data"
            },
            "mimeType": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. The IANA standard MIME type of the source data.",
               "title": "Mimetype"
            }
         },
         "title": "Blob",
         "type": "object"
      },
      "CacheMetadata": {
         "additionalProperties": false,
         "description": "Metadata for context cache associated with LLM responses.\n\nThis class stores cache identification, usage tracking, and lifecycle\ninformation for a particular cache instance. It can be in two states:\n\n1. Active cache state: cache_name is set, all fields populated\n2. Fingerprint-only state: cache_name is None, only fingerprint and\n   contents_count are set for prefix matching\n\nToken counts (cached and total) are available in the LlmResponse.usage_metadata\nand should be accessed from there to avoid duplication.\n\nAttributes:\n    cache_name: The full resource name of the cached content (e.g.,\n        'projects/123/locations/us-central1/cachedContents/456').\n        None when no active cache exists (fingerprint-only state).\n    expire_time: Unix timestamp when the cache expires. None when no\n        active cache exists.\n    fingerprint: Hash of cacheable contents (instruction + tools + contents).\n        Always present for prefix matching.\n    invocations_used: Number of invocations this cache has been used for.\n        None when no active cache exists.\n    contents_count: Number of contents. When active cache exists, this is\n        the count of cached contents. When no active cache exists, this is\n        the total count of contents in the request.\n    created_at: Unix timestamp when the cache was created. None when\n        no active cache exists.",
         "properties": {
            "cache_name": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Full resource name of the cached content (None if no active cache)",
               "title": "Cache Name"
            },
            "expire_time": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Unix timestamp when cache expires (None if no active cache)",
               "title": "Expire Time"
            },
            "fingerprint": {
               "description": "Hash of cacheable contents used to detect changes",
               "title": "Fingerprint",
               "type": "string"
            },
            "invocations_used": {
               "anyOf": [
                  {
                     "minimum": 0,
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Number of invocations this cache has been used for (None if no active cache)",
               "title": "Invocations Used"
            },
            "contents_count": {
               "description": "Number of contents (cached contents when active cache exists, total contents in request when no active cache)",
               "minimum": 0,
               "title": "Contents Count",
               "type": "integer"
            },
            "created_at": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Unix timestamp when cache was created (None if no active cache)",
               "title": "Created At"
            }
         },
         "required": [
            "fingerprint",
            "contents_count"
         ],
         "title": "CacheMetadata",
         "type": "object"
      },
      "Citation": {
         "additionalProperties": false,
         "description": "Source attributions for content.",
         "properties": {
            "endIndex": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Output only. End index into the content.",
               "title": "Endindex"
            },
            "license": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Output only. License of the attribution.",
               "title": "License"
            },
            "publicationDate": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/GoogleTypeDate"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Output only. Publication date of the attribution."
            },
            "startIndex": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Output only. Start index into the content.",
               "title": "Startindex"
            },
            "title": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Output only. Title of the attribution.",
               "title": "Title"
            },
            "uri": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Output only. Url reference of the attribution.",
               "title": "Uri"
            }
         },
         "title": "Citation",
         "type": "object"
      },
      "CitationMetadata": {
         "additionalProperties": false,
         "description": "Citation information when the model quotes another source.",
         "properties": {
            "citations": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/Citation"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Contains citation information when the model directly quotes, at\n      length, from another source. Can include traditional websites and code\n      repositories.\n      ",
               "title": "Citations"
            }
         },
         "title": "CitationMetadata",
         "type": "object"
      },
      "CodeExecutionResult": {
         "additionalProperties": false,
         "description": "Result of executing the [ExecutableCode].\n\nOnly generated when using the [CodeExecution] tool, and always follows a\n`part` containing the [ExecutableCode].",
         "properties": {
            "outcome": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/Outcome"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. Outcome of the code execution."
            },
            "output": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Contains stdout when code execution is successful, stderr or other description otherwise.",
               "title": "Output"
            }
         },
         "title": "CodeExecutionResult",
         "type": "object"
      },
      "Content": {
         "additionalProperties": false,
         "description": "Contains the multi-part content of a message.",
         "properties": {
            "parts": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/Part"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "List of parts that constitute a single message. Each part may have\n      a different IANA MIME type.",
               "title": "Parts"
            },
            "role": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. The producer of the content. Must be either 'user' or\n      'model'. Useful to set for multi-turn conversations, otherwise can be\n      empty. If role is not specified, SDK will determine the role.",
               "title": "Role"
            }
         },
         "title": "Content",
         "type": "object"
      },
      "EventActions": {
         "additionalProperties": false,
         "description": "Represents the actions attached to an event.",
         "properties": {
            "skipSummarization": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Skipsummarization"
            },
            "stateDelta": {
               "additionalProperties": true,
               "title": "Statedelta",
               "type": "object"
            },
            "artifactDelta": {
               "additionalProperties": {
                  "type": "integer"
               },
               "title": "Artifactdelta",
               "type": "object"
            },
            "transferToAgent": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Transfertoagent"
            },
            "escalate": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Escalate"
            },
            "requestedAuthConfigs": {
               "additionalProperties": {
                  "$ref": "#/$defs/AuthConfig"
               },
               "title": "Requestedauthconfigs",
               "type": "object"
            },
            "requestedToolConfirmations": {
               "additionalProperties": {
                  "$ref": "#/$defs/ToolConfirmation"
               },
               "title": "Requestedtoolconfirmations",
               "type": "object"
            },
            "compaction": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/EventCompaction"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "endOfAgent": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Endofagent"
            },
            "agentState": {
               "anyOf": [
                  {
                     "additionalProperties": true,
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Agentstate"
            },
            "rewindBeforeInvocationId": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Rewindbeforeinvocationid"
            }
         },
         "title": "EventActions",
         "type": "object"
      },
      "EventCompaction": {
         "additionalProperties": false,
         "description": "The compaction of the events.",
         "properties": {
            "startTimestamp": {
               "title": "Starttimestamp",
               "type": "number"
            },
            "endTimestamp": {
               "title": "Endtimestamp",
               "type": "number"
            },
            "compactedContent": {
               "$ref": "#/$defs/Content"
            }
         },
         "required": [
            "startTimestamp",
            "endTimestamp",
            "compactedContent"
         ],
         "title": "EventCompaction",
         "type": "object"
      },
      "ExecutableCode": {
         "additionalProperties": false,
         "description": "Code generated by the model that is meant to be executed, and the result returned to the model.\n\nGenerated when using the [CodeExecution] tool, in which the code will be\nautomatically executed, and a corresponding [CodeExecutionResult] will also be\ngenerated.",
         "properties": {
            "code": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. The code to be executed.",
               "title": "Code"
            },
            "language": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/Language"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. Programming language of the `code`."
            }
         },
         "title": "ExecutableCode",
         "type": "object"
      },
      "FileData": {
         "additionalProperties": false,
         "description": "URI based data.",
         "properties": {
            "displayName": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. It is not currently used in the Gemini GenerateContent calls.",
               "title": "Displayname"
            },
            "fileUri": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. URI.",
               "title": "Fileuri"
            },
            "mimeType": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. The IANA standard MIME type of the source data.",
               "title": "Mimetype"
            }
         },
         "title": "FileData",
         "type": "object"
      },
      "FinishReason": {
         "description": "Output only. The reason why the model stopped generating tokens.\n\nIf empty, the model has not stopped generating the tokens.",
         "enum": [
            "FINISH_REASON_UNSPECIFIED",
            "STOP",
            "MAX_TOKENS",
            "SAFETY",
            "RECITATION",
            "LANGUAGE",
            "OTHER",
            "BLOCKLIST",
            "PROHIBITED_CONTENT",
            "SPII",
            "MALFORMED_FUNCTION_CALL",
            "IMAGE_SAFETY",
            "UNEXPECTED_TOOL_CALL",
            "IMAGE_PROHIBITED_CONTENT",
            "NO_IMAGE"
         ],
         "title": "FinishReason",
         "type": "string"
      },
      "FunctionCall": {
         "additionalProperties": false,
         "description": "A function call.",
         "properties": {
            "id": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The unique id of the function call. If populated, the client to execute the\n   `function_call` and return the response with the matching `id`.",
               "title": "Id"
            },
            "args": {
               "anyOf": [
                  {
                     "additionalProperties": true,
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.",
               "title": "Args"
            },
            "name": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. The name of the function to call. Matches [FunctionDeclaration.name].",
               "title": "Name"
            }
         },
         "title": "FunctionCall",
         "type": "object"
      },
      "FunctionResponse": {
         "additionalProperties": false,
         "description": "A function response.",
         "properties": {
            "willContinue": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Signals that function call continues, and more responses will be returned, turning the function call into a generator. Is only applicable to NON_BLOCKING function calls (see FunctionDeclaration.behavior for details), ignored otherwise. If false, the default, future responses will not be considered. Is only applicable to NON_BLOCKING function calls, is ignored otherwise. If set to false, future responses will not be considered. It is allowed to return empty `response` with `will_continue=False` to signal that the function call is finished.",
               "title": "Willcontinue"
            },
            "scheduling": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/FunctionResponseScheduling"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE."
            },
            "parts": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/FunctionResponsePart"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "List of parts that constitute a function response. Each part may\n      have a different IANA MIME type.",
               "title": "Parts"
            },
            "id": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`.",
               "title": "Id"
            },
            "name": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].",
               "title": "Name"
            },
            "response": {
               "anyOf": [
                  {
                     "additionalProperties": true,
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. The function response in JSON object format. Use \"output\" key to specify function output and \"error\" key to specify error details (if any). If \"output\" and \"error\" keys are not specified, then whole \"response\" is treated as function output.",
               "title": "Response"
            }
         },
         "title": "FunctionResponse",
         "type": "object"
      },
      "FunctionResponseBlob": {
         "additionalProperties": false,
         "description": "Raw media bytes for function response.\n\nText should not be sent as raw bytes, use the FunctionResponse.response\nfield.",
         "properties": {
            "mimeType": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. The IANA standard MIME type of the source data.",
               "title": "Mimetype"
            },
            "data": {
               "anyOf": [
                  {
                     "format": "base64url",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. Inline media bytes.",
               "title": "Data"
            }
         },
         "title": "FunctionResponseBlob",
         "type": "object"
      },
      "FunctionResponseFileData": {
         "additionalProperties": false,
         "description": "URI based data for function response.",
         "properties": {
            "fileUri": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. URI.",
               "title": "Fileuri"
            },
            "mimeType": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. The IANA standard MIME type of the source data.",
               "title": "Mimetype"
            }
         },
         "title": "FunctionResponseFileData",
         "type": "object"
      },
      "FunctionResponsePart": {
         "additionalProperties": false,
         "description": "A datatype containing media that is part of a `FunctionResponse` message.\n\nA `FunctionResponsePart` consists of data which has an associated datatype. A\n`FunctionResponsePart` can only contain one of the accepted types in\n`FunctionResponsePart.data`.\n\nA `FunctionResponsePart` must have a fixed IANA MIME type identifying the\ntype and subtype of the media if the `inline_data` field is filled with raw\nbytes.",
         "properties": {
            "inlineData": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/FunctionResponseBlob"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Inline media bytes."
            },
            "fileData": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/FunctionResponseFileData"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. URI based data."
            }
         },
         "title": "FunctionResponsePart",
         "type": "object"
      },
      "FunctionResponseScheduling": {
         "description": "Specifies how the response should be scheduled in the conversation.",
         "enum": [
            "SCHEDULING_UNSPECIFIED",
            "SILENT",
            "WHEN_IDLE",
            "INTERRUPT"
         ],
         "title": "FunctionResponseScheduling",
         "type": "string"
      },
      "GenerateContentResponseUsageMetadata": {
         "additionalProperties": false,
         "description": "Usage metadata about response(s).",
         "properties": {
            "cacheTokensDetails": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/ModalityTokenCount"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Output only. List of modalities of the cached content in the request input.",
               "title": "Cachetokensdetails"
            },
            "cachedContentTokenCount": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Output only. Number of tokens in the cached part in the input (the cached content).",
               "title": "Cachedcontenttokencount"
            },
            "candidatesTokenCount": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Number of tokens in the response(s).",
               "title": "Candidatestokencount"
            },
            "candidatesTokensDetails": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/ModalityTokenCount"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Output only. List of modalities that were returned in the response.",
               "title": "Candidatestokensdetails"
            },
            "promptTokenCount": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Number of tokens in the request. When `cached_content` is set, this is still the total effective prompt size meaning this includes the number of tokens in the cached content.",
               "title": "Prompttokencount"
            },
            "promptTokensDetails": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/ModalityTokenCount"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Output only. List of modalities that were processed in the request input.",
               "title": "Prompttokensdetails"
            },
            "thoughtsTokenCount": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Output only. Number of tokens present in thoughts output.",
               "title": "Thoughtstokencount"
            },
            "toolUsePromptTokenCount": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Output only. Number of tokens present in tool-use prompt(s).",
               "title": "Tooluseprompttokencount"
            },
            "toolUsePromptTokensDetails": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/ModalityTokenCount"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Output only. List of modalities that were processed for tool-use request inputs.",
               "title": "Tooluseprompttokensdetails"
            },
            "totalTokenCount": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Total token count for prompt, response candidates, and tool-use prompts (if present).",
               "title": "Totaltokencount"
            },
            "trafficType": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/TrafficType"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Output only. Traffic type. This shows whether a request consumes Pay-As-You-Go or Provisioned Throughput quota."
            }
         },
         "title": "GenerateContentResponseUsageMetadata",
         "type": "object"
      },
      "GoogleTypeDate": {
         "additionalProperties": false,
         "description": "Represents a whole or partial calendar date, such as a birthday.\n\nThe time of day and time zone are either specified elsewhere or are\ninsignificant. The date is relative to the Gregorian Calendar. This can\nrepresent one of the following: * A full date, with non-zero year, month, and\nday values. * A month and day, with a zero year (for example, an anniversary).\n* A year on its own, with a zero month and a zero day. * A year and month,\nwith a zero day (for example, a credit card expiration date). Related types: *\ngoogle.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp",
         "properties": {
            "day": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.",
               "title": "Day"
            },
            "month": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.",
               "title": "Month"
            },
            "year": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.",
               "title": "Year"
            }
         },
         "title": "GoogleTypeDate",
         "type": "object"
      },
      "GroundingChunk": {
         "additionalProperties": false,
         "description": "Grounding chunk.",
         "properties": {
            "maps": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/GroundingChunkMaps"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Grounding chunk from Google Maps."
            },
            "retrievedContext": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/GroundingChunkRetrievedContext"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Grounding chunk from context retrieved by the retrieval tools."
            },
            "web": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/GroundingChunkWeb"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Grounding chunk from the web."
            }
         },
         "title": "GroundingChunk",
         "type": "object"
      },
      "GroundingChunkMaps": {
         "additionalProperties": false,
         "description": "Chunk from Google Maps.",
         "properties": {
            "placeAnswerSources": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/GroundingChunkMapsPlaceAnswerSources"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Sources used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as uris to flag content."
            },
            "placeId": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "This Place's resource name, in `places/{place_id}` format. Can be used to look up the Place.",
               "title": "Placeid"
            },
            "text": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Text of the chunk.",
               "title": "Text"
            },
            "title": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Title of the chunk.",
               "title": "Title"
            },
            "uri": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "URI reference of the chunk.",
               "title": "Uri"
            }
         },
         "title": "GroundingChunkMaps",
         "type": "object"
      },
      "GroundingChunkMapsPlaceAnswerSources": {
         "additionalProperties": false,
         "description": "Sources used to generate the place answer.",
         "properties": {
            "flagContentUri": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "A link where users can flag a problem with the generated answer.",
               "title": "Flagcontenturi"
            },
            "reviewSnippets": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/GroundingChunkMapsPlaceAnswerSourcesReviewSnippet"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Snippets of reviews that are used to generate the answer.",
               "title": "Reviewsnippets"
            }
         },
         "title": "GroundingChunkMapsPlaceAnswerSources",
         "type": "object"
      },
      "GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution": {
         "additionalProperties": false,
         "description": "Author attribution for a photo or review.",
         "properties": {
            "displayName": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Name of the author of the Photo or Review.",
               "title": "Displayname"
            },
            "photoUri": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Profile photo URI of the author of the Photo or Review.",
               "title": "Photouri"
            },
            "uri": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "URI of the author of the Photo or Review.",
               "title": "Uri"
            }
         },
         "title": "GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution",
         "type": "object"
      },
      "GroundingChunkMapsPlaceAnswerSourcesReviewSnippet": {
         "additionalProperties": false,
         "description": "Encapsulates a review snippet.",
         "properties": {
            "authorAttribution": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "This review's author."
            },
            "flagContentUri": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "A link where users can flag a problem with the review.",
               "title": "Flagcontenturi"
            },
            "googleMapsUri": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "A link to show the review on Google Maps.",
               "title": "Googlemapsuri"
            },
            "relativePublishTimeDescription": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "A string of formatted recent time, expressing the review time relative to the current time in a form appropriate for the language and country.",
               "title": "Relativepublishtimedescription"
            },
            "review": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "A reference representing this place review which may be used to look up this place review again.",
               "title": "Review"
            },
            "reviewId": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Id of the review referencing the place.",
               "title": "Reviewid"
            },
            "title": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Title of the review.",
               "title": "Title"
            }
         },
         "title": "GroundingChunkMapsPlaceAnswerSourcesReviewSnippet",
         "type": "object"
      },
      "GroundingChunkRetrievedContext": {
         "additionalProperties": false,
         "description": "Chunk from context retrieved by the retrieval tools.",
         "properties": {
            "documentName": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Output only. The full document name for the referenced Vertex AI Search document.",
               "title": "Documentname"
            },
            "ragChunk": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/RagChunk"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Additional context for the RAG retrieval result. This is only populated when using the RAG retrieval tool."
            },
            "text": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Text of the attribution.",
               "title": "Text"
            },
            "title": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Title of the attribution.",
               "title": "Title"
            },
            "uri": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "URI reference of the attribution.",
               "title": "Uri"
            }
         },
         "title": "GroundingChunkRetrievedContext",
         "type": "object"
      },
      "GroundingChunkWeb": {
         "additionalProperties": false,
         "description": "Chunk from the web.",
         "properties": {
            "domain": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Domain of the (original) URI.",
               "title": "Domain"
            },
            "title": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Title of the chunk.",
               "title": "Title"
            },
            "uri": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "URI reference of the chunk.",
               "title": "Uri"
            }
         },
         "title": "GroundingChunkWeb",
         "type": "object"
      },
      "GroundingMetadata": {
         "additionalProperties": false,
         "description": "Metadata returned to client when grounding is enabled.",
         "properties": {
            "googleMapsWidgetContextToken": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Output only. Resource name of the Google Maps widget context token to be used with the PlacesContextElement widget to render contextual data. This is populated only for Google Maps grounding.",
               "title": "Googlemapswidgetcontexttoken"
            },
            "groundingChunks": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/GroundingChunk"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "List of supporting references retrieved from specified grounding source.",
               "title": "Groundingchunks"
            },
            "groundingSupports": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/GroundingSupport"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. List of grounding support.",
               "title": "Groundingsupports"
            },
            "retrievalMetadata": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/RetrievalMetadata"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Output only. Retrieval metadata."
            },
            "retrievalQueries": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Queries executed by the retrieval tools.",
               "title": "Retrievalqueries"
            },
            "searchEntryPoint": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/SearchEntryPoint"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Google search entry for the following-up web searches."
            },
            "sourceFlaggingUris": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/GroundingMetadataSourceFlaggingUri"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Output only. List of source flagging uris. This is currently populated only for Google Maps grounding.",
               "title": "Sourceflagginguris"
            },
            "webSearchQueries": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Web search queries for the following-up web search.",
               "title": "Websearchqueries"
            }
         },
         "title": "GroundingMetadata",
         "type": "object"
      },
      "GroundingMetadataSourceFlaggingUri": {
         "additionalProperties": false,
         "description": "Source content flagging uri for a place or review.\n\nThis is currently populated only for Google Maps grounding.",
         "properties": {
            "flagContentUri": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "A link where users can flag a problem with the source (place or review).",
               "title": "Flagcontenturi"
            },
            "sourceId": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Id of the place or review.",
               "title": "Sourceid"
            }
         },
         "title": "GroundingMetadataSourceFlaggingUri",
         "type": "object"
      },
      "GroundingSupport": {
         "additionalProperties": false,
         "description": "Grounding support.",
         "properties": {
            "confidenceScores": {
               "anyOf": [
                  {
                     "items": {
                        "type": "number"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Confidence score of the support references. Ranges from 0 to 1. 1 is the most confident. For Gemini 2.0 and before, this list must have the same size as the grounding_chunk_indices. For Gemini 2.5 and after, this list will be empty and should be ignored.",
               "title": "Confidencescores"
            },
            "groundingChunkIndices": {
               "anyOf": [
                  {
                     "items": {
                        "type": "integer"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "A list of indices (into 'grounding_chunk') specifying the citations associated with the claim. For instance [1,3,4] means that grounding_chunk[1], grounding_chunk[3], grounding_chunk[4] are the retrieved content attributed to the claim.",
               "title": "Groundingchunkindices"
            },
            "segment": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/Segment"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Segment of the content this support belongs to."
            }
         },
         "title": "GroundingSupport",
         "type": "object"
      },
      "HTTPBase": {
         "additionalProperties": true,
         "properties": {
            "type": {
               "$ref": "#/$defs/SecuritySchemeType",
               "default": "http"
            },
            "description": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Description"
            },
            "scheme": {
               "title": "Scheme",
               "type": "string"
            }
         },
         "required": [
            "scheme"
         ],
         "title": "HTTPBase",
         "type": "object"
      },
      "HTTPBearer": {
         "additionalProperties": true,
         "properties": {
            "type": {
               "$ref": "#/$defs/SecuritySchemeType",
               "default": "http"
            },
            "description": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Description"
            },
            "scheme": {
               "const": "bearer",
               "default": "bearer",
               "title": "Scheme",
               "type": "string"
            },
            "bearerFormat": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Bearerformat"
            }
         },
         "title": "HTTPBearer",
         "type": "object"
      },
      "HttpAuth": {
         "additionalProperties": true,
         "description": "The credentials and metadata for HTTP authentication.",
         "properties": {
            "scheme": {
               "title": "Scheme",
               "type": "string"
            },
            "credentials": {
               "$ref": "#/$defs/HttpCredentials"
            }
         },
         "required": [
            "scheme",
            "credentials"
         ],
         "title": "HttpAuth",
         "type": "object"
      },
      "HttpCredentials": {
         "additionalProperties": true,
         "description": "Represents the secret token value for HTTP authentication, like user name, password, oauth token, etc.",
         "properties": {
            "username": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Username"
            },
            "password": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Password"
            },
            "token": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Token"
            }
         },
         "title": "HttpCredentials",
         "type": "object"
      },
      "Language": {
         "description": "Required. Programming language of the `code`.",
         "enum": [
            "LANGUAGE_UNSPECIFIED",
            "PYTHON"
         ],
         "title": "Language",
         "type": "string"
      },
      "LiveServerSessionResumptionUpdate": {
         "additionalProperties": false,
         "description": "Update of the session resumption state.\n\nOnly sent if `session_resumption` was set in the connection config.",
         "properties": {
            "newHandle": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "New handle that represents state that can be resumed. Empty if `resumable`=false.",
               "title": "Newhandle"
            },
            "resumable": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "True if session can be resumed at this point. It might be not possible to resume session at some points. In that case we send update empty new_handle and resumable=false. Example of such case could be model executing function calls or just generating. Resuming session (using previous session token) in such state will result in some data loss.",
               "title": "Resumable"
            },
            "lastConsumedClientMessageIndex": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Index of last message sent by client that is included in state represented by this SessionResumptionToken. Only sent when `SessionResumptionConfig.transparent` is set.\n\nPresence of this index allows users to transparently reconnect and avoid issue of losing some part of realtime audio input/video. If client wishes to temporarily disconnect (for example as result of receiving GoAway) they can do it without losing state by buffering messages sent since last `SessionResmumptionTokenUpdate`. This field will enable them to limit buffering (avoid keeping all requests in RAM).\n\nNote: This should not be used for when resuming a session at some time later -- in those cases partial audio and video frames arelikely not needed.",
               "title": "Lastconsumedclientmessageindex"
            }
         },
         "title": "LiveServerSessionResumptionUpdate",
         "type": "object"
      },
      "LogprobsResult": {
         "additionalProperties": false,
         "description": "Logprobs Result",
         "properties": {
            "chosenCandidates": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/LogprobsResultCandidate"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Length = total number of decoding steps. The chosen candidates may or may not be in top_candidates.",
               "title": "Chosencandidates"
            },
            "topCandidates": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/LogprobsResultTopCandidates"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Length = total number of decoding steps.",
               "title": "Topcandidates"
            }
         },
         "title": "LogprobsResult",
         "type": "object"
      },
      "LogprobsResultCandidate": {
         "additionalProperties": false,
         "description": "Candidate for the logprobs token and score.",
         "properties": {
            "logProbability": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The candidate's log probability.",
               "title": "Logprobability"
            },
            "token": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The candidate's token string value.",
               "title": "Token"
            },
            "tokenId": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The candidate's token id value.",
               "title": "Tokenid"
            }
         },
         "title": "LogprobsResultCandidate",
         "type": "object"
      },
      "LogprobsResultTopCandidates": {
         "additionalProperties": false,
         "description": "Candidates with top log probabilities at each decoding step.",
         "properties": {
            "candidates": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/LogprobsResultCandidate"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Sorted by log probability in descending order.",
               "title": "Candidates"
            }
         },
         "title": "LogprobsResultTopCandidates",
         "type": "object"
      },
      "MediaModality": {
         "description": "Server content modalities.",
         "enum": [
            "MODALITY_UNSPECIFIED",
            "TEXT",
            "IMAGE",
            "VIDEO",
            "AUDIO",
            "DOCUMENT"
         ],
         "title": "MediaModality",
         "type": "string"
      },
      "ModalityTokenCount": {
         "additionalProperties": false,
         "description": "Represents token counting info for a single modality.",
         "properties": {
            "modality": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/MediaModality"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The modality associated with this token count."
            },
            "tokenCount": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Number of tokens.",
               "title": "Tokencount"
            }
         },
         "title": "ModalityTokenCount",
         "type": "object"
      },
      "OAuth2": {
         "additionalProperties": true,
         "properties": {
            "type": {
               "$ref": "#/$defs/SecuritySchemeType",
               "default": "oauth2"
            },
            "description": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Description"
            },
            "flows": {
               "$ref": "#/$defs/OAuthFlows"
            }
         },
         "required": [
            "flows"
         ],
         "title": "OAuth2",
         "type": "object"
      },
      "OAuth2Auth": {
         "additionalProperties": true,
         "description": "Represents credential value and its metadata for a OAuth2 credential.",
         "properties": {
            "clientId": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Clientid"
            },
            "clientSecret": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Clientsecret"
            },
            "authUri": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Authuri"
            },
            "state": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "State"
            },
            "redirectUri": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Redirecturi"
            },
            "authResponseUri": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Authresponseuri"
            },
            "authCode": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Authcode"
            },
            "accessToken": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Accesstoken"
            },
            "refreshToken": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Refreshtoken"
            },
            "expiresAt": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Expiresat"
            },
            "expiresIn": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Expiresin"
            },
            "audience": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Audience"
            }
         },
         "title": "OAuth2Auth",
         "type": "object"
      },
      "OAuthFlowAuthorizationCode": {
         "additionalProperties": true,
         "properties": {
            "refreshUrl": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Refreshurl"
            },
            "scopes": {
               "additionalProperties": {
                  "type": "string"
               },
               "default": {},
               "title": "Scopes",
               "type": "object"
            },
            "authorizationUrl": {
               "title": "Authorizationurl",
               "type": "string"
            },
            "tokenUrl": {
               "title": "Tokenurl",
               "type": "string"
            }
         },
         "required": [
            "authorizationUrl",
            "tokenUrl"
         ],
         "title": "OAuthFlowAuthorizationCode",
         "type": "object"
      },
      "OAuthFlowClientCredentials": {
         "additionalProperties": true,
         "properties": {
            "refreshUrl": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Refreshurl"
            },
            "scopes": {
               "additionalProperties": {
                  "type": "string"
               },
               "default": {},
               "title": "Scopes",
               "type": "object"
            },
            "tokenUrl": {
               "title": "Tokenurl",
               "type": "string"
            }
         },
         "required": [
            "tokenUrl"
         ],
         "title": "OAuthFlowClientCredentials",
         "type": "object"
      },
      "OAuthFlowImplicit": {
         "additionalProperties": true,
         "properties": {
            "refreshUrl": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Refreshurl"
            },
            "scopes": {
               "additionalProperties": {
                  "type": "string"
               },
               "default": {},
               "title": "Scopes",
               "type": "object"
            },
            "authorizationUrl": {
               "title": "Authorizationurl",
               "type": "string"
            }
         },
         "required": [
            "authorizationUrl"
         ],
         "title": "OAuthFlowImplicit",
         "type": "object"
      },
      "OAuthFlowPassword": {
         "additionalProperties": true,
         "properties": {
            "refreshUrl": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Refreshurl"
            },
            "scopes": {
               "additionalProperties": {
                  "type": "string"
               },
               "default": {},
               "title": "Scopes",
               "type": "object"
            },
            "tokenUrl": {
               "title": "Tokenurl",
               "type": "string"
            }
         },
         "required": [
            "tokenUrl"
         ],
         "title": "OAuthFlowPassword",
         "type": "object"
      },
      "OAuthFlows": {
         "additionalProperties": true,
         "properties": {
            "implicit": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/OAuthFlowImplicit"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "password": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/OAuthFlowPassword"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "clientCredentials": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/OAuthFlowClientCredentials"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "authorizationCode": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/OAuthFlowAuthorizationCode"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            }
         },
         "title": "OAuthFlows",
         "type": "object"
      },
      "OpenIdConnect": {
         "additionalProperties": true,
         "properties": {
            "type": {
               "$ref": "#/$defs/SecuritySchemeType",
               "default": "openIdConnect"
            },
            "description": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Description"
            },
            "openIdConnectUrl": {
               "title": "Openidconnecturl",
               "type": "string"
            }
         },
         "required": [
            "openIdConnectUrl"
         ],
         "title": "OpenIdConnect",
         "type": "object"
      },
      "OpenIdConnectWithConfig": {
         "additionalProperties": true,
         "properties": {
            "type": {
               "$ref": "#/$defs/SecuritySchemeType",
               "default": "openIdConnect"
            },
            "description": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Description"
            },
            "authorization_endpoint": {
               "title": "Authorization Endpoint",
               "type": "string"
            },
            "token_endpoint": {
               "title": "Token Endpoint",
               "type": "string"
            },
            "userinfo_endpoint": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Userinfo Endpoint"
            },
            "revocation_endpoint": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Revocation Endpoint"
            },
            "token_endpoint_auth_methods_supported": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Token Endpoint Auth Methods Supported"
            },
            "grant_types_supported": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Grant Types Supported"
            },
            "scopes": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Scopes"
            }
         },
         "required": [
            "authorization_endpoint",
            "token_endpoint"
         ],
         "title": "OpenIdConnectWithConfig",
         "type": "object"
      },
      "Outcome": {
         "description": "Required. Outcome of the code execution.",
         "enum": [
            "OUTCOME_UNSPECIFIED",
            "OUTCOME_OK",
            "OUTCOME_FAILED",
            "OUTCOME_DEADLINE_EXCEEDED"
         ],
         "title": "Outcome",
         "type": "string"
      },
      "Part": {
         "additionalProperties": false,
         "description": "A datatype containing media content.\n\nExactly one field within a Part should be set, representing the specific type\nof content being conveyed. Using multiple fields within the same `Part`\ninstance is considered invalid.",
         "properties": {
            "videoMetadata": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/VideoMetadata"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Metadata for a given video."
            },
            "thought": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Indicates if the part is thought from the model.",
               "title": "Thought"
            },
            "inlineData": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/Blob"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Inlined bytes data."
            },
            "fileData": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/FileData"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. URI based data."
            },
            "thoughtSignature": {
               "anyOf": [
                  {
                     "format": "base64url",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "An opaque signature for the thought so it can be reused in subsequent requests.",
               "title": "Thoughtsignature"
            },
            "functionCall": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/FunctionCall"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "A predicted [FunctionCall] returned from the model that contains a string\n      representing the [FunctionDeclaration.name] and a structured JSON object\n      containing the parameters and their values."
            },
            "codeExecutionResult": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/CodeExecutionResult"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Result of executing the [ExecutableCode]."
            },
            "executableCode": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/ExecutableCode"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Code generated by the model that is meant to be executed."
            },
            "functionResponse": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/FunctionResponse"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model."
            },
            "text": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Text part (can be code).",
               "title": "Text"
            }
         },
         "title": "Part",
         "type": "object"
      },
      "RagChunk": {
         "additionalProperties": false,
         "description": "A RagChunk includes the content of a chunk of a RagFile, and associated metadata.",
         "properties": {
            "pageSpan": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/RagChunkPageSpan"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "If populated, represents where the chunk starts and ends in the document."
            },
            "text": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The content of the chunk.",
               "title": "Text"
            }
         },
         "title": "RagChunk",
         "type": "object"
      },
      "RagChunkPageSpan": {
         "additionalProperties": false,
         "description": "Represents where the chunk starts and ends in the document.",
         "properties": {
            "firstPage": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Page where chunk starts in the document. Inclusive. 1-indexed.",
               "title": "Firstpage"
            },
            "lastPage": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Page where chunk ends in the document. Inclusive. 1-indexed.",
               "title": "Lastpage"
            }
         },
         "title": "RagChunkPageSpan",
         "type": "object"
      },
      "RetrievalMetadata": {
         "additionalProperties": false,
         "description": "Metadata related to retrieval in the grounding flow.",
         "properties": {
            "googleSearchDynamicRetrievalScore": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Score indicating how likely information from Google Search could help answer the prompt. The score is in the range `[0, 1]`, where 0 is the least likely and 1 is the most likely. This score is only populated when Google Search grounding and dynamic retrieval is enabled. It will be compared to the threshold to determine whether to trigger Google Search.",
               "title": "Googlesearchdynamicretrievalscore"
            }
         },
         "title": "RetrievalMetadata",
         "type": "object"
      },
      "SearchEntryPoint": {
         "additionalProperties": false,
         "description": "Google search entry point.",
         "properties": {
            "renderedContent": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Web content snippet that can be embedded in a web page or an app webview.",
               "title": "Renderedcontent"
            },
            "sdkBlob": {
               "anyOf": [
                  {
                     "format": "base64url",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Base64 encoded JSON representing array of tuple.",
               "title": "Sdkblob"
            }
         },
         "title": "SearchEntryPoint",
         "type": "object"
      },
      "SecuritySchemeType": {
         "enum": [
            "apiKey",
            "http",
            "oauth2",
            "openIdConnect"
         ],
         "title": "SecuritySchemeType",
         "type": "string"
      },
      "Segment": {
         "additionalProperties": false,
         "description": "Segment of the content.",
         "properties": {
            "endIndex": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Output only. End index in the given Part, measured in bytes. Offset from the start of the Part, exclusive, starting at zero.",
               "title": "Endindex"
            },
            "partIndex": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Output only. The index of a Part object within its parent Content object.",
               "title": "Partindex"
            },
            "startIndex": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Output only. Start index in the given Part, measured in bytes. Offset from the start of the Part, inclusive, starting at zero.",
               "title": "Startindex"
            },
            "text": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Output only. The text corresponding to the segment from the response.",
               "title": "Text"
            }
         },
         "title": "Segment",
         "type": "object"
      },
      "ServiceAccount": {
         "additionalProperties": true,
         "description": "Represents Google Service Account configuration.",
         "properties": {
            "serviceAccountCredential": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/ServiceAccountCredential"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "scopes": {
               "items": {
                  "type": "string"
               },
               "title": "Scopes",
               "type": "array"
            },
            "useDefaultCredential": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": false,
               "title": "Usedefaultcredential"
            }
         },
         "required": [
            "scopes"
         ],
         "title": "ServiceAccount",
         "type": "object"
      },
      "ServiceAccountCredential": {
         "additionalProperties": true,
         "description": "Represents Google Service Account configuration.\n\nAttributes:\n  type: The type should be \"service_account\".\n  project_id: The project ID.\n  private_key_id: The ID of the private key.\n  private_key: The private key.\n  client_email: The client email.\n  client_id: The client ID.\n  auth_uri: The authorization URI.\n  token_uri: The token URI.\n  auth_provider_x509_cert_url: URL for auth provider's X.509 cert.\n  client_x509_cert_url: URL for the client's X.509 cert.\n  universe_domain: The universe domain.\n\nExample:\n\n    config = ServiceAccountCredential(\n        type_=\"service_account\",\n        project_id=\"your_project_id\",\n        private_key_id=\"your_private_key_id\",\n        private_key=\"-----BEGIN PRIVATE KEY-----...\",\n        client_email=\"...@....iam.gserviceaccount.com\",\n        client_id=\"your_client_id\",\n        auth_uri=\"https://accounts.google.com/o/oauth2/auth\",\n        token_uri=\"https://oauth2.googleapis.com/token\",\n        auth_provider_x509_cert_url=\"https://www.googleapis.com/oauth2/v1/certs\",\n        client_x509_cert_url=\"https://www.googleapis.com/robot/v1/metadata/x509/...\",\n        universe_domain=\"googleapis.com\"\n    )\n\n\n    config = ServiceAccountConfig.model_construct(**{\n        ...service account config dict\n    })",
         "properties": {
            "type": {
               "default": "",
               "title": "Type",
               "type": "string"
            },
            "projectId": {
               "title": "Projectid",
               "type": "string"
            },
            "privateKeyId": {
               "title": "Privatekeyid",
               "type": "string"
            },
            "privateKey": {
               "title": "Privatekey",
               "type": "string"
            },
            "clientEmail": {
               "title": "Clientemail",
               "type": "string"
            },
            "clientId": {
               "title": "Clientid",
               "type": "string"
            },
            "authUri": {
               "title": "Authuri",
               "type": "string"
            },
            "tokenUri": {
               "title": "Tokenuri",
               "type": "string"
            },
            "authProviderX509CertUrl": {
               "title": "Authproviderx509Certurl",
               "type": "string"
            },
            "clientX509CertUrl": {
               "title": "Clientx509Certurl",
               "type": "string"
            },
            "universeDomain": {
               "title": "Universedomain",
               "type": "string"
            }
         },
         "required": [
            "projectId",
            "privateKeyId",
            "privateKey",
            "clientEmail",
            "clientId",
            "authUri",
            "tokenUri",
            "authProviderX509CertUrl",
            "clientX509CertUrl",
            "universeDomain"
         ],
         "title": "ServiceAccountCredential",
         "type": "object"
      },
      "ToolConfirmation": {
         "additionalProperties": false,
         "description": "Represents a tool confirmation configuration.",
         "properties": {
            "hint": {
               "default": "",
               "title": "Hint",
               "type": "string"
            },
            "confirmed": {
               "default": false,
               "title": "Confirmed",
               "type": "boolean"
            },
            "payload": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Payload"
            }
         },
         "title": "ToolConfirmation",
         "type": "object"
      },
      "TrafficType": {
         "description": "Output only.\n\nTraffic type. This shows whether a request consumes Pay-As-You-Go or\nProvisioned Throughput quota.",
         "enum": [
            "TRAFFIC_TYPE_UNSPECIFIED",
            "ON_DEMAND",
            "PROVISIONED_THROUGHPUT"
         ],
         "title": "TrafficType",
         "type": "string"
      },
      "Transcription": {
         "additionalProperties": false,
         "description": "Audio transcription in Server Conent.",
         "properties": {
            "text": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Transcription text.\n      ",
               "title": "Text"
            },
            "finished": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The bool indicates the end of the transcription.\n      ",
               "title": "Finished"
            }
         },
         "title": "Transcription",
         "type": "object"
      },
      "VideoMetadata": {
         "additionalProperties": false,
         "description": "Describes how the video in the Part should be used by the model.",
         "properties": {
            "fps": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The frame rate of the video sent to the model. If not specified, the\n        default value will be 1.0. The fps range is (0.0, 24.0].",
               "title": "Fps"
            },
            "endOffset": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. The end offset of the video.",
               "title": "Endoffset"
            },
            "startOffset": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. The start offset of the video.",
               "title": "Startoffset"
            }
         },
         "title": "VideoMetadata",
         "type": "object"
      }
   },
   "additionalProperties": false,
   "required": [
      "author"
   ]
}

Fields:

• actions (google.adk.events.event_actions.EventActions)

• author (str)

• branch (str | None)

• id (str)

• invocation_id (str)

• long_running_tool_ids (set[str] | None)

• timestamp (float)

field actions: EventActions [Optional]

The actions taken by the agent.

field author: str [Required]

‘user’ or the name of the agent, indicating who appended the event to the session.

field branch: Optional[str] = None

The branch of the event.

The format is like agent_1.agent_2.agent_3, where agent_1 is the parent of agent_2, and agent_2 is the parent of agent_3.

Branch is used when multiple sub-agent shouldn’t see their peer agents’ conversation history.

field id: str = ''

The unique identifier of the event.

field invocation_id: str = '' (alias 'invocationId')

The invocation ID of the event. Should be non-empty before appending to a session.

field long_running_tool_ids: Optional[set[str]] = None (alias 'longRunningToolIds')

Set of ids of the long running function calls. Agent client will know from this field about which function call is long running. only valid for function call event

field timestamp: float [Optional]

The timestamp of the event.

static new_id()

get_function_calls()

Returns the function calls in the event.

Return type:

list[FunctionCall]

get_function_responses()

Returns the function responses in the event.

Return type:

list[FunctionResponse]

has_trailing_code_execution_result()

Returns whether the event has a trailing code execution result.

Return type:

bool

is_final_response()

Returns whether the event is the final response of an agent.

NOTE: This method is ONLY for use by Agent Development Kit.

Note that when multiple agents participate in one invocation, there could be one event has is_final_response() as True for each participating agent.

Return type:

bool

model_post_init(_Event__context)

Post initialization logic for the event.

pydantic model google.adk.events.EventActions

Bases: BaseModel

Represents the actions attached to an event.

Show JSON schema

{
   "title": "EventActions",
   "description": "Represents the actions attached to an event.",
   "type": "object",
   "properties": {
      "skipSummarization": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Skipsummarization"
      },
      "stateDelta": {
         "additionalProperties": true,
         "title": "Statedelta",
         "type": "object"
      },
      "artifactDelta": {
         "additionalProperties": {
            "type": "integer"
         },
         "title": "Artifactdelta",
         "type": "object"
      },
      "transferToAgent": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Transfertoagent"
      },
      "escalate": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Escalate"
      },
      "requestedAuthConfigs": {
         "additionalProperties": {
            "$ref": "#/$defs/AuthConfig"
         },
         "title": "Requestedauthconfigs",
         "type": "object"
      },
      "requestedToolConfirmations": {
         "additionalProperties": {
            "$ref": "#/$defs/ToolConfirmation"
         },
         "title": "Requestedtoolconfirmations",
         "type": "object"
      },
      "compaction": {
         "anyOf": [
            {
               "$ref": "#/$defs/EventCompaction"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "endOfAgent": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Endofagent"
      },
      "agentState": {
         "anyOf": [
            {
               "additionalProperties": true,
               "type": "object"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Agentstate"
      },
      "rewindBeforeInvocationId": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Rewindbeforeinvocationid"
      }
   },
   "$defs": {
      "APIKey": {
         "additionalProperties": true,
         "properties": {
            "type": {
               "$ref": "#/$defs/SecuritySchemeType",
               "default": "apiKey"
            },
            "description": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Description"
            },
            "in": {
               "$ref": "#/$defs/APIKeyIn"
            },
            "name": {
               "title": "Name",
               "type": "string"
            }
         },
         "required": [
            "in",
            "name"
         ],
         "title": "APIKey",
         "type": "object"
      },
      "APIKeyIn": {
         "enum": [
            "query",
            "header",
            "cookie"
         ],
         "title": "APIKeyIn",
         "type": "string"
      },
      "AuthConfig": {
         "additionalProperties": true,
         "description": "The auth config sent by tool asking client to collect auth credentials and\n\nadk and client will help to fill in the response",
         "properties": {
            "authScheme": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/APIKey"
                  },
                  {
                     "$ref": "#/$defs/HTTPBase"
                  },
                  {
                     "$ref": "#/$defs/OAuth2"
                  },
                  {
                     "$ref": "#/$defs/OpenIdConnect"
                  },
                  {
                     "$ref": "#/$defs/HTTPBearer"
                  },
                  {
                     "$ref": "#/$defs/OpenIdConnectWithConfig"
                  }
               ],
               "title": "Authscheme"
            },
            "rawAuthCredential": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/AuthCredential"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "exchangedAuthCredential": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/AuthCredential"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "credentialKey": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Credentialkey"
            }
         },
         "required": [
            "authScheme"
         ],
         "title": "AuthConfig",
         "type": "object"
      },
      "AuthCredential": {
         "additionalProperties": true,
         "description": "Data class representing an authentication credential.\n\nTo exchange for the actual credential, please use\nCredentialExchanger.exchange_credential().\n\nExamples: API Key Auth\nAuthCredential(\n    auth_type=AuthCredentialTypes.API_KEY,\n    api_key=\"1234\",\n)\n\nExample: HTTP Auth\nAuthCredential(\n    auth_type=AuthCredentialTypes.HTTP,\n    http=HttpAuth(\n        scheme=\"basic\",\n        credentials=HttpCredentials(username=\"user\", password=\"password\"),\n    ),\n)\n\nExample: OAuth2 Bearer Token in HTTP Header\nAuthCredential(\n    auth_type=AuthCredentialTypes.HTTP,\n    http=HttpAuth(\n        scheme=\"bearer\",\n        credentials=HttpCredentials(token=\"eyAkaknabna....\"),\n    ),\n)\n\nExample: OAuth2 Auth with Authorization Code Flow\nAuthCredential(\n    auth_type=AuthCredentialTypes.OAUTH2,\n    oauth2=OAuth2Auth(\n        client_id=\"1234\",\n        client_secret=\"secret\",\n    ),\n)\n\nExample: OpenID Connect Auth\nAuthCredential(\n    auth_type=AuthCredentialTypes.OPEN_ID_CONNECT,\n    oauth2=OAuth2Auth(\n        client_id=\"1234\",\n        client_secret=\"secret\",\n        redirect_uri=\"https://example.com\",\n        scopes=[\"scope1\", \"scope2\"],\n    ),\n)\n\nExample: Auth with resource reference\nAuthCredential(\n    auth_type=AuthCredentialTypes.API_KEY,\n    resource_ref=\"projects/1234/locations/us-central1/resources/resource1\",\n)",
         "properties": {
            "authType": {
               "$ref": "#/$defs/AuthCredentialTypes"
            },
            "resourceRef": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Resourceref"
            },
            "apiKey": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Apikey"
            },
            "http": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/HttpAuth"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "serviceAccount": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/ServiceAccount"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "oauth2": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/OAuth2Auth"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            }
         },
         "required": [
            "authType"
         ],
         "title": "AuthCredential",
         "type": "object"
      },
      "AuthCredentialTypes": {
         "description": "Represents the type of authentication credential.",
         "enum": [
            "apiKey",
            "http",
            "oauth2",
            "openIdConnect",
            "serviceAccount"
         ],
         "title": "AuthCredentialTypes",
         "type": "string"
      },
      "Blob": {
         "additionalProperties": false,
         "description": "Content blob.",
         "properties": {
            "displayName": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is not currently used in the Gemini GenerateContent calls.",
               "title": "Displayname"
            },
            "data": {
               "anyOf": [
                  {
                     "format": "base64url",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. Raw bytes.",
               "title": "Data"
            },
            "mimeType": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. The IANA standard MIME type of the source data.",
               "title": "Mimetype"
            }
         },
         "title": "Blob",
         "type": "object"
      },
      "CodeExecutionResult": {
         "additionalProperties": false,
         "description": "Result of executing the [ExecutableCode].\n\nOnly generated when using the [CodeExecution] tool, and always follows a\n`part` containing the [ExecutableCode].",
         "properties": {
            "outcome": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/Outcome"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. Outcome of the code execution."
            },
            "output": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Contains stdout when code execution is successful, stderr or other description otherwise.",
               "title": "Output"
            }
         },
         "title": "CodeExecutionResult",
         "type": "object"
      },
      "Content": {
         "additionalProperties": false,
         "description": "Contains the multi-part content of a message.",
         "properties": {
            "parts": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/Part"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "List of parts that constitute a single message. Each part may have\n      a different IANA MIME type.",
               "title": "Parts"
            },
            "role": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. The producer of the content. Must be either 'user' or\n      'model'. Useful to set for multi-turn conversations, otherwise can be\n      empty. If role is not specified, SDK will determine the role.",
               "title": "Role"
            }
         },
         "title": "Content",
         "type": "object"
      },
      "EventCompaction": {
         "additionalProperties": false,
         "description": "The compaction of the events.",
         "properties": {
            "startTimestamp": {
               "title": "Starttimestamp",
               "type": "number"
            },
            "endTimestamp": {
               "title": "Endtimestamp",
               "type": "number"
            },
            "compactedContent": {
               "$ref": "#/$defs/Content"
            }
         },
         "required": [
            "startTimestamp",
            "endTimestamp",
            "compactedContent"
         ],
         "title": "EventCompaction",
         "type": "object"
      },
      "ExecutableCode": {
         "additionalProperties": false,
         "description": "Code generated by the model that is meant to be executed, and the result returned to the model.\n\nGenerated when using the [CodeExecution] tool, in which the code will be\nautomatically executed, and a corresponding [CodeExecutionResult] will also be\ngenerated.",
         "properties": {
            "code": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. The code to be executed.",
               "title": "Code"
            },
            "language": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/Language"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. Programming language of the `code`."
            }
         },
         "title": "ExecutableCode",
         "type": "object"
      },
      "FileData": {
         "additionalProperties": false,
         "description": "URI based data.",
         "properties": {
            "displayName": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. It is not currently used in the Gemini GenerateContent calls.",
               "title": "Displayname"
            },
            "fileUri": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. URI.",
               "title": "Fileuri"
            },
            "mimeType": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. The IANA standard MIME type of the source data.",
               "title": "Mimetype"
            }
         },
         "title": "FileData",
         "type": "object"
      },
      "FunctionCall": {
         "additionalProperties": false,
         "description": "A function call.",
         "properties": {
            "id": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The unique id of the function call. If populated, the client to execute the\n   `function_call` and return the response with the matching `id`.",
               "title": "Id"
            },
            "args": {
               "anyOf": [
                  {
                     "additionalProperties": true,
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.",
               "title": "Args"
            },
            "name": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. The name of the function to call. Matches [FunctionDeclaration.name].",
               "title": "Name"
            }
         },
         "title": "FunctionCall",
         "type": "object"
      },
      "FunctionResponse": {
         "additionalProperties": false,
         "description": "A function response.",
         "properties": {
            "willContinue": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Signals that function call continues, and more responses will be returned, turning the function call into a generator. Is only applicable to NON_BLOCKING function calls (see FunctionDeclaration.behavior for details), ignored otherwise. If false, the default, future responses will not be considered. Is only applicable to NON_BLOCKING function calls, is ignored otherwise. If set to false, future responses will not be considered. It is allowed to return empty `response` with `will_continue=False` to signal that the function call is finished.",
               "title": "Willcontinue"
            },
            "scheduling": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/FunctionResponseScheduling"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE."
            },
            "parts": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/FunctionResponsePart"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "List of parts that constitute a function response. Each part may\n      have a different IANA MIME type.",
               "title": "Parts"
            },
            "id": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`.",
               "title": "Id"
            },
            "name": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].",
               "title": "Name"
            },
            "response": {
               "anyOf": [
                  {
                     "additionalProperties": true,
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. The function response in JSON object format. Use \"output\" key to specify function output and \"error\" key to specify error details (if any). If \"output\" and \"error\" keys are not specified, then whole \"response\" is treated as function output.",
               "title": "Response"
            }
         },
         "title": "FunctionResponse",
         "type": "object"
      },
      "FunctionResponseBlob": {
         "additionalProperties": false,
         "description": "Raw media bytes for function response.\n\nText should not be sent as raw bytes, use the FunctionResponse.response\nfield.",
         "properties": {
            "mimeType": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. The IANA standard MIME type of the source data.",
               "title": "Mimetype"
            },
            "data": {
               "anyOf": [
                  {
                     "format": "base64url",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. Inline media bytes.",
               "title": "Data"
            }
         },
         "title": "FunctionResponseBlob",
         "type": "object"
      },
      "FunctionResponseFileData": {
         "additionalProperties": false,
         "description": "URI based data for function response.",
         "properties": {
            "fileUri": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. URI.",
               "title": "Fileuri"
            },
            "mimeType": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. The IANA standard MIME type of the source data.",
               "title": "Mimetype"
            }
         },
         "title": "FunctionResponseFileData",
         "type": "object"
      },
      "FunctionResponsePart": {
         "additionalProperties": false,
         "description": "A datatype containing media that is part of a `FunctionResponse` message.\n\nA `FunctionResponsePart` consists of data which has an associated datatype. A\n`FunctionResponsePart` can only contain one of the accepted types in\n`FunctionResponsePart.data`.\n\nA `FunctionResponsePart` must have a fixed IANA MIME type identifying the\ntype and subtype of the media if the `inline_data` field is filled with raw\nbytes.",
         "properties": {
            "inlineData": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/FunctionResponseBlob"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Inline media bytes."
            },
            "fileData": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/FunctionResponseFileData"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. URI based data."
            }
         },
         "title": "FunctionResponsePart",
         "type": "object"
      },
      "FunctionResponseScheduling": {
         "description": "Specifies how the response should be scheduled in the conversation.",
         "enum": [
            "SCHEDULING_UNSPECIFIED",
            "SILENT",
            "WHEN_IDLE",
            "INTERRUPT"
         ],
         "title": "FunctionResponseScheduling",
         "type": "string"
      },
      "HTTPBase": {
         "additionalProperties": true,
         "properties": {
            "type": {
               "$ref": "#/$defs/SecuritySchemeType",
               "default": "http"
            },
            "description": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Description"
            },
            "scheme": {
               "title": "Scheme",
               "type": "string"
            }
         },
         "required": [
            "scheme"
         ],
         "title": "HTTPBase",
         "type": "object"
      },
      "HTTPBearer": {
         "additionalProperties": true,
         "properties": {
            "type": {
               "$ref": "#/$defs/SecuritySchemeType",
               "default": "http"
            },
            "description": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Description"
            },
            "scheme": {
               "const": "bearer",
               "default": "bearer",
               "title": "Scheme",
               "type": "string"
            },
            "bearerFormat": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Bearerformat"
            }
         },
         "title": "HTTPBearer",
         "type": "object"
      },
      "HttpAuth": {
         "additionalProperties": true,
         "description": "The credentials and metadata for HTTP authentication.",
         "properties": {
            "scheme": {
               "title": "Scheme",
               "type": "string"
            },
            "credentials": {
               "$ref": "#/$defs/HttpCredentials"
            }
         },
         "required": [
            "scheme",
            "credentials"
         ],
         "title": "HttpAuth",
         "type": "object"
      },
      "HttpCredentials": {
         "additionalProperties": true,
         "description": "Represents the secret token value for HTTP authentication, like user name, password, oauth token, etc.",
         "properties": {
            "username": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Username"
            },
            "password": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Password"
            },
            "token": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Token"
            }
         },
         "title": "HttpCredentials",
         "type": "object"
      },
      "Language": {
         "description": "Required. Programming language of the `code`.",
         "enum": [
            "LANGUAGE_UNSPECIFIED",
            "PYTHON"
         ],
         "title": "Language",
         "type": "string"
      },
      "OAuth2": {
         "additionalProperties": true,
         "properties": {
            "type": {
               "$ref": "#/$defs/SecuritySchemeType",
               "default": "oauth2"
            },
            "description": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Description"
            },
            "flows": {
               "$ref": "#/$defs/OAuthFlows"
            }
         },
         "required": [
            "flows"
         ],
         "title": "OAuth2",
         "type": "object"
      },
      "OAuth2Auth": {
         "additionalProperties": true,
         "description": "Represents credential value and its metadata for a OAuth2 credential.",
         "properties": {
            "clientId": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Clientid"
            },
            "clientSecret": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Clientsecret"
            },
            "authUri": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Authuri"
            },
            "state": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "State"
            },
            "redirectUri": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Redirecturi"
            },
            "authResponseUri": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Authresponseuri"
            },
            "authCode": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Authcode"
            },
            "accessToken": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Accesstoken"
            },
            "refreshToken": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Refreshtoken"
            },
            "expiresAt": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Expiresat"
            },
            "expiresIn": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Expiresin"
            },
            "audience": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Audience"
            }
         },
         "title": "OAuth2Auth",
         "type": "object"
      },
      "OAuthFlowAuthorizationCode": {
         "additionalProperties": true,
         "properties": {
            "refreshUrl": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Refreshurl"
            },
            "scopes": {
               "additionalProperties": {
                  "type": "string"
               },
               "default": {},
               "title": "Scopes",
               "type": "object"
            },
            "authorizationUrl": {
               "title": "Authorizationurl",
               "type": "string"
            },
            "tokenUrl": {
               "title": "Tokenurl",
               "type": "string"
            }
         },
         "required": [
            "authorizationUrl",
            "tokenUrl"
         ],
         "title": "OAuthFlowAuthorizationCode",
         "type": "object"
      },
      "OAuthFlowClientCredentials": {
         "additionalProperties": true,
         "properties": {
            "refreshUrl": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Refreshurl"
            },
            "scopes": {
               "additionalProperties": {
                  "type": "string"
               },
               "default": {},
               "title": "Scopes",
               "type": "object"
            },
            "tokenUrl": {
               "title": "Tokenurl",
               "type": "string"
            }
         },
         "required": [
            "tokenUrl"
         ],
         "title": "OAuthFlowClientCredentials",
         "type": "object"
      },
      "OAuthFlowImplicit": {
         "additionalProperties": true,
         "properties": {
            "refreshUrl": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Refreshurl"
            },
            "scopes": {
               "additionalProperties": {
                  "type": "string"
               },
               "default": {},
               "title": "Scopes",
               "type": "object"
            },
            "authorizationUrl": {
               "title": "Authorizationurl",
               "type": "string"
            }
         },
         "required": [
            "authorizationUrl"
         ],
         "title": "OAuthFlowImplicit",
         "type": "object"
      },
      "OAuthFlowPassword": {
         "additionalProperties": true,
         "properties": {
            "refreshUrl": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Refreshurl"
            },
            "scopes": {
               "additionalProperties": {
                  "type": "string"
               },
               "default": {},
               "title": "Scopes",
               "type": "object"
            },
            "tokenUrl": {
               "title": "Tokenurl",
               "type": "string"
            }
         },
         "required": [
            "tokenUrl"
         ],
         "title": "OAuthFlowPassword",
         "type": "object"
      },
      "OAuthFlows": {
         "additionalProperties": true,
         "properties": {
            "implicit": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/OAuthFlowImplicit"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "password": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/OAuthFlowPassword"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "clientCredentials": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/OAuthFlowClientCredentials"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "authorizationCode": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/OAuthFlowAuthorizationCode"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            }
         },
         "title": "OAuthFlows",
         "type": "object"
      },
      "OpenIdConnect": {
         "additionalProperties": true,
         "properties": {
            "type": {
               "$ref": "#/$defs/SecuritySchemeType",
               "default": "openIdConnect"
            },
            "description": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Description"
            },
            "openIdConnectUrl": {
               "title": "Openidconnecturl",
               "type": "string"
            }
         },
         "required": [
            "openIdConnectUrl"
         ],
         "title": "OpenIdConnect",
         "type": "object"
      },
      "OpenIdConnectWithConfig": {
         "additionalProperties": true,
         "properties": {
            "type": {
               "$ref": "#/$defs/SecuritySchemeType",
               "default": "openIdConnect"
            },
            "description": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Description"
            },
            "authorization_endpoint": {
               "title": "Authorization Endpoint",
               "type": "string"
            },
            "token_endpoint": {
               "title": "Token Endpoint",
               "type": "string"
            },
            "userinfo_endpoint": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Userinfo Endpoint"
            },
            "revocation_endpoint": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Revocation Endpoint"
            },
            "token_endpoint_auth_methods_supported": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Token Endpoint Auth Methods Supported"
            },
            "grant_types_supported": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Grant Types Supported"
            },
            "scopes": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Scopes"
            }
         },
         "required": [
            "authorization_endpoint",
            "token_endpoint"
         ],
         "title": "OpenIdConnectWithConfig",
         "type": "object"
      },
      "Outcome": {
         "description": "Required. Outcome of the code execution.",
         "enum": [
            "OUTCOME_UNSPECIFIED",
            "OUTCOME_OK",
            "OUTCOME_FAILED",
            "OUTCOME_DEADLINE_EXCEEDED"
         ],
         "title": "Outcome",
         "type": "string"
      },
      "Part": {
         "additionalProperties": false,
         "description": "A datatype containing media content.\n\nExactly one field within a Part should be set, representing the specific type\nof content being conveyed. Using multiple fields within the same `Part`\ninstance is considered invalid.",
         "properties": {
            "videoMetadata": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/VideoMetadata"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Metadata for a given video."
            },
            "thought": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Indicates if the part is thought from the model.",
               "title": "Thought"
            },
            "inlineData": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/Blob"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Inlined bytes data."
            },
            "fileData": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/FileData"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. URI based data."
            },
            "thoughtSignature": {
               "anyOf": [
                  {
                     "format": "base64url",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "An opaque signature for the thought so it can be reused in subsequent requests.",
               "title": "Thoughtsignature"
            },
            "functionCall": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/FunctionCall"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "A predicted [FunctionCall] returned from the model that contains a string\n      representing the [FunctionDeclaration.name] and a structured JSON object\n      containing the parameters and their values."
            },
            "codeExecutionResult": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/CodeExecutionResult"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Result of executing the [ExecutableCode]."
            },
            "executableCode": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/ExecutableCode"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Code generated by the model that is meant to be executed."
            },
            "functionResponse": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/FunctionResponse"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model."
            },
            "text": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Text part (can be code).",
               "title": "Text"
            }
         },
         "title": "Part",
         "type": "object"
      },
      "SecuritySchemeType": {
         "enum": [
            "apiKey",
            "http",
            "oauth2",
            "openIdConnect"
         ],
         "title": "SecuritySchemeType",
         "type": "string"
      },
      "ServiceAccount": {
         "additionalProperties": true,
         "description": "Represents Google Service Account configuration.",
         "properties": {
            "serviceAccountCredential": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/ServiceAccountCredential"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "scopes": {
               "items": {
                  "type": "string"
               },
               "title": "Scopes",
               "type": "array"
            },
            "useDefaultCredential": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": false,
               "title": "Usedefaultcredential"
            }
         },
         "required": [
            "scopes"
         ],
         "title": "ServiceAccount",
         "type": "object"
      },
      "ServiceAccountCredential": {
         "additionalProperties": true,
         "description": "Represents Google Service Account configuration.\n\nAttributes:\n  type: The type should be \"service_account\".\n  project_id: The project ID.\n  private_key_id: The ID of the private key.\n  private_key: The private key.\n  client_email: The client email.\n  client_id: The client ID.\n  auth_uri: The authorization URI.\n  token_uri: The token URI.\n  auth_provider_x509_cert_url: URL for auth provider's X.509 cert.\n  client_x509_cert_url: URL for the client's X.509 cert.\n  universe_domain: The universe domain.\n\nExample:\n\n    config = ServiceAccountCredential(\n        type_=\"service_account\",\n        project_id=\"your_project_id\",\n        private_key_id=\"your_private_key_id\",\n        private_key=\"-----BEGIN PRIVATE KEY-----...\",\n        client_email=\"...@....iam.gserviceaccount.com\",\n        client_id=\"your_client_id\",\n        auth_uri=\"https://accounts.google.com/o/oauth2/auth\",\n        token_uri=\"https://oauth2.googleapis.com/token\",\n        auth_provider_x509_cert_url=\"https://www.googleapis.com/oauth2/v1/certs\",\n        client_x509_cert_url=\"https://www.googleapis.com/robot/v1/metadata/x509/...\",\n        universe_domain=\"googleapis.com\"\n    )\n\n\n    config = ServiceAccountConfig.model_construct(**{\n        ...service account config dict\n    })",
         "properties": {
            "type": {
               "default": "",
               "title": "Type",
               "type": "string"
            },
            "projectId": {
               "title": "Projectid",
               "type": "string"
            },
            "privateKeyId": {
               "title": "Privatekeyid",
               "type": "string"
            },
            "privateKey": {
               "title": "Privatekey",
               "type": "string"
            },
            "clientEmail": {
               "title": "Clientemail",
               "type": "string"
            },
            "clientId": {
               "title": "Clientid",
               "type": "string"
            },
            "authUri": {
               "title": "Authuri",
               "type": "string"
            },
            "tokenUri": {
               "title": "Tokenuri",
               "type": "string"
            },
            "authProviderX509CertUrl": {
               "title": "Authproviderx509Certurl",
               "type": "string"
            },
            "clientX509CertUrl": {
               "title": "Clientx509Certurl",
               "type": "string"
            },
            "universeDomain": {
               "title": "Universedomain",
               "type": "string"
            }
         },
         "required": [
            "projectId",
            "privateKeyId",
            "privateKey",
            "clientEmail",
            "clientId",
            "authUri",
            "tokenUri",
            "authProviderX509CertUrl",
            "clientX509CertUrl",
            "universeDomain"
         ],
         "title": "ServiceAccountCredential",
         "type": "object"
      },
      "ToolConfirmation": {
         "additionalProperties": false,
         "description": "Represents a tool confirmation configuration.",
         "properties": {
            "hint": {
               "default": "",
               "title": "Hint",
               "type": "string"
            },
            "confirmed": {
               "default": false,
               "title": "Confirmed",
               "type": "boolean"
            },
            "payload": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Payload"
            }
         },
         "title": "ToolConfirmation",
         "type": "object"
      },
      "VideoMetadata": {
         "additionalProperties": false,
         "description": "Describes how the video in the Part should be used by the model.",
         "properties": {
            "fps": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The frame rate of the video sent to the model. If not specified, the\n        default value will be 1.0. The fps range is (0.0, 24.0].",
               "title": "Fps"
            },
            "endOffset": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. The end offset of the video.",
               "title": "Endoffset"
            },
            "startOffset": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. The start offset of the video.",
               "title": "Startoffset"
            }
         },
         "title": "VideoMetadata",
         "type": "object"
      }
   },
   "additionalProperties": false
}

Fields:

• agent_state (dict[str, Any] | None)

• artifact_delta (dict[str, int])

• compaction (google.adk.events.event_actions.EventCompaction | None)

• end_of_agent (bool | None)

• escalate (bool | None)

• requested_auth_configs (dict[str, google.adk.auth.auth_tool.AuthConfig])

• requested_tool_confirmations (dict[str, google.adk.tools.tool_confirmation.ToolConfirmation])

• rewind_before_invocation_id (str | None)

• skip_summarization (bool | None)

• state_delta (dict[str, object])

• transfer_to_agent (str | None)

field agent_state: Optional[dict[str, Any]] = None (alias 'agentState')

The agent state at the current event, used for checkpoint and resume. This should only be set by ADK workflow.

field artifact_delta: dict[str, int] [Optional] (alias 'artifactDelta')

Indicates that the event is updating an artifact. key is the filename, value is the version.

field compaction: Optional[EventCompaction] = None

The compaction of the events.

field end_of_agent: Optional[bool] = None (alias 'endOfAgent')

If true, the current agent has finished its current run. Note that there can be multiple events with end_of_agent=True for the same agent within one invocation when there is a loop. This should only be set by ADK workflow.

field escalate: Optional[bool] = None

The agent is escalating to a higher level agent.

field requested_auth_configs: dict[str, AuthConfig] [Optional] (alias 'requestedAuthConfigs')

Authentication configurations requested by tool responses.

This field will only be set by a tool response event indicating tool request auth credential. - Keys: The function call id. Since one function response event could contain multiple function responses that correspond to multiple function calls. Each function call could request different auth configs. This id is used to identify the function call. - Values: The requested auth config.

field requested_tool_confirmations: dict[str, ToolConfirmation] [Optional] (alias 'requestedToolConfirmations')

A dict of tool confirmation requested by this event, keyed by function call id.

field rewind_before_invocation_id: Optional[str] = None (alias 'rewindBeforeInvocationId')

The invocation id to rewind to. This is only set for rewind event.

field skip_summarization: Optional[bool] = None (alias 'skipSummarization')

If true, it won’t call model to summarize function response.

Only used for function_response event.

field state_delta: dict[str, object] [Optional] (alias 'stateDelta')

Indicates that the event is updating the state with the given delta.

field transfer_to_agent: Optional[str] = None (alias 'transferToAgent')

If set, the event transfers to the specified agent.

google.adk.examples module

class google.adk.examples.BaseExampleProvider

Bases: ABC

Base class for example providers.

This class defines the interface for providing examples for a given query.

abstractmethod get_examples(query)

Returns a list of examples for a given query.

Return type:

list[Example]

Parameters:

query – The query to get examples for.

Returns:

A list of Example objects.

pydantic model google.adk.examples.Example

Bases: BaseModel

A few-shot example.

input

The input content for the example.

output

The expected output content for the example.

Show JSON schema

{
   "title": "Example",
   "description": "A few-shot example.\n\nAttributes:\n  input: The input content for the example.\n  output: The expected output content for the example.",
   "type": "object",
   "properties": {
      "input": {
         "$ref": "#/$defs/Content"
      },
      "output": {
         "items": {
            "$ref": "#/$defs/Content"
         },
         "title": "Output",
         "type": "array"
      }
   },
   "$defs": {
      "Blob": {
         "additionalProperties": false,
         "description": "Content blob.",
         "properties": {
            "displayName": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is not currently used in the Gemini GenerateContent calls.",
               "title": "Displayname"
            },
            "data": {
               "anyOf": [
                  {
                     "format": "base64url",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. Raw bytes.",
               "title": "Data"
            },
            "mimeType": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. The IANA standard MIME type of the source data.",
               "title": "Mimetype"
            }
         },
         "title": "Blob",
         "type": "object"
      },
      "CodeExecutionResult": {
         "additionalProperties": false,
         "description": "Result of executing the [ExecutableCode].\n\nOnly generated when using the [CodeExecution] tool, and always follows a\n`part` containing the [ExecutableCode].",
         "properties": {
            "outcome": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/Outcome"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. Outcome of the code execution."
            },
            "output": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Contains stdout when code execution is successful, stderr or other description otherwise.",
               "title": "Output"
            }
         },
         "title": "CodeExecutionResult",
         "type": "object"
      },
      "Content": {
         "additionalProperties": false,
         "description": "Contains the multi-part content of a message.",
         "properties": {
            "parts": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/Part"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "List of parts that constitute a single message. Each part may have\n      a different IANA MIME type.",
               "title": "Parts"
            },
            "role": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. The producer of the content. Must be either 'user' or\n      'model'. Useful to set for multi-turn conversations, otherwise can be\n      empty. If role is not specified, SDK will determine the role.",
               "title": "Role"
            }
         },
         "title": "Content",
         "type": "object"
      },
      "ExecutableCode": {
         "additionalProperties": false,
         "description": "Code generated by the model that is meant to be executed, and the result returned to the model.\n\nGenerated when using the [CodeExecution] tool, in which the code will be\nautomatically executed, and a corresponding [CodeExecutionResult] will also be\ngenerated.",
         "properties": {
            "code": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. The code to be executed.",
               "title": "Code"
            },
            "language": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/Language"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. Programming language of the `code`."
            }
         },
         "title": "ExecutableCode",
         "type": "object"
      },
      "FileData": {
         "additionalProperties": false,
         "description": "URI based data.",
         "properties": {
            "displayName": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. It is not currently used in the Gemini GenerateContent calls.",
               "title": "Displayname"
            },
            "fileUri": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. URI.",
               "title": "Fileuri"
            },
            "mimeType": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. The IANA standard MIME type of the source data.",
               "title": "Mimetype"
            }
         },
         "title": "FileData",
         "type": "object"
      },
      "FunctionCall": {
         "additionalProperties": false,
         "description": "A function call.",
         "properties": {
            "id": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The unique id of the function call. If populated, the client to execute the\n   `function_call` and return the response with the matching `id`.",
               "title": "Id"
            },
            "args": {
               "anyOf": [
                  {
                     "additionalProperties": true,
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.",
               "title": "Args"
            },
            "name": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. The name of the function to call. Matches [FunctionDeclaration.name].",
               "title": "Name"
            }
         },
         "title": "FunctionCall",
         "type": "object"
      },
      "FunctionResponse": {
         "additionalProperties": false,
         "description": "A function response.",
         "properties": {
            "willContinue": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Signals that function call continues, and more responses will be returned, turning the function call into a generator. Is only applicable to NON_BLOCKING function calls (see FunctionDeclaration.behavior for details), ignored otherwise. If false, the default, future responses will not be considered. Is only applicable to NON_BLOCKING function calls, is ignored otherwise. If set to false, future responses will not be considered. It is allowed to return empty `response` with `will_continue=False` to signal that the function call is finished.",
               "title": "Willcontinue"
            },
            "scheduling": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/FunctionResponseScheduling"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE."
            },
            "parts": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/FunctionResponsePart"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "List of parts that constitute a function response. Each part may\n      have a different IANA MIME type.",
               "title": "Parts"
            },
            "id": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`.",
               "title": "Id"
            },
            "name": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].",
               "title": "Name"
            },
            "response": {
               "anyOf": [
                  {
                     "additionalProperties": true,
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. The function response in JSON object format. Use \"output\" key to specify function output and \"error\" key to specify error details (if any). If \"output\" and \"error\" keys are not specified, then whole \"response\" is treated as function output.",
               "title": "Response"
            }
         },
         "title": "FunctionResponse",
         "type": "object"
      },
      "FunctionResponseBlob": {
         "additionalProperties": false,
         "description": "Raw media bytes for function response.\n\nText should not be sent as raw bytes, use the FunctionResponse.response\nfield.",
         "properties": {
            "mimeType": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. The IANA standard MIME type of the source data.",
               "title": "Mimetype"
            },
            "data": {
               "anyOf": [
                  {
                     "format": "base64url",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. Inline media bytes.",
               "title": "Data"
            }
         },
         "title": "FunctionResponseBlob",
         "type": "object"
      },
      "FunctionResponseFileData": {
         "additionalProperties": false,
         "description": "URI based data for function response.",
         "properties": {
            "fileUri": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. URI.",
               "title": "Fileuri"
            },
            "mimeType": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. The IANA standard MIME type of the source data.",
               "title": "Mimetype"
            }
         },
         "title": "FunctionResponseFileData",
         "type": "object"
      },
      "FunctionResponsePart": {
         "additionalProperties": false,
         "description": "A datatype containing media that is part of a `FunctionResponse` message.\n\nA `FunctionResponsePart` consists of data which has an associated datatype. A\n`FunctionResponsePart` can only contain one of the accepted types in\n`FunctionResponsePart.data`.\n\nA `FunctionResponsePart` must have a fixed IANA MIME type identifying the\ntype and subtype of the media if the `inline_data` field is filled with raw\nbytes.",
         "properties": {
            "inlineData": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/FunctionResponseBlob"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Inline media bytes."
            },
            "fileData": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/FunctionResponseFileData"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. URI based data."
            }
         },
         "title": "FunctionResponsePart",
         "type": "object"
      },
      "FunctionResponseScheduling": {
         "description": "Specifies how the response should be scheduled in the conversation.",
         "enum": [
            "SCHEDULING_UNSPECIFIED",
            "SILENT",
            "WHEN_IDLE",
            "INTERRUPT"
         ],
         "title": "FunctionResponseScheduling",
         "type": "string"
      },
      "Language": {
         "description": "Required. Programming language of the `code`.",
         "enum": [
            "LANGUAGE_UNSPECIFIED",
            "PYTHON"
         ],
         "title": "Language",
         "type": "string"
      },
      "Outcome": {
         "description": "Required. Outcome of the code execution.",
         "enum": [
            "OUTCOME_UNSPECIFIED",
            "OUTCOME_OK",
            "OUTCOME_FAILED",
            "OUTCOME_DEADLINE_EXCEEDED"
         ],
         "title": "Outcome",
         "type": "string"
      },
      "Part": {
         "additionalProperties": false,
         "description": "A datatype containing media content.\n\nExactly one field within a Part should be set, representing the specific type\nof content being conveyed. Using multiple fields within the same `Part`\ninstance is considered invalid.",
         "properties": {
            "videoMetadata": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/VideoMetadata"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Metadata for a given video."
            },
            "thought": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Indicates if the part is thought from the model.",
               "title": "Thought"
            },
            "inlineData": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/Blob"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Inlined bytes data."
            },
            "fileData": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/FileData"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. URI based data."
            },
            "thoughtSignature": {
               "anyOf": [
                  {
                     "format": "base64url",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "An opaque signature for the thought so it can be reused in subsequent requests.",
               "title": "Thoughtsignature"
            },
            "functionCall": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/FunctionCall"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "A predicted [FunctionCall] returned from the model that contains a string\n      representing the [FunctionDeclaration.name] and a structured JSON object\n      containing the parameters and their values."
            },
            "codeExecutionResult": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/CodeExecutionResult"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Result of executing the [ExecutableCode]."
            },
            "executableCode": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/ExecutableCode"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Code generated by the model that is meant to be executed."
            },
            "functionResponse": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/FunctionResponse"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model."
            },
            "text": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Text part (can be code).",
               "title": "Text"
            }
         },
         "title": "Part",
         "type": "object"
      },
      "VideoMetadata": {
         "additionalProperties": false,
         "description": "Describes how the video in the Part should be used by the model.",
         "properties": {
            "fps": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The frame rate of the video sent to the model. If not specified, the\n        default value will be 1.0. The fps range is (0.0, 24.0].",
               "title": "Fps"
            },
            "endOffset": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. The end offset of the video.",
               "title": "Endoffset"
            },
            "startOffset": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. The start offset of the video.",
               "title": "Startoffset"
            }
         },
         "title": "VideoMetadata",
         "type": "object"
      }
   },
   "required": [
      "input",
      "output"
   ]
}

Fields:

• input (google.genai.types.Content)

• output (list[google.genai.types.Content])

field input: Content [Required]

field output: list[Content] [Required]

class google.adk.examples.VertexAiExampleStore(examples_store_name)

Bases: BaseExampleProvider

Provides examples from Vertex example store.

Initializes the VertexAiExampleStore.

Parameters:

examples_store_name – The resource name of the vertex example store, in the format of projects/{project}/locations/{location}/exampleStores/{example_store}.

get_examples(query)

Returns a list of examples for a given query.

Return type:

list[Example]

Parameters:

query – The query to get examples for.

Returns:

A list of Example objects.

google.adk.flows module

google.adk.memory module

class google.adk.memory.BaseMemoryService

Bases: ABC

Base class for memory services.

The service provides functionalities to ingest sessions into memory so that the memory can be used for user queries.

abstractmethod async add_session_to_memory(session)

Adds a session to the memory service.

A session may be added multiple times during its lifetime.

Parameters:

session – The session to add.

abstractmethod async search_memory(*, app_name, user_id, query)

Searches for sessions that match the query.

Return type:

SearchMemoryResponse

Parameters:

• app_name – The name of the application.

• user_id – The id of the user.

• query – The query to search for.

Returns:

A SearchMemoryResponse containing the matching memories.

class google.adk.memory.InMemoryMemoryService

Bases: BaseMemoryService

An in-memory memory service for prototyping purpose only.

Uses keyword matching instead of semantic search.

This class is thread-safe, however, it should be used for testing and development only.

async add_session_to_memory(session)

Adds a session to the memory service.

A session may be added multiple times during its lifetime.

Parameters:

session – The session to add.

async search_memory(*, app_name, user_id, query)

Searches for sessions that match the query.

Return type:

SearchMemoryResponse

Parameters:

• app_name – The name of the application.

• user_id – The id of the user.

• query – The query to search for.

Returns:

A SearchMemoryResponse containing the matching memories.

class google.adk.memory.VertexAiMemoryBankService(project=None, location=None, agent_engine_id=None, *, express_mode_api_key=None)

Bases: BaseMemoryService

Implementation of the BaseMemoryService using Vertex AI Memory Bank.

Initializes a VertexAiMemoryBankService.

Parameters:

• project – The project ID of the Memory Bank to use.

• location – The location of the Memory Bank to use.

• agent_engine_id – The ID of the agent engine to use for the Memory Bank. e.g. ‘456’ in ‘projects/my-project/locations/us-central1/reasoningEngines/456’.

• express_mode_api_key – The API key to use for Express Mode. If not provided, the API key from the GOOGLE_API_KEY environment variable will be used. It will only be used if GOOGLE_GENAI_USE_VERTEXAI is true. Do not use Google AI Studio API key for this field. For more details, visit https://cloud.google.com/vertex-ai/generative-ai/docs/start/express-mode/overview

async add_session_to_memory(session)

Adds a session to the memory service.

A session may be added multiple times during its lifetime.

Parameters:

session – The session to add.

async search_memory(*, app_name, user_id, query)

Searches for sessions that match the query.

Parameters:

• app_name – The name of the application.

• user_id – The id of the user.

• query – The query to search for.

Returns:

A SearchMemoryResponse containing the matching memories.

class google.adk.memory.VertexAiRagMemoryService(rag_corpus=None, similarity_top_k=None, vector_distance_threshold=10)

Bases: BaseMemoryService

A memory service that uses Vertex AI RAG for storage and retrieval.

Initializes a VertexAiRagMemoryService.

Parameters:

• rag_corpus – The name of the Vertex AI RAG corpus to use. Format: projects/{project}/locations/{location}/ragCorpora/{rag_corpus_id} or {rag_corpus_id}

• similarity_top_k – The number of contexts to retrieve.

• vector_distance_threshold – Only returns contexts with vector distance smaller than the threshold..

async add_session_to_memory(session)

Adds a session to the memory service.

A session may be added multiple times during its lifetime.

Parameters:

session – The session to add.

async search_memory(*, app_name, user_id, query)

Searches for sessions that match the query using rag.retrieval_query.

Return type:

SearchMemoryResponse

google.adk.models module

Defines the interface to support a model.

pydantic model google.adk.models.BaseLlm

Bases: BaseModel

The BaseLLM class.

Show JSON schema

{
   "title": "BaseLlm",
   "description": "The BaseLLM class.",
   "type": "object",
   "properties": {
      "model": {
         "title": "Model",
         "type": "string"
      }
   },
   "required": [
      "model"
   ]
}

Fields:

• model (str)

field model: str [Required]

The name of the LLM, e.g. gemini-2.5-flash or gemini-2.5-pro.

classmethod supported_models()

Returns a list of supported models in regex for LlmRegistry.

Return type:

list[str]

connect(llm_request)

Creates a live connection to the LLM.

Return type:

BaseLlmConnection

Parameters:

llm_request – LlmRequest, the request to send to the LLM.

Returns:

BaseLlmConnection, the connection to the LLM.

abstractmethod async generate_content_async(llm_request, stream=False)

Generates content for a single model turn.

This method handles Server-Sent Events (SSE) streaming for unidirectional content generation. For bidirectional streaming (e.g., Gemini Live API), use the connect() method instead.

Args:

llm_request: LlmRequest, the request to send to the LLM. stream: bool = False, whether to enable SSE streaming mode.

Yields:

LlmResponse objects representing the model’s response for one turn.

Non-streaming mode (stream=False):

Yields exactly one LlmResponse containing the complete model output (text, function calls, bytes, etc.). This response has partial=False.

Streaming mode (stream=True):

Yields multiple LlmResponse objects as chunks arrive:

• Intermediate chunks: partial=True (progressive updates)

• Final chunk: partial=False (aggregated content from entire turn, identical to stream=False output)

• Text consolidation: Consecutive text parts of the same type (thought/non-thought) SHOULD merge without separator, but client code must not rely on this - unconsolidated parts are unusual but also valid

Common content in partial chunks:

All intermediate chunks have partial=True regardless of content type. Common examples include:

• Text: Streams incrementally as tokens arrive

• Function calls: May arrive in separate chunks

• Bytes (e.g., images): Typically arrive as single chunk, interleaved with text

• Thoughts: Stream incrementally when thinking_config is enabled

Examples:

1. Simple text streaming:

   LlmResponse(partial=True,  parts=["The weather"])
   LlmResponse(partial=True,  parts=[" in Tokyo is"])
   LlmResponse(partial=True,  parts=[" sunny."])
   LlmResponse(partial=False, parts=["The weather in Tokyo is sunny."])
   

2. Text + function call:

   LlmResponse(partial=True,  parts=[Text("Let me check...")])
   LlmResponse(partial=True,  parts=[FunctionCall("get_weather", ...)])
   LlmResponse(partial=False, parts=[Text("Let me check..."),
                                     FunctionCall("get_weather", ...)])
   

3. Parallel function calls across chunks:

   LlmResponse(partial=True,  parts=[Text("Checking both cities...")])
   LlmResponse(partial=True,  parts=[FunctionCall("get_weather", Tokyo)])
   LlmResponse(partial=True,  parts=[FunctionCall("get_weather", NYC)])
   LlmResponse(partial=False, parts=[Text("Checking both cities..."),
                                     FunctionCall("get_weather", Tokyo),
                                     FunctionCall("get_weather", NYC)])
   

4. Text + bytes (image generation with gemini-2.5-flash-image):

   LlmResponse(partial=True,  parts=[Text("Here's an image of a dog.")])
   LlmResponse(partial=True,  parts=[Text("
   

“)])

LlmResponse(partial=True, parts=[Blob(image/png, 1.6MB)]) LlmResponse(partial=True, parts=[Text(“It carries a bone”)]) LlmResponse(partial=True, parts=[Text(” and running around.”)]) LlmResponse(partial=False, parts=[Text(“Here’s an image of a dog.

“),

Blob(image/png, 1.6MB), Text(“It carries a bone and running around.”)])

Note: Consecutive text parts before and after blob merge separately.

5. Text with thinking (gemini-2.5-flash with thinking_config):

   LlmResponse(partial=True,  parts=[Thought("Let me analyze...")])
   LlmResponse(partial=True,  parts=[Thought("The user wants...")])
   LlmResponse(partial=True,  parts=[Text("Based on my analysis,")])
   LlmResponse(partial=True,  parts=[Text(" the answer is 42.")])
   LlmResponse(partial=False, parts=[Thought("Let me analyze...The user wants..."),
                                     Text("Based on my analysis, the answer is 42.")])
   

   Note: Consecutive parts of same type merge (thoughts→thought, text→text).

Important: All yielded responses represent one logical model turn. The final response with partial=False should be identical to the response that would be received with stream=False.

Return type:

AsyncGenerator[LlmResponse, None]

pydantic model google.adk.models.Gemini

Bases: BaseLlm

Integration for Gemini models.

model

The name of the Gemini model.

Show JSON schema

{
   "title": "Gemini",
   "description": "Integration for Gemini models.\n\nAttributes:\n  model: The name of the Gemini model.",
   "type": "object",
   "properties": {
      "model": {
         "default": "gemini-2.5-flash",
         "title": "Model",
         "type": "string"
      },
      "speech_config": {
         "anyOf": [
            {
               "$ref": "#/$defs/SpeechConfig"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "retry_options": {
         "anyOf": [
            {
               "$ref": "#/$defs/HttpRetryOptions"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      }
   },
   "$defs": {
      "HttpRetryOptions": {
         "additionalProperties": false,
         "description": "HTTP retry options to be used in each of the requests.",
         "properties": {
            "attempts": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Maximum number of attempts, including the original request.\n      If 0 or 1, it means no retries.",
               "title": "Attempts"
            },
            "initialDelay": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Initial delay before the first retry, in fractions of a second.",
               "title": "Initialdelay"
            },
            "maxDelay": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Maximum delay between retries, in fractions of a second.",
               "title": "Maxdelay"
            },
            "expBase": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Multiplier by which the delay increases after each attempt.",
               "title": "Expbase"
            },
            "jitter": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Randomness factor for the delay.",
               "title": "Jitter"
            },
            "httpStatusCodes": {
               "anyOf": [
                  {
                     "items": {
                        "type": "integer"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "List of HTTP status codes that should trigger a retry.\n      If not specified, a default set of retryable codes may be used.",
               "title": "Httpstatuscodes"
            }
         },
         "title": "HttpRetryOptions",
         "type": "object"
      },
      "MultiSpeakerVoiceConfig": {
         "additionalProperties": false,
         "description": "The configuration for the multi-speaker setup.",
         "properties": {
            "speakerVoiceConfigs": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/SpeakerVoiceConfig"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The configuration for the speaker to use.",
               "title": "Speakervoiceconfigs"
            }
         },
         "title": "MultiSpeakerVoiceConfig",
         "type": "object"
      },
      "PrebuiltVoiceConfig": {
         "additionalProperties": false,
         "description": "The configuration for the prebuilt speaker to use.",
         "properties": {
            "voiceName": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The name of the prebuilt voice to use.",
               "title": "Voicename"
            }
         },
         "title": "PrebuiltVoiceConfig",
         "type": "object"
      },
      "SpeakerVoiceConfig": {
         "additionalProperties": false,
         "description": "The configuration for the speaker to use.",
         "properties": {
            "speaker": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The name of the speaker to use. Should be the same as in the\n          prompt.",
               "title": "Speaker"
            },
            "voiceConfig": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/VoiceConfig"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The configuration for the voice to use."
            }
         },
         "title": "SpeakerVoiceConfig",
         "type": "object"
      },
      "SpeechConfig": {
         "additionalProperties": false,
         "description": "The speech generation configuration.",
         "properties": {
            "voiceConfig": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/VoiceConfig"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The configuration for the speaker to use.\n      "
            },
            "multiSpeakerVoiceConfig": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/MultiSpeakerVoiceConfig"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The configuration for the multi-speaker setup.\n          It is mutually exclusive with the voice_config field.\n          "
            },
            "languageCode": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Language code (ISO 639. e.g. en-US) for the speech synthesization.\n      Only available for Live API.\n      ",
               "title": "Languagecode"
            }
         },
         "title": "SpeechConfig",
         "type": "object"
      },
      "VoiceConfig": {
         "additionalProperties": false,
         "description": "The configuration for the voice to use.",
         "properties": {
            "prebuiltVoiceConfig": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/PrebuiltVoiceConfig"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The configuration for the speaker to use.\n      "
            }
         },
         "title": "VoiceConfig",
         "type": "object"
      }
   }
}

Fields:

• model (str)

• retry_options (Optional[types.HttpRetryOptions])

• speech_config (Optional[types.SpeechConfig])

field model: str = 'gemini-2.5-flash'

The name of the LLM, e.g. gemini-2.5-flash or gemini-2.5-pro.

field retry_options: Optional[types.HttpRetryOptions] = None

Allow Gemini to retry failed responses.

Sample: ```python from google.genai import types

# …

agent = Agent(

model=Gemini(

retry_options=types.HttpRetryOptions(initial_delay=1, attempts=2),

)

)

field speech_config: Optional[types.SpeechConfig] = None

classmethod supported_models()

Provides the list of supported models.

Return type:

list[str]

Returns:

A list of supported models.

connect(llm_request)

Connects to the Gemini model and returns an llm connection.

Return type:

BaseLlmConnection

Parameters:

llm_request – LlmRequest, the request to send to the Gemini model.

Yields:

BaseLlmConnection, the connection to the Gemini model.

async generate_content_async(llm_request, stream=False)

Sends a request to the Gemini model.

Return type:

AsyncGenerator[LlmResponse, None]

Parameters:

• llm_request – LlmRequest, the request to send to the Gemini model.

• stream – bool = False, whether to do streaming call.

Yields:

LlmResponse – The model response.

property api_client: Client

Provides the api client.

Returns:

The api client.

pydantic model google.adk.models.Gemma

Bases: Gemini

Integration for Gemma models exposed via the Gemini API.

Only Gemma 3 models are supported at this time. For agentic use cases, use of gemma-3-27b-it and gemma-3-12b-it are strongly recommended.

For full documentation, see: https://ai.google.dev/gemma/docs/core/

NOTE: Gemma does NOT support system instructions. Any system instructions will be replaced with an initial user prompt in the LLM request. If system instructions change over the course of agent execution, the initial content SHOULD be replaced. Special care is warranted here. See: https://ai.google.dev/gemma/docs/core/prompt-structure#system-instructions

NOTE: Gemma’s function calling support is limited. It does not have full access to the same built-in tools as Gemini. It also does not have special API support for tools and functions. Rather, tools must be passed in via a user prompt, and extracted from model responses based on approximate shape.

NOTE: Vertex AI API support for Gemma is not currently included. This ONLY supports usage via the Gemini API.

Show JSON schema

{
   "title": "Gemma",
   "description": "Integration for Gemma models exposed via the Gemini API.\n\nOnly Gemma 3 models are supported at this time. For agentic use cases,\nuse of gemma-3-27b-it and gemma-3-12b-it are strongly recommended.\n\nFor full documentation, see: https://ai.google.dev/gemma/docs/core/\n\nNOTE: Gemma does **NOT** support system instructions. Any system instructions\nwill be replaced with an initial *user* prompt in the LLM request. If system\ninstructions change over the course of agent execution, the initial content\n**SHOULD** be replaced. Special care is warranted here.\nSee: https://ai.google.dev/gemma/docs/core/prompt-structure#system-instructions\n\nNOTE: Gemma's function calling support is limited. It does not have full access to the\nsame built-in tools as Gemini. It also does not have special API support for tools and\nfunctions. Rather, tools must be passed in via a `user` prompt, and extracted from model\nresponses based on approximate shape.\n\nNOTE: Vertex AI API support for Gemma is not currently included. This **ONLY** supports\nusage via the Gemini API.",
   "type": "object",
   "properties": {
      "model": {
         "default": "gemma-3-27b-it",
         "title": "Model",
         "type": "string"
      },
      "speech_config": {
         "anyOf": [
            {
               "$ref": "#/$defs/SpeechConfig"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "retry_options": {
         "anyOf": [
            {
               "$ref": "#/$defs/HttpRetryOptions"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      }
   },
   "$defs": {
      "HttpRetryOptions": {
         "additionalProperties": false,
         "description": "HTTP retry options to be used in each of the requests.",
         "properties": {
            "attempts": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Maximum number of attempts, including the original request.\n      If 0 or 1, it means no retries.",
               "title": "Attempts"
            },
            "initialDelay": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Initial delay before the first retry, in fractions of a second.",
               "title": "Initialdelay"
            },
            "maxDelay": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Maximum delay between retries, in fractions of a second.",
               "title": "Maxdelay"
            },
            "expBase": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Multiplier by which the delay increases after each attempt.",
               "title": "Expbase"
            },
            "jitter": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Randomness factor for the delay.",
               "title": "Jitter"
            },
            "httpStatusCodes": {
               "anyOf": [
                  {
                     "items": {
                        "type": "integer"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "List of HTTP status codes that should trigger a retry.\n      If not specified, a default set of retryable codes may be used.",
               "title": "Httpstatuscodes"
            }
         },
         "title": "HttpRetryOptions",
         "type": "object"
      },
      "MultiSpeakerVoiceConfig": {
         "additionalProperties": false,
         "description": "The configuration for the multi-speaker setup.",
         "properties": {
            "speakerVoiceConfigs": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/SpeakerVoiceConfig"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The configuration for the speaker to use.",
               "title": "Speakervoiceconfigs"
            }
         },
         "title": "MultiSpeakerVoiceConfig",
         "type": "object"
      },
      "PrebuiltVoiceConfig": {
         "additionalProperties": false,
         "description": "The configuration for the prebuilt speaker to use.",
         "properties": {
            "voiceName": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The name of the prebuilt voice to use.",
               "title": "Voicename"
            }
         },
         "title": "PrebuiltVoiceConfig",
         "type": "object"
      },
      "SpeakerVoiceConfig": {
         "additionalProperties": false,
         "description": "The configuration for the speaker to use.",
         "properties": {
            "speaker": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The name of the speaker to use. Should be the same as in the\n          prompt.",
               "title": "Speaker"
            },
            "voiceConfig": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/VoiceConfig"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The configuration for the voice to use."
            }
         },
         "title": "SpeakerVoiceConfig",
         "type": "object"
      },
      "SpeechConfig": {
         "additionalProperties": false,
         "description": "The speech generation configuration.",
         "properties": {
            "voiceConfig": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/VoiceConfig"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The configuration for the speaker to use.\n      "
            },
            "multiSpeakerVoiceConfig": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/MultiSpeakerVoiceConfig"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The configuration for the multi-speaker setup.\n          It is mutually exclusive with the voice_config field.\n          "
            },
            "languageCode": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Language code (ISO 639. e.g. en-US) for the speech synthesization.\n      Only available for Live API.\n      ",
               "title": "Languagecode"
            }
         },
         "title": "SpeechConfig",
         "type": "object"
      },
      "VoiceConfig": {
         "additionalProperties": false,
         "description": "The configuration for the voice to use.",
         "properties": {
            "prebuiltVoiceConfig": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/PrebuiltVoiceConfig"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The configuration for the speaker to use.\n      "
            }
         },
         "title": "VoiceConfig",
         "type": "object"
      }
   }
}

Fields:

• model (str)

field model: str = 'gemma-3-27b-it'

The name of the LLM, e.g. gemini-2.5-flash or gemini-2.5-pro.

classmethod supported_models()

Provides the list of supported models.

Returns: A list of supported models.

Return type:

list[str]

async generate_content_async(llm_request, stream=False)

Sends a request to the Gemma model.

Return type:

AsyncGenerator[LlmResponse, None]

Parameters:

• llm_request – LlmRequest, the request to send to the Gemini model.

• stream – bool = False, whether to do streaming call.

Yields:

LlmResponse – The model response.

class google.adk.models.LLMRegistry

Bases: object

Registry for LLMs.

static new_llm(model)

Creates a new LLM instance.

Return type:

BaseLlm

Parameters:

model – The model name.

Returns:

The LLM instance.

static register(llm_cls)

Registers a new LLM class.

Parameters:

llm_cls – The class that implements the model.

static resolve(model)

Resolves the model to a BaseLlm subclass.

Return type:

type[BaseLlm]

Parameters:

model – The model name.

Returns:

The BaseLlm subclass.

Raises:

ValueError – If the model is not found.

google.adk.planners module

class google.adk.planners.BasePlanner

Bases: ABC

Abstract base class for all planners.

The planner allows the agent to generate plans for the queries to guide its action.

abstractmethod build_planning_instruction(readonly_context, llm_request)

Builds the system instruction to be appended to the LLM request for planning.

Return type:

Optional[str]

Parameters:

• readonly_context – The readonly context of the invocation.

• llm_request – The LLM request. Readonly.

Returns:

The planning system instruction, or None if no instruction is needed.

abstractmethod process_planning_response(callback_context, response_parts)

Processes the LLM response for planning.

Return type:

Optional[List[Part]]

Parameters:

• callback_context – The callback context of the invocation.

• response_parts – The LLM response parts. Readonly.

Returns:

The processed response parts, or None if no processing is needed.

class google.adk.planners.BuiltInPlanner(*, thinking_config)

Bases: BasePlanner

The built-in planner that uses model’s built-in thinking features.

thinking_config

Config for model built-in thinking features. An error will be returned if this field is set for models that don’t support thinking.

Initializes the built-in planner.

Parameters:

thinking_config – Config for model built-in thinking features. An error will be returned if this field is set for models that don’t support thinking.

apply_thinking_config(llm_request)

Applies the thinking config to the LLM request.

Return type:

None

Parameters:

llm_request – The LLM request to apply the thinking config to.

build_planning_instruction(readonly_context, llm_request)

Builds the system instruction to be appended to the LLM request for planning.

Return type:

Optional[str]

Parameters:

• readonly_context – The readonly context of the invocation.

• llm_request – The LLM request. Readonly.

Returns:

The planning system instruction, or None if no instruction is needed.

process_planning_response(callback_context, response_parts)

Processes the LLM response for planning.

Return type:

Optional[List[Part]]

Parameters:

• callback_context – The callback context of the invocation.

• response_parts – The LLM response parts. Readonly.

Returns:

The processed response parts, or None if no processing is needed.

thinking_config: ThinkingConfig

Config for model built-in thinking features. An error will be returned if this field is set for models that don’t support thinking.

class google.adk.planners.PlanReActPlanner

Bases: BasePlanner

Plan-Re-Act planner that constrains the LLM response to generate a plan before any action/observation.

Note: this planner does not require the model to support built-in thinking features or setting the thinking config.

build_planning_instruction(readonly_context, llm_request)

Builds the system instruction to be appended to the LLM request for planning.

Return type:

str

Parameters:

• readonly_context – The readonly context of the invocation.

• llm_request – The LLM request. Readonly.

Returns:

The planning system instruction, or None if no instruction is needed.

process_planning_response(callback_context, response_parts)

Processes the LLM response for planning.

Return type:

Optional[List[Part]]

Parameters:

• callback_context – The callback context of the invocation.

• response_parts – The LLM response parts. Readonly.

Returns:

The processed response parts, or None if no processing is needed.

google.adk.platform module

google.adk.plugins module

class google.adk.plugins.BasePlugin(name)

Bases: ABC

Base class for creating plugins.

Plugins provide a structured way to intercept and modify agent, tool, and LLM behaviors at critical execution points in a callback manner. While agent callbacks apply to a particular agent, plugins applies globally to all agents added in the runner. Plugins are best used for adding custom behaviors like logging, monitoring, caching, or modifying requests and responses at key stages.

A plugin can implement one or more methods of callbacks, but should not implement the same method of callback for multiple times.

Relation with [Agent callbacks](https://google.github.io/adk-docs/callbacks/):

Execution Order Similar to Agent callbacks, Plugins are executed in the order they are registered. However, Plugin and Agent Callbacks are executed sequentially, with Plugins takes precedence over agent callbacks. When the callback in a plugin returns a value, it will short circuit all remaining plugins and agent callbacks, causing all remaining plugins and agent callbacks to be skipped.

Change Propagation Plugins and agent callbacks can both modify the value of the input parameters, including agent input, tool input, and LLM request/response, etc. They work in the exactly same way. The modifications will be visible and passed to the next callback in the chain. For example, if a plugin modifies the tool input with before_tool_callback, the modified tool input will be passed to the before_tool_callback of the next plugin, and further passed to the agent callbacks if not short circuited.

To use a plugin, implement the desired callback methods and pass an instance of your custom plugin class to the ADK Runner.

Examples

A simple plugin that logs every tool call.

>>> class ToolLoggerPlugin(BasePlugin):
..   def __init__(self):
..     super().__init__(name="tool_logger")
..
..   async def before_tool_callback(
..       self, *, tool: BaseTool, tool_args: dict[str, Any],
tool_context:
ToolContext
..   ):
..     print(f"[{self.name}] Calling tool '{tool.name}' with args:
{tool_args}")
..
..   async def after_tool_callback(
..       self, *, tool: BaseTool, tool_args: dict, tool_context:
ToolContext, result: dict
..   ):
..     print(f"[{self.name}] Tool '{tool.name}' finished with result:
{result}")
..
>>> # Add the plugin to ADK Runner
>>> # runner = Runner(
>>> #     ...
>>> #     plugins=[ToolLoggerPlugin(), AgentPolicyPlugin()],
>>> # )

Initializes the plugin.

Parameters:

name – A unique identifier for this plugin instance.

async after_agent_callback(*, agent, callback_context)

Callback executed after an agent’s primary logic has completed.

Return type:

Optional[Content]

Parameters:

• agent – The agent that has just run.

• callback_context – The context for the agent invocation.

Returns:

An optional types.Content object. The content to return to the user. When the content is present, the provided content will be used as agent response and appended to event history as agent response.

async after_model_callback(*, callback_context, llm_response)

Callback executed after a response is received from the model.

This is the ideal place to log model responses, collect metrics on token usage, or perform post-processing on the raw LlmResponse.

Return type:

Optional[LlmResponse]

Parameters:

• callback_context – The context for the current agent call.

• llm_response – The response object received from the model.

Returns:

An optional value. A non-None return may be used by the framework to modify or replace the response. Returning None allows the original response to be used.

async after_run_callback(*, invocation_context)

Callback executed after an ADK runner run has completed.

This is the final callback in the ADK lifecycle, suitable for cleanup, final logging, or reporting tasks.

Return type:

None

Parameters:

invocation_context – The context for the entire invocation.

Returns:

None

async after_tool_callback(*, tool, tool_args, tool_context, result)

Callback executed after a tool has been called.

This callback allows for inspecting, logging, or modifying the result returned by a tool.

Return type:

Optional[dict]

Parameters:

• tool – The tool instance that has just been executed.

• tool_args – The original arguments that were passed to the tool.

• tool_context – The context specific to the tool execution.

• result – The dictionary returned by the tool invocation.

Returns:

An optional dictionary. If a dictionary is returned, it will replace the original result from the tool. This allows for post-processing or altering tool outputs. Returning None uses the original, unmodified result.

async before_agent_callback(*, agent, callback_context)

Callback executed before an agent’s primary logic is invoked.

This callback can be used for logging, setup, or to short-circuit the agent’s execution by returning a value.

Return type:

Optional[Content]

Parameters:

• agent – The agent that is about to run.

• callback_context – The context for the agent invocation.

Returns:

An optional types.Content object. If a value is returned, it will bypass the agent’s callbacks and its execution, and return this value directly. Returning None allows the agent to proceed normally.

async before_model_callback(*, callback_context, llm_request)

Callback executed before a request is sent to the model.

This provides an opportunity to inspect, log, or modify the LlmRequest object. It can also be used to implement caching by returning a cached LlmResponse, which would skip the actual model call.

Return type:

Optional[LlmResponse]

Parameters:

• callback_context – The context for the current agent call.

• llm_request – The prepared request object to be sent to the model.

Returns:

An optional value. The interpretation of a non-None trigger an early exit and returns the response immediately. Returning None allows the LLM request to proceed normally.

async before_run_callback(*, invocation_context)

Callback executed before the ADK runner runs.

This is the first callback to be called in the lifecycle, ideal for global setup or initialization tasks.

Return type:

Optional[Content]

Parameters:

invocation_context – The context for the entire invocation, containing session information, the root agent, etc.

Returns:

An optional Event to be returned to the ADK. Returning a value to halt execution of the runner and ends the runner with that event. Return None to proceed normally.

async before_tool_callback(*, tool, tool_args, tool_context)

Callback executed before a tool is called.

This callback is useful for logging tool usage, input validation, or modifying the arguments before they are passed to the tool.

Return type:

Optional[dict]

Parameters:

• tool – The tool instance that is about to be executed.

• tool_args – The dictionary of arguments to be used for invoking the tool.

• tool_context – The context specific to the tool execution.

Returns:

An optional dictionary. If a dictionary is returned, it will stop the tool execution and return this response immediately. Returning None uses the original, unmodified arguments.

async close()

Method executed when the runner is closed.

This method is used for cleanup tasks such as closing network connections or releasing resources.

Return type:

None

async on_event_callback(*, invocation_context, event)

Callback executed after an event is yielded from runner.

This is the ideal place to make modification to the event before the event is handled by the underlying agent app.

Return type:

Optional[Event]

Parameters:

• invocation_context – The context for the entire invocation.

• event – The event raised by the runner.

Returns:

An optional value. A non-None return may be used by the framework to modify or replace the response. Returning None allows the original response to be used.

async on_model_error_callback(*, callback_context, llm_request, error)

Callback executed when a model call encounters an error.

This callback provides an opportunity to handle model errors gracefully, potentially providing alternative responses or recovery mechanisms.

Return type:

Optional[LlmResponse]

Parameters:

• callback_context – The context for the current agent call.

• llm_request – The request that was sent to the model when the error occurred.

• error – The exception that was raised during model execution.

Returns:

An optional LlmResponse. If an LlmResponse is returned, it will be used instead of propagating the error. Returning None allows the original error to be raised.

async on_tool_error_callback(*, tool, tool_args, tool_context, error)

Callback executed when a tool call encounters an error.

This callback provides an opportunity to handle tool errors gracefully, potentially providing alternative responses or recovery mechanisms.

Return type:

Optional[dict]

Parameters:

• tool – The tool instance that encountered an error.

• tool_args – The arguments that were passed to the tool.

• tool_context – The context specific to the tool execution.

• error – The exception that was raised during tool execution.

Returns:

An optional dictionary. If a dictionary is returned, it will be used as the tool response instead of propagating the error. Returning None allows the original error to be raised.

async on_user_message_callback(*, invocation_context, user_message)

Callback executed when a user message is received before an invocation starts.

This callback helps logging and modifying the user message before the runner starts the invocation.

Return type:

Optional[Content]

Parameters:

• invocation_context – The context for the entire invocation.

• user_message – The message content input by user.

Returns:

An optional types.Content to be returned to the ADK. Returning a value to replace the user message. Returning None to proceed normally.

class google.adk.plugins.LoggingPlugin(name='logging_plugin')

Bases: BasePlugin

A plugin that logs important information at each callback point.

This plugin helps printing all critical events in the console. It is not a replacement of existing logging in ADK. It rather helps terminal based debugging by showing all logs in the console, and serves as a simple demo for everyone to leverage when developing new plugins.

This plugin helps users track the invocation status by logging: - User messages and invocation context - Agent execution flow - LLM requests and responses - Tool calls with arguments and results - Events and final responses - Errors during model and tool execution

Example

>>> logging_plugin = LoggingPlugin()
>>> runner = Runner(
...     agents=[my_agent],
...     # ...
...     plugins=[logging_plugin],
... )

Initialize the logging plugin.

Parameters:

name – The name of the plugin instance.

async after_agent_callback(*, agent, callback_context)

Log agent execution completion.

Return type:

Optional[Content]

async after_model_callback(*, callback_context, llm_response)

Log LLM response after receiving from model.

Return type:

Optional[LlmResponse]

async after_run_callback(*, invocation_context)

Log invocation completion.

Return type:

None

async after_tool_callback(*, tool, tool_args, tool_context, result)

Log tool execution completion.

Return type:

Optional[dict]

async before_agent_callback(*, agent, callback_context)

Log agent execution start.

Return type:

Optional[Content]

async before_model_callback(*, callback_context, llm_request)

Log LLM request before sending to model.

Return type:

Optional[LlmResponse]

async before_run_callback(*, invocation_context)

Log invocation start.

Return type:

Optional[Content]

async before_tool_callback(*, tool, tool_args, tool_context)

Log tool execution start.

Return type:

Optional[dict]

async on_event_callback(*, invocation_context, event)

Log events yielded from the runner.

Return type:

Optional[Event]

async on_model_error_callback(*, callback_context, llm_request, error)

Log LLM error.

Return type:

Optional[LlmResponse]

async on_tool_error_callback(*, tool, tool_args, tool_context, error)

Log tool error.

Return type:

Optional[dict]

async on_user_message_callback(*, invocation_context, user_message)

Log user message and invocation start.

Return type:

Optional[Content]

class google.adk.plugins.PluginManager(plugins=None, close_timeout=5.0)

Bases: object

Manages the registration and execution of plugins.

The PluginManager is an internal class that orchestrates the invocation of plugin callbacks at key points in the SDK’s execution lifecycle. It maintains a list of registered plugins and ensures they are called in the order they were registered.

The core execution logic implements an “early exit” strategy: if any plugin callback returns a non-None value, the execution of subsequent plugins for that specific event is halted, and the returned value is propagated up the call stack. This allows plugins to short-circuit operations like agent runs, tool calls, or model requests.

Initializes the plugin service.

Parameters:

• plugins – An optional list of plugins to register upon initialization.

• close_timeout – The timeout in seconds for each plugin’s close method.

async close()

Calls the close method on all registered plugins concurrently.

Return type:

None

Raises:

RuntimeError – If one or more plugins failed to close, containing details of all failures.

get_plugin(plugin_name)

Retrieves a registered plugin by its name.

Return type:

Optional[BasePlugin]

Parameters:

plugin_name – The name of the plugin to retrieve.

Returns:

The plugin instance if found; otherwise, None.

register_plugin(plugin)

Registers a new plugin.

Return type:

None

Parameters:

plugin – The plugin instance to register.

Raises:

ValueError – If a plugin with the same name is already registered.

async run_after_agent_callback(*, agent, callback_context)

Runs the after_agent_callback for all plugins.

Return type:

Optional[Content]

async run_after_model_callback(*, callback_context, llm_response)

Runs the after_model_callback for all plugins.

Return type:

Optional[LlmResponse]

async run_after_run_callback(*, invocation_context)

Runs the after_run_callback for all plugins.

Return type:

None

async run_after_tool_callback(*, tool, tool_args, tool_context, result)

Runs the after_tool_callback for all plugins.

Return type:

Optional[dict]

async run_before_agent_callback(*, agent, callback_context)

Runs the before_agent_callback for all plugins.

Return type:

Optional[Content]

async run_before_model_callback(*, callback_context, llm_request)

Runs the before_model_callback for all plugins.

Return type:

Optional[LlmResponse]

async run_before_run_callback(*, invocation_context)

Runs the before_run_callback for all plugins.

Return type:

Optional[Content]

async run_before_tool_callback(*, tool, tool_args, tool_context)

Runs the before_tool_callback for all plugins.

Return type:

Optional[dict]

async run_on_event_callback(*, invocation_context, event)

Runs the on_event_callback for all plugins.

Return type:

Optional[Event]

async run_on_model_error_callback(*, callback_context, llm_request, error)

Runs the on_model_error_callback for all plugins.

Return type:

Optional[LlmResponse]

async run_on_tool_error_callback(*, tool, tool_args, tool_context, error)

Runs the on_tool_error_callback for all plugins.

Return type:

Optional[dict]

async run_on_user_message_callback(*, user_message, invocation_context)

Runs the on_user_message_callback for all plugins.

Return type:

Optional[Content]

class google.adk.plugins.ReflectAndRetryToolPlugin(name='reflect_retry_tool_plugin', max_retries=3, throw_exception_if_retry_exceeded=True, tracking_scope=TrackingScope.INVOCATION)

Bases: BasePlugin

Provides self-healing, concurrent-safe error recovery for tool failures.

This plugin intercepts tool failures, provides structured guidance to the LLM for reflection and correction, and retries the operation up to a configurable limit.

Key Features:

• Concurrency Safe: Uses locking to safely handle parallel tool

executions - Configurable Scope: Tracks failures per-invocation (default) or globally

using the TrackingScope enum.

• Extensible Scoping: The _get_scope_key method can be overridden to implement custom tracking logic (e.g., per-user or per-session).

• Granular Tracking: Failure counts are tracked per-tool within the defined scope. A success with one tool resets its counter without affecting others.

• Custom Error Extraction: Supports detecting errors in normal tool

responses that

don’t throw exceptions, by overriding the extract_error_from_result method.

Example: ```python from my_project.plugins import ReflectAndRetryToolPlugin, TrackingScope

# Example 1: (MOST COMMON USAGE): # Track failures only within the current agent invocation (default). error_handling_plugin = ReflectAndRetryToolPlugin(max_retries=3)

# Example 2: # Track failures globally across all turns and users. global_error_handling_plugin = ReflectAndRetryToolPlugin(max_retries=5, scope=TrackingScope.GLOBAL)

# Example 3: # Retry on failures but do not throw exceptions. error_handling_plugin =

ReflectAndRetryToolPlugin(max_retries=3, throw_exception_if_retry_exceeded=False)

# Example 4: # Track failures in successful tool responses that contain errors. class CustomRetryPlugin(ReflectAndRetryToolPlugin):

async def extract_error_from_result(self, *, tool, tool_args,tool_context, result):

# Detect error based on response content if result.get(‘status’) == ‘error’:

return result

return None # No error detected

error_handling_plugin = CustomRetryPlugin(max_retries=5) ```

Initializes the ReflectAndRetryToolPlugin.

Parameters:

• name – Plugin instance identifier.

• max_retries – Maximum consecutive failures before giving up (0 = no retries).

• throw_exception_if_retry_exceeded – If True, raises the final exception when the retry limit is reached. If False, returns guidance instead.

• tracking_scope – Determines the lifecycle of the error tracking state. Defaults to TrackingScope.INVOCATION tracking per-invocation.

async after_tool_callback(*, tool, tool_args, tool_context, result)

Handles successful tool calls or extracts and processes errors.

Return type:

Optional[dict[str, Any]]

Parameters:

• tool – The tool that was called.

• tool_args – The arguments passed to the tool.

• tool_context – The context of the tool call.

• result – The result of the tool call.

Returns:

An optional dictionary containing reflection guidance if an error is detected, or None if the tool call was successful or the response is already a reflection message.

async extract_error_from_result(*, tool, tool_args, tool_context, result)

Extracts an error from a successful tool result and triggers retry logic.

This is useful when tool call finishes successfully but the result contains an error object like {“error”: …} that should be handled by the plugin.

By overriding this method, you can trigger retry logic on these successful results that contain errors.

Return type:

Optional[dict[str, Any]]

Parameters:

• tool – The tool that was called.

• tool_args – The arguments passed to the tool.

• tool_context – The context of the tool call.

• result – The result of the tool call.

Returns:

The extracted error if any, or None if no error was detected.

async on_tool_error_callback(*, tool, tool_args, tool_context, error)

Handles tool exceptions by providing reflection guidance.

Return type:

Optional[dict[str, Any]]

Parameters:

• tool – The tool that was called.

• tool_args – The arguments passed to the tool.

• tool_context – The context of the tool call.

• error – The exception raised by the tool.

Returns:

An optional dictionary containing reflection guidance for the error.

google.adk.runners module

class google.adk.runners.InMemoryRunner(agent=None, *, app_name=None, plugins=None, app=None, plugin_close_timeout=5.0)

Bases: Runner

An in-memory Runner for testing and development.

This runner uses in-memory implementations for artifact, session, and memory services, providing a lightweight and self-contained environment for agent execution.

agent

The root agent to run.

app_name

The application name of the runner. Defaults to ‘InMemoryRunner’.

Initializes the InMemoryRunner.

Parameters:

• agent – The root agent to run.

• app_name – The application name of the runner. Defaults to ‘InMemoryRunner’.

• plugins – Optional list of plugins for the runner.

• app – Optional App instance.

• plugin_close_timeout – The timeout in seconds for plugin close methods.

class google.adk.runners.Runner(*, app=None, app_name=None, agent=None, plugins=None, artifact_service=None, session_service, memory_service=None, credential_service=None, plugin_close_timeout=5.0)

Bases: object

The Runner class is used to run agents.

It manages the execution of an agent within a session, handling message processing, event generation, and interaction with various services like artifact storage, session management, and memory.

app_name

The application name of the runner.

agent

The root agent to run.

artifact_service

The artifact service for the runner.

plugin_manager

The plugin manager for the runner.

session_service

The session service for the runner.

memory_service

The memory service for the runner.

credential_service

The credential service for the runner.

context_cache_config

The context cache config for the runner.

resumability_config

The resumability config for the application.

Initializes the Runner.

Developers should provide either an app instance or both app_name and agent. Providing a mix of app and app_name/agent will result in a ValueError. Providing app is the recommended way to create a runner.

Parameters:

• app – An optional App instance. If provided, app_name and agent should not be specified.

• app_name – The application name of the runner. Required if app is not provided.

• agent – The root agent to run. Required if app is not provided.

• plugins – Deprecated. A list of plugins for the runner. Please use the app argument to provide plugins instead.

• artifact_service – The artifact service for the runner.

• session_service – The session service for the runner.

• memory_service – The memory service for the runner.

• credential_service – The credential service for the runner.

• plugin_close_timeout – The timeout in seconds for plugin close methods.

Raises:

ValueError – If app is provided along with app_name or plugins, or if app is not provided but either app_name or agent is missing.

agent: BaseAgent

The root agent to run.

app_name: str

The app name of the runner.

artifact_service: Optional[BaseArtifactService] = None

The artifact service for the runner.

async close()

Closes the runner.

context_cache_config: Optional[ContextCacheConfig] = None

The context cache config for the runner.

credential_service: Optional[BaseCredentialService] = None

The credential service for the runner.

memory_service: Optional[BaseMemoryService] = None

The memory service for the runner.

plugin_manager: PluginManager

The plugin manager for the runner.

resumability_config: Optional[ResumabilityConfig] = None

The resumability config for the application.

async rewind_async(*, user_id, session_id, rewind_before_invocation_id)

Rewinds the session to before the specified invocation.

Return type:

None

run(*, user_id, session_id, new_message, run_config=None)

Runs the agent.

Return type:

Generator[Event, None, None]

Note

This sync interface is only for local testing and convenience purpose. Consider using run_async for production usage.

If event compaction is enabled in the App configuration, it will be performed after all agent events for the current invocation have been yielded. The generator will only finish iterating after event compaction is complete.

Parameters:

• user_id – The user ID of the session.

• session_id – The session ID of the session.

• new_message – A new message to append to the session.

• run_config – The run config for the agent.

Yields:

The events generated by the agent.

async run_async(*, user_id, session_id, invocation_id=None, new_message=None, state_delta=None, run_config=None)

Main entry method to run the agent in this runner.

If event compaction is enabled in the App configuration, it will be performed after all agent events for the current invocation have been yielded. The async generator will only finish iterating after event compaction is complete. However, this does not block new run_async calls for subsequent user queries, which can be started concurrently.

Return type:

AsyncGenerator[Event, None]

Parameters:

• user_id – The user ID of the session.

• session_id – The session ID of the session.

• invocation_id – The invocation ID of the session, set this to resume an interrupted invocation.

• new_message – A new message to append to the session.

• state_delta – Optional state changes to apply to the session.

• run_config – The run config for the agent.

Yields:

The events generated by the agent.

Raises:

ValueError – If the session is not found; If both invocation_id and new_message are None.

async run_debug(user_messages, *, user_id='debug_user_id', session_id='debug_session_id', run_config=None, quiet=False, verbose=False)

Debug helper for quick agent experimentation and testing.

This convenience method is designed for developers getting started with ADK who want to quickly test agents without dealing with session management, content formatting, or event streaming. It automatically handles common boilerplate while hiding complexity.

IMPORTANT: This is for debugging and experimentation only. For production use, please use the standard run_async() method which provides full control over session management, event streaming, and error handling.

Return type:

list[Event]

Parameters:

• user_messages – Message(s) to send to the agent. Can be: - Single string: “What is 2+2?” - List of strings: [“Hello!”, “What’s my name?”]

• user_id – User identifier. Defaults to “debug_user_id”.

• session_id – Session identifier for conversation persistence. Defaults to “debug_session_id”. Reuse the same ID to continue a conversation.

• run_config – Optional configuration for the agent execution.

• quiet – If True, suppresses console output. Defaults to False (output shown).

• verbose – If True, shows detailed tool calls and responses. Defaults to False for cleaner output showing only final agent responses.

Returns:

All events from all messages.

Return type:

list[Event]

Raises:

ValueError – If session creation/retrieval fails.

Examples

Quick debugging: >>> runner = InMemoryRunner(agent=my_agent) >>> await runner.run_debug(“What is 2+2?”)

Multiple queries in conversation: >>> await runner.run_debug([“Hello!”, “What’s my name?”])

Continue a debug session: >>> await runner.run_debug(“What did we discuss?”) # Continues default session

Separate debug sessions: >>> await runner.run_debug(“Hi”, user_id=”alice”, session_id=”debug1”) >>> await runner.run_debug(“Hi”, user_id=”bob”, session_id=”debug2”)

Capture events for inspection: >>> events = await runner.run_debug(“Analyze this”) >>> for event in events: … inspect_event(event)

Note

For production applications requiring: - Custom session/memory services (Spanner, Cloud SQL, etc.) - Fine-grained event processing and streaming - Error recovery and resumability - Performance optimization Please use run_async() with proper configuration.

async run_live(*, user_id=None, session_id=None, live_request_queue, run_config=None, session=None)

Runs the agent in live mode (experimental feature).

The run_live method yields a stream of Event objects, but not all yielded events are saved to the session. Here’s a breakdown:

Return type:

AsyncGenerator[Event, None]

Events Yielded to Callers: * Live Model Audio Events with Inline Data: Events containing raw

audio Blob data(inline_data).

• Live Model Audio Events with File Data: Both input and ouput audio data are aggregated into a audio file saved into artifacts. The reference to the file is saved in the event as file_data.

• Usage Metadata: Events containing token usage.

• Transcription Events: Both partial and non-partial transcription events are yielded.

• Function Call and Response Events: Always saved.

• Other Control Events: Most control events are saved.

Events Saved to the Session: * Live Model Audio Events with File Data: Both input and ouput audio

data are aggregated into a audio file saved into artifacts. The reference to the file is saved as event in the file_data to session if RunConfig.save_live_model_audio_to_session is True.

• Usage Metadata Events: Saved to the session.

• Non-Partial Transcription Events: Non-partial transcription events are saved.

• Function Call and Response Events: Always saved.

• Other Control Events: Most control events are saved.

Events Not Saved to the Session: * Live Model Audio Events with Inline Data: Events containing raw

audio Blob data are not saved to the session.

Parameters:

• user_id – The user ID for the session. Required if session is None.

• session_id – The session ID for the session. Required if session is None.

• live_request_queue – The queue for live requests.

• run_config – The run config for the agent.

• session – The session to use. This parameter is deprecated, please use user_id and session_id instead.

Yields:

AsyncGenerator[Event, None] – An asynchronous generator that yields Event objects as they are produced by the agent during its live execution.

Warning

This feature is experimental and its API or behavior may change in future releases.

Note

Either session or both user_id and session_id must be provided.

session_service: BaseSessionService

The session service for the runner.

google.adk.sessions module

class google.adk.sessions.BaseSessionService

Bases: ABC

Base class for session services.

The service provides a set of methods for managing sessions and events.

async append_event(session, event)

Appends an event to a session object.

Return type:

Event

abstractmethod async create_session(*, app_name, user_id, state=None, session_id=None)

Creates a new session.

Return type:

Session

Parameters:

• app_name – the name of the app.

• user_id – the id of the user.

• state – the initial state of the session.

• session_id – the client-provided id of the session. If not provided, a generated ID will be used.

Returns:

The newly created session instance.

Return type:

session

abstractmethod async delete_session(*, app_name, user_id, session_id)

Deletes a session.

Return type:

None

abstractmethod async get_session(*, app_name, user_id, session_id, config=None)

Gets a session.

Return type:

Optional[Session]

abstractmethod async list_sessions(*, app_name, user_id=None)

Lists all the sessions for a user.

Return type:

ListSessionsResponse

Parameters:

• app_name – The name of the app.

• user_id – The ID of the user. If not provided, lists all sessions for all users.

Returns:

A ListSessionsResponse containing the sessions.

class google.adk.sessions.InMemorySessionService

Bases: BaseSessionService

An in-memory implementation of the session service.

It is not suitable for multi-threaded production environments. Use it for testing and development only.

async append_event(session, event)

Appends an event to a session object.

Return type:

Event

async create_session(*, app_name, user_id, state=None, session_id=None)

Creates a new session.

Return type:

Session

Parameters:

• app_name – the name of the app.

• user_id – the id of the user.

• state – the initial state of the session.

• session_id – the client-provided id of the session. If not provided, a generated ID will be used.

Returns:

The newly created session instance.

Return type:

session

create_session_sync(*, app_name, user_id, state=None, session_id=None)

Return type:

Session

async delete_session(*, app_name, user_id, session_id)

Deletes a session.

Return type:

None

delete_session_sync(*, app_name, user_id, session_id)

Return type:

None

async get_session(*, app_name, user_id, session_id, config=None)

Gets a session.

Return type:

Optional[Session]

get_session_sync(*, app_name, user_id, session_id, config=None)

Return type:

Optional[Session]

async list_sessions(*, app_name, user_id=None)

Lists all the sessions for a user.

Return type:

ListSessionsResponse

Parameters:

• app_name – The name of the app.

• user_id – The ID of the user. If not provided, lists all sessions for all users.

Returns:

A ListSessionsResponse containing the sessions.

list_sessions_sync(*, app_name, user_id=None)

Return type:

ListSessionsResponse

pydantic model google.adk.sessions.Session

Bases: BaseModel

Represents a series of interactions between a user and agents.

Show JSON schema

{
   "title": "Session",
   "description": "Represents a series of interactions between a user and agents.",
   "type": "object",
   "properties": {
      "id": {
         "title": "Id",
         "type": "string"
      },
      "appName": {
         "title": "Appname",
         "type": "string"
      },
      "userId": {
         "title": "Userid",
         "type": "string"
      },
      "state": {
         "additionalProperties": true,
         "title": "State",
         "type": "object"
      },
      "events": {
         "items": {
            "$ref": "#/$defs/Event"
         },
         "title": "Events",
         "type": "array"
      },
      "lastUpdateTime": {
         "default": 0.0,
         "title": "Lastupdatetime",
         "type": "number"
      }
   },
   "$defs": {
      "APIKey": {
         "additionalProperties": true,
         "properties": {
            "type": {
               "$ref": "#/$defs/SecuritySchemeType",
               "default": "apiKey"
            },
            "description": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Description"
            },
            "in": {
               "$ref": "#/$defs/APIKeyIn"
            },
            "name": {
               "title": "Name",
               "type": "string"
            }
         },
         "required": [
            "in",
            "name"
         ],
         "title": "APIKey",
         "type": "object"
      },
      "APIKeyIn": {
         "enum": [
            "query",
            "header",
            "cookie"
         ],
         "title": "APIKeyIn",
         "type": "string"
      },
      "AuthConfig": {
         "additionalProperties": true,
         "description": "The auth config sent by tool asking client to collect auth credentials and\n\nadk and client will help to fill in the response",
         "properties": {
            "authScheme": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/APIKey"
                  },
                  {
                     "$ref": "#/$defs/HTTPBase"
                  },
                  {
                     "$ref": "#/$defs/OAuth2"
                  },
                  {
                     "$ref": "#/$defs/OpenIdConnect"
                  },
                  {
                     "$ref": "#/$defs/HTTPBearer"
                  },
                  {
                     "$ref": "#/$defs/OpenIdConnectWithConfig"
                  }
               ],
               "title": "Authscheme"
            },
            "rawAuthCredential": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/AuthCredential"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "exchangedAuthCredential": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/AuthCredential"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "credentialKey": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Credentialkey"
            }
         },
         "required": [
            "authScheme"
         ],
         "title": "AuthConfig",
         "type": "object"
      },
      "AuthCredential": {
         "additionalProperties": true,
         "description": "Data class representing an authentication credential.\n\nTo exchange for the actual credential, please use\nCredentialExchanger.exchange_credential().\n\nExamples: API Key Auth\nAuthCredential(\n    auth_type=AuthCredentialTypes.API_KEY,\n    api_key=\"1234\",\n)\n\nExample: HTTP Auth\nAuthCredential(\n    auth_type=AuthCredentialTypes.HTTP,\n    http=HttpAuth(\n        scheme=\"basic\",\n        credentials=HttpCredentials(username=\"user\", password=\"password\"),\n    ),\n)\n\nExample: OAuth2 Bearer Token in HTTP Header\nAuthCredential(\n    auth_type=AuthCredentialTypes.HTTP,\n    http=HttpAuth(\n        scheme=\"bearer\",\n        credentials=HttpCredentials(token=\"eyAkaknabna....\"),\n    ),\n)\n\nExample: OAuth2 Auth with Authorization Code Flow\nAuthCredential(\n    auth_type=AuthCredentialTypes.OAUTH2,\n    oauth2=OAuth2Auth(\n        client_id=\"1234\",\n        client_secret=\"secret\",\n    ),\n)\n\nExample: OpenID Connect Auth\nAuthCredential(\n    auth_type=AuthCredentialTypes.OPEN_ID_CONNECT,\n    oauth2=OAuth2Auth(\n        client_id=\"1234\",\n        client_secret=\"secret\",\n        redirect_uri=\"https://example.com\",\n        scopes=[\"scope1\", \"scope2\"],\n    ),\n)\n\nExample: Auth with resource reference\nAuthCredential(\n    auth_type=AuthCredentialTypes.API_KEY,\n    resource_ref=\"projects/1234/locations/us-central1/resources/resource1\",\n)",
         "properties": {
            "authType": {
               "$ref": "#/$defs/AuthCredentialTypes"
            },
            "resourceRef": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Resourceref"
            },
            "apiKey": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Apikey"
            },
            "http": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/HttpAuth"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "serviceAccount": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/ServiceAccount"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "oauth2": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/OAuth2Auth"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            }
         },
         "required": [
            "authType"
         ],
         "title": "AuthCredential",
         "type": "object"
      },
      "AuthCredentialTypes": {
         "description": "Represents the type of authentication credential.",
         "enum": [
            "apiKey",
            "http",
            "oauth2",
            "openIdConnect",
            "serviceAccount"
         ],
         "title": "AuthCredentialTypes",
         "type": "string"
      },
      "Blob": {
         "additionalProperties": false,
         "description": "Content blob.",
         "properties": {
            "displayName": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is not currently used in the Gemini GenerateContent calls.",
               "title": "Displayname"
            },
            "data": {
               "anyOf": [
                  {
                     "format": "base64url",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. Raw bytes.",
               "title": "Data"
            },
            "mimeType": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. The IANA standard MIME type of the source data.",
               "title": "Mimetype"
            }
         },
         "title": "Blob",
         "type": "object"
      },
      "CacheMetadata": {
         "additionalProperties": false,
         "description": "Metadata for context cache associated with LLM responses.\n\nThis class stores cache identification, usage tracking, and lifecycle\ninformation for a particular cache instance. It can be in two states:\n\n1. Active cache state: cache_name is set, all fields populated\n2. Fingerprint-only state: cache_name is None, only fingerprint and\n   contents_count are set for prefix matching\n\nToken counts (cached and total) are available in the LlmResponse.usage_metadata\nand should be accessed from there to avoid duplication.\n\nAttributes:\n    cache_name: The full resource name of the cached content (e.g.,\n        'projects/123/locations/us-central1/cachedContents/456').\n        None when no active cache exists (fingerprint-only state).\n    expire_time: Unix timestamp when the cache expires. None when no\n        active cache exists.\n    fingerprint: Hash of cacheable contents (instruction + tools + contents).\n        Always present for prefix matching.\n    invocations_used: Number of invocations this cache has been used for.\n        None when no active cache exists.\n    contents_count: Number of contents. When active cache exists, this is\n        the count of cached contents. When no active cache exists, this is\n        the total count of contents in the request.\n    created_at: Unix timestamp when the cache was created. None when\n        no active cache exists.",
         "properties": {
            "cache_name": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Full resource name of the cached content (None if no active cache)",
               "title": "Cache Name"
            },
            "expire_time": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Unix timestamp when cache expires (None if no active cache)",
               "title": "Expire Time"
            },
            "fingerprint": {
               "description": "Hash of cacheable contents used to detect changes",
               "title": "Fingerprint",
               "type": "string"
            },
            "invocations_used": {
               "anyOf": [
                  {
                     "minimum": 0,
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Number of invocations this cache has been used for (None if no active cache)",
               "title": "Invocations Used"
            },
            "contents_count": {
               "description": "Number of contents (cached contents when active cache exists, total contents in request when no active cache)",
               "minimum": 0,
               "title": "Contents Count",
               "type": "integer"
            },
            "created_at": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Unix timestamp when cache was created (None if no active cache)",
               "title": "Created At"
            }
         },
         "required": [
            "fingerprint",
            "contents_count"
         ],
         "title": "CacheMetadata",
         "type": "object"
      },
      "Citation": {
         "additionalProperties": false,
         "description": "Source attributions for content.",
         "properties": {
            "endIndex": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Output only. End index into the content.",
               "title": "Endindex"
            },
            "license": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Output only. License of the attribution.",
               "title": "License"
            },
            "publicationDate": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/GoogleTypeDate"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Output only. Publication date of the attribution."
            },
            "startIndex": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Output only. Start index into the content.",
               "title": "Startindex"
            },
            "title": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Output only. Title of the attribution.",
               "title": "Title"
            },
            "uri": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Output only. Url reference of the attribution.",
               "title": "Uri"
            }
         },
         "title": "Citation",
         "type": "object"
      },
      "CitationMetadata": {
         "additionalProperties": false,
         "description": "Citation information when the model quotes another source.",
         "properties": {
            "citations": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/Citation"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Contains citation information when the model directly quotes, at\n      length, from another source. Can include traditional websites and code\n      repositories.\n      ",
               "title": "Citations"
            }
         },
         "title": "CitationMetadata",
         "type": "object"
      },
      "CodeExecutionResult": {
         "additionalProperties": false,
         "description": "Result of executing the [ExecutableCode].\n\nOnly generated when using the [CodeExecution] tool, and always follows a\n`part` containing the [ExecutableCode].",
         "properties": {
            "outcome": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/Outcome"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. Outcome of the code execution."
            },
            "output": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Contains stdout when code execution is successful, stderr or other description otherwise.",
               "title": "Output"
            }
         },
         "title": "CodeExecutionResult",
         "type": "object"
      },
      "Content": {
         "additionalProperties": false,
         "description": "Contains the multi-part content of a message.",
         "properties": {
            "parts": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/Part"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "List of parts that constitute a single message. Each part may have\n      a different IANA MIME type.",
               "title": "Parts"
            },
            "role": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. The producer of the content. Must be either 'user' or\n      'model'. Useful to set for multi-turn conversations, otherwise can be\n      empty. If role is not specified, SDK will determine the role.",
               "title": "Role"
            }
         },
         "title": "Content",
         "type": "object"
      },
      "Event": {
         "additionalProperties": false,
         "description": "Represents an event in a conversation between agents and users.\n\nIt is used to store the content of the conversation, as well as the actions\ntaken by the agents like function calls, etc.",
         "properties": {
            "modelVersion": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Modelversion"
            },
            "content": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/Content"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "groundingMetadata": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/GroundingMetadata"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "partial": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Partial"
            },
            "turnComplete": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Turncomplete"
            },
            "finishReason": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/FinishReason"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "errorCode": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Errorcode"
            },
            "errorMessage": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Errormessage"
            },
            "interrupted": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Interrupted"
            },
            "customMetadata": {
               "anyOf": [
                  {
                     "additionalProperties": true,
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Custommetadata"
            },
            "usageMetadata": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/GenerateContentResponseUsageMetadata"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "liveSessionResumptionUpdate": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/LiveServerSessionResumptionUpdate"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "inputTranscription": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/Transcription"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "outputTranscription": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/Transcription"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "avgLogprobs": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Avglogprobs"
            },
            "logprobsResult": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/LogprobsResult"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "cacheMetadata": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/CacheMetadata"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "citationMetadata": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/CitationMetadata"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "invocationId": {
               "default": "",
               "title": "Invocationid",
               "type": "string"
            },
            "author": {
               "title": "Author",
               "type": "string"
            },
            "actions": {
               "$ref": "#/$defs/EventActions"
            },
            "longRunningToolIds": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array",
                     "uniqueItems": true
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Longrunningtoolids"
            },
            "branch": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Branch"
            },
            "id": {
               "default": "",
               "title": "Id",
               "type": "string"
            },
            "timestamp": {
               "title": "Timestamp",
               "type": "number"
            }
         },
         "required": [
            "author"
         ],
         "title": "Event",
         "type": "object"
      },
      "EventActions": {
         "additionalProperties": false,
         "description": "Represents the actions attached to an event.",
         "properties": {
            "skipSummarization": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Skipsummarization"
            },
            "stateDelta": {
               "additionalProperties": true,
               "title": "Statedelta",
               "type": "object"
            },
            "artifactDelta": {
               "additionalProperties": {
                  "type": "integer"
               },
               "title": "Artifactdelta",
               "type": "object"
            },
            "transferToAgent": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Transfertoagent"
            },
            "escalate": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Escalate"
            },
            "requestedAuthConfigs": {
               "additionalProperties": {
                  "$ref": "#/$defs/AuthConfig"
               },
               "title": "Requestedauthconfigs",
               "type": "object"
            },
            "requestedToolConfirmations": {
               "additionalProperties": {
                  "$ref": "#/$defs/ToolConfirmation"
               },
               "title": "Requestedtoolconfirmations",
               "type": "object"
            },
            "compaction": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/EventCompaction"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "endOfAgent": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Endofagent"
            },
            "agentState": {
               "anyOf": [
                  {
                     "additionalProperties": true,
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Agentstate"
            },
            "rewindBeforeInvocationId": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Rewindbeforeinvocationid"
            }
         },
         "title": "EventActions",
         "type": "object"
      },
      "EventCompaction": {
         "additionalProperties": false,
         "description": "The compaction of the events.",
         "properties": {
            "startTimestamp": {
               "title": "Starttimestamp",
               "type": "number"
            },
            "endTimestamp": {
               "title": "Endtimestamp",
               "type": "number"
            },
            "compactedContent": {
               "$ref": "#/$defs/Content"
            }
         },
         "required": [
            "startTimestamp",
            "endTimestamp",
            "compactedContent"
         ],
         "title": "EventCompaction",
         "type": "object"
      },
      "ExecutableCode": {
         "additionalProperties": false,
         "description": "Code generated by the model that is meant to be executed, and the result returned to the model.\n\nGenerated when using the [CodeExecution] tool, in which the code will be\nautomatically executed, and a corresponding [CodeExecutionResult] will also be\ngenerated.",
         "properties": {
            "code": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. The code to be executed.",
               "title": "Code"
            },
            "language": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/Language"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. Programming language of the `code`."
            }
         },
         "title": "ExecutableCode",
         "type": "object"
      },
      "FileData": {
         "additionalProperties": false,
         "description": "URI based data.",
         "properties": {
            "displayName": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. It is not currently used in the Gemini GenerateContent calls.",
               "title": "Displayname"
            },
            "fileUri": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. URI.",
               "title": "Fileuri"
            },
            "mimeType": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. The IANA standard MIME type of the source data.",
               "title": "Mimetype"
            }
         },
         "title": "FileData",
         "type": "object"
      },
      "FinishReason": {
         "description": "Output only. The reason why the model stopped generating tokens.\n\nIf empty, the model has not stopped generating the tokens.",
         "enum": [
            "FINISH_REASON_UNSPECIFIED",
            "STOP",
            "MAX_TOKENS",
            "SAFETY",
            "RECITATION",
            "LANGUAGE",
            "OTHER",
            "BLOCKLIST",
            "PROHIBITED_CONTENT",
            "SPII",
            "MALFORMED_FUNCTION_CALL",
            "IMAGE_SAFETY",
            "UNEXPECTED_TOOL_CALL",
            "IMAGE_PROHIBITED_CONTENT",
            "NO_IMAGE"
         ],
         "title": "FinishReason",
         "type": "string"
      },
      "FunctionCall": {
         "additionalProperties": false,
         "description": "A function call.",
         "properties": {
            "id": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The unique id of the function call. If populated, the client to execute the\n   `function_call` and return the response with the matching `id`.",
               "title": "Id"
            },
            "args": {
               "anyOf": [
                  {
                     "additionalProperties": true,
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.",
               "title": "Args"
            },
            "name": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. The name of the function to call. Matches [FunctionDeclaration.name].",
               "title": "Name"
            }
         },
         "title": "FunctionCall",
         "type": "object"
      },
      "FunctionResponse": {
         "additionalProperties": false,
         "description": "A function response.",
         "properties": {
            "willContinue": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Signals that function call continues, and more responses will be returned, turning the function call into a generator. Is only applicable to NON_BLOCKING function calls (see FunctionDeclaration.behavior for details), ignored otherwise. If false, the default, future responses will not be considered. Is only applicable to NON_BLOCKING function calls, is ignored otherwise. If set to false, future responses will not be considered. It is allowed to return empty `response` with `will_continue=False` to signal that the function call is finished.",
               "title": "Willcontinue"
            },
            "scheduling": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/FunctionResponseScheduling"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE."
            },
            "parts": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/FunctionResponsePart"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "List of parts that constitute a function response. Each part may\n      have a different IANA MIME type.",
               "title": "Parts"
            },
            "id": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`.",
               "title": "Id"
            },
            "name": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].",
               "title": "Name"
            },
            "response": {
               "anyOf": [
                  {
                     "additionalProperties": true,
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. The function response in JSON object format. Use \"output\" key to specify function output and \"error\" key to specify error details (if any). If \"output\" and \"error\" keys are not specified, then whole \"response\" is treated as function output.",
               "title": "Response"
            }
         },
         "title": "FunctionResponse",
         "type": "object"
      },
      "FunctionResponseBlob": {
         "additionalProperties": false,
         "description": "Raw media bytes for function response.\n\nText should not be sent as raw bytes, use the FunctionResponse.response\nfield.",
         "properties": {
            "mimeType": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. The IANA standard MIME type of the source data.",
               "title": "Mimetype"
            },
            "data": {
               "anyOf": [
                  {
                     "format": "base64url",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. Inline media bytes.",
               "title": "Data"
            }
         },
         "title": "FunctionResponseBlob",
         "type": "object"
      },
      "FunctionResponseFileData": {
         "additionalProperties": false,
         "description": "URI based data for function response.",
         "properties": {
            "fileUri": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. URI.",
               "title": "Fileuri"
            },
            "mimeType": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. The IANA standard MIME type of the source data.",
               "title": "Mimetype"
            }
         },
         "title": "FunctionResponseFileData",
         "type": "object"
      },
      "FunctionResponsePart": {
         "additionalProperties": false,
         "description": "A datatype containing media that is part of a `FunctionResponse` message.\n\nA `FunctionResponsePart` consists of data which has an associated datatype. A\n`FunctionResponsePart` can only contain one of the accepted types in\n`FunctionResponsePart.data`.\n\nA `FunctionResponsePart` must have a fixed IANA MIME type identifying the\ntype and subtype of the media if the `inline_data` field is filled with raw\nbytes.",
         "properties": {
            "inlineData": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/FunctionResponseBlob"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Inline media bytes."
            },
            "fileData": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/FunctionResponseFileData"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. URI based data."
            }
         },
         "title": "FunctionResponsePart",
         "type": "object"
      },
      "FunctionResponseScheduling": {
         "description": "Specifies how the response should be scheduled in the conversation.",
         "enum": [
            "SCHEDULING_UNSPECIFIED",
            "SILENT",
            "WHEN_IDLE",
            "INTERRUPT"
         ],
         "title": "FunctionResponseScheduling",
         "type": "string"
      },
      "GenerateContentResponseUsageMetadata": {
         "additionalProperties": false,
         "description": "Usage metadata about response(s).",
         "properties": {
            "cacheTokensDetails": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/ModalityTokenCount"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Output only. List of modalities of the cached content in the request input.",
               "title": "Cachetokensdetails"
            },
            "cachedContentTokenCount": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Output only. Number of tokens in the cached part in the input (the cached content).",
               "title": "Cachedcontenttokencount"
            },
            "candidatesTokenCount": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Number of tokens in the response(s).",
               "title": "Candidatestokencount"
            },
            "candidatesTokensDetails": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/ModalityTokenCount"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Output only. List of modalities that were returned in the response.",
               "title": "Candidatestokensdetails"
            },
            "promptTokenCount": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Number of tokens in the request. When `cached_content` is set, this is still the total effective prompt size meaning this includes the number of tokens in the cached content.",
               "title": "Prompttokencount"
            },
            "promptTokensDetails": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/ModalityTokenCount"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Output only. List of modalities that were processed in the request input.",
               "title": "Prompttokensdetails"
            },
            "thoughtsTokenCount": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Output only. Number of tokens present in thoughts output.",
               "title": "Thoughtstokencount"
            },
            "toolUsePromptTokenCount": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Output only. Number of tokens present in tool-use prompt(s).",
               "title": "Tooluseprompttokencount"
            },
            "toolUsePromptTokensDetails": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/ModalityTokenCount"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Output only. List of modalities that were processed for tool-use request inputs.",
               "title": "Tooluseprompttokensdetails"
            },
            "totalTokenCount": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Total token count for prompt, response candidates, and tool-use prompts (if present).",
               "title": "Totaltokencount"
            },
            "trafficType": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/TrafficType"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Output only. Traffic type. This shows whether a request consumes Pay-As-You-Go or Provisioned Throughput quota."
            }
         },
         "title": "GenerateContentResponseUsageMetadata",
         "type": "object"
      },
      "GoogleTypeDate": {
         "additionalProperties": false,
         "description": "Represents a whole or partial calendar date, such as a birthday.\n\nThe time of day and time zone are either specified elsewhere or are\ninsignificant. The date is relative to the Gregorian Calendar. This can\nrepresent one of the following: * A full date, with non-zero year, month, and\nday values. * A month and day, with a zero year (for example, an anniversary).\n* A year on its own, with a zero month and a zero day. * A year and month,\nwith a zero day (for example, a credit card expiration date). Related types: *\ngoogle.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp",
         "properties": {
            "day": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.",
               "title": "Day"
            },
            "month": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.",
               "title": "Month"
            },
            "year": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.",
               "title": "Year"
            }
         },
         "title": "GoogleTypeDate",
         "type": "object"
      },
      "GroundingChunk": {
         "additionalProperties": false,
         "description": "Grounding chunk.",
         "properties": {
            "maps": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/GroundingChunkMaps"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Grounding chunk from Google Maps."
            },
            "retrievedContext": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/GroundingChunkRetrievedContext"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Grounding chunk from context retrieved by the retrieval tools."
            },
            "web": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/GroundingChunkWeb"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Grounding chunk from the web."
            }
         },
         "title": "GroundingChunk",
         "type": "object"
      },
      "GroundingChunkMaps": {
         "additionalProperties": false,
         "description": "Chunk from Google Maps.",
         "properties": {
            "placeAnswerSources": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/GroundingChunkMapsPlaceAnswerSources"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Sources used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as uris to flag content."
            },
            "placeId": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "This Place's resource name, in `places/{place_id}` format. Can be used to look up the Place.",
               "title": "Placeid"
            },
            "text": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Text of the chunk.",
               "title": "Text"
            },
            "title": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Title of the chunk.",
               "title": "Title"
            },
            "uri": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "URI reference of the chunk.",
               "title": "Uri"
            }
         },
         "title": "GroundingChunkMaps",
         "type": "object"
      },
      "GroundingChunkMapsPlaceAnswerSources": {
         "additionalProperties": false,
         "description": "Sources used to generate the place answer.",
         "properties": {
            "flagContentUri": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "A link where users can flag a problem with the generated answer.",
               "title": "Flagcontenturi"
            },
            "reviewSnippets": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/GroundingChunkMapsPlaceAnswerSourcesReviewSnippet"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Snippets of reviews that are used to generate the answer.",
               "title": "Reviewsnippets"
            }
         },
         "title": "GroundingChunkMapsPlaceAnswerSources",
         "type": "object"
      },
      "GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution": {
         "additionalProperties": false,
         "description": "Author attribution for a photo or review.",
         "properties": {
            "displayName": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Name of the author of the Photo or Review.",
               "title": "Displayname"
            },
            "photoUri": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Profile photo URI of the author of the Photo or Review.",
               "title": "Photouri"
            },
            "uri": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "URI of the author of the Photo or Review.",
               "title": "Uri"
            }
         },
         "title": "GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution",
         "type": "object"
      },
      "GroundingChunkMapsPlaceAnswerSourcesReviewSnippet": {
         "additionalProperties": false,
         "description": "Encapsulates a review snippet.",
         "properties": {
            "authorAttribution": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "This review's author."
            },
            "flagContentUri": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "A link where users can flag a problem with the review.",
               "title": "Flagcontenturi"
            },
            "googleMapsUri": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "A link to show the review on Google Maps.",
               "title": "Googlemapsuri"
            },
            "relativePublishTimeDescription": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "A string of formatted recent time, expressing the review time relative to the current time in a form appropriate for the language and country.",
               "title": "Relativepublishtimedescription"
            },
            "review": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "A reference representing this place review which may be used to look up this place review again.",
               "title": "Review"
            },
            "reviewId": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Id of the review referencing the place.",
               "title": "Reviewid"
            },
            "title": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Title of the review.",
               "title": "Title"
            }
         },
         "title": "GroundingChunkMapsPlaceAnswerSourcesReviewSnippet",
         "type": "object"
      },
      "GroundingChunkRetrievedContext": {
         "additionalProperties": false,
         "description": "Chunk from context retrieved by the retrieval tools.",
         "properties": {
            "documentName": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Output only. The full document name for the referenced Vertex AI Search document.",
               "title": "Documentname"
            },
            "ragChunk": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/RagChunk"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Additional context for the RAG retrieval result. This is only populated when using the RAG retrieval tool."
            },
            "text": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Text of the attribution.",
               "title": "Text"
            },
            "title": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Title of the attribution.",
               "title": "Title"
            },
            "uri": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "URI reference of the attribution.",
               "title": "Uri"
            }
         },
         "title": "GroundingChunkRetrievedContext",
         "type": "object"
      },
      "GroundingChunkWeb": {
         "additionalProperties": false,
         "description": "Chunk from the web.",
         "properties": {
            "domain": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Domain of the (original) URI.",
               "title": "Domain"
            },
            "title": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Title of the chunk.",
               "title": "Title"
            },
            "uri": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "URI reference of the chunk.",
               "title": "Uri"
            }
         },
         "title": "GroundingChunkWeb",
         "type": "object"
      },
      "GroundingMetadata": {
         "additionalProperties": false,
         "description": "Metadata returned to client when grounding is enabled.",
         "properties": {
            "googleMapsWidgetContextToken": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Output only. Resource name of the Google Maps widget context token to be used with the PlacesContextElement widget to render contextual data. This is populated only for Google Maps grounding.",
               "title": "Googlemapswidgetcontexttoken"
            },
            "groundingChunks": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/GroundingChunk"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "List of supporting references retrieved from specified grounding source.",
               "title": "Groundingchunks"
            },
            "groundingSupports": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/GroundingSupport"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. List of grounding support.",
               "title": "Groundingsupports"
            },
            "retrievalMetadata": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/RetrievalMetadata"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Output only. Retrieval metadata."
            },
            "retrievalQueries": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Queries executed by the retrieval tools.",
               "title": "Retrievalqueries"
            },
            "searchEntryPoint": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/SearchEntryPoint"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Google search entry for the following-up web searches."
            },
            "sourceFlaggingUris": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/GroundingMetadataSourceFlaggingUri"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Output only. List of source flagging uris. This is currently populated only for Google Maps grounding.",
               "title": "Sourceflagginguris"
            },
            "webSearchQueries": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Web search queries for the following-up web search.",
               "title": "Websearchqueries"
            }
         },
         "title": "GroundingMetadata",
         "type": "object"
      },
      "GroundingMetadataSourceFlaggingUri": {
         "additionalProperties": false,
         "description": "Source content flagging uri for a place or review.\n\nThis is currently populated only for Google Maps grounding.",
         "properties": {
            "flagContentUri": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "A link where users can flag a problem with the source (place or review).",
               "title": "Flagcontenturi"
            },
            "sourceId": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Id of the place or review.",
               "title": "Sourceid"
            }
         },
         "title": "GroundingMetadataSourceFlaggingUri",
         "type": "object"
      },
      "GroundingSupport": {
         "additionalProperties": false,
         "description": "Grounding support.",
         "properties": {
            "confidenceScores": {
               "anyOf": [
                  {
                     "items": {
                        "type": "number"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Confidence score of the support references. Ranges from 0 to 1. 1 is the most confident. For Gemini 2.0 and before, this list must have the same size as the grounding_chunk_indices. For Gemini 2.5 and after, this list will be empty and should be ignored.",
               "title": "Confidencescores"
            },
            "groundingChunkIndices": {
               "anyOf": [
                  {
                     "items": {
                        "type": "integer"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "A list of indices (into 'grounding_chunk') specifying the citations associated with the claim. For instance [1,3,4] means that grounding_chunk[1], grounding_chunk[3], grounding_chunk[4] are the retrieved content attributed to the claim.",
               "title": "Groundingchunkindices"
            },
            "segment": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/Segment"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Segment of the content this support belongs to."
            }
         },
         "title": "GroundingSupport",
         "type": "object"
      },
      "HTTPBase": {
         "additionalProperties": true,
         "properties": {
            "type": {
               "$ref": "#/$defs/SecuritySchemeType",
               "default": "http"
            },
            "description": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Description"
            },
            "scheme": {
               "title": "Scheme",
               "type": "string"
            }
         },
         "required": [
            "scheme"
         ],
         "title": "HTTPBase",
         "type": "object"
      },
      "HTTPBearer": {
         "additionalProperties": true,
         "properties": {
            "type": {
               "$ref": "#/$defs/SecuritySchemeType",
               "default": "http"
            },
            "description": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Description"
            },
            "scheme": {
               "const": "bearer",
               "default": "bearer",
               "title": "Scheme",
               "type": "string"
            },
            "bearerFormat": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Bearerformat"
            }
         },
         "title": "HTTPBearer",
         "type": "object"
      },
      "HttpAuth": {
         "additionalProperties": true,
         "description": "The credentials and metadata for HTTP authentication.",
         "properties": {
            "scheme": {
               "title": "Scheme",
               "type": "string"
            },
            "credentials": {
               "$ref": "#/$defs/HttpCredentials"
            }
         },
         "required": [
            "scheme",
            "credentials"
         ],
         "title": "HttpAuth",
         "type": "object"
      },
      "HttpCredentials": {
         "additionalProperties": true,
         "description": "Represents the secret token value for HTTP authentication, like user name, password, oauth token, etc.",
         "properties": {
            "username": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Username"
            },
            "password": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Password"
            },
            "token": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Token"
            }
         },
         "title": "HttpCredentials",
         "type": "object"
      },
      "Language": {
         "description": "Required. Programming language of the `code`.",
         "enum": [
            "LANGUAGE_UNSPECIFIED",
            "PYTHON"
         ],
         "title": "Language",
         "type": "string"
      },
      "LiveServerSessionResumptionUpdate": {
         "additionalProperties": false,
         "description": "Update of the session resumption state.\n\nOnly sent if `session_resumption` was set in the connection config.",
         "properties": {
            "newHandle": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "New handle that represents state that can be resumed. Empty if `resumable`=false.",
               "title": "Newhandle"
            },
            "resumable": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "True if session can be resumed at this point. It might be not possible to resume session at some points. In that case we send update empty new_handle and resumable=false. Example of such case could be model executing function calls or just generating. Resuming session (using previous session token) in such state will result in some data loss.",
               "title": "Resumable"
            },
            "lastConsumedClientMessageIndex": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Index of last message sent by client that is included in state represented by this SessionResumptionToken. Only sent when `SessionResumptionConfig.transparent` is set.\n\nPresence of this index allows users to transparently reconnect and avoid issue of losing some part of realtime audio input/video. If client wishes to temporarily disconnect (for example as result of receiving GoAway) they can do it without losing state by buffering messages sent since last `SessionResmumptionTokenUpdate`. This field will enable them to limit buffering (avoid keeping all requests in RAM).\n\nNote: This should not be used for when resuming a session at some time later -- in those cases partial audio and video frames arelikely not needed.",
               "title": "Lastconsumedclientmessageindex"
            }
         },
         "title": "LiveServerSessionResumptionUpdate",
         "type": "object"
      },
      "LogprobsResult": {
         "additionalProperties": false,
         "description": "Logprobs Result",
         "properties": {
            "chosenCandidates": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/LogprobsResultCandidate"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Length = total number of decoding steps. The chosen candidates may or may not be in top_candidates.",
               "title": "Chosencandidates"
            },
            "topCandidates": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/LogprobsResultTopCandidates"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Length = total number of decoding steps.",
               "title": "Topcandidates"
            }
         },
         "title": "LogprobsResult",
         "type": "object"
      },
      "LogprobsResultCandidate": {
         "additionalProperties": false,
         "description": "Candidate for the logprobs token and score.",
         "properties": {
            "logProbability": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The candidate's log probability.",
               "title": "Logprobability"
            },
            "token": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The candidate's token string value.",
               "title": "Token"
            },
            "tokenId": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The candidate's token id value.",
               "title": "Tokenid"
            }
         },
         "title": "LogprobsResultCandidate",
         "type": "object"
      },
      "LogprobsResultTopCandidates": {
         "additionalProperties": false,
         "description": "Candidates with top log probabilities at each decoding step.",
         "properties": {
            "candidates": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/LogprobsResultCandidate"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Sorted by log probability in descending order.",
               "title": "Candidates"
            }
         },
         "title": "LogprobsResultTopCandidates",
         "type": "object"
      },
      "MediaModality": {
         "description": "Server content modalities.",
         "enum": [
            "MODALITY_UNSPECIFIED",
            "TEXT",
            "IMAGE",
            "VIDEO",
            "AUDIO",
            "DOCUMENT"
         ],
         "title": "MediaModality",
         "type": "string"
      },
      "ModalityTokenCount": {
         "additionalProperties": false,
         "description": "Represents token counting info for a single modality.",
         "properties": {
            "modality": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/MediaModality"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The modality associated with this token count."
            },
            "tokenCount": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Number of tokens.",
               "title": "Tokencount"
            }
         },
         "title": "ModalityTokenCount",
         "type": "object"
      },
      "OAuth2": {
         "additionalProperties": true,
         "properties": {
            "type": {
               "$ref": "#/$defs/SecuritySchemeType",
               "default": "oauth2"
            },
            "description": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Description"
            },
            "flows": {
               "$ref": "#/$defs/OAuthFlows"
            }
         },
         "required": [
            "flows"
         ],
         "title": "OAuth2",
         "type": "object"
      },
      "OAuth2Auth": {
         "additionalProperties": true,
         "description": "Represents credential value and its metadata for a OAuth2 credential.",
         "properties": {
            "clientId": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Clientid"
            },
            "clientSecret": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Clientsecret"
            },
            "authUri": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Authuri"
            },
            "state": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "State"
            },
            "redirectUri": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Redirecturi"
            },
            "authResponseUri": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Authresponseuri"
            },
            "authCode": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Authcode"
            },
            "accessToken": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Accesstoken"
            },
            "refreshToken": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Refreshtoken"
            },
            "expiresAt": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Expiresat"
            },
            "expiresIn": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Expiresin"
            },
            "audience": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Audience"
            }
         },
         "title": "OAuth2Auth",
         "type": "object"
      },
      "OAuthFlowAuthorizationCode": {
         "additionalProperties": true,
         "properties": {
            "refreshUrl": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Refreshurl"
            },
            "scopes": {
               "additionalProperties": {
                  "type": "string"
               },
               "default": {},
               "title": "Scopes",
               "type": "object"
            },
            "authorizationUrl": {
               "title": "Authorizationurl",
               "type": "string"
            },
            "tokenUrl": {
               "title": "Tokenurl",
               "type": "string"
            }
         },
         "required": [
            "authorizationUrl",
            "tokenUrl"
         ],
         "title": "OAuthFlowAuthorizationCode",
         "type": "object"
      },
      "OAuthFlowClientCredentials": {
         "additionalProperties": true,
         "properties": {
            "refreshUrl": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Refreshurl"
            },
            "scopes": {
               "additionalProperties": {
                  "type": "string"
               },
               "default": {},
               "title": "Scopes",
               "type": "object"
            },
            "tokenUrl": {
               "title": "Tokenurl",
               "type": "string"
            }
         },
         "required": [
            "tokenUrl"
         ],
         "title": "OAuthFlowClientCredentials",
         "type": "object"
      },
      "OAuthFlowImplicit": {
         "additionalProperties": true,
         "properties": {
            "refreshUrl": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Refreshurl"
            },
            "scopes": {
               "additionalProperties": {
                  "type": "string"
               },
               "default": {},
               "title": "Scopes",
               "type": "object"
            },
            "authorizationUrl": {
               "title": "Authorizationurl",
               "type": "string"
            }
         },
         "required": [
            "authorizationUrl"
         ],
         "title": "OAuthFlowImplicit",
         "type": "object"
      },
      "OAuthFlowPassword": {
         "additionalProperties": true,
         "properties": {
            "refreshUrl": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Refreshurl"
            },
            "scopes": {
               "additionalProperties": {
                  "type": "string"
               },
               "default": {},
               "title": "Scopes",
               "type": "object"
            },
            "tokenUrl": {
               "title": "Tokenurl",
               "type": "string"
            }
         },
         "required": [
            "tokenUrl"
         ],
         "title": "OAuthFlowPassword",
         "type": "object"
      },
      "OAuthFlows": {
         "additionalProperties": true,
         "properties": {
            "implicit": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/OAuthFlowImplicit"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "password": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/OAuthFlowPassword"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "clientCredentials": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/OAuthFlowClientCredentials"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "authorizationCode": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/OAuthFlowAuthorizationCode"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            }
         },
         "title": "OAuthFlows",
         "type": "object"
      },
      "OpenIdConnect": {
         "additionalProperties": true,
         "properties": {
            "type": {
               "$ref": "#/$defs/SecuritySchemeType",
               "default": "openIdConnect"
            },
            "description": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Description"
            },
            "openIdConnectUrl": {
               "title": "Openidconnecturl",
               "type": "string"
            }
         },
         "required": [
            "openIdConnectUrl"
         ],
         "title": "OpenIdConnect",
         "type": "object"
      },
      "OpenIdConnectWithConfig": {
         "additionalProperties": true,
         "properties": {
            "type": {
               "$ref": "#/$defs/SecuritySchemeType",
               "default": "openIdConnect"
            },
            "description": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Description"
            },
            "authorization_endpoint": {
               "title": "Authorization Endpoint",
               "type": "string"
            },
            "token_endpoint": {
               "title": "Token Endpoint",
               "type": "string"
            },
            "userinfo_endpoint": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Userinfo Endpoint"
            },
            "revocation_endpoint": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Revocation Endpoint"
            },
            "token_endpoint_auth_methods_supported": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Token Endpoint Auth Methods Supported"
            },
            "grant_types_supported": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Grant Types Supported"
            },
            "scopes": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Scopes"
            }
         },
         "required": [
            "authorization_endpoint",
            "token_endpoint"
         ],
         "title": "OpenIdConnectWithConfig",
         "type": "object"
      },
      "Outcome": {
         "description": "Required. Outcome of the code execution.",
         "enum": [
            "OUTCOME_UNSPECIFIED",
            "OUTCOME_OK",
            "OUTCOME_FAILED",
            "OUTCOME_DEADLINE_EXCEEDED"
         ],
         "title": "Outcome",
         "type": "string"
      },
      "Part": {
         "additionalProperties": false,
         "description": "A datatype containing media content.\n\nExactly one field within a Part should be set, representing the specific type\nof content being conveyed. Using multiple fields within the same `Part`\ninstance is considered invalid.",
         "properties": {
            "videoMetadata": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/VideoMetadata"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Metadata for a given video."
            },
            "thought": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Indicates if the part is thought from the model.",
               "title": "Thought"
            },
            "inlineData": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/Blob"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Inlined bytes data."
            },
            "fileData": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/FileData"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. URI based data."
            },
            "thoughtSignature": {
               "anyOf": [
                  {
                     "format": "base64url",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "An opaque signature for the thought so it can be reused in subsequent requests.",
               "title": "Thoughtsignature"
            },
            "functionCall": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/FunctionCall"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "A predicted [FunctionCall] returned from the model that contains a string\n      representing the [FunctionDeclaration.name] and a structured JSON object\n      containing the parameters and their values."
            },
            "codeExecutionResult": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/CodeExecutionResult"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Result of executing the [ExecutableCode]."
            },
            "executableCode": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/ExecutableCode"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Code generated by the model that is meant to be executed."
            },
            "functionResponse": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/FunctionResponse"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model."
            },
            "text": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Text part (can be code).",
               "title": "Text"
            }
         },
         "title": "Part",
         "type": "object"
      },
      "RagChunk": {
         "additionalProperties": false,
         "description": "A RagChunk includes the content of a chunk of a RagFile, and associated metadata.",
         "properties": {
            "pageSpan": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/RagChunkPageSpan"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "If populated, represents where the chunk starts and ends in the document."
            },
            "text": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The content of the chunk.",
               "title": "Text"
            }
         },
         "title": "RagChunk",
         "type": "object"
      },
      "RagChunkPageSpan": {
         "additionalProperties": false,
         "description": "Represents where the chunk starts and ends in the document.",
         "properties": {
            "firstPage": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Page where chunk starts in the document. Inclusive. 1-indexed.",
               "title": "Firstpage"
            },
            "lastPage": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Page where chunk ends in the document. Inclusive. 1-indexed.",
               "title": "Lastpage"
            }
         },
         "title": "RagChunkPageSpan",
         "type": "object"
      },
      "RetrievalMetadata": {
         "additionalProperties": false,
         "description": "Metadata related to retrieval in the grounding flow.",
         "properties": {
            "googleSearchDynamicRetrievalScore": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Score indicating how likely information from Google Search could help answer the prompt. The score is in the range `[0, 1]`, where 0 is the least likely and 1 is the most likely. This score is only populated when Google Search grounding and dynamic retrieval is enabled. It will be compared to the threshold to determine whether to trigger Google Search.",
               "title": "Googlesearchdynamicretrievalscore"
            }
         },
         "title": "RetrievalMetadata",
         "type": "object"
      },
      "SearchEntryPoint": {
         "additionalProperties": false,
         "description": "Google search entry point.",
         "properties": {
            "renderedContent": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Web content snippet that can be embedded in a web page or an app webview.",
               "title": "Renderedcontent"
            },
            "sdkBlob": {
               "anyOf": [
                  {
                     "format": "base64url",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Base64 encoded JSON representing array of tuple.",
               "title": "Sdkblob"
            }
         },
         "title": "SearchEntryPoint",
         "type": "object"
      },
      "SecuritySchemeType": {
         "enum": [
            "apiKey",
            "http",
            "oauth2",
            "openIdConnect"
         ],
         "title": "SecuritySchemeType",
         "type": "string"
      },
      "Segment": {
         "additionalProperties": false,
         "description": "Segment of the content.",
         "properties": {
            "endIndex": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Output only. End index in the given Part, measured in bytes. Offset from the start of the Part, exclusive, starting at zero.",
               "title": "Endindex"
            },
            "partIndex": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Output only. The index of a Part object within its parent Content object.",
               "title": "Partindex"
            },
            "startIndex": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Output only. Start index in the given Part, measured in bytes. Offset from the start of the Part, inclusive, starting at zero.",
               "title": "Startindex"
            },
            "text": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Output only. The text corresponding to the segment from the response.",
               "title": "Text"
            }
         },
         "title": "Segment",
         "type": "object"
      },
      "ServiceAccount": {
         "additionalProperties": true,
         "description": "Represents Google Service Account configuration.",
         "properties": {
            "serviceAccountCredential": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/ServiceAccountCredential"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "scopes": {
               "items": {
                  "type": "string"
               },
               "title": "Scopes",
               "type": "array"
            },
            "useDefaultCredential": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": false,
               "title": "Usedefaultcredential"
            }
         },
         "required": [
            "scopes"
         ],
         "title": "ServiceAccount",
         "type": "object"
      },
      "ServiceAccountCredential": {
         "additionalProperties": true,
         "description": "Represents Google Service Account configuration.\n\nAttributes:\n  type: The type should be \"service_account\".\n  project_id: The project ID.\n  private_key_id: The ID of the private key.\n  private_key: The private key.\n  client_email: The client email.\n  client_id: The client ID.\n  auth_uri: The authorization URI.\n  token_uri: The token URI.\n  auth_provider_x509_cert_url: URL for auth provider's X.509 cert.\n  client_x509_cert_url: URL for the client's X.509 cert.\n  universe_domain: The universe domain.\n\nExample:\n\n    config = ServiceAccountCredential(\n        type_=\"service_account\",\n        project_id=\"your_project_id\",\n        private_key_id=\"your_private_key_id\",\n        private_key=\"-----BEGIN PRIVATE KEY-----...\",\n        client_email=\"...@....iam.gserviceaccount.com\",\n        client_id=\"your_client_id\",\n        auth_uri=\"https://accounts.google.com/o/oauth2/auth\",\n        token_uri=\"https://oauth2.googleapis.com/token\",\n        auth_provider_x509_cert_url=\"https://www.googleapis.com/oauth2/v1/certs\",\n        client_x509_cert_url=\"https://www.googleapis.com/robot/v1/metadata/x509/...\",\n        universe_domain=\"googleapis.com\"\n    )\n\n\n    config = ServiceAccountConfig.model_construct(**{\n        ...service account config dict\n    })",
         "properties": {
            "type": {
               "default": "",
               "title": "Type",
               "type": "string"
            },
            "projectId": {
               "title": "Projectid",
               "type": "string"
            },
            "privateKeyId": {
               "title": "Privatekeyid",
               "type": "string"
            },
            "privateKey": {
               "title": "Privatekey",
               "type": "string"
            },
            "clientEmail": {
               "title": "Clientemail",
               "type": "string"
            },
            "clientId": {
               "title": "Clientid",
               "type": "string"
            },
            "authUri": {
               "title": "Authuri",
               "type": "string"
            },
            "tokenUri": {
               "title": "Tokenuri",
               "type": "string"
            },
            "authProviderX509CertUrl": {
               "title": "Authproviderx509Certurl",
               "type": "string"
            },
            "clientX509CertUrl": {
               "title": "Clientx509Certurl",
               "type": "string"
            },
            "universeDomain": {
               "title": "Universedomain",
               "type": "string"
            }
         },
         "required": [
            "projectId",
            "privateKeyId",
            "privateKey",
            "clientEmail",
            "clientId",
            "authUri",
            "tokenUri",
            "authProviderX509CertUrl",
            "clientX509CertUrl",
            "universeDomain"
         ],
         "title": "ServiceAccountCredential",
         "type": "object"
      },
      "ToolConfirmation": {
         "additionalProperties": false,
         "description": "Represents a tool confirmation configuration.",
         "properties": {
            "hint": {
               "default": "",
               "title": "Hint",
               "type": "string"
            },
            "confirmed": {
               "default": false,
               "title": "Confirmed",
               "type": "boolean"
            },
            "payload": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Payload"
            }
         },
         "title": "ToolConfirmation",
         "type": "object"
      },
      "TrafficType": {
         "description": "Output only.\n\nTraffic type. This shows whether a request consumes Pay-As-You-Go or\nProvisioned Throughput quota.",
         "enum": [
            "TRAFFIC_TYPE_UNSPECIFIED",
            "ON_DEMAND",
            "PROVISIONED_THROUGHPUT"
         ],
         "title": "TrafficType",
         "type": "string"
      },
      "Transcription": {
         "additionalProperties": false,
         "description": "Audio transcription in Server Conent.",
         "properties": {
            "text": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Transcription text.\n      ",
               "title": "Text"
            },
            "finished": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The bool indicates the end of the transcription.\n      ",
               "title": "Finished"
            }
         },
         "title": "Transcription",
         "type": "object"
      },
      "VideoMetadata": {
         "additionalProperties": false,
         "description": "Describes how the video in the Part should be used by the model.",
         "properties": {
            "fps": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The frame rate of the video sent to the model. If not specified, the\n        default value will be 1.0. The fps range is (0.0, 24.0].",
               "title": "Fps"
            },
            "endOffset": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. The end offset of the video.",
               "title": "Endoffset"
            },
            "startOffset": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. The start offset of the video.",
               "title": "Startoffset"
            }
         },
         "title": "VideoMetadata",
         "type": "object"
      }
   },
   "additionalProperties": false,
   "required": [
      "id",
      "appName",
      "userId"
   ]
}

Fields:

• app_name (str)

• events (list[google.adk.events.event.Event])

• id (str)

• last_update_time (float)

• state (dict[str, Any])

• user_id (str)

field app_name: str [Required] (alias 'appName')

The name of the app.

field events: list[Event] [Optional]

The events of the session, e.g. user input, model response, function call/response, etc.

field id: str [Required]

The unique identifier of the session.

field last_update_time: float = 0.0 (alias 'lastUpdateTime')

The last update time of the session.

field state: dict[str, Any] [Optional]

The state of the session.

field user_id: str [Required] (alias 'userId')

The id of the user.

class google.adk.sessions.State(value, delta)

Bases: object

A state dict that maintains the current value and the pending-commit delta.

Parameters:

• value – The current value of the state dict.

• delta – The delta change to the current value that hasn’t been committed.

APP_PREFIX = 'app:'

TEMP_PREFIX = 'temp:'

USER_PREFIX = 'user:'

get(key, default=None)

Returns the value of the state dict for the given key.

Return type:

Any

has_delta()

Whether the state has pending delta.

Return type:

bool

setdefault(key, default=None)

Gets the value of a key, or sets it to a default if the key doesn’t exist.

Return type:

Any

to_dict()

Returns the state dict.

Return type:

dict[str, Any]

update(delta)

Updates the state dict with the given delta.

class google.adk.sessions.VertexAiSessionService(project=None, location=None, agent_engine_id=None, *, express_mode_api_key=None)

Bases: BaseSessionService

Connects to the Vertex AI Agent Engine Session Service using Agent Engine SDK.

https://cloud.google.com/vertex-ai/generative-ai/docs/agent-engine/sessions/overview

Initializes the VertexAiSessionService.

Parameters:

• project – The project id of the project to use.

• location – The location of the project to use.

• agent_engine_id – The resource ID of the agent engine to use.

• express_mode_api_key – The API key to use for Express Mode. If not provided, the API key from the GOOGLE_API_KEY environment variable will be used. It will only be used if GOOGLE_GENAI_USE_VERTEXAI is true. Do not use Google AI Studio API key for this field. For more details, visit https://cloud.google.com/vertex-ai/generative-ai/docs/start/express-mode/overview

async append_event(session, event)

Appends an event to a session object.

Return type:

Event

async create_session(*, app_name, user_id, state=None, session_id=None, **kwargs)

Creates a new session.

Return type:

Session

Parameters:

• app_name – The name of the application.

• user_id – The ID of the user.

• state – The initial state of the session.

• session_id – The ID of the session.

• **kwargs – Additional arguments to pass to the session creation. E.g. set expire_time=’2025-10-01T00:00:00Z’ to set the session expiration time. See https://cloud.google.com/vertex-ai/generative-ai/docs/reference/rest/v1beta1/projects.locations.reasoningEngines.sessions for more details.

Returns:

The created session.

async delete_session(*, app_name, user_id, session_id)

Deletes a session.

Return type:

None

async get_session(*, app_name, user_id, session_id, config=None)

Gets a session.

Return type:

Optional[Session]

async list_sessions(*, app_name, user_id=None)

Lists all the sessions for a user.

Return type:

ListSessionsResponse

Parameters:

• app_name – The name of the app.

• user_id – The ID of the user. If not provided, lists all sessions for all users.

Returns:

A ListSessionsResponse containing the sessions.

google.adk.telemetry module

google.adk.telemetry.trace_call_llm(invocation_context, event_id, llm_request, llm_response)

Traces a call to the LLM.

This function records details about the LLM request and response as attributes on the current OpenTelemetry span.

Parameters:

• invocation_context – The invocation context for the current agent run.

• event_id – The ID of the event.

• llm_request – The LLM request object.

• llm_response – The LLM response object.

google.adk.telemetry.trace_merged_tool_calls(response_event_id, function_response_event)

Traces merged tool call events.

Calling this function is not needed for telemetry purposes. This is provided for preventing /debug/trace requests (typically sent by web UI).

Parameters:

• response_event_id – The ID of the response event.

• function_response_event – The merged response event.

google.adk.telemetry.trace_send_data(invocation_context, event_id, data)

Traces the sending of data to the agent.

This function records details about the data sent to the agent as attributes on the current OpenTelemetry span.

Parameters:

• invocation_context – The invocation context for the current agent run.

• event_id – The ID of the event.

• data – A list of content objects.

google.adk.telemetry.trace_tool_call(tool, args, function_response_event)

Traces tool call.

Parameters:

• tool – The tool that was called.

• args – The arguments to the tool call.

• function_response_event – The event with the function response details.

google.adk.tools package

class google.adk.tools.APIHubToolset(*, apihub_resource_name, access_token=None, service_account_json=None, name='', description='', lazy_load_spec=False, auth_scheme=None, auth_credential=None, apihub_client=None, tool_filter=None)

Bases: BaseToolset

APIHubTool generates tools from a given API Hub resource.

Examples:

apihub_toolset = APIHubToolset(
    apihub_resource_name="projects/test-project/locations/us-central1/apis/test-api",
    service_account_json="...",
    tool_filter=lambda tool, ctx=None: tool.name in ('my_tool',
    'my_other_tool')
)

# Get all available tools
agent = LlmAgent(tools=apihub_toolset)

apihub_resource_name is the resource name from API Hub. It must include API name, and can optionally include API version and spec name.

• If apihub_resource_name includes a spec resource name, the content of that spec will be used for generating the tools.

• If apihub_resource_name includes only an api or a version name, the first spec of the first version of that API will be used.

Initializes the APIHubTool with the given parameters.

Examples:

apihub_toolset = APIHubToolset(
    apihub_resource_name="projects/test-project/locations/us-central1/apis/test-api",
    service_account_json="...",
)

# Get all available tools
agent = LlmAgent(tools=[apihub_toolset])

apihub_toolset = APIHubToolset(
    apihub_resource_name="projects/test-project/locations/us-central1/apis/test-api",
    service_account_json="...",
    tool_filter = ['my_tool']
)
# Get a specific tool
agent = LlmAgent(tools=[
    ...,
    apihub_toolset,
])

apihub_resource_name is the resource name from API Hub. It must include API name, and can optionally include API version and spec name.

• If apihub_resource_name includes a spec resource name, the content of that spec will be used for generating the tools.

• If apihub_resource_name includes only an api or a version name, the first spec of the first version of that API will be used.

Example:

• projects/xxx/locations/us-central1/apis/apiname/…

• https://console.cloud.google.com/apigee/api-hub/apis/apiname?project=xxx

Parameters:

• apihub_resource_name – The resource name of the API in API Hub. Example: projects/test-project/locations/us-central1/apis/test-api.

• access_token – Google Access token. Generate with gcloud cli gcloud auth print-access-token. Used for fetching API Specs from API Hub.

• service_account_json – The service account config as a json string. Required if not using default service credential. It is used for creating the API Hub client and fetching the API Specs from API Hub.

• apihub_client – Optional custom API Hub client.

• name – Name of the toolset. Optional.

• description – Description of the toolset. Optional.

• auth_scheme – Auth scheme that applies to all the tool in the toolset.

• auth_credential – Auth credential that applies to all the tool in the toolset.

• lazy_load_spec – If True, the spec will be loaded lazily when needed. Otherwise, the spec will be loaded immediately and the tools will be generated during initialization.

• tool_filter – The filter used to filter the tools in the toolset. It can be either a tool predicate or a list of tool names of the tools to expose.

async close()

Performs cleanup and releases resources held by the toolset.

Note

This method is invoked, for example, at the end of an agent server’s lifecycle or when the toolset is no longer needed. Implementations should ensure that any open connections, files, or other managed resources are properly released to prevent leaks.

async get_tools(readonly_context=None)

Retrieves all available tools.

Return type:

List[RestApiTool]

Returns:

A list of all available RestApiTool objects.

class google.adk.tools.AgentTool(agent, skip_summarization=False)

Bases: BaseTool

A tool that wraps an agent.

This tool allows an agent to be called as a tool within a larger application. The agent’s input schema is used to define the tool’s input parameters, and the agent’s output is returned as the tool’s result.

agent

The agent to wrap.

skip_summarization

Whether to skip summarization of the agent output.

classmethod from_config(config, config_abs_path)

Creates a tool instance from a config.

This default implementation uses inspect to automatically map config values to constructor arguments based on their type hints. Subclasses should override this method for custom initialization logic.

Return type:

AgentTool

Parameters:

• config – The config for the tool.

• config_abs_path – The absolute path to the config file that contains the tool config.

Returns:

The tool instance.

populate_name()

Return type:

Any

async run_async(*, args, tool_context)

Runs the tool with the given arguments and context.

Return type:

Any

Note

• Required if this tool needs to run at the client side.

• Otherwise, can be skipped, e.g. for a built-in GoogleSearch tool for Gemini.

Parameters:

• args – The LLM-filled arguments.

• tool_context – The context of the tool.

Returns:

The result of running the tool.

pydantic model google.adk.tools.AuthToolArguments

Bases: BaseModelWithConfig

the arguments for the special long running function tool that is used to

request end user credentials.

Show JSON schema

{
   "title": "AuthToolArguments",
   "description": "the arguments for the special long running function tool that is used to\n\nrequest end user credentials.",
   "type": "object",
   "properties": {
      "functionCallId": {
         "title": "Functioncallid",
         "type": "string"
      },
      "authConfig": {
         "$ref": "#/$defs/AuthConfig"
      }
   },
   "$defs": {
      "APIKey": {
         "additionalProperties": true,
         "properties": {
            "type": {
               "$ref": "#/$defs/SecuritySchemeType",
               "default": "apiKey"
            },
            "description": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Description"
            },
            "in": {
               "$ref": "#/$defs/APIKeyIn"
            },
            "name": {
               "title": "Name",
               "type": "string"
            }
         },
         "required": [
            "in",
            "name"
         ],
         "title": "APIKey",
         "type": "object"
      },
      "APIKeyIn": {
         "enum": [
            "query",
            "header",
            "cookie"
         ],
         "title": "APIKeyIn",
         "type": "string"
      },
      "AuthConfig": {
         "additionalProperties": true,
         "description": "The auth config sent by tool asking client to collect auth credentials and\n\nadk and client will help to fill in the response",
         "properties": {
            "authScheme": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/APIKey"
                  },
                  {
                     "$ref": "#/$defs/HTTPBase"
                  },
                  {
                     "$ref": "#/$defs/OAuth2"
                  },
                  {
                     "$ref": "#/$defs/OpenIdConnect"
                  },
                  {
                     "$ref": "#/$defs/HTTPBearer"
                  },
                  {
                     "$ref": "#/$defs/OpenIdConnectWithConfig"
                  }
               ],
               "title": "Authscheme"
            },
            "rawAuthCredential": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/AuthCredential"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "exchangedAuthCredential": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/AuthCredential"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "credentialKey": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Credentialkey"
            }
         },
         "required": [
            "authScheme"
         ],
         "title": "AuthConfig",
         "type": "object"
      },
      "AuthCredential": {
         "additionalProperties": true,
         "description": "Data class representing an authentication credential.\n\nTo exchange for the actual credential, please use\nCredentialExchanger.exchange_credential().\n\nExamples: API Key Auth\nAuthCredential(\n    auth_type=AuthCredentialTypes.API_KEY,\n    api_key=\"1234\",\n)\n\nExample: HTTP Auth\nAuthCredential(\n    auth_type=AuthCredentialTypes.HTTP,\n    http=HttpAuth(\n        scheme=\"basic\",\n        credentials=HttpCredentials(username=\"user\", password=\"password\"),\n    ),\n)\n\nExample: OAuth2 Bearer Token in HTTP Header\nAuthCredential(\n    auth_type=AuthCredentialTypes.HTTP,\n    http=HttpAuth(\n        scheme=\"bearer\",\n        credentials=HttpCredentials(token=\"eyAkaknabna....\"),\n    ),\n)\n\nExample: OAuth2 Auth with Authorization Code Flow\nAuthCredential(\n    auth_type=AuthCredentialTypes.OAUTH2,\n    oauth2=OAuth2Auth(\n        client_id=\"1234\",\n        client_secret=\"secret\",\n    ),\n)\n\nExample: OpenID Connect Auth\nAuthCredential(\n    auth_type=AuthCredentialTypes.OPEN_ID_CONNECT,\n    oauth2=OAuth2Auth(\n        client_id=\"1234\",\n        client_secret=\"secret\",\n        redirect_uri=\"https://example.com\",\n        scopes=[\"scope1\", \"scope2\"],\n    ),\n)\n\nExample: Auth with resource reference\nAuthCredential(\n    auth_type=AuthCredentialTypes.API_KEY,\n    resource_ref=\"projects/1234/locations/us-central1/resources/resource1\",\n)",
         "properties": {
            "authType": {
               "$ref": "#/$defs/AuthCredentialTypes"
            },
            "resourceRef": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Resourceref"
            },
            "apiKey": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Apikey"
            },
            "http": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/HttpAuth"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "serviceAccount": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/ServiceAccount"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "oauth2": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/OAuth2Auth"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            }
         },
         "required": [
            "authType"
         ],
         "title": "AuthCredential",
         "type": "object"
      },
      "AuthCredentialTypes": {
         "description": "Represents the type of authentication credential.",
         "enum": [
            "apiKey",
            "http",
            "oauth2",
            "openIdConnect",
            "serviceAccount"
         ],
         "title": "AuthCredentialTypes",
         "type": "string"
      },
      "HTTPBase": {
         "additionalProperties": true,
         "properties": {
            "type": {
               "$ref": "#/$defs/SecuritySchemeType",
               "default": "http"
            },
            "description": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Description"
            },
            "scheme": {
               "title": "Scheme",
               "type": "string"
            }
         },
         "required": [
            "scheme"
         ],
         "title": "HTTPBase",
         "type": "object"
      },
      "HTTPBearer": {
         "additionalProperties": true,
         "properties": {
            "type": {
               "$ref": "#/$defs/SecuritySchemeType",
               "default": "http"
            },
            "description": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Description"
            },
            "scheme": {
               "const": "bearer",
               "default": "bearer",
               "title": "Scheme",
               "type": "string"
            },
            "bearerFormat": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Bearerformat"
            }
         },
         "title": "HTTPBearer",
         "type": "object"
      },
      "HttpAuth": {
         "additionalProperties": true,
         "description": "The credentials and metadata for HTTP authentication.",
         "properties": {
            "scheme": {
               "title": "Scheme",
               "type": "string"
            },
            "credentials": {
               "$ref": "#/$defs/HttpCredentials"
            }
         },
         "required": [
            "scheme",
            "credentials"
         ],
         "title": "HttpAuth",
         "type": "object"
      },
      "HttpCredentials": {
         "additionalProperties": true,
         "description": "Represents the secret token value for HTTP authentication, like user name, password, oauth token, etc.",
         "properties": {
            "username": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Username"
            },
            "password": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Password"
            },
            "token": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Token"
            }
         },
         "title": "HttpCredentials",
         "type": "object"
      },
      "OAuth2": {
         "additionalProperties": true,
         "properties": {
            "type": {
               "$ref": "#/$defs/SecuritySchemeType",
               "default": "oauth2"
            },
            "description": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Description"
            },
            "flows": {
               "$ref": "#/$defs/OAuthFlows"
            }
         },
         "required": [
            "flows"
         ],
         "title": "OAuth2",
         "type": "object"
      },
      "OAuth2Auth": {
         "additionalProperties": true,
         "description": "Represents credential value and its metadata for a OAuth2 credential.",
         "properties": {
            "clientId": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Clientid"
            },
            "clientSecret": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Clientsecret"
            },
            "authUri": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Authuri"
            },
            "state": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "State"
            },
            "redirectUri": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Redirecturi"
            },
            "authResponseUri": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Authresponseuri"
            },
            "authCode": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Authcode"
            },
            "accessToken": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Accesstoken"
            },
            "refreshToken": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Refreshtoken"
            },
            "expiresAt": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Expiresat"
            },
            "expiresIn": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Expiresin"
            },
            "audience": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Audience"
            }
         },
         "title": "OAuth2Auth",
         "type": "object"
      },
      "OAuthFlowAuthorizationCode": {
         "additionalProperties": true,
         "properties": {
            "refreshUrl": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Refreshurl"
            },
            "scopes": {
               "additionalProperties": {
                  "type": "string"
               },
               "default": {},
               "title": "Scopes",
               "type": "object"
            },
            "authorizationUrl": {
               "title": "Authorizationurl",
               "type": "string"
            },
            "tokenUrl": {
               "title": "Tokenurl",
               "type": "string"
            }
         },
         "required": [
            "authorizationUrl",
            "tokenUrl"
         ],
         "title": "OAuthFlowAuthorizationCode",
         "type": "object"
      },
      "OAuthFlowClientCredentials": {
         "additionalProperties": true,
         "properties": {
            "refreshUrl": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Refreshurl"
            },
            "scopes": {
               "additionalProperties": {
                  "type": "string"
               },
               "default": {},
               "title": "Scopes",
               "type": "object"
            },
            "tokenUrl": {
               "title": "Tokenurl",
               "type": "string"
            }
         },
         "required": [
            "tokenUrl"
         ],
         "title": "OAuthFlowClientCredentials",
         "type": "object"
      },
      "OAuthFlowImplicit": {
         "additionalProperties": true,
         "properties": {
            "refreshUrl": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Refreshurl"
            },
            "scopes": {
               "additionalProperties": {
                  "type": "string"
               },
               "default": {},
               "title": "Scopes",
               "type": "object"
            },
            "authorizationUrl": {
               "title": "Authorizationurl",
               "type": "string"
            }
         },
         "required": [
            "authorizationUrl"
         ],
         "title": "OAuthFlowImplicit",
         "type": "object"
      },
      "OAuthFlowPassword": {
         "additionalProperties": true,
         "properties": {
            "refreshUrl": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Refreshurl"
            },
            "scopes": {
               "additionalProperties": {
                  "type": "string"
               },
               "default": {},
               "title": "Scopes",
               "type": "object"
            },
            "tokenUrl": {
               "title": "Tokenurl",
               "type": "string"
            }
         },
         "required": [
            "tokenUrl"
         ],
         "title": "OAuthFlowPassword",
         "type": "object"
      },
      "OAuthFlows": {
         "additionalProperties": true,
         "properties": {
            "implicit": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/OAuthFlowImplicit"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "password": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/OAuthFlowPassword"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "clientCredentials": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/OAuthFlowClientCredentials"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "authorizationCode": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/OAuthFlowAuthorizationCode"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            }
         },
         "title": "OAuthFlows",
         "type": "object"
      },
      "OpenIdConnect": {
         "additionalProperties": true,
         "properties": {
            "type": {
               "$ref": "#/$defs/SecuritySchemeType",
               "default": "openIdConnect"
            },
            "description": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Description"
            },
            "openIdConnectUrl": {
               "title": "Openidconnecturl",
               "type": "string"
            }
         },
         "required": [
            "openIdConnectUrl"
         ],
         "title": "OpenIdConnect",
         "type": "object"
      },
      "OpenIdConnectWithConfig": {
         "additionalProperties": true,
         "properties": {
            "type": {
               "$ref": "#/$defs/SecuritySchemeType",
               "default": "openIdConnect"
            },
            "description": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Description"
            },
            "authorization_endpoint": {
               "title": "Authorization Endpoint",
               "type": "string"
            },
            "token_endpoint": {
               "title": "Token Endpoint",
               "type": "string"
            },
            "userinfo_endpoint": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Userinfo Endpoint"
            },
            "revocation_endpoint": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Revocation Endpoint"
            },
            "token_endpoint_auth_methods_supported": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Token Endpoint Auth Methods Supported"
            },
            "grant_types_supported": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Grant Types Supported"
            },
            "scopes": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Scopes"
            }
         },
         "required": [
            "authorization_endpoint",
            "token_endpoint"
         ],
         "title": "OpenIdConnectWithConfig",
         "type": "object"
      },
      "SecuritySchemeType": {
         "enum": [
            "apiKey",
            "http",
            "oauth2",
            "openIdConnect"
         ],
         "title": "SecuritySchemeType",
         "type": "string"
      },
      "ServiceAccount": {
         "additionalProperties": true,
         "description": "Represents Google Service Account configuration.",
         "properties": {
            "serviceAccountCredential": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/ServiceAccountCredential"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "scopes": {
               "items": {
                  "type": "string"
               },
               "title": "Scopes",
               "type": "array"
            },
            "useDefaultCredential": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": false,
               "title": "Usedefaultcredential"
            }
         },
         "required": [
            "scopes"
         ],
         "title": "ServiceAccount",
         "type": "object"
      },
      "ServiceAccountCredential": {
         "additionalProperties": true,
         "description": "Represents Google Service Account configuration.\n\nAttributes:\n  type: The type should be \"service_account\".\n  project_id: The project ID.\n  private_key_id: The ID of the private key.\n  private_key: The private key.\n  client_email: The client email.\n  client_id: The client ID.\n  auth_uri: The authorization URI.\n  token_uri: The token URI.\n  auth_provider_x509_cert_url: URL for auth provider's X.509 cert.\n  client_x509_cert_url: URL for the client's X.509 cert.\n  universe_domain: The universe domain.\n\nExample:\n\n    config = ServiceAccountCredential(\n        type_=\"service_account\",\n        project_id=\"your_project_id\",\n        private_key_id=\"your_private_key_id\",\n        private_key=\"-----BEGIN PRIVATE KEY-----...\",\n        client_email=\"...@....iam.gserviceaccount.com\",\n        client_id=\"your_client_id\",\n        auth_uri=\"https://accounts.google.com/o/oauth2/auth\",\n        token_uri=\"https://oauth2.googleapis.com/token\",\n        auth_provider_x509_cert_url=\"https://www.googleapis.com/oauth2/v1/certs\",\n        client_x509_cert_url=\"https://www.googleapis.com/robot/v1/metadata/x509/...\",\n        universe_domain=\"googleapis.com\"\n    )\n\n\n    config = ServiceAccountConfig.model_construct(**{\n        ...service account config dict\n    })",
         "properties": {
            "type": {
               "default": "",
               "title": "Type",
               "type": "string"
            },
            "projectId": {
               "title": "Projectid",
               "type": "string"
            },
            "privateKeyId": {
               "title": "Privatekeyid",
               "type": "string"
            },
            "privateKey": {
               "title": "Privatekey",
               "type": "string"
            },
            "clientEmail": {
               "title": "Clientemail",
               "type": "string"
            },
            "clientId": {
               "title": "Clientid",
               "type": "string"
            },
            "authUri": {
               "title": "Authuri",
               "type": "string"
            },
            "tokenUri": {
               "title": "Tokenuri",
               "type": "string"
            },
            "authProviderX509CertUrl": {
               "title": "Authproviderx509Certurl",
               "type": "string"
            },
            "clientX509CertUrl": {
               "title": "Clientx509Certurl",
               "type": "string"
            },
            "universeDomain": {
               "title": "Universedomain",
               "type": "string"
            }
         },
         "required": [
            "projectId",
            "privateKeyId",
            "privateKey",
            "clientEmail",
            "clientId",
            "authUri",
            "tokenUri",
            "authProviderX509CertUrl",
            "clientX509CertUrl",
            "universeDomain"
         ],
         "title": "ServiceAccountCredential",
         "type": "object"
      }
   },
   "additionalProperties": true,
   "required": [
      "functionCallId",
      "authConfig"
   ]
}

Fields:

• auth_config (google.adk.auth.auth_tool.AuthConfig)

• function_call_id (str)

field auth_config: AuthConfig [Required] (alias 'authConfig')

field function_call_id: str [Required] (alias 'functionCallId')

class google.adk.tools.BaseTool(*, name, description, is_long_running=False, custom_metadata=None)

Bases: ABC

The base class for all tools.

custom_metadata: Optional[dict[str, Any]] = None

The custom metadata of the BaseTool.

An optional key-value pair for storing and retrieving tool-specific metadata, such as tool manifests, etc.

NOTE: the entire dict must be JSON serializable.

description: str

The description of the tool.

classmethod from_config(config, config_abs_path)

Creates a tool instance from a config.

This default implementation uses inspect to automatically map config values to constructor arguments based on their type hints. Subclasses should override this method for custom initialization logic.

Return type:

TypeVar(SelfTool, bound= BaseTool)

Parameters:

• config – The config for the tool.

• config_abs_path – The absolute path to the config file that contains the tool config.

Returns:

The tool instance.

is_long_running: bool = False

Whether the tool is a long running operation, which typically returns a resource id first and finishes the operation later.

name: str

The name of the tool.

async process_llm_request(*, tool_context, llm_request)

Processes the outgoing LLM request for this tool.

Use cases: - Most common use case is adding this tool to the LLM request. - Some tools may just preprocess the LLM request before it’s sent out.

Return type:

None

Parameters:

• tool_context – The context of the tool.

• llm_request – The outgoing LLM request, mutable this method.

async run_async(*, args, tool_context)

Runs the tool with the given arguments and context.

Return type:

Any

Note

• Required if this tool needs to run at the client side.

• Otherwise, can be skipped, e.g. for a built-in GoogleSearch tool for Gemini.

Parameters:

• args – The LLM-filled arguments.

• tool_context – The context of the tool.

Returns:

The result of running the tool.

class google.adk.tools.DiscoveryEngineSearchTool(data_store_id=None, data_store_specs=None, search_engine_id=None, filter=None, max_results=None)

Bases: FunctionTool

Tool for searching the discovery engine.

Initializes the DiscoveryEngineSearchTool.

Parameters:

• data_store_id – The Vertex AI search data store resource ID in the format of “projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}”.

• data_store_specs – Specifications that define the specific DataStores to be searched. It should only be set if engine is used.

• search_engine_id – The Vertex AI search engine resource ID in the format of “projects/{project}/locations/{location}/collections/{collection}/engines/{engine}”.

• filter – The filter to be applied to the search request. Default is None.

• max_results – The maximum number of results to return. Default is None.

discovery_engine_search(query)

Search through Vertex AI Search’s discovery engine search API.

Return type:

dict[str, Any]

Parameters:

query – The search query.

Returns:

A dictionary containing the status of the request and the list of search results, which contains the title, url and content.

class google.adk.tools.ExampleTool(examples)

Bases: BaseTool

A tool that adds (few-shot) examples to the LLM request.

examples

The examples to add to the LLM request.

classmethod from_config(config, config_abs_path)

Creates a tool instance from a config.

This default implementation uses inspect to automatically map config values to constructor arguments based on their type hints. Subclasses should override this method for custom initialization logic.

Return type:

ExampleTool

Parameters:

• config – The config for the tool.

• config_abs_path – The absolute path to the config file that contains the tool config.

Returns:

The tool instance.

async process_llm_request(*, tool_context, llm_request)

Processes the outgoing LLM request for this tool.

Use cases: - Most common use case is adding this tool to the LLM request. - Some tools may just preprocess the LLM request before it’s sent out.

Return type:

None

Parameters:

• tool_context – The context of the tool.

• llm_request – The outgoing LLM request, mutable this method.

class google.adk.tools.FunctionTool(func, *, require_confirmation=False)

Bases: BaseTool

A tool that wraps a user-defined Python function.

func

The function to wrap.

Initializes the FunctionTool. Extracts metadata from a callable object.

Parameters:

• func – The function to wrap.

• require_confirmation – Whether this tool requires confirmation. A boolean or a callable that takes the function’s arguments and returns a boolean. If the callable returns True, the tool will require confirmation from the user.

async run_async(*, args, tool_context)

Runs the tool with the given arguments and context.

Return type:

Any

Note

• Required if this tool needs to run at the client side.

• Otherwise, can be skipped, e.g. for a built-in GoogleSearch tool for Gemini.

Parameters:

• args – The LLM-filled arguments.

• tool_context – The context of the tool.

Returns:

The result of running the tool.

class google.adk.tools.LongRunningFunctionTool(func)

Bases: FunctionTool

A function tool that returns the result asynchronously.

This tool is used for long-running operations that may take a significant amount of time to complete. The framework will call the function. Once the function returns, the response will be returned asynchronously to the framework which is identified by the function_call_id.

Example: `python tool = LongRunningFunctionTool(a_long_running_function) `

is_long_running

Whether the tool is a long running operation.

Initializes the FunctionTool. Extracts metadata from a callable object.

Parameters:

• func – The function to wrap.

• require_confirmation – Whether this tool requires confirmation. A boolean or a callable that takes the function’s arguments and returns a boolean. If the callable returns True, the tool will require confirmation from the user.

class google.adk.tools.MCPToolset(*args, **kwargs)

Bases: McpToolset

Deprecated name, use McpToolset instead.

Initializes the McpToolset.

Parameters:

• connection_params – The connection parameters to the MCP server. Can be: StdioConnectionParams for using local mcp server (e.g. using npx or python3); or SseConnectionParams for a local/remote SSE server; or StreamableHTTPConnectionParams for local/remote Streamable http server. Note, StdioServerParameters is also supported for using local mcp server (e.g. using npx or python3 ), but it does not support timeout, and we recommend to use StdioConnectionParams instead when timeout is needed.

• tool_filter – Optional filter to select specific tools. Can be either: - A list of tool names to include - A ToolPredicate function for custom filtering logic

• tool_name_prefix – A prefix to be added to the name of each tool in this toolset.

• errlog – TextIO stream for error logging.

• auth_scheme – The auth scheme of the tool for tool calling

• auth_credential – The auth credential of the tool for tool calling

• require_confirmation – Whether tools in this toolset require confirmation. Can be a single boolean or a callable to apply to all tools.

• header_provider – A callable that takes a ReadonlyContext and returns a dictionary of headers to be used for the MCP session.

class google.adk.tools.McpToolset(*, connection_params, tool_filter=None, tool_name_prefix=None, errlog=<_io.TextIOWrapper name='<stderr>' mode='w' encoding='utf-8'>, auth_scheme=None, auth_credential=None, require_confirmation=False, header_provider=None)

Bases: BaseToolset

Connects to a MCP Server, and retrieves MCP Tools into ADK Tools.

This toolset manages the connection to an MCP server and provides tools that can be used by an agent. It properly implements the BaseToolset interface for easy integration with the agent framework.

Usage:

toolset = McpToolset(
    connection_params=StdioServerParameters(
        command='npx',
        args=["-y", "@modelcontextprotocol/server-filesystem"],
    ),
    tool_filter=['read_file', 'list_directory']  # Optional: filter specific tools
)

# Use in an agent
agent = LlmAgent(
    model='gemini-2.0-flash',
    name='enterprise_assistant',
    instruction='Help user accessing their file systems',
    tools=[toolset],
)

# Cleanup is handled automatically by the agent framework
# But you can also manually close if needed:
# await toolset.close()

Initializes the McpToolset.

Parameters:

• connection_params – The connection parameters to the MCP server. Can be: StdioConnectionParams for using local mcp server (e.g. using npx or python3); or SseConnectionParams for a local/remote SSE server; or StreamableHTTPConnectionParams for local/remote Streamable http server. Note, StdioServerParameters is also supported for using local mcp server (e.g. using npx or python3 ), but it does not support timeout, and we recommend to use StdioConnectionParams instead when timeout is needed.

• tool_filter – Optional filter to select specific tools. Can be either: - A list of tool names to include - A ToolPredicate function for custom filtering logic

• tool_name_prefix – A prefix to be added to the name of each tool in this toolset.

• errlog – TextIO stream for error logging.

• auth_scheme – The auth scheme of the tool for tool calling

• auth_credential – The auth credential of the tool for tool calling

• require_confirmation – Whether tools in this toolset require confirmation. Can be a single boolean or a callable to apply to all tools.

• header_provider – A callable that takes a ReadonlyContext and returns a dictionary of headers to be used for the MCP session.

async close()

Performs cleanup and releases resources held by the toolset.

This method closes the MCP session and cleans up all associated resources. It’s designed to be safe to call multiple times and handles cleanup errors gracefully to avoid blocking application shutdown.

Return type:

None

classmethod from_config(config, config_abs_path)

Creates an McpToolset from a configuration object.

Return type:

McpToolset

async get_tools(readonly_context=None)

Return all tools in the toolset based on the provided context.

Return type:

List[BaseTool]

Parameters:

readonly_context – Context used to filter tools available to the agent. If None, all tools in the toolset are returned.

Returns:

A list of tools available under the specified context.

Return type:

List[BaseTool]

class google.adk.tools.ToolContext(invocation_context, *, function_call_id=None, event_actions=None, tool_confirmation=None)

Bases: CallbackContext

The context of the tool.

This class provides the context for a tool invocation, including access to the invocation context, function call ID, event actions, and authentication response. It also provides methods for requesting credentials, retrieving authentication responses, listing artifacts, and searching memory.

invocation_context

The invocation context of the tool.

function_call_id

The function call id of the current tool call. This id was returned in the function call event from LLM to identify a function call. If LLM didn’t return this id, ADK will assign one to it. This id is used to map function call response to the original function call.

event_actions

The event actions of the current tool call.

tool_confirmation

The tool confirmation of the current tool call.

property actions: EventActions

get_auth_response(auth_config)

Return type:

AuthCredential

request_confirmation(*, hint=None, payload=None)

Requests confirmation for the given function call.

Return type:

None

Parameters:

• hint – A hint to the user on how to confirm the tool call.

• payload – The payload used to confirm the tool call.

request_credential(auth_config)

Return type:

None

async search_memory(query)

Searches the memory of the current user.

Return type:

SearchMemoryResponse

class google.adk.tools.VertexAiSearchTool(*, data_store_id=None, data_store_specs=None, search_engine_id=None, filter=None, max_results=None, bypass_multi_tools_limit=False)

Bases: BaseTool

A built-in tool using Vertex AI Search.

data_store_id

The Vertex AI search data store resource ID.

search_engine_id

The Vertex AI search engine resource ID.

Initializes the Vertex AI Search tool.

Parameters:

• data_store_id – The Vertex AI search data store resource ID in the format of “projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}”.

• data_store_specs – Specifications that define the specific DataStores to be searched. It should only be set if engine is used.

• search_engine_id – The Vertex AI search engine resource ID in the format of “projects/{project}/locations/{location}/collections/{collection}/engines/{engine}”.

• filter – The filter to apply to the search results.

• max_results – The maximum number of results to return.

• bypass_multi_tools_limit – Whether to bypass the multi tools limitation, so that the tool can be used with other tools in the same agent.

Raises:

• ValueError – If both data_store_id and search_engine_id are not specified

• or both are specified. –

async process_llm_request(*, tool_context, llm_request)

Processes the outgoing LLM request for this tool.

Use cases: - Most common use case is adding this tool to the LLM request. - Some tools may just preprocess the LLM request before it’s sent out.

Return type:

None

Parameters:

• tool_context – The context of the tool.

• llm_request – The outgoing LLM request, mutable this method.

google.adk.tools.exit_loop(tool_context)

Exits the loop.

Call this function only when you are instructed to do so.

google.adk.tools.transfer_to_agent(agent_name, tool_context)

Transfer the question to another agent.

This tool hands off control to another agent when it’s more suitable to answer the user’s question according to the agent’s description.

Return type:

None

Parameters:

agent_name – the agent name to transfer to.

google.adk.tools.agent_tool module

class google.adk.tools.agent_tool.AgentTool(agent, skip_summarization=False)

Bases: BaseTool

A tool that wraps an agent.

This tool allows an agent to be called as a tool within a larger application. The agent’s input schema is used to define the tool’s input parameters, and the agent’s output is returned as the tool’s result.

agent

The agent to wrap.

skip_summarization

Whether to skip summarization of the agent output.

classmethod from_config(config, config_abs_path)

Creates a tool instance from a config.

This default implementation uses inspect to automatically map config values to constructor arguments based on their type hints. Subclasses should override this method for custom initialization logic.

Return type:

AgentTool

Parameters:

• config – The config for the tool.

• config_abs_path – The absolute path to the config file that contains the tool config.

Returns:

The tool instance.

populate_name()

Return type:

Any

async run_async(*, args, tool_context)

Runs the tool with the given arguments and context.

Return type:

Any

Note

• Required if this tool needs to run at the client side.

• Otherwise, can be skipped, e.g. for a built-in GoogleSearch tool for Gemini.

Parameters:

• args – The LLM-filled arguments.

• tool_context – The context of the tool.

Returns:

The result of running the tool.

pydantic model google.adk.tools.agent_tool.AgentToolConfig

Bases: BaseToolConfig

The config for the AgentTool.

Show JSON schema

{
   "title": "AgentToolConfig",
   "description": "The config for the AgentTool.",
   "type": "object",
   "properties": {
      "agent": {
         "$ref": "#/$defs/AgentRefConfig"
      },
      "skip_summarization": {
         "default": false,
         "title": "Skip Summarization",
         "type": "boolean"
      }
   },
   "$defs": {
      "AgentRefConfig": {
         "additionalProperties": false,
         "description": "The config for the reference to another agent.",
         "properties": {
            "config_path": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Config Path"
            },
            "code": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Code"
            }
         },
         "title": "AgentRefConfig",
         "type": "object"
      }
   },
   "additionalProperties": false,
   "required": [
      "agent"
   ]
}

Fields:

• agent (google.adk.agents.common_configs.AgentRefConfig)

• skip_summarization (bool)

field agent: AgentRefConfig [Required]

The reference to the agent instance.

field skip_summarization: bool = False

Whether to skip summarization of the agent output.

google.adk.tools.apihub_tool module

class google.adk.tools.apihub_tool.APIHubToolset(*, apihub_resource_name, access_token=None, service_account_json=None, name='', description='', lazy_load_spec=False, auth_scheme=None, auth_credential=None, apihub_client=None, tool_filter=None)

Bases: BaseToolset

APIHubTool generates tools from a given API Hub resource.

Examples:

apihub_toolset = APIHubToolset(
    apihub_resource_name="projects/test-project/locations/us-central1/apis/test-api",
    service_account_json="...",
    tool_filter=lambda tool, ctx=None: tool.name in ('my_tool',
    'my_other_tool')
)

# Get all available tools
agent = LlmAgent(tools=apihub_toolset)

apihub_resource_name is the resource name from API Hub. It must include API name, and can optionally include API version and spec name.

• If apihub_resource_name includes a spec resource name, the content of that spec will be used for generating the tools.

• If apihub_resource_name includes only an api or a version name, the first spec of the first version of that API will be used.

Initializes the APIHubTool with the given parameters.

Examples:

apihub_toolset = APIHubToolset(
    apihub_resource_name="projects/test-project/locations/us-central1/apis/test-api",
    service_account_json="...",
)

# Get all available tools
agent = LlmAgent(tools=[apihub_toolset])

apihub_toolset = APIHubToolset(
    apihub_resource_name="projects/test-project/locations/us-central1/apis/test-api",
    service_account_json="...",
    tool_filter = ['my_tool']
)
# Get a specific tool
agent = LlmAgent(tools=[
    ...,
    apihub_toolset,
])

apihub_resource_name is the resource name from API Hub. It must include API name, and can optionally include API version and spec name.

• If apihub_resource_name includes a spec resource name, the content of that spec will be used for generating the tools.

• If apihub_resource_name includes only an api or a version name, the first spec of the first version of that API will be used.

Example:

• projects/xxx/locations/us-central1/apis/apiname/…

• https://console.cloud.google.com/apigee/api-hub/apis/apiname?project=xxx

Parameters:

• apihub_resource_name – The resource name of the API in API Hub. Example: projects/test-project/locations/us-central1/apis/test-api.

• access_token – Google Access token. Generate with gcloud cli gcloud auth print-access-token. Used for fetching API Specs from API Hub.

• service_account_json – The service account config as a json string. Required if not using default service credential. It is used for creating the API Hub client and fetching the API Specs from API Hub.

• apihub_client – Optional custom API Hub client.

• name – Name of the toolset. Optional.

• description – Description of the toolset. Optional.

• auth_scheme – Auth scheme that applies to all the tool in the toolset.

• auth_credential – Auth credential that applies to all the tool in the toolset.

• lazy_load_spec – If True, the spec will be loaded lazily when needed. Otherwise, the spec will be loaded immediately and the tools will be generated during initialization.

• tool_filter – The filter used to filter the tools in the toolset. It can be either a tool predicate or a list of tool names of the tools to expose.

async close()

Performs cleanup and releases resources held by the toolset.

Note

This method is invoked, for example, at the end of an agent server’s lifecycle or when the toolset is no longer needed. Implementations should ensure that any open connections, files, or other managed resources are properly released to prevent leaks.

async get_tools(readonly_context=None)

Retrieves all available tools.

Return type:

List[RestApiTool]

Returns:

A list of all available RestApiTool objects.

google.adk.tools.application_integration_tool module

class google.adk.tools.application_integration_tool.ApplicationIntegrationToolset(project, location, integration=None, triggers=None, connection=None, entity_operations=None, actions=None, tool_name_prefix='', tool_instructions='', service_account_json=None, auth_scheme=None, auth_credential=None, tool_filter=None)

Bases: BaseToolset

ApplicationIntegrationToolset generates tools from a given Application Integration or Integration Connector resource.

Example Usage:

# Get all available tools for an integration with api trigger
application_integration_toolset = ApplicationIntegrationToolset(
    project="test-project",
    location="us-central1"
    integration="test-integration",
    triggers=["api_trigger/test_trigger"],
    service_account_credentials={...},
)

# Get all available tools for a connection using entity operations and
# actions
# Note: Find the list of supported entity operations and actions for a
# connection using integration connector apis:
# https://cloud.google.com/integration-connectors/docs/reference/rest/v1/projects.locations.connections.connectionSchemaMetadata
application_integration_toolset = ApplicationIntegrationToolset(
    project="test-project",
    location="us-central1"
    connection="test-connection",
    entity_operations=["EntityId1": ["LIST","CREATE"], "EntityId2": []],
    #empty list for actions means all operations on the entity are supported
    actions=["action1"],
    service_account_credentials={...},
)

# Feed the toolset to agent
agent = LlmAgent(tools=[
    ...,
    application_integration_toolset,
])

Args:

Parameters:

• project – The GCP project ID.

• location – The GCP location.

• integration – The integration name.

• triggers – The list of trigger names in the integration.

• connection – The connection name.

• entity_operations – The entity operations supported by the connection.

• actions – The actions supported by the connection.

• tool_name_prefix – The name prefix of the generated tools.

• tool_instructions – The instructions for the tool.

• service_account_json – The service account configuration as a dictionary. Required if not using default service credential. Used for fetching the Application Integration or Integration Connector resource.

• tool_filter – The filter used to filter the tools in the toolset. It can be either a tool predicate or a list of tool names of the tools to expose.

Raises:

• ValueError – If none of the following conditions are met: - integration is provided. - connection is provided and at least one of entity_operations or actions is provided.

• Exception – If there is an error during the initialization of the integration or connection client.

async close()

Performs cleanup and releases resources held by the toolset.

Return type:

None

Note

This method is invoked, for example, at the end of an agent server’s lifecycle or when the toolset is no longer needed. Implementations should ensure that any open connections, files, or other managed resources are properly released to prevent leaks.

async get_tools(readonly_context=None)

Return all tools in the toolset based on the provided context.

Return type:

List[RestApiTool]

Parameters:

readonly_context (ReadonlyContext, optional) – Context used to filter tools available to the agent. If None, all tools in the toolset are returned.

Returns:

A list of tools available under the specified context.

Return type:

list[BaseTool]

class google.adk.tools.application_integration_tool.IntegrationConnectorTool(name, description, connection_name, connection_host, connection_service_name, entity, operation, action, rest_api_tool, auth_scheme=None, auth_credential=None)

Bases: BaseTool

A tool that wraps a RestApiTool to interact with a specific Application Integration endpoint.

This tool adds Application Integration specific context like connection details, entity, operation, and action to the underlying REST API call handled by RestApiTool. It prepares the arguments and then delegates the actual API call execution to the contained RestApiTool instance.

• Generates request params and body

• Attaches auth credentials to API call.

Example:

# Each API operation in the spec will be turned into its own tool
# Name of the tool is the operationId of that operation, in snake case
operations = OperationGenerator().parse(openapi_spec_dict)
tool = [RestApiTool.from_parsed_operation(o) for o in operations]

Initializes the ApplicationIntegrationTool.

Parameters:

• name – The name of the tool, typically derived from the API operation. Should be unique and adhere to Gemini function naming conventions (e.g., less than 64 characters).

• description – A description of what the tool does, usually based on the API operation’s summary or description.

• connection_name – The name of the Integration Connector connection.

• connection_host – The hostname or IP address for the connection.

• connection_service_name – The specific service name within the host.

• entity – The Integration Connector entity being targeted.

• operation – The specific operation being performed on the entity.

• action – The action associated with the operation (e.g., ‘execute’).

• rest_api_tool – An initialized RestApiTool instance that handles the underlying REST API communication based on an OpenAPI specification operation. This tool will be called by ApplicationIntegrationTool with added connection and context arguments. tool = [RestApiTool.from_parsed_operation(o) for o in operations]

EXCLUDE_FIELDS = ['connection_name', 'service_name', 'host', 'entity', 'operation', 'action', 'dynamic_auth_config']

OPTIONAL_FIELDS = ['page_size', 'page_token', 'filter', 'sortByColumns']

async run_async(*, args, tool_context)

Runs the tool with the given arguments and context.

Return type:

Dict[str, Any]

Note

• Required if this tool needs to run at the client side.

• Otherwise, can be skipped, e.g. for a built-in GoogleSearch tool for Gemini.

Parameters:

• args – The LLM-filled arguments.

• tool_context – The context of the tool.

Returns:

The result of running the tool.

google.adk.tools.authenticated_function_tool module

class google.adk.tools.authenticated_function_tool.AuthenticatedFunctionTool(*, func, auth_config=None, response_for_auth_required=None)

Bases: FunctionTool

A FunctionTool that handles authentication before the actual tool logic gets called. Functions can accept a special credential argument which is the credential ready for use.(Experimental)

Initializes the AuthenticatedFunctionTool.

Parameters:

• func – The function to be called.

• auth_config – The authentication configuration.

• response_for_auth_required – The response to return when the tool is requesting auth credential from the client. There could be two case, the tool doesn’t configure any credentials (auth_config.raw_auth_credential is missing) or the credentials configured is not enough to authenticate the tool (e.g. an OAuth client id and client secret are configured) and needs client input (e.g. client need to involve the end user in an oauth flow and get back the oauth response.)

async run_async(*, args, tool_context)

Runs the tool with the given arguments and context.

Return type:

Any

Note

• Required if this tool needs to run at the client side.

• Otherwise, can be skipped, e.g. for a built-in GoogleSearch tool for Gemini.

Parameters:

• args – The LLM-filled arguments.

• tool_context – The context of the tool.

Returns:

The result of running the tool.

google.adk.tools.base_authenticated_tool module

class google.adk.tools.base_authenticated_tool.BaseAuthenticatedTool(*, name, description, auth_config=None, response_for_auth_required=None)

Bases: BaseTool

A base tool class that handles authentication before the actual tool logic gets called. Functions can accept a special credential argument which is the credential ready for use.(Experimental)

Parameters:

• name – The name of the tool.

• description – The description of the tool.

• auth_config – The auth configuration of the tool.

• response_for_auth_required – The response to return when the tool is requesting auth credential from the client. There could be two case, the tool doesn’t configure any credentials (auth_config.raw_auth_credential is missing) or the credentials configured is not enough to authenticate the tool (e.g. an OAuth client id and client secret are configured) and needs client input (e.g. client need to involve the end user in an oauth flow and get back the oauth response.)

async run_async(*, args, tool_context)

Runs the tool with the given arguments and context.

Return type:

Any

Note

• Required if this tool needs to run at the client side.

• Otherwise, can be skipped, e.g. for a built-in GoogleSearch tool for Gemini.

Parameters:

• args – The LLM-filled arguments.

• tool_context – The context of the tool.

Returns:

The result of running the tool.

google.adk.tools.base_tool module

class google.adk.tools.base_tool.BaseTool(*, name, description, is_long_running=False, custom_metadata=None)

Bases: ABC

The base class for all tools.

custom_metadata: Optional[dict[str, Any]] = None

The custom metadata of the BaseTool.

An optional key-value pair for storing and retrieving tool-specific metadata, such as tool manifests, etc.

NOTE: the entire dict must be JSON serializable.

description: str

The description of the tool.

classmethod from_config(config, config_abs_path)

Creates a tool instance from a config.

This default implementation uses inspect to automatically map config values to constructor arguments based on their type hints. Subclasses should override this method for custom initialization logic.

Return type:

TypeVar(SelfTool, bound= BaseTool)

Parameters:

• config – The config for the tool.

• config_abs_path – The absolute path to the config file that contains the tool config.

Returns:

The tool instance.

is_long_running: bool = False

Whether the tool is a long running operation, which typically returns a resource id first and finishes the operation later.

name: str

The name of the tool.

async process_llm_request(*, tool_context, llm_request)

Processes the outgoing LLM request for this tool.

Use cases: - Most common use case is adding this tool to the LLM request. - Some tools may just preprocess the LLM request before it’s sent out.

Return type:

None

Parameters:

• tool_context – The context of the tool.

• llm_request – The outgoing LLM request, mutable this method.

async run_async(*, args, tool_context)

Runs the tool with the given arguments and context.

Return type:

Any

Note

• Required if this tool needs to run at the client side.

• Otherwise, can be skipped, e.g. for a built-in GoogleSearch tool for Gemini.

Parameters:

• args – The LLM-filled arguments.

• tool_context – The context of the tool.

Returns:

The result of running the tool.

google.adk.tools.base_toolset module

class google.adk.tools.base_toolset.BaseToolset(*, tool_filter=None, tool_name_prefix=None)

Bases: ABC

Base class for toolset.

A toolset is a collection of tools that can be used by an agent.

Initialize the toolset.

Parameters:

• tool_filter – Filter to apply to tools.

• tool_name_prefix – The prefix to prepend to the names of the tools returned by the toolset.

async close()

Performs cleanup and releases resources held by the toolset.

Return type:

None

Note

This method is invoked, for example, at the end of an agent server’s lifecycle or when the toolset is no longer needed. Implementations should ensure that any open connections, files, or other managed resources are properly released to prevent leaks.

classmethod from_config(config, config_abs_path)

Creates a toolset instance from a config.

Return type:

TypeVar(SelfToolset, bound= BaseToolset)

Parameters:

• config – The config for the tool.

• config_abs_path – The absolute path to the config file that contains the tool config.

Returns:

The toolset instance.

abstractmethod async get_tools(readonly_context=None)

Return all tools in the toolset based on the provided context.

Return type:

list[BaseTool]

Parameters:

readonly_context (ReadonlyContext, optional) – Context used to filter tools available to the agent. If None, all tools in the toolset are returned.

Returns:

A list of tools available under the specified context.

Return type:

list[BaseTool]

final async get_tools_with_prefix(readonly_context=None)

Return all tools with optional prefix applied to tool names.

This method calls get_tools() and applies prefixing if tool_name_prefix is provided.

Return type:

list[BaseTool]

Parameters:

readonly_context (ReadonlyContext, optional) – Context used to filter tools available to the agent. If None, all tools in the toolset are returned.

Returns:

A list of tools with prefixed names if tool_name_prefix is provided.

Return type:

list[BaseTool]

async process_llm_request(*, tool_context, llm_request)

Processes the outgoing LLM request for this toolset. This method will be called before each tool processes the llm request.

Return type:

None

Use cases: - Instead of let each tool process the llm request, we can let the toolset

process the llm request. e.g. ComputerUseToolset can add computer use tool to the llm request.

Parameters:

• tool_context – The context of the tool.

• llm_request – The outgoing LLM request, mutable this method.

class google.adk.tools.base_toolset.ToolPredicate(*args, **kwargs)

Bases: Protocol

Base class for a predicate that defines the interface to decide whether a

tool should be exposed to LLM. Toolset implementer could consider whether to accept such instance in the toolset’s constructor and apply the predicate in get_tools method.

google.adk.tools.bigquery module

BigQuery Tools (Experimental).

BigQuery Tools under this module are hand crafted and customized while the tools under google.adk.tools.google_api_tool are auto generated based on API definition. The rationales to have customized tool are:

1. BigQuery APIs have functions overlaps and LLM can’t tell what tool to use

2. BigQuery APIs have a lot of parameters with some rarely used, which are not LLM-friendly

3. We want to provide more high-level tools like forecasting, RAG, segmentation, etc.

4. We want to provide extra access guardrails in those tools. For example, execute_sql can’t arbitrarily mutate existing data.

pydantic model google.adk.tools.bigquery.BigQueryCredentialsConfig

Bases: BaseGoogleCredentialsConfig

BigQuery Credentials Configuration for Google API tools (Experimental).

Please do not use this in production, as it may be deprecated later.

Show JSON schema

{
   "title": "BigQueryCredentialsConfig",
   "type": "object",
   "properties": {
      "credentials": {
         "default": null,
         "title": "Credentials"
      },
      "client_id": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Client Id"
      },
      "client_secret": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Client Secret"
      },
      "scopes": {
         "anyOf": [
            {
               "items": {
                  "type": "string"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Scopes"
      }
   },
   "additionalProperties": false
}

Fields:

Validators:

• __post_init__ » all fields

model_post_init(context, /)

This function is meant to behave like a BaseModel method to initialise private attributes.

It takes context as an argument since that’s what pydantic-core passes when calling it.

Return type:

None

Parameters:

• self – The BaseModel instance.

• context – The context.

class google.adk.tools.bigquery.BigQueryToolset(*, tool_filter=None, credentials_config=None, bigquery_tool_config=None)

Bases: BaseToolset

BigQuery Toolset contains tools for interacting with BigQuery data and metadata.

Initialize the toolset.

Parameters:

• tool_filter – Filter to apply to tools.

• tool_name_prefix – The prefix to prepend to the names of the tools returned by the toolset.

async close()

Performs cleanup and releases resources held by the toolset.

Note

This method is invoked, for example, at the end of an agent server’s lifecycle or when the toolset is no longer needed. Implementations should ensure that any open connections, files, or other managed resources are properly released to prevent leaks.

async get_tools(readonly_context=None)

Get tools from the toolset.

Return type:

List[BaseTool]

google.adk.tools.crewai_tool module

class google.adk.tools.crewai_tool.CrewaiTool(tool, *, name, description)

Bases: FunctionTool

Use this class to wrap a CrewAI tool.

If the original tool name and description are not suitable, you can override them in the constructor.

Initializes the FunctionTool. Extracts metadata from a callable object.

Parameters:

• func – The function to wrap.

• require_confirmation – Whether this tool requires confirmation. A boolean or a callable that takes the function’s arguments and returns a boolean. If the callable returns True, the tool will require confirmation from the user.

classmethod from_config(config, config_abs_path)

Creates a tool instance from a config.

This default implementation uses inspect to automatically map config values to constructor arguments based on their type hints. Subclasses should override this method for custom initialization logic.

Return type:

CrewaiTool

Parameters:

• config – The config for the tool.

• config_abs_path – The absolute path to the config file that contains the tool config.

Returns:

The tool instance.

async run_async(*, args, tool_context)

Override run_async to handle CrewAI-specific parameter filtering.

CrewAI tools use **kwargs pattern, so we need special parameter filtering logic that allows all parameters to pass through while removing only reserved parameters like ‘self’ and ‘tool_context’.

Note: ‘tool_context’ is removed from the initial args dictionary to prevent duplicates, but is re-added if the function signature explicitly requires it as a parameter.

Return type:

Any

tool: CrewaiBaseTool

The wrapped CrewAI tool.

pydantic model google.adk.tools.crewai_tool.CrewaiToolConfig

Bases: BaseToolConfig

Show JSON schema

{
   "title": "CrewaiToolConfig",
   "type": "object",
   "properties": {
      "tool": {
         "title": "Tool",
         "type": "string"
      },
      "name": {
         "default": "",
         "title": "Name",
         "type": "string"
      },
      "description": {
         "default": "",
         "title": "Description",
         "type": "string"
      }
   },
   "additionalProperties": false,
   "required": [
      "tool"
   ]
}

Fields:

• description (str)

• name (str)

• tool (str)

field description: str = ''

The description of the tool.

field name: str = ''

The name of the tool.

field tool: str [Required]

The fully qualified path of the CrewAI tool instance.

google.adk.tools.enterprise_search_tool module

class google.adk.tools.enterprise_search_tool.EnterpriseWebSearchTool

Bases: BaseTool

A Gemini 2+ built-in tool using web grounding for Enterprise compliance.

See the documentation for more details: https://cloud.google.com/vertex-ai/generative-ai/docs/grounding/web-grounding-enterprise.

Initializes the Vertex AI Search tool.

async process_llm_request(*, tool_context, llm_request)

Processes the outgoing LLM request for this tool.

Use cases: - Most common use case is adding this tool to the LLM request. - Some tools may just preprocess the LLM request before it’s sent out.

Return type:

None

Parameters:

• tool_context – The context of the tool.

• llm_request – The outgoing LLM request, mutable this method.

google.adk.tools.example_tool module

class google.adk.tools.example_tool.ExampleTool(examples)

Bases: BaseTool

A tool that adds (few-shot) examples to the LLM request.

examples

The examples to add to the LLM request.

classmethod from_config(config, config_abs_path)

Creates a tool instance from a config.

This default implementation uses inspect to automatically map config values to constructor arguments based on their type hints. Subclasses should override this method for custom initialization logic.

Return type:

ExampleTool

Parameters:

• config – The config for the tool.

• config_abs_path – The absolute path to the config file that contains the tool config.

Returns:

The tool instance.

async process_llm_request(*, tool_context, llm_request)

Processes the outgoing LLM request for this tool.

Use cases: - Most common use case is adding this tool to the LLM request. - Some tools may just preprocess the LLM request before it’s sent out.

Return type:

None

Parameters:

• tool_context – The context of the tool.

• llm_request – The outgoing LLM request, mutable this method.

pydantic model google.adk.tools.example_tool.ExampleToolConfig

Bases: BaseToolConfig

Show JSON schema

{
   "title": "ExampleToolConfig",
   "type": "object",
   "properties": {
      "examples": {
         "anyOf": [
            {
               "items": {
                  "$ref": "#/$defs/Example"
               },
               "type": "array"
            },
            {
               "type": "string"
            }
         ],
         "title": "Examples"
      }
   },
   "$defs": {
      "Blob": {
         "additionalProperties": false,
         "description": "Content blob.",
         "properties": {
            "displayName": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is not currently used in the Gemini GenerateContent calls.",
               "title": "Displayname"
            },
            "data": {
               "anyOf": [
                  {
                     "format": "base64url",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. Raw bytes.",
               "title": "Data"
            },
            "mimeType": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. The IANA standard MIME type of the source data.",
               "title": "Mimetype"
            }
         },
         "title": "Blob",
         "type": "object"
      },
      "CodeExecutionResult": {
         "additionalProperties": false,
         "description": "Result of executing the [ExecutableCode].\n\nOnly generated when using the [CodeExecution] tool, and always follows a\n`part` containing the [ExecutableCode].",
         "properties": {
            "outcome": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/Outcome"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. Outcome of the code execution."
            },
            "output": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Contains stdout when code execution is successful, stderr or other description otherwise.",
               "title": "Output"
            }
         },
         "title": "CodeExecutionResult",
         "type": "object"
      },
      "Content": {
         "additionalProperties": false,
         "description": "Contains the multi-part content of a message.",
         "properties": {
            "parts": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/Part"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "List of parts that constitute a single message. Each part may have\n      a different IANA MIME type.",
               "title": "Parts"
            },
            "role": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. The producer of the content. Must be either 'user' or\n      'model'. Useful to set for multi-turn conversations, otherwise can be\n      empty. If role is not specified, SDK will determine the role.",
               "title": "Role"
            }
         },
         "title": "Content",
         "type": "object"
      },
      "Example": {
         "description": "A few-shot example.\n\nAttributes:\n  input: The input content for the example.\n  output: The expected output content for the example.",
         "properties": {
            "input": {
               "$ref": "#/$defs/Content"
            },
            "output": {
               "items": {
                  "$ref": "#/$defs/Content"
               },
               "title": "Output",
               "type": "array"
            }
         },
         "required": [
            "input",
            "output"
         ],
         "title": "Example",
         "type": "object"
      },
      "ExecutableCode": {
         "additionalProperties": false,
         "description": "Code generated by the model that is meant to be executed, and the result returned to the model.\n\nGenerated when using the [CodeExecution] tool, in which the code will be\nautomatically executed, and a corresponding [CodeExecutionResult] will also be\ngenerated.",
         "properties": {
            "code": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. The code to be executed.",
               "title": "Code"
            },
            "language": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/Language"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. Programming language of the `code`."
            }
         },
         "title": "ExecutableCode",
         "type": "object"
      },
      "FileData": {
         "additionalProperties": false,
         "description": "URI based data.",
         "properties": {
            "displayName": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. It is not currently used in the Gemini GenerateContent calls.",
               "title": "Displayname"
            },
            "fileUri": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. URI.",
               "title": "Fileuri"
            },
            "mimeType": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. The IANA standard MIME type of the source data.",
               "title": "Mimetype"
            }
         },
         "title": "FileData",
         "type": "object"
      },
      "FunctionCall": {
         "additionalProperties": false,
         "description": "A function call.",
         "properties": {
            "id": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The unique id of the function call. If populated, the client to execute the\n   `function_call` and return the response with the matching `id`.",
               "title": "Id"
            },
            "args": {
               "anyOf": [
                  {
                     "additionalProperties": true,
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.",
               "title": "Args"
            },
            "name": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. The name of the function to call. Matches [FunctionDeclaration.name].",
               "title": "Name"
            }
         },
         "title": "FunctionCall",
         "type": "object"
      },
      "FunctionResponse": {
         "additionalProperties": false,
         "description": "A function response.",
         "properties": {
            "willContinue": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Signals that function call continues, and more responses will be returned, turning the function call into a generator. Is only applicable to NON_BLOCKING function calls (see FunctionDeclaration.behavior for details), ignored otherwise. If false, the default, future responses will not be considered. Is only applicable to NON_BLOCKING function calls, is ignored otherwise. If set to false, future responses will not be considered. It is allowed to return empty `response` with `will_continue=False` to signal that the function call is finished.",
               "title": "Willcontinue"
            },
            "scheduling": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/FunctionResponseScheduling"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE."
            },
            "parts": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/FunctionResponsePart"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "List of parts that constitute a function response. Each part may\n      have a different IANA MIME type.",
               "title": "Parts"
            },
            "id": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`.",
               "title": "Id"
            },
            "name": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].",
               "title": "Name"
            },
            "response": {
               "anyOf": [
                  {
                     "additionalProperties": true,
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. The function response in JSON object format. Use \"output\" key to specify function output and \"error\" key to specify error details (if any). If \"output\" and \"error\" keys are not specified, then whole \"response\" is treated as function output.",
               "title": "Response"
            }
         },
         "title": "FunctionResponse",
         "type": "object"
      },
      "FunctionResponseBlob": {
         "additionalProperties": false,
         "description": "Raw media bytes for function response.\n\nText should not be sent as raw bytes, use the FunctionResponse.response\nfield.",
         "properties": {
            "mimeType": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. The IANA standard MIME type of the source data.",
               "title": "Mimetype"
            },
            "data": {
               "anyOf": [
                  {
                     "format": "base64url",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. Inline media bytes.",
               "title": "Data"
            }
         },
         "title": "FunctionResponseBlob",
         "type": "object"
      },
      "FunctionResponseFileData": {
         "additionalProperties": false,
         "description": "URI based data for function response.",
         "properties": {
            "fileUri": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. URI.",
               "title": "Fileuri"
            },
            "mimeType": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. The IANA standard MIME type of the source data.",
               "title": "Mimetype"
            }
         },
         "title": "FunctionResponseFileData",
         "type": "object"
      },
      "FunctionResponsePart": {
         "additionalProperties": false,
         "description": "A datatype containing media that is part of a `FunctionResponse` message.\n\nA `FunctionResponsePart` consists of data which has an associated datatype. A\n`FunctionResponsePart` can only contain one of the accepted types in\n`FunctionResponsePart.data`.\n\nA `FunctionResponsePart` must have a fixed IANA MIME type identifying the\ntype and subtype of the media if the `inline_data` field is filled with raw\nbytes.",
         "properties": {
            "inlineData": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/FunctionResponseBlob"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Inline media bytes."
            },
            "fileData": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/FunctionResponseFileData"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. URI based data."
            }
         },
         "title": "FunctionResponsePart",
         "type": "object"
      },
      "FunctionResponseScheduling": {
         "description": "Specifies how the response should be scheduled in the conversation.",
         "enum": [
            "SCHEDULING_UNSPECIFIED",
            "SILENT",
            "WHEN_IDLE",
            "INTERRUPT"
         ],
         "title": "FunctionResponseScheduling",
         "type": "string"
      },
      "Language": {
         "description": "Required. Programming language of the `code`.",
         "enum": [
            "LANGUAGE_UNSPECIFIED",
            "PYTHON"
         ],
         "title": "Language",
         "type": "string"
      },
      "Outcome": {
         "description": "Required. Outcome of the code execution.",
         "enum": [
            "OUTCOME_UNSPECIFIED",
            "OUTCOME_OK",
            "OUTCOME_FAILED",
            "OUTCOME_DEADLINE_EXCEEDED"
         ],
         "title": "Outcome",
         "type": "string"
      },
      "Part": {
         "additionalProperties": false,
         "description": "A datatype containing media content.\n\nExactly one field within a Part should be set, representing the specific type\nof content being conveyed. Using multiple fields within the same `Part`\ninstance is considered invalid.",
         "properties": {
            "videoMetadata": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/VideoMetadata"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Metadata for a given video."
            },
            "thought": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Indicates if the part is thought from the model.",
               "title": "Thought"
            },
            "inlineData": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/Blob"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Inlined bytes data."
            },
            "fileData": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/FileData"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. URI based data."
            },
            "thoughtSignature": {
               "anyOf": [
                  {
                     "format": "base64url",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "An opaque signature for the thought so it can be reused in subsequent requests.",
               "title": "Thoughtsignature"
            },
            "functionCall": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/FunctionCall"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "A predicted [FunctionCall] returned from the model that contains a string\n      representing the [FunctionDeclaration.name] and a structured JSON object\n      containing the parameters and their values."
            },
            "codeExecutionResult": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/CodeExecutionResult"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Result of executing the [ExecutableCode]."
            },
            "executableCode": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/ExecutableCode"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Code generated by the model that is meant to be executed."
            },
            "functionResponse": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/FunctionResponse"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model."
            },
            "text": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Text part (can be code).",
               "title": "Text"
            }
         },
         "title": "Part",
         "type": "object"
      },
      "VideoMetadata": {
         "additionalProperties": false,
         "description": "Describes how the video in the Part should be used by the model.",
         "properties": {
            "fps": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The frame rate of the video sent to the model. If not specified, the\n        default value will be 1.0. The fps range is (0.0, 24.0].",
               "title": "Fps"
            },
            "endOffset": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. The end offset of the video.",
               "title": "Endoffset"
            },
            "startOffset": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. The start offset of the video.",
               "title": "Startoffset"
            }
         },
         "title": "VideoMetadata",
         "type": "object"
      }
   },
   "additionalProperties": false,
   "required": [
      "examples"
   ]
}

Fields:

• examples (list[google.adk.examples.example.Example] | str)

field examples: Union[list[Example], str] [Required]

The examples to add to the LLM request. User can either provide a list of examples or a fully-qualified name to a BaseExampleProvider object in code.

google.adk.tools.exit_loop_tool module

google.adk.tools.exit_loop_tool.exit_loop(tool_context)

Exits the loop.

Call this function only when you are instructed to do so.

google.adk.tools.function_tool module

class google.adk.tools.function_tool.FunctionTool(func, *, require_confirmation=False)

Bases: BaseTool

A tool that wraps a user-defined Python function.

func

The function to wrap.

Initializes the FunctionTool. Extracts metadata from a callable object.

Parameters:

• func – The function to wrap.

• require_confirmation – Whether this tool requires confirmation. A boolean or a callable that takes the function’s arguments and returns a boolean. If the callable returns True, the tool will require confirmation from the user.

async run_async(*, args, tool_context)

Runs the tool with the given arguments and context.

Return type:

Any

Note

• Required if this tool needs to run at the client side.

• Otherwise, can be skipped, e.g. for a built-in GoogleSearch tool for Gemini.

Parameters:

• args – The LLM-filled arguments.

• tool_context – The context of the tool.

Returns:

The result of running the tool.

google.adk.tools.get_user_choice_tool module

google.adk.tools.get_user_choice_tool.get_user_choice(options, tool_context)

Provides the options to the user and asks them to choose one.

Return type:

Optional[str]

google.adk.tools.google_api_tool module

Auto-generated tools and toolsets for Google APIs.

These tools and toolsets are auto-generated based on the API specifications provided by the Google API Discovery API.

class google.adk.tools.google_api_tool.BigQueryToolset(client_id=None, client_secret=None, tool_filter=None, service_account=None, tool_name_prefix=None)

Bases: GoogleApiToolset

Auto-generated BigQuery toolset based on Google BigQuery API v2 spec exposed by Google API discovery API.

Parameters:

• client_id – OAuth2 client ID for authentication.

• client_secret – OAuth2 client secret for authentication.

• tool_filter – Optional filter to include only specific tools or use a predicate function.

• service_account – Optional service account for authentication.

• tool_name_prefix – Optional prefix to add to all tool names in this toolset.

Initialize the toolset.

Parameters:

• tool_filter – Filter to apply to tools.

• tool_name_prefix – The prefix to prepend to the names of the tools returned by the toolset.

class google.adk.tools.google_api_tool.CalendarToolset(client_id=None, client_secret=None, tool_filter=None, service_account=None, tool_name_prefix=None)

Bases: GoogleApiToolset

Auto-generated Calendar toolset based on Google Calendar API v3 spec exposed by Google API discovery API.

Parameters:

• client_id – OAuth2 client ID for authentication.

• client_secret – OAuth2 client secret for authentication.

• tool_filter – Optional filter to include only specific tools or use a predicate function.

• service_account – Optional service account for authentication.

• tool_name_prefix – Optional prefix to add to all tool names in this toolset.

Initialize the toolset.

Parameters:

• tool_filter – Filter to apply to tools.

• tool_name_prefix – The prefix to prepend to the names of the tools returned by the toolset.

class google.adk.tools.google_api_tool.DocsToolset(client_id=None, client_secret=None, tool_filter=None, service_account=None, tool_name_prefix=None)

Bases: GoogleApiToolset

Auto-generated Docs toolset based on Google Docs API v1 spec exposed by Google API discovery API.

Parameters:

• client_id – OAuth2 client ID for authentication.

• client_secret – OAuth2 client secret for authentication.

• tool_filter – Optional filter to include only specific tools or use a predicate function.

• service_account – Optional service account for authentication.

• tool_name_prefix – Optional prefix to add to all tool names in this toolset.

Initialize the toolset.

Parameters:

• tool_filter – Filter to apply to tools.

• tool_name_prefix – The prefix to prepend to the names of the tools returned by the toolset.

class google.adk.tools.google_api_tool.GmailToolset(client_id=None, client_secret=None, tool_filter=None, service_account=None, tool_name_prefix=None)

Bases: GoogleApiToolset

Auto-generated Gmail toolset based on Google Gmail API v1 spec exposed by Google API discovery API.

Parameters:

• client_id – OAuth2 client ID for authentication.

• client_secret – OAuth2 client secret for authentication.

• tool_filter – Optional filter to include only specific tools or use a predicate function.

• service_account – Optional service account for authentication.

• tool_name_prefix – Optional prefix to add to all tool names in this toolset.

Initialize the toolset.

Parameters:

• tool_filter – Filter to apply to tools.

• tool_name_prefix – The prefix to prepend to the names of the tools returned by the toolset.

class google.adk.tools.google_api_tool.GoogleApiTool(rest_api_tool, client_id=None, client_secret=None, service_account=None, *, additional_headers=None)

Bases: BaseTool

configure_auth(client_id, client_secret)

configure_sa_auth(service_account)

async run_async(*, args, tool_context)

Runs the tool with the given arguments and context.

Return type:

Dict[str, Any]

Note

• Required if this tool needs to run at the client side.

• Otherwise, can be skipped, e.g. for a built-in GoogleSearch tool for Gemini.

Parameters:

• args – The LLM-filled arguments.

• tool_context – The context of the tool.

Returns:

The result of running the tool.

class google.adk.tools.google_api_tool.GoogleApiToolset(api_name, api_version, client_id=None, client_secret=None, tool_filter=None, service_account=None, tool_name_prefix=None, *, additional_headers=None)

Bases: BaseToolset

Google API Toolset contains tools for interacting with Google APIs.

Usually one toolsets will contain tools only related to one Google API, e.g. Google Bigquery API toolset will contain tools only related to Google Bigquery API, like list dataset tool, list table tool etc.

Parameters:

• api_name – The name of the Google API (e.g., “calendar”, “gmail”).

• api_version – The version of the API (e.g., “v3”, “v1”).

• client_id – OAuth2 client ID for authentication.

• client_secret – OAuth2 client secret for authentication.

• tool_filter – Optional filter to include only specific tools or use a predicate function.

• service_account – Optional service account for authentication.

• tool_name_prefix – Optional prefix to add to all tool names in this toolset.

• additional_headers – Optional dict of HTTP headers to inject into every request executed by this toolset.

Initialize the toolset.

Parameters:

• tool_filter – Filter to apply to tools.

• tool_name_prefix – The prefix to prepend to the names of the tools returned by the toolset.

async close()

Performs cleanup and releases resources held by the toolset.

Note

This method is invoked, for example, at the end of an agent server’s lifecycle or when the toolset is no longer needed. Implementations should ensure that any open connections, files, or other managed resources are properly released to prevent leaks.

configure_auth(client_id, client_secret)

configure_sa_auth(service_account)

async get_tools(readonly_context=None)

Get all tools in the toolset.

Return type:

List[GoogleApiTool]

set_tool_filter(tool_filter)

class google.adk.tools.google_api_tool.SheetsToolset(client_id=None, client_secret=None, tool_filter=None, service_account=None, tool_name_prefix=None)

Bases: GoogleApiToolset

Auto-generated Sheets toolset based on Google Sheets API v4 spec exposed by Google API discovery API.

Parameters:

• client_id – OAuth2 client ID for authentication.

• client_secret – OAuth2 client secret for authentication.

• tool_filter – Optional filter to include only specific tools or use a predicate function.

• service_account – Optional service account for authentication.

• tool_name_prefix – Optional prefix to add to all tool names in this toolset.

Initialize the toolset.

Parameters:

• tool_filter – Filter to apply to tools.

• tool_name_prefix – The prefix to prepend to the names of the tools returned by the toolset.

class google.adk.tools.google_api_tool.SlidesToolset(client_id=None, client_secret=None, tool_filter=None, service_account=None, tool_name_prefix=None)

Bases: GoogleApiToolset

Auto-generated Slides toolset based on Google Slides API v1 spec exposed by Google API discovery API.

Parameters:

• client_id – OAuth2 client ID for authentication.

• client_secret – OAuth2 client secret for authentication.

• tool_filter – Optional filter to include only specific tools or use a predicate function.

• service_account – Optional service account for authentication.

• tool_name_prefix – Optional prefix to add to all tool names in this toolset.

Initialize the toolset.

Parameters:

• tool_filter – Filter to apply to tools.

• tool_name_prefix – The prefix to prepend to the names of the tools returned by the toolset.

class google.adk.tools.google_api_tool.YoutubeToolset(client_id=None, client_secret=None, tool_filter=None, service_account=None, tool_name_prefix=None)

Bases: GoogleApiToolset

Auto-generated YouTube toolset based on YouTube API v3 spec exposed by Google API discovery API.

Parameters:

• client_id – OAuth2 client ID for authentication.

• client_secret – OAuth2 client secret for authentication.

• tool_filter – Optional filter to include only specific tools or use a predicate function.

• service_account – Optional service account for authentication.

• tool_name_prefix – Optional prefix to add to all tool names in this toolset.

Initialize the toolset.

Parameters:

• tool_filter – Filter to apply to tools.

• tool_name_prefix – The prefix to prepend to the names of the tools returned by the toolset.

google.adk.tools.google_maps_grounding_tool module

class google.adk.tools.google_maps_grounding_tool.GoogleMapsGroundingTool

Bases: BaseTool

A built-in tool that is automatically invoked by Gemini 2 models to ground query results with Google Maps.

This tool operates internally within the model and does not require or perform local code execution.

Only available for use with the VertexAI Gemini API (e.g. GOOGLE_GENAI_USE_VERTEXAI=TRUE)

async process_llm_request(*, tool_context, llm_request)

Processes the outgoing LLM request for this tool.

Use cases: - Most common use case is adding this tool to the LLM request. - Some tools may just preprocess the LLM request before it’s sent out.

Return type:

None

Parameters:

• tool_context – The context of the tool.

• llm_request – The outgoing LLM request, mutable this method.

google.adk.tools.google_search_tool module

class google.adk.tools.google_search_tool.GoogleSearchTool(*, bypass_multi_tools_limit=False)

Bases: BaseTool

A built-in tool that is automatically invoked by Gemini 2 models to retrieve search results from Google Search.

This tool operates internally within the model and does not require or perform local code execution.

Initializes the Google search tool.

Parameters:

bypass_multi_tools_limit – Whether to bypass the multi tools limitation, so that the tool can be used with other tools in the same agent.

async process_llm_request(*, tool_context, llm_request)

Processes the outgoing LLM request for this tool.

Use cases: - Most common use case is adding this tool to the LLM request. - Some tools may just preprocess the LLM request before it’s sent out.

Return type:

None

Parameters:

• tool_context – The context of the tool.

• llm_request – The outgoing LLM request, mutable this method.

google.adk.tools.langchain_tool module

class google.adk.tools.langchain_tool.LangchainTool(tool, name=None, description=None)

Bases: FunctionTool

Adapter class that wraps a Langchain tool for use with ADK.

This adapter converts Langchain tools into a format compatible with Google’s generative AI function calling interface. It preserves the tool’s name, description, and functionality while adapting its schema.

The original tool’s name and description can be overridden if needed.

Parameters:

• tool – A Langchain tool to wrap (BaseTool or a tool with a .run method)

• name – Optional override for the tool’s name

• description – Optional override for the tool’s description

Examples:

from langchain.tools import DuckDuckGoSearchTool
from google.genai.tools import LangchainTool

search_tool = DuckDuckGoSearchTool()
wrapped_tool = LangchainTool(search_tool)

Initializes the FunctionTool. Extracts metadata from a callable object.

Parameters:

• func – The function to wrap.

• require_confirmation – Whether this tool requires confirmation. A boolean or a callable that takes the function’s arguments and returns a boolean. If the callable returns True, the tool will require confirmation from the user.

classmethod from_config(config, config_abs_path)

Creates a tool instance from a config.

This default implementation uses inspect to automatically map config values to constructor arguments based on their type hints. Subclasses should override this method for custom initialization logic.

Return type:

LangchainTool

Parameters:

• config – The config for the tool.

• config_abs_path – The absolute path to the config file that contains the tool config.

Returns:

The tool instance.

pydantic model google.adk.tools.langchain_tool.LangchainToolConfig

Bases: BaseToolConfig

Show JSON schema

{
   "title": "LangchainToolConfig",
   "type": "object",
   "properties": {
      "tool": {
         "title": "Tool",
         "type": "string"
      },
      "name": {
         "default": "",
         "title": "Name",
         "type": "string"
      },
      "description": {
         "default": "",
         "title": "Description",
         "type": "string"
      }
   },
   "additionalProperties": false,
   "required": [
      "tool"
   ]
}

Fields:

• description (str)

• name (str)

• tool (str)

field description: str = ''

The description of the tool.

field name: str = ''

The name of the tool.

field tool: str [Required]

The fully qualified path of the Langchain tool instance.

google.adk.tools.load_artifacts_tool module

class google.adk.tools.load_artifacts_tool.LoadArtifactsTool

Bases: BaseTool

A tool that loads the artifacts and adds them to the session.

async process_llm_request(*, tool_context, llm_request)

Processes the outgoing LLM request for this tool.

Use cases: - Most common use case is adding this tool to the LLM request. - Some tools may just preprocess the LLM request before it’s sent out.

Return type:

None

Parameters:

• tool_context – The context of the tool.

• llm_request – The outgoing LLM request, mutable this method.

async run_async(*, args, tool_context)

Runs the tool with the given arguments and context.

Return type:

Any

Note

• Required if this tool needs to run at the client side.

• Otherwise, can be skipped, e.g. for a built-in GoogleSearch tool for Gemini.

Parameters:

• args – The LLM-filled arguments.

• tool_context – The context of the tool.

Returns:

The result of running the tool.

google.adk.tools.load_memory_tool module

pydantic model google.adk.tools.load_memory_tool.LoadMemoryResponse

Bases: BaseModel

Show JSON schema

{
   "title": "LoadMemoryResponse",
   "type": "object",
   "properties": {
      "memories": {
         "items": {
            "$ref": "#/$defs/MemoryEntry"
         },
         "title": "Memories",
         "type": "array"
      }
   },
   "$defs": {
      "Blob": {
         "additionalProperties": false,
         "description": "Content blob.",
         "properties": {
            "displayName": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is not currently used in the Gemini GenerateContent calls.",
               "title": "Displayname"
            },
            "data": {
               "anyOf": [
                  {
                     "format": "base64url",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. Raw bytes.",
               "title": "Data"
            },
            "mimeType": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. The IANA standard MIME type of the source data.",
               "title": "Mimetype"
            }
         },
         "title": "Blob",
         "type": "object"
      },
      "CodeExecutionResult": {
         "additionalProperties": false,
         "description": "Result of executing the [ExecutableCode].\n\nOnly generated when using the [CodeExecution] tool, and always follows a\n`part` containing the [ExecutableCode].",
         "properties": {
            "outcome": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/Outcome"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. Outcome of the code execution."
            },
            "output": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Contains stdout when code execution is successful, stderr or other description otherwise.",
               "title": "Output"
            }
         },
         "title": "CodeExecutionResult",
         "type": "object"
      },
      "Content": {
         "additionalProperties": false,
         "description": "Contains the multi-part content of a message.",
         "properties": {
            "parts": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/Part"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "List of parts that constitute a single message. Each part may have\n      a different IANA MIME type.",
               "title": "Parts"
            },
            "role": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. The producer of the content. Must be either 'user' or\n      'model'. Useful to set for multi-turn conversations, otherwise can be\n      empty. If role is not specified, SDK will determine the role.",
               "title": "Role"
            }
         },
         "title": "Content",
         "type": "object"
      },
      "ExecutableCode": {
         "additionalProperties": false,
         "description": "Code generated by the model that is meant to be executed, and the result returned to the model.\n\nGenerated when using the [CodeExecution] tool, in which the code will be\nautomatically executed, and a corresponding [CodeExecutionResult] will also be\ngenerated.",
         "properties": {
            "code": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. The code to be executed.",
               "title": "Code"
            },
            "language": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/Language"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. Programming language of the `code`."
            }
         },
         "title": "ExecutableCode",
         "type": "object"
      },
      "FileData": {
         "additionalProperties": false,
         "description": "URI based data.",
         "properties": {
            "displayName": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. It is not currently used in the Gemini GenerateContent calls.",
               "title": "Displayname"
            },
            "fileUri": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. URI.",
               "title": "Fileuri"
            },
            "mimeType": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. The IANA standard MIME type of the source data.",
               "title": "Mimetype"
            }
         },
         "title": "FileData",
         "type": "object"
      },
      "FunctionCall": {
         "additionalProperties": false,
         "description": "A function call.",
         "properties": {
            "id": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The unique id of the function call. If populated, the client to execute the\n   `function_call` and return the response with the matching `id`.",
               "title": "Id"
            },
            "args": {
               "anyOf": [
                  {
                     "additionalProperties": true,
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.",
               "title": "Args"
            },
            "name": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. The name of the function to call. Matches [FunctionDeclaration.name].",
               "title": "Name"
            }
         },
         "title": "FunctionCall",
         "type": "object"
      },
      "FunctionResponse": {
         "additionalProperties": false,
         "description": "A function response.",
         "properties": {
            "willContinue": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Signals that function call continues, and more responses will be returned, turning the function call into a generator. Is only applicable to NON_BLOCKING function calls (see FunctionDeclaration.behavior for details), ignored otherwise. If false, the default, future responses will not be considered. Is only applicable to NON_BLOCKING function calls, is ignored otherwise. If set to false, future responses will not be considered. It is allowed to return empty `response` with `will_continue=False` to signal that the function call is finished.",
               "title": "Willcontinue"
            },
            "scheduling": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/FunctionResponseScheduling"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE."
            },
            "parts": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/FunctionResponsePart"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "List of parts that constitute a function response. Each part may\n      have a different IANA MIME type.",
               "title": "Parts"
            },
            "id": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`.",
               "title": "Id"
            },
            "name": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].",
               "title": "Name"
            },
            "response": {
               "anyOf": [
                  {
                     "additionalProperties": true,
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. The function response in JSON object format. Use \"output\" key to specify function output and \"error\" key to specify error details (if any). If \"output\" and \"error\" keys are not specified, then whole \"response\" is treated as function output.",
               "title": "Response"
            }
         },
         "title": "FunctionResponse",
         "type": "object"
      },
      "FunctionResponseBlob": {
         "additionalProperties": false,
         "description": "Raw media bytes for function response.\n\nText should not be sent as raw bytes, use the FunctionResponse.response\nfield.",
         "properties": {
            "mimeType": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. The IANA standard MIME type of the source data.",
               "title": "Mimetype"
            },
            "data": {
               "anyOf": [
                  {
                     "format": "base64url",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. Inline media bytes.",
               "title": "Data"
            }
         },
         "title": "FunctionResponseBlob",
         "type": "object"
      },
      "FunctionResponseFileData": {
         "additionalProperties": false,
         "description": "URI based data for function response.",
         "properties": {
            "fileUri": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. URI.",
               "title": "Fileuri"
            },
            "mimeType": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Required. The IANA standard MIME type of the source data.",
               "title": "Mimetype"
            }
         },
         "title": "FunctionResponseFileData",
         "type": "object"
      },
      "FunctionResponsePart": {
         "additionalProperties": false,
         "description": "A datatype containing media that is part of a `FunctionResponse` message.\n\nA `FunctionResponsePart` consists of data which has an associated datatype. A\n`FunctionResponsePart` can only contain one of the accepted types in\n`FunctionResponsePart.data`.\n\nA `FunctionResponsePart` must have a fixed IANA MIME type identifying the\ntype and subtype of the media if the `inline_data` field is filled with raw\nbytes.",
         "properties": {
            "inlineData": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/FunctionResponseBlob"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Inline media bytes."
            },
            "fileData": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/FunctionResponseFileData"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. URI based data."
            }
         },
         "title": "FunctionResponsePart",
         "type": "object"
      },
      "FunctionResponseScheduling": {
         "description": "Specifies how the response should be scheduled in the conversation.",
         "enum": [
            "SCHEDULING_UNSPECIFIED",
            "SILENT",
            "WHEN_IDLE",
            "INTERRUPT"
         ],
         "title": "FunctionResponseScheduling",
         "type": "string"
      },
      "Language": {
         "description": "Required. Programming language of the `code`.",
         "enum": [
            "LANGUAGE_UNSPECIFIED",
            "PYTHON"
         ],
         "title": "Language",
         "type": "string"
      },
      "MemoryEntry": {
         "description": "Represent one memory entry.",
         "properties": {
            "content": {
               "$ref": "#/$defs/Content"
            },
            "custom_metadata": {
               "additionalProperties": true,
               "title": "Custom Metadata",
               "type": "object"
            },
            "id": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Id"
            },
            "author": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Author"
            },
            "timestamp": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Timestamp"
            }
         },
         "required": [
            "content"
         ],
         "title": "MemoryEntry",
         "type": "object"
      },
      "Outcome": {
         "description": "Required. Outcome of the code execution.",
         "enum": [
            "OUTCOME_UNSPECIFIED",
            "OUTCOME_OK",
            "OUTCOME_FAILED",
            "OUTCOME_DEADLINE_EXCEEDED"
         ],
         "title": "Outcome",
         "type": "string"
      },
      "Part": {
         "additionalProperties": false,
         "description": "A datatype containing media content.\n\nExactly one field within a Part should be set, representing the specific type\nof content being conveyed. Using multiple fields within the same `Part`\ninstance is considered invalid.",
         "properties": {
            "videoMetadata": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/VideoMetadata"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Metadata for a given video."
            },
            "thought": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Indicates if the part is thought from the model.",
               "title": "Thought"
            },
            "inlineData": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/Blob"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Inlined bytes data."
            },
            "fileData": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/FileData"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. URI based data."
            },
            "thoughtSignature": {
               "anyOf": [
                  {
                     "format": "base64url",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "An opaque signature for the thought so it can be reused in subsequent requests.",
               "title": "Thoughtsignature"
            },
            "functionCall": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/FunctionCall"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "A predicted [FunctionCall] returned from the model that contains a string\n      representing the [FunctionDeclaration.name] and a structured JSON object\n      containing the parameters and their values."
            },
            "codeExecutionResult": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/CodeExecutionResult"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Result of executing the [ExecutableCode]."
            },
            "executableCode": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/ExecutableCode"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Code generated by the model that is meant to be executed."
            },
            "functionResponse": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/FunctionResponse"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model."
            },
            "text": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. Text part (can be code).",
               "title": "Text"
            }
         },
         "title": "Part",
         "type": "object"
      },
      "VideoMetadata": {
         "additionalProperties": false,
         "description": "Describes how the video in the Part should be used by the model.",
         "properties": {
            "fps": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The frame rate of the video sent to the model. If not specified, the\n        default value will be 1.0. The fps range is (0.0, 24.0].",
               "title": "Fps"
            },
            "endOffset": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. The end offset of the video.",
               "title": "Endoffset"
            },
            "startOffset": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional. The start offset of the video.",
               "title": "Startoffset"
            }
         },
         "title": "VideoMetadata",
         "type": "object"
      }
   }
}

Fields:

• memories (list[google.adk.memory.memory_entry.MemoryEntry])

field memories: list[MemoryEntry] [Optional]

class google.adk.tools.load_memory_tool.LoadMemoryTool

Bases: FunctionTool

A tool that loads the memory for the current user.

NOTE: Currently this tool only uses text part from the memory.

Initializes the FunctionTool. Extracts metadata from a callable object.

Parameters:

• func – The function to wrap.

• require_confirmation – Whether this tool requires confirmation. A boolean or a callable that takes the function’s arguments and returns a boolean. If the callable returns True, the tool will require confirmation from the user.

async process_llm_request(*, tool_context, llm_request)

Processes the outgoing LLM request for this tool.

Use cases: - Most common use case is adding this tool to the LLM request. - Some tools may just preprocess the LLM request before it’s sent out.

Return type:

None

Parameters:

• tool_context – The context of the tool.

• llm_request – The outgoing LLM request, mutable this method.

async google.adk.tools.load_memory_tool.load_memory(query, tool_context)

Loads the memory for the current user.

Return type:

LoadMemoryResponse

Parameters:

query – The query to load the memory for.

Returns:

A list of memory results.

google.adk.tools.load_web_page module

Tool for web browse.

google.adk.tools.load_web_page.load_web_page(url)

Fetches the content in the url and returns the text in it.

Return type:

str

Parameters:

url (str) – The url to browse.

Returns:

The text content of the url.

Return type:

str

google.adk.tools.long_running_tool module

class google.adk.tools.long_running_tool.LongRunningFunctionTool(func)

Bases: FunctionTool

A function tool that returns the result asynchronously.

This tool is used for long-running operations that may take a significant amount of time to complete. The framework will call the function. Once the function returns, the response will be returned asynchronously to the framework which is identified by the function_call_id.

Example: `python tool = LongRunningFunctionTool(a_long_running_function) `

is_long_running

Whether the tool is a long running operation.

Initializes the FunctionTool. Extracts metadata from a callable object.

Parameters:

• func – The function to wrap.

• require_confirmation – Whether this tool requires confirmation. A boolean or a callable that takes the function’s arguments and returns a boolean. If the callable returns True, the tool will require confirmation from the user.

google.adk.tools.mcp_tool module

class google.adk.tools.mcp_tool.MCPTool(*args, **kwargs)

Bases: McpTool

Deprecated name, use McpTool instead.

Initializes an McpTool.

This tool wraps an MCP Tool interface and uses a session manager to communicate with the MCP server.

Parameters:

• mcp_tool – The MCP tool to wrap.

• mcp_session_manager – The MCP session manager to use for communication.

• auth_scheme – The authentication scheme to use.

• auth_credential – The authentication credential to use.

• require_confirmation – Whether this tool requires confirmation. A boolean or a callable that takes the function’s arguments and returns a boolean. If the callable returns True, the tool will require confirmation from the user.

Raises:

ValueError – If mcp_tool or mcp_session_manager is None.

class google.adk.tools.mcp_tool.MCPToolset(*args, **kwargs)

Bases: McpToolset

Deprecated name, use McpToolset instead.

Initializes the McpToolset.

Parameters:

• connection_params – The connection parameters to the MCP server. Can be: StdioConnectionParams for using local mcp server (e.g. using npx or python3); or SseConnectionParams for a local/remote SSE server; or StreamableHTTPConnectionParams for local/remote Streamable http server. Note, StdioServerParameters is also supported for using local mcp server (e.g. using npx or python3 ), but it does not support timeout, and we recommend to use StdioConnectionParams instead when timeout is needed.

• tool_filter – Optional filter to select specific tools. Can be either: - A list of tool names to include - A ToolPredicate function for custom filtering logic

• tool_name_prefix – A prefix to be added to the name of each tool in this toolset.

• errlog – TextIO stream for error logging.

• auth_scheme – The auth scheme of the tool for tool calling

• auth_credential – The auth credential of the tool for tool calling

• require_confirmation – Whether tools in this toolset require confirmation. Can be a single boolean or a callable to apply to all tools.

• header_provider – A callable that takes a ReadonlyContext and returns a dictionary of headers to be used for the MCP session.

class google.adk.tools.mcp_tool.McpTool(*, mcp_tool, mcp_session_manager, auth_scheme=None, auth_credential=None, require_confirmation=False, header_provider=None)

Bases: BaseAuthenticatedTool

Turns an MCP Tool into an ADK Tool.

Internally, the tool initializes from a MCP Tool, and uses the MCP Session to call the tool.

Note: For API key authentication, only header-based API keys are supported. Query and cookie-based API keys will result in authentication errors.

Initializes an McpTool.

This tool wraps an MCP Tool interface and uses a session manager to communicate with the MCP server.

Parameters:

• mcp_tool – The MCP tool to wrap.

• mcp_session_manager – The MCP session manager to use for communication.

• auth_scheme – The authentication scheme to use.

• auth_credential – The authentication credential to use.

• require_confirmation – Whether this tool requires confirmation. A boolean or a callable that takes the function’s arguments and returns a boolean. If the callable returns True, the tool will require confirmation from the user.

Raises:

ValueError – If mcp_tool or mcp_session_manager is None.

property raw_mcp_tool: Tool

Returns the raw MCP tool.

async run_async(*, args, tool_context)

Runs the tool with the given arguments and context.

Return type:

Any

Note

• Required if this tool needs to run at the client side.

• Otherwise, can be skipped, e.g. for a built-in GoogleSearch tool for Gemini.

Parameters:

• args – The LLM-filled arguments.

• tool_context – The context of the tool.

Returns:

The result of running the tool.

class google.adk.tools.mcp_tool.McpToolset(*, connection_params, tool_filter=None, tool_name_prefix=None, errlog=<_io.TextIOWrapper name='<stderr>' mode='w' encoding='utf-8'>, auth_scheme=None, auth_credential=None, require_confirmation=False, header_provider=None)

Bases: BaseToolset

Connects to a MCP Server, and retrieves MCP Tools into ADK Tools.

This toolset manages the connection to an MCP server and provides tools that can be used by an agent. It properly implements the BaseToolset interface for easy integration with the agent framework.

Usage:

toolset = McpToolset(
    connection_params=StdioServerParameters(
        command='npx',
        args=["-y", "@modelcontextprotocol/server-filesystem"],
    ),
    tool_filter=['read_file', 'list_directory']  # Optional: filter specific tools
)

# Use in an agent
agent = LlmAgent(
    model='gemini-2.0-flash',
    name='enterprise_assistant',
    instruction='Help user accessing their file systems',
    tools=[toolset],
)

# Cleanup is handled automatically by the agent framework
# But you can also manually close if needed:
# await toolset.close()

Initializes the McpToolset.

Parameters:

• connection_params – The connection parameters to the MCP server. Can be: StdioConnectionParams for using local mcp server (e.g. using npx or python3); or SseConnectionParams for a local/remote SSE server; or StreamableHTTPConnectionParams for local/remote Streamable http server. Note, StdioServerParameters is also supported for using local mcp server (e.g. using npx or python3 ), but it does not support timeout, and we recommend to use StdioConnectionParams instead when timeout is needed.

• tool_filter – Optional filter to select specific tools. Can be either: - A list of tool names to include - A ToolPredicate function for custom filtering logic

• tool_name_prefix – A prefix to be added to the name of each tool in this toolset.

• errlog – TextIO stream for error logging.

• auth_scheme – The auth scheme of the tool for tool calling

• auth_credential – The auth credential of the tool for tool calling

• require_confirmation – Whether tools in this toolset require confirmation. Can be a single boolean or a callable to apply to all tools.

• header_provider – A callable that takes a ReadonlyContext and returns a dictionary of headers to be used for the MCP session.

async close()

Performs cleanup and releases resources held by the toolset.

This method closes the MCP session and cleans up all associated resources. It’s designed to be safe to call multiple times and handles cleanup errors gracefully to avoid blocking application shutdown.

Return type:

None

classmethod from_config(config, config_abs_path)

Creates an McpToolset from a configuration object.

Return type:

McpToolset

async get_tools(readonly_context=None)

Return all tools in the toolset based on the provided context.

Return type:

List[BaseTool]

Parameters:

readonly_context – Context used to filter tools available to the agent. If None, all tools in the toolset are returned.

Returns:

A list of tools available under the specified context.

Return type:

List[BaseTool]

pydantic model google.adk.tools.mcp_tool.SseConnectionParams

Bases: BaseModel

Parameters for the MCP SSE connection.

See MCP SSE Client documentation for more details. https://github.com/modelcontextprotocol/python-sdk/blob/main/src/mcp/client/sse.py

url

URL for the MCP SSE server.

headers

Headers for the MCP SSE connection.

timeout

Timeout in seconds for establishing the connection to the MCP SSE server.

sse_read_timeout

Timeout in seconds for reading data from the MCP SSE server.

Show JSON schema

{
   "title": "SseConnectionParams",
   "description": "Parameters for the MCP SSE connection.\n\nSee MCP SSE Client documentation for more details.\nhttps://github.com/modelcontextprotocol/python-sdk/blob/main/src/mcp/client/sse.py\n\nAttributes:\n    url: URL for the MCP SSE server.\n    headers: Headers for the MCP SSE connection.\n    timeout: Timeout in seconds for establishing the connection to the MCP SSE\n      server.\n    sse_read_timeout: Timeout in seconds for reading data from the MCP SSE\n      server.",
   "type": "object",
   "properties": {
      "url": {
         "title": "Url",
         "type": "string"
      },
      "headers": {
         "anyOf": [
            {
               "additionalProperties": true,
               "type": "object"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Headers"
      },
      "timeout": {
         "default": 5.0,
         "title": "Timeout",
         "type": "number"
      },
      "sse_read_timeout": {
         "default": 300.0,
         "title": "Sse Read Timeout",
         "type": "number"
      }
   },
   "required": [
      "url"
   ]
}

Fields:

• headers (dict[str, Any] | None)

• sse_read_timeout (float)

• timeout (float)

• url (str)

field headers: dict[str, Any] | None = None

field sse_read_timeout: float = 300.0

field timeout: float = 5.0

field url: str [Required]

pydantic model google.adk.tools.mcp_tool.StdioConnectionParams

Bases: BaseModel

Parameters for the MCP Stdio connection.

server_params

Parameters for the MCP Stdio server.

timeout

Timeout in seconds for establishing the connection to the MCP stdio server.

Show JSON schema

{
   "title": "StdioConnectionParams",
   "description": "Parameters for the MCP Stdio connection.\n\nAttributes:\n    server_params: Parameters for the MCP Stdio server.\n    timeout: Timeout in seconds for establishing the connection to the MCP\n      stdio server.",
   "type": "object",
   "properties": {
      "server_params": {
         "$ref": "#/$defs/StdioServerParameters"
      },
      "timeout": {
         "default": 5.0,
         "title": "Timeout",
         "type": "number"
      }
   },
   "$defs": {
      "StdioServerParameters": {
         "properties": {
            "command": {
               "title": "Command",
               "type": "string"
            },
            "args": {
               "items": {
                  "type": "string"
               },
               "title": "Args",
               "type": "array"
            },
            "env": {
               "anyOf": [
                  {
                     "additionalProperties": {
                        "type": "string"
                     },
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Env"
            },
            "cwd": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "format": "path",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Cwd"
            },
            "encoding": {
               "default": "utf-8",
               "title": "Encoding",
               "type": "string"
            },
            "encoding_error_handler": {
               "default": "strict",
               "enum": [
                  "strict",
                  "ignore",
                  "replace"
               ],
               "title": "Encoding Error Handler",
               "type": "string"
            }
         },
         "required": [
            "command"
         ],
         "title": "StdioServerParameters",
         "type": "object"
      }
   },
   "required": [
      "server_params"
   ]
}

Fields:

• server_params (mcp.client.stdio.StdioServerParameters)

• timeout (float)

field server_params: StdioServerParameters [Required]

field timeout: float = 5.0

pydantic model google.adk.tools.mcp_tool.StreamableHTTPConnectionParams

Bases: BaseModel

Parameters for the MCP Streamable HTTP connection.

See MCP Streamable HTTP Client documentation for more details. https://github.com/modelcontextprotocol/python-sdk/blob/main/src/mcp/client/streamable_http.py

url

URL for the MCP Streamable HTTP server.

headers

Headers for the MCP Streamable HTTP connection.

timeout

Timeout in seconds for establishing the connection to the MCP Streamable HTTP server.

sse_read_timeout

Timeout in seconds for reading data from the MCP Streamable HTTP server.

terminate_on_close

Whether to terminate the MCP Streamable HTTP server when the connection is closed.

Show JSON schema

{
   "title": "StreamableHTTPConnectionParams",
   "description": "Parameters for the MCP Streamable HTTP connection.\n\nSee MCP Streamable HTTP Client documentation for more details.\nhttps://github.com/modelcontextprotocol/python-sdk/blob/main/src/mcp/client/streamable_http.py\n\nAttributes:\n    url: URL for the MCP Streamable HTTP server.\n    headers: Headers for the MCP Streamable HTTP connection.\n    timeout: Timeout in seconds for establishing the connection to the MCP\n      Streamable HTTP server.\n    sse_read_timeout: Timeout in seconds for reading data from the MCP\n      Streamable HTTP server.\n    terminate_on_close: Whether to terminate the MCP Streamable HTTP server\n      when the connection is closed.",
   "type": "object",
   "properties": {
      "url": {
         "title": "Url",
         "type": "string"
      },
      "headers": {
         "anyOf": [
            {
               "additionalProperties": true,
               "type": "object"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Headers"
      },
      "timeout": {
         "default": 5.0,
         "title": "Timeout",
         "type": "number"
      },
      "sse_read_timeout": {
         "default": 300.0,
         "title": "Sse Read Timeout",
         "type": "number"
      },
      "terminate_on_close": {
         "default": true,
         "title": "Terminate On Close",
         "type": "boolean"
      }
   },
   "required": [
      "url"
   ]
}

Fields:

• headers (dict[str, Any] | None)

• sse_read_timeout (float)

• terminate_on_close (bool)

• timeout (float)

• url (str)

field headers: dict[str, Any] | None = None

field sse_read_timeout: float = 300.0

field terminate_on_close: bool = True

field timeout: float = 5.0

field url: str [Required]

google.adk.tools.mcp_tool.adk_to_mcp_tool_type(tool)

Convert a Tool in ADK into MCP tool type.

This function transforms an ADK tool definition into its equivalent representation in the MCP (Model Context Protocol) system.

Return type:

Tool

Parameters:

tool – The ADK tool to convert. It should be an instance of a class derived from BaseTool.

Returns:

An object of MCP Tool type, representing the converted tool.

Examples

# Assuming ‘my_tool’ is an instance of a BaseTool derived class mcp_tool = adk_to_mcp_tool_type(my_tool) print(mcp_tool)

google.adk.tools.mcp_tool.gemini_to_json_schema(gemini_schema)

Converts a Gemini Schema object into a JSON Schema dictionary.

Return type:

Dict[str, Any]

Parameters:

gemini_schema – An instance of the Gemini Schema class.

Returns:

A dictionary representing the equivalent JSON Schema.

Raises:

• TypeError – If the input is not an instance of the expected Schema class.

• ValueError – If an invalid Gemini Type enum value is encountered.

google.adk.tools.openapi_tool module

class google.adk.tools.openapi_tool.OpenAPIToolset(*, spec_dict=None, spec_str=None, spec_str_type='json', auth_scheme=None, auth_credential=None, tool_filter=None)

Bases: BaseToolset

Class for parsing OpenAPI spec into a list of RestApiTool.

Usage:

# Initialize OpenAPI toolset from a spec string.
openapi_toolset = OpenAPIToolset(spec_str=openapi_spec_str,
  spec_str_type="json")
# Or, initialize OpenAPI toolset from a spec dictionary.
openapi_toolset = OpenAPIToolset(spec_dict=openapi_spec_dict)

# Add all tools to an agent.
agent = Agent(
  tools=[*openapi_toolset.get_tools()]
)
# Or, add a single tool to an agent.
agent = Agent(
  tools=[openapi_toolset.get_tool('tool_name')]
)

Initializes the OpenAPIToolset.

Usage:

# Initialize OpenAPI toolset from a spec string.
openapi_toolset = OpenAPIToolset(spec_str=openapi_spec_str,
  spec_str_type="json")
# Or, initialize OpenAPI toolset from a spec dictionary.
openapi_toolset = OpenAPIToolset(spec_dict=openapi_spec_dict)

# Add all tools to an agent.
agent = Agent(
  tools=[*openapi_toolset.get_tools()]
)
# Or, add a single tool to an agent.
agent = Agent(
  tools=[openapi_toolset.get_tool('tool_name')]
)

Parameters:

• spec_dict – The OpenAPI spec dictionary. If provided, it will be used instead of loading the spec from a string.

• spec_str – The OpenAPI spec string in JSON or YAML format. It will be used when spec_dict is not provided.

• spec_str_type – The type of the OpenAPI spec string. Can be “json” or “yaml”.

• auth_scheme – The auth scheme to use for all tools. Use AuthScheme or use helpers in google.adk.tools.openapi_tool.auth.auth_helpers

• auth_credential – The auth credential to use for all tools. Use AuthCredential or use helpers in google.adk.tools.openapi_tool.auth.auth_helpers

• tool_filter – The filter used to filter the tools in the toolset. It can be either a tool predicate or a list of tool names of the tools to expose.

async close()

Performs cleanup and releases resources held by the toolset.

Note

This method is invoked, for example, at the end of an agent server’s lifecycle or when the toolset is no longer needed. Implementations should ensure that any open connections, files, or other managed resources are properly released to prevent leaks.

get_tool(tool_name)

Get a tool by name.

Return type:

Optional[RestApiTool]

async get_tools(readonly_context=None)

Get all tools in the toolset.

Return type:

List[RestApiTool]

class google.adk.tools.openapi_tool.RestApiTool(name, description, endpoint, operation, auth_scheme=None, auth_credential=None, should_parse_operation=True)

Bases: BaseTool

A generic tool that interacts with a REST API.

• Generates request params and body

• Attaches auth credentials to API call.

Example:

# Each API operation in the spec will be turned into its own tool
# Name of the tool is the operationId of that operation, in snake case
operations = OperationGenerator().parse(openapi_spec_dict)
tool = [RestApiTool.from_parsed_operation(o) for o in operations]

Initializes the RestApiTool with the given parameters.

To generate RestApiTool from OpenAPI Specs, use OperationGenerator. Example:

# Each API operation in the spec will be turned into its own tool
# Name of the tool is the operationId of that operation, in snake case
operations = OperationGenerator().parse(openapi_spec_dict)
tool = [RestApiTool.from_parsed_operation(o) for o in operations]

Hint: Use google.adk.tools.openapi_tool.auth.auth_helpers to construct auth_scheme and auth_credential.

Parameters:

• name – The name of the tool.

• description – The description of the tool.

• endpoint – Include the base_url, path, and method of the tool.

• operation – Pydantic object or a dict. Representing the OpenAPI Operation object (https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#operation-object)

• auth_scheme – The auth scheme of the tool. Representing the OpenAPI SecurityScheme object (https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#security-scheme-object)

• auth_credential – The authentication credential of the tool.

• should_parse_operation – Whether to parse the operation.

async call(*, args, tool_context)

Executes the REST API call.

Return type:

Dict[str, Any]

Parameters:

• args – Keyword arguments representing the operation parameters.

• tool_context – The tool context (not used here, but required by the interface).

Returns:

The API response as a dictionary.

configure_auth_credential(auth_credential=None)

Configures the authentication credential for the API call.

Parameters:

auth_credential – AuthCredential|dict - The authentication credential. The dict is converted to an AuthCredential object.

configure_auth_scheme(auth_scheme)

Configures the authentication scheme for the API call.

Parameters:

auth_scheme – AuthScheme|dict -: The authentication scheme. The dict is converted to a AuthScheme object.

classmethod from_parsed_operation(parsed)

Initializes the RestApiTool from a ParsedOperation object.

Return type:

RestApiTool

Parameters:

parsed – A ParsedOperation object.

Returns:

A RestApiTool object.

classmethod from_parsed_operation_str(parsed_operation_str)

Initializes the RestApiTool from a dict.

Return type:

RestApiTool

Parameters:

parsed – A dict representation of a ParsedOperation object.

Returns:

A RestApiTool object.

async run_async(*, args, tool_context)

Runs the tool with the given arguments and context.

Return type:

Dict[str, Any]

Note

• Required if this tool needs to run at the client side.

• Otherwise, can be skipped, e.g. for a built-in GoogleSearch tool for Gemini.

Parameters:

• args – The LLM-filled arguments.

• tool_context – The context of the tool.

Returns:

The result of running the tool.

set_default_headers(headers)

Sets default headers that are merged into every request.

google.adk.tools.preload_memory_tool module

class google.adk.tools.preload_memory_tool.PreloadMemoryTool

Bases: BaseTool

A tool that preloads the memory for the current user.

This tool will be automatically executed for each llm_request, and it won’t be called by the model.

NOTE: Currently this tool only uses text part from the memory.

async process_llm_request(*, tool_context, llm_request)

Processes the outgoing LLM request for this tool.

Use cases: - Most common use case is adding this tool to the LLM request. - Some tools may just preprocess the LLM request before it’s sent out.

Return type:

None

Parameters:

• tool_context – The context of the tool.

• llm_request – The outgoing LLM request, mutable this method.

google.adk.tools.retrieval module

class google.adk.tools.retrieval.BaseRetrievalTool(*, name, description, is_long_running=False, custom_metadata=None)

Bases: BaseTool

google.adk.tools.tool_context module

class google.adk.tools.tool_context.ToolContext(invocation_context, *, function_call_id=None, event_actions=None, tool_confirmation=None)

Bases: CallbackContext

The context of the tool.

This class provides the context for a tool invocation, including access to the invocation context, function call ID, event actions, and authentication response. It also provides methods for requesting credentials, retrieving authentication responses, listing artifacts, and searching memory.

invocation_context

The invocation context of the tool.

function_call_id

The function call id of the current tool call. This id was returned in the function call event from LLM to identify a function call. If LLM didn’t return this id, ADK will assign one to it. This id is used to map function call response to the original function call.

event_actions

The event actions of the current tool call.

tool_confirmation

The tool confirmation of the current tool call.

property actions: EventActions

get_auth_response(auth_config)

Return type:

AuthCredential

request_confirmation(*, hint=None, payload=None)

Requests confirmation for the given function call.

Return type:

None

Parameters:

• hint – A hint to the user on how to confirm the tool call.

• payload – The payload used to confirm the tool call.

request_credential(auth_config)

Return type:

None

async search_memory(query)

Searches the memory of the current user.

Return type:

SearchMemoryResponse

google.adk.tools.toolbox_toolset module

class google.adk.tools.toolbox_toolset.ToolboxToolset(server_url, toolset_name=None, tool_names=None, auth_token_getters=None, bound_params=None)

Bases: BaseToolset

A class that provides access to toolbox toolsets.

Example: `python toolbox_toolset = ToolboxToolset("http://127.0.0.1:5000", toolset_name="my-toolset") ) `

Parameters:

• server_url – The URL of the toolbox server.

• toolset_name – The name of the toolbox toolset to load.

• tool_names – The names of the tools to load.

• auth_token_getters – A mapping of authentication service names to callables that return the corresponding authentication token. see: https://github.com/googleapis/mcp-toolbox-sdk-python/tree/main/packages/toolbox-core#authenticating-tools for details.

• bound_params – A mapping of parameter names to bind to specific values or callables that are called to produce values as needed. see: https://github.com/googleapis/mcp-toolbox-sdk-python/tree/main/packages/toolbox-core#binding-parameter-values for details.

The resulting ToolboxToolset will contain both tools loaded by tool_names and toolset_name.

async close()

Performs cleanup and releases resources held by the toolset.

Note

This method is invoked, for example, at the end of an agent server’s lifecycle or when the toolset is no longer needed. Implementations should ensure that any open connections, files, or other managed resources are properly released to prevent leaks.

async get_tools(readonly_context=None)

Return all tools in the toolset based on the provided context.

Return type:

list[BaseTool]

Parameters:

readonly_context (ReadonlyContext, optional) – Context used to filter tools available to the agent. If None, all tools in the toolset are returned.

Returns:

A list of tools available under the specified context.

Return type:

list[BaseTool]

google.adk.tools.transfer_to_agent_tool module

google.adk.tools.transfer_to_agent_tool.transfer_to_agent(agent_name, tool_context)

Transfer the question to another agent.

This tool hands off control to another agent when it’s more suitable to answer the user’s question according to the agent’s description.

Return type:

None

Parameters:

agent_name – the agent name to transfer to.

google.adk.tools.url_context_tool module

class google.adk.tools.url_context_tool.UrlContextTool

Bases: BaseTool

A built-in tool that is automatically invoked by Gemini 2 models to retrieve content from the URLs and use that content to inform and shape its response.

This tool operates internally within the model and does not require or perform local code execution.

async process_llm_request(*, tool_context, llm_request)

Processes the outgoing LLM request for this tool.

Use cases: - Most common use case is adding this tool to the LLM request. - Some tools may just preprocess the LLM request before it’s sent out.

Return type:

None

Parameters:

• tool_context – The context of the tool.

• llm_request – The outgoing LLM request, mutable this method.

google.adk.tools.vertex_ai_search_tool module

class google.adk.tools.vertex_ai_search_tool.VertexAiSearchTool(*, data_store_id=None, data_store_specs=None, search_engine_id=None, filter=None, max_results=None, bypass_multi_tools_limit=False)

Bases: BaseTool

A built-in tool using Vertex AI Search.

data_store_id

The Vertex AI search data store resource ID.

search_engine_id

The Vertex AI search engine resource ID.

Initializes the Vertex AI Search tool.

Parameters:

• data_store_id – The Vertex AI search data store resource ID in the format of “projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}”.

• data_store_specs – Specifications that define the specific DataStores to be searched. It should only be set if engine is used.

• search_engine_id – The Vertex AI search engine resource ID in the format of “projects/{project}/locations/{location}/collections/{collection}/engines/{engine}”.

• filter – The filter to apply to the search results.

• max_results – The maximum number of results to return.

• bypass_multi_tools_limit – Whether to bypass the multi tools limitation, so that the tool can be used with other tools in the same agent.

Raises:

• ValueError – If both data_store_id and search_engine_id are not specified

• or both are specified. –

async process_llm_request(*, tool_context, llm_request)

Processes the outgoing LLM request for this tool.

Use cases: - Most common use case is adding this tool to the LLM request. - Some tools may just preprocess the LLM request before it’s sent out.

Return type:

None

Parameters:

• tool_context – The context of the tool.

• llm_request – The outgoing LLM request, mutable this method.

google.adk.utils module

google.adk.version module