Gemini Agents API

Agents are systems that leverage Gemini models, a set of tools, and reasoning capabilities to perform complex, multi-step tasks and achieve specific goals. Unlike a single model call, an agent can plan, execute a series of actions, interact with external systems, and synthesize information to fulfill a user's request.

View as markdown View the OpenAPI Spec

CreateAgent

post https://generativelanguage.googleapis.com/v1beta/agents

Creates a new Agent (Typed version for SDK).

Request body

The request body contains data with the following structure:

agent_config AntigravityAgentConfig  (optional)

Configuration parameters for the agent.

Configuration for the Antigravity agent runtime. Provides server-side control over the agent's execution environment and tool configuration.

Fields

max_total_tokens string  (optional)

Max total tokens for the agent run.

model string  (optional)

The model to use for agent reasoning.

type object  (optional)

No description provided.

Always set to "antigravity".

base_agent string  (optional)

The base agent to extend.

base_environment EnvironmentConfig  (optional)

The environment configuration for the agent.

Configuration for a custom environment.

Fields

created string  (optional)

Output only. The time at which the environment was created in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).

id string  (optional)

Optional. The environment ID for the interaction. If specified, the request will update the existing environment instead of creating a new one.

last_accessed string  (optional)

Output only. The time at which the environment was last accessed in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).

network EnvironmentNetworkEgressAllowlist  (optional)

Network configuration for the environment.

Outbound networking configuration for the sandbox. Accepts an object with an 'allowlist' array to restrict traffic, or the string 'disabled' to turn off all network access. Omit entirely to allow all outbound traffic with no header injection.

Possible Types

object

Outbound networking configuration for the sandbox. When specified, restricts which external domains the sandbox can reach. Omit entirely to allow all outbound traffic with no header injection.

allowlist AllowlistEntry  (optional)

List of allowed outbound domains. Only requests to listed domains are permitted. Use [{'domain': '*'}] to allow all domains while still injecting headers on specific ones.

A single domain allowlist rule with optional header injection.

Fields

domain string  (optional)

Domain to allow outbound requests to. Supports wildcards (e.g. '*.googleapis.com'). Use '*' to allow all domains.

transform array (object) or object  (optional)

Headers to inject on all outbound requests matching this domain. Accepts a single dict or a list of dicts. The egress proxy injects these automatically.

string

Turns all network off.

Possible values

  • disabled

    Turns all network off.

sources Source  (optional)

No description provided.

A source to be mounted into the environment.

Fields

content string  (optional)

The inline content if `type` is `INLINE`.

encoding string  (optional)

Optional encoding for inline content (e.g. `base64`).

source string  (optional)

The source of the environment. For GCS, this is the GCS path. For GitHub, this is the GitHub path.

target string  (optional)

Where the source should appear in the environment.

type enum (string)  (optional)

No description provided.

Possible values:

  • gcs

    A GCS bucket.

  • inline

    Inline content.

  • repository

    A generic repository. The protocol prefix in the source URL identifies the provider (e.g., github://, gcs://).

  • skill_registry

    A skill resource from the Skill Registry Service. Skill: projects/{project}/locations/{location}/skills/{skill} SkillRevision: projects/{project}/locations/{location}/skills/{skill}/revisions/{revision} Support mounting all skills under a project: projects/{project}/locations/{location}/skills.

status enum (string)  (optional)

No description provided.

Possible values:

  • active
  • expired
type object  (optional)

No description provided.

Always set to "remote".

updated string  (optional)

Output only. The time at which the environment was last updated in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).

description string  (optional)

Agent description for developers to quickly read and understand.

id string  (optional)

The unique identifier for the agent.

system_instruction string  (optional)

System instruction for the agent.

tools AgentTool  (optional)

The tools available to the agent.

A tool that the agent can use.

Possible Types

Polymorphic discriminator: type

CodeExecution

A tool that can be used by the model to execute code.

type object  (required)

No description provided.

Always set to "code_execution".

GoogleSearch

A tool that can be used by the model to search Google.

search_types array (enum (string))  (optional)

The types of search grounding to enable.

Possible values:

  • web_search

    Setting this field enables web search. Only text results are returned.

  • image_search

    Setting this field enables image search. Image bytes are returned.

  • enterprise_web_search

    Setting this field enables enterprise web search.

type object  (required)

No description provided.

Always set to "google_search".

UrlContext

A tool that can be used by the model to fetch URL context.

type object  (required)

No description provided.

Always set to "url_context".

McpServer

A MCPServer is a server that can be called by the model to perform actions.

allowed_tools AllowedTools  (optional)

The allowed tools.

The configuration for allowed tools.

Fields

mode enum (string)  (optional)

The mode of the tool choice.

Possible values:

  • auto

    Auto tool choice.

  • any

    Any tool choice.

  • none

    No tool choice.

  • validated

    Validated tool choice.

tools array (string)  (optional)

The names of the allowed tools.

headers object  (optional)

Optional: Fields for authentication headers, timeouts, etc., if needed.

name string  (optional)

The name of the MCPServer.

type object  (required)

No description provided.

Always set to "mcp_server".

url string  (optional)

The full URL for the MCPServer endpoint. Example: "https://api.example.com/mcp"

Function

A tool that can be used by the model.

description string  (optional)

A description of the function.

name string  (optional)

The name of the function.

parameters object  (optional)

The JSON Schema for the function's parameters.

type object  (required)

No description provided.

Always set to "function".

Response

If successful, the response body contains data with the following structure:

agent_config AntigravityAgentConfig  (optional)

Configuration parameters for the agent.

Configuration for the Antigravity agent runtime. Provides server-side control over the agent's execution environment and tool configuration.

Fields

max_total_tokens string  (optional)

Max total tokens for the agent run.

model string  (optional)

The model to use for agent reasoning.

type object  (optional)

No description provided.

Always set to "antigravity".

base_agent string  (optional)

The base agent to extend.

base_environment EnvironmentConfig  (optional)

The environment configuration for the agent.

Configuration for a custom environment.

Fields

created string  (optional)

Output only. The time at which the environment was created in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).

id string  (optional)

Optional. The environment ID for the interaction. If specified, the request will update the existing environment instead of creating a new one.

last_accessed string  (optional)

Output only. The time at which the environment was last accessed in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).

network EnvironmentNetworkEgressAllowlist  (optional)

Network configuration for the environment.

Outbound networking configuration for the sandbox. Accepts an object with an 'allowlist' array to restrict traffic, or the string 'disabled' to turn off all network access. Omit entirely to allow all outbound traffic with no header injection.

Possible Types

object

Outbound networking configuration for the sandbox. When specified, restricts which external domains the sandbox can reach. Omit entirely to allow all outbound traffic with no header injection.

allowlist AllowlistEntry  (optional)

List of allowed outbound domains. Only requests to listed domains are permitted. Use [{'domain': '*'}] to allow all domains while still injecting headers on specific ones.

A single domain allowlist rule with optional header injection.

Fields

domain string  (optional)

Domain to allow outbound requests to. Supports wildcards (e.g. '*.googleapis.com'). Use '*' to allow all domains.

transform array (object) or object  (optional)

Headers to inject on all outbound requests matching this domain. Accepts a single dict or a list of dicts. The egress proxy injects these automatically.

string

Turns all network off.

Possible values

  • disabled

    Turns all network off.

sources Source  (optional)

No description provided.

A source to be mounted into the environment.

Fields

content string  (optional)

The inline content if `type` is `INLINE`.

encoding string  (optional)

Optional encoding for inline content (e.g. `base64`).

source string  (optional)

The source of the environment. For GCS, this is the GCS path. For GitHub, this is the GitHub path.

target string  (optional)

Where the source should appear in the environment.

type enum (string)  (optional)

No description provided.

Possible values:

  • gcs

    A GCS bucket.

  • inline

    Inline content.

  • repository

    A generic repository. The protocol prefix in the source URL identifies the provider (e.g., github://, gcs://).

  • skill_registry

    A skill resource from the Skill Registry Service. Skill: projects/{project}/locations/{location}/skills/{skill} SkillRevision: projects/{project}/locations/{location}/skills/{skill}/revisions/{revision} Support mounting all skills under a project: projects/{project}/locations/{location}/skills.

status enum (string)  (optional)

No description provided.

Possible values:

  • active
  • expired
type object  (optional)

No description provided.

Always set to "remote".

updated string  (optional)

Output only. The time at which the environment was last updated in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).

description string  (optional)

Agent description for developers to quickly read and understand.

id string  (optional)

The unique identifier for the agent.

system_instruction string  (optional)

System instruction for the agent.

tools AgentTool  (optional)

The tools available to the agent.

A tool that the agent can use.

Possible Types

Polymorphic discriminator: type

CodeExecution

A tool that can be used by the model to execute code.

type object  (required)

No description provided.

Always set to "code_execution".

GoogleSearch

A tool that can be used by the model to search Google.

search_types array (enum (string))  (optional)

The types of search grounding to enable.

Possible values:

  • web_search

    Setting this field enables web search. Only text results are returned.

  • image_search

    Setting this field enables image search. Image bytes are returned.

  • enterprise_web_search

    Setting this field enables enterprise web search.

type object  (required)

No description provided.

Always set to "google_search".

UrlContext

A tool that can be used by the model to fetch URL context.

type object  (required)

No description provided.

Always set to "url_context".

McpServer

A MCPServer is a server that can be called by the model to perform actions.

allowed_tools AllowedTools  (optional)

The allowed tools.

The configuration for allowed tools.

Fields

mode enum (string)  (optional)

The mode of the tool choice.

Possible values:

  • auto

    Auto tool choice.

  • any

    Any tool choice.

  • none

    No tool choice.

  • validated

    Validated tool choice.

tools array (string)  (optional)

The names of the allowed tools.

headers object  (optional)

Optional: Fields for authentication headers, timeouts, etc., if needed.

name string  (optional)

The name of the MCPServer.

type object  (required)

No description provided.

Always set to "mcp_server".

url string  (optional)

The full URL for the MCPServer endpoint. Example: "https://api.example.com/mcp"

Function

A tool that can be used by the model.

description string  (optional)

A description of the function.

name string  (optional)

The name of the function.

parameters object  (optional)

The JSON Schema for the function's parameters.

type object  (required)

No description provided.

Always set to "function".

Create Agent

Example Response

{
  "id": "ag_abc123",
  "display_name": "My Research Agent",
  "system_instruction": "You are a helpful research assistant.",
  "tools": [
    {
      "type": "google_search"
    }
  ],
  "object": "agent",
  "created": "2025-11-26T12:25:15Z",
  "updated": "2025-11-26T12:25:15Z"
}

Agent with Sources

Example Response

{
  "id": "data-analyst-abc123",
  "system_instruction": "You are a data analyst. Always include visualizations and export results as PDF.",
  "object": "agent",
  "created": "2025-11-26T12:25:15Z",
  "updated": "2025-11-26T12:25:15Z"
}

Agent Forked from Environment

Example Response

{
  "id": "my-data-analyst",
  "system_instruction": "You are a data analyst. Use the template at /workspace/template.py for all reports.",
  "object": "agent",
  "created": "2025-11-26T12:25:15Z",
  "updated": "2025-11-26T12:25:15Z"
}

ListAgents

get https://generativelanguage.googleapis.com/v1beta/agents

Lists all Agents.

Path / Query Parameters

page_size integer  (optional)

No description provided.

page_token string  (optional)

No description provided.

parent string  (optional)

No description provided.

Response

If successful, the response body contains data with the following structure:

agents array (Agent)  (optional)

No description provided.

next_page_token string  (optional)

No description provided.

List Agents

Example Response

{
  "object": "list",
  "data": [
    {
      "id": "ag_abc123",
      "display_name": "My Research Agent",
      "system_instruction": "You are a helpful research assistant.",
      "object": "agent",
      "created": "2025-11-26T12:25:15Z",
      "updated": "2025-11-26T12:25:15Z"
    }
  ]
}

GetAgent

get https://generativelanguage.googleapis.com/v1beta/agents/{id}

Gets a specific Agent.

Path / Query Parameters

id string  (required)

No description provided.

Response

If successful, the response body contains data with the following structure:

agent_config AntigravityAgentConfig  (optional)

Configuration parameters for the agent.

Configuration for the Antigravity agent runtime. Provides server-side control over the agent's execution environment and tool configuration.

Fields

max_total_tokens string  (optional)

Max total tokens for the agent run.

model string  (optional)

The model to use for agent reasoning.

type object  (optional)

No description provided.

Always set to "antigravity".

base_agent string  (optional)

The base agent to extend.

base_environment EnvironmentConfig  (optional)

The environment configuration for the agent.

Configuration for a custom environment.

Fields

created string  (optional)

Output only. The time at which the environment was created in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).

id string  (optional)

Optional. The environment ID for the interaction. If specified, the request will update the existing environment instead of creating a new one.

last_accessed string  (optional)

Output only. The time at which the environment was last accessed in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).

network EnvironmentNetworkEgressAllowlist  (optional)

Network configuration for the environment.

Outbound networking configuration for the sandbox. Accepts an object with an 'allowlist' array to restrict traffic, or the string 'disabled' to turn off all network access. Omit entirely to allow all outbound traffic with no header injection.

Possible Types

object

Outbound networking configuration for the sandbox. When specified, restricts which external domains the sandbox can reach. Omit entirely to allow all outbound traffic with no header injection.

allowlist AllowlistEntry  (optional)

List of allowed outbound domains. Only requests to listed domains are permitted. Use [{'domain': '*'}] to allow all domains while still injecting headers on specific ones.

A single domain allowlist rule with optional header injection.

Fields

domain string  (optional)

Domain to allow outbound requests to. Supports wildcards (e.g. '*.googleapis.com'). Use '*' to allow all domains.

transform array (object) or object  (optional)

Headers to inject on all outbound requests matching this domain. Accepts a single dict or a list of dicts. The egress proxy injects these automatically.

string

Turns all network off.

Possible values

  • disabled

    Turns all network off.

sources Source  (optional)

No description provided.

A source to be mounted into the environment.

Fields

content string  (optional)

The inline content if `type` is `INLINE`.

encoding string  (optional)

Optional encoding for inline content (e.g. `base64`).

source string  (optional)

The source of the environment. For GCS, this is the GCS path. For GitHub, this is the GitHub path.

target string  (optional)

Where the source should appear in the environment.

type enum (string)  (optional)

No description provided.

Possible values:

  • gcs

    A GCS bucket.

  • inline

    Inline content.

  • repository

    A generic repository. The protocol prefix in the source URL identifies the provider (e.g., github://, gcs://).

  • skill_registry

    A skill resource from the Skill Registry Service. Skill: projects/{project}/locations/{location}/skills/{skill} SkillRevision: projects/{project}/locations/{location}/skills/{skill}/revisions/{revision} Support mounting all skills under a project: projects/{project}/locations/{location}/skills.

status enum (string)  (optional)

No description provided.

Possible values:

  • active
  • expired
type object  (optional)

No description provided.

Always set to "remote".

updated string  (optional)

Output only. The time at which the environment was last updated in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).

description string  (optional)

Agent description for developers to quickly read and understand.

id string  (optional)

The unique identifier for the agent.

system_instruction string  (optional)

System instruction for the agent.

tools AgentTool  (optional)

The tools available to the agent.

A tool that the agent can use.

Possible Types

Polymorphic discriminator: type

CodeExecution

A tool that can be used by the model to execute code.

type object  (required)

No description provided.

Always set to "code_execution".

GoogleSearch

A tool that can be used by the model to search Google.

search_types array (enum (string))  (optional)

The types of search grounding to enable.

Possible values:

  • web_search

    Setting this field enables web search. Only text results are returned.

  • image_search

    Setting this field enables image search. Image bytes are returned.

  • enterprise_web_search

    Setting this field enables enterprise web search.

type object  (required)

No description provided.

Always set to "google_search".

UrlContext

A tool that can be used by the model to fetch URL context.

type object  (required)

No description provided.

Always set to "url_context".

McpServer

A MCPServer is a server that can be called by the model to perform actions.

allowed_tools AllowedTools  (optional)

The allowed tools.

The configuration for allowed tools.

Fields

mode enum (string)  (optional)

The mode of the tool choice.

Possible values:

  • auto

    Auto tool choice.

  • any

    Any tool choice.

  • none

    No tool choice.

  • validated

    Validated tool choice.

tools array (string)  (optional)

The names of the allowed tools.

headers object  (optional)

Optional: Fields for authentication headers, timeouts, etc., if needed.

name string  (optional)

The name of the MCPServer.

type object  (required)

No description provided.

Always set to "mcp_server".

url string  (optional)

The full URL for the MCPServer endpoint. Example: "https://api.example.com/mcp"

Function

A tool that can be used by the model.

description string  (optional)

A description of the function.

name string  (optional)

The name of the function.

parameters object  (optional)

The JSON Schema for the function's parameters.

type object  (required)

No description provided.

Always set to "function".

Get Agent

Example Response

{
  "id": "ag_abc123",
  "display_name": "My Research Agent",
  "system_instruction": "You are a helpful research assistant.",
  "tools": [
    {
      "type": "google_search"
    }
  ],
  "object": "agent",
  "created": "2025-11-26T12:25:15Z",
  "updated": "2025-11-26T12:25:15Z"
}

DeleteAgent

delete https://generativelanguage.googleapis.com/v1beta/agents/{id}

Deletes an Agent.

Path / Query Parameters

id string  (required)

No description provided.

Response

If successful, the response is empty.

Delete Agent

Resources

Agent

An agent definition for the CreateAgent API. This message is the target for annotation-parser-based JSON parsing. New format: { "id": "customer-sentinel", "base_agent": "", "system_instruction": "...", "base_environment": { "type": "remote", "sources": [...] }, "tools": [ {"type": "code_execution"} ] }

Fields

agent_config AntigravityAgentConfig  (optional)

Configuration parameters for the agent.

Configuration for the Antigravity agent runtime. Provides server-side control over the agent's execution environment and tool configuration.

Fields

max_total_tokens string  (optional)

Max total tokens for the agent run.

model string  (optional)

The model to use for agent reasoning.

type object  (optional)

No description provided.

Always set to "antigravity".

base_agent string  (optional)

The base agent to extend.

base_environment EnvironmentConfig  (optional)

The environment configuration for the agent.

Configuration for a custom environment.

Fields

created string  (optional)

Output only. The time at which the environment was created in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).

id string  (optional)

Optional. The environment ID for the interaction. If specified, the request will update the existing environment instead of creating a new one.

last_accessed string  (optional)

Output only. The time at which the environment was last accessed in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).

network EnvironmentNetworkEgressAllowlist  (optional)

Network configuration for the environment.

Outbound networking configuration for the sandbox. Accepts an object with an 'allowlist' array to restrict traffic, or the string 'disabled' to turn off all network access. Omit entirely to allow all outbound traffic with no header injection.

Possible Types

object

Outbound networking configuration for the sandbox. When specified, restricts which external domains the sandbox can reach. Omit entirely to allow all outbound traffic with no header injection.

allowlist AllowlistEntry  (optional)

List of allowed outbound domains. Only requests to listed domains are permitted. Use [{'domain': '*'}] to allow all domains while still injecting headers on specific ones.

A single domain allowlist rule with optional header injection.

Fields

domain string  (optional)

Domain to allow outbound requests to. Supports wildcards (e.g. '*.googleapis.com'). Use '*' to allow all domains.

transform array (object) or object  (optional)

Headers to inject on all outbound requests matching this domain. Accepts a single dict or a list of dicts. The egress proxy injects these automatically.

string

Turns all network off.

Possible values

  • disabled

    Turns all network off.

sources Source  (optional)

No description provided.

A source to be mounted into the environment.

Fields

content string  (optional)

The inline content if `type` is `INLINE`.

encoding string  (optional)

Optional encoding for inline content (e.g. `base64`).

source string  (optional)

The source of the environment. For GCS, this is the GCS path. For GitHub, this is the GitHub path.

target string  (optional)

Where the source should appear in the environment.

type enum (string)  (optional)

No description provided.

Possible values:

  • gcs

    A GCS bucket.

  • inline

    Inline content.

  • repository

    A generic repository. The protocol prefix in the source URL identifies the provider (e.g., github://, gcs://).

  • skill_registry

    A skill resource from the Skill Registry Service. Skill: projects/{project}/locations/{location}/skills/{skill} SkillRevision: projects/{project}/locations/{location}/skills/{skill}/revisions/{revision} Support mounting all skills under a project: projects/{project}/locations/{location}/skills.

status enum (string)  (optional)

No description provided.

Possible values:

  • active
  • expired
type object  (optional)

No description provided.

Always set to "remote".

updated string  (optional)

Output only. The time at which the environment was last updated in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).

description string  (optional)

Agent description for developers to quickly read and understand.

id string  (optional)

The unique identifier for the agent.

system_instruction string  (optional)

System instruction for the agent.

tools AgentTool  (optional)

The tools available to the agent.

A tool that the agent can use.

Possible Types

Polymorphic discriminator: type

CodeExecution

A tool that can be used by the model to execute code.

type object  (required)

No description provided.

Always set to "code_execution".

GoogleSearch

A tool that can be used by the model to search Google.

search_types array (enum (string))  (optional)

The types of search grounding to enable.

Possible values:

  • web_search

    Setting this field enables web search. Only text results are returned.

  • image_search

    Setting this field enables image search. Image bytes are returned.

  • enterprise_web_search

    Setting this field enables enterprise web search.

type object  (required)

No description provided.

Always set to "google_search".

UrlContext

A tool that can be used by the model to fetch URL context.

type object  (required)

No description provided.

Always set to "url_context".

McpServer

A MCPServer is a server that can be called by the model to perform actions.

allowed_tools AllowedTools  (optional)

The allowed tools.

The configuration for allowed tools.

Fields

mode enum (string)  (optional)

The mode of the tool choice.

Possible values:

  • auto

    Auto tool choice.

  • any

    Any tool choice.

  • none

    No tool choice.

  • validated

    Validated tool choice.

tools array (string)  (optional)

The names of the allowed tools.

headers object  (optional)

Optional: Fields for authentication headers, timeouts, etc., if needed.

name string  (optional)

The name of the MCPServer.

type object  (required)

No description provided.

Always set to "mcp_server".

url string  (optional)

The full URL for the MCPServer endpoint. Example: "https://api.example.com/mcp"

Function

A tool that can be used by the model.

description string  (optional)

A description of the function.

name string  (optional)

The name of the function.

parameters object  (optional)

The JSON Schema for the function's parameters.

type object  (required)

No description provided.

Always set to "function".

Data Models

InteractionSseEvent

Possible Types

Polymorphic discriminator: event_type

InteractionCreatedEvent

event_id string  (optional)

The event_id token to be used to resume the interaction stream, from this event.

event_type object  (required)

No description provided.

Always set to "interaction.created".

interaction InteractionSseEventInteraction  (required)

Partial interaction resource emitted when the stream is created.

Partial interaction resource emitted by interaction lifecycle SSE events. Streaming lifecycle payloads may omit fields that are only available on full non-streaming Interaction responses.

Fields

agent string  (optional)

The agent to interact with.

created string  (optional)

Output only. The time at which the response was created in ISO 8601 format.

id string  (optional)

Required. Output only. A unique identifier for the interaction completion.

model string  (optional)

The model that will complete your prompt.

object string  (optional)

Output only. The resource type.

service_tier ServiceTier  (optional)

The service tier for the interaction.

Possible values

  • flex

    Flex service tier.

  • standard

    Standard service tier.

  • priority

    Priority service tier.

status enum (string)  (optional)

Required. Output only. The status of the interaction.

Possible values:

  • in_progress

    The interaction is in progress.

  • requires_action

    The interaction requires action/input from the user.

  • completed

    The interaction is completed.

  • failed

    The interaction failed.

  • cancelled

    The interaction was cancelled.

  • incomplete

    The interaction is completed, but contains incomplete results (e.g. hitting max_tokens).

steps Step  (optional)

Output only. The steps that make up the interaction, if included in this event.

A step in the interaction.

Possible Types

Polymorphic discriminator: type

UserInputStep

Input provided by the user.

content Content  (optional)

No description provided.

The content of the response.

Possible Types

Polymorphic discriminator: type

TextContent

A text content block.

annotations Annotation  (optional)

Citation information for model-generated content.

Citation information for model-generated content.

Possible Types

Polymorphic discriminator: type

UrlCitation

A URL citation annotation.

end_index integer  (optional)

End of the attributed segment, exclusive.

start_index integer  (optional)

Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.

title string  (optional)

The title of the URL.

type object  (required)

No description provided.

Always set to "url_citation".

url string  (optional)

The URL.

FileCitation

A file citation annotation.

custom_metadata object  (optional)

User provided metadata about the retrieved context.

document_uri string  (optional)

The URI of the file.

end_index integer  (optional)

End of the attributed segment, exclusive.

file_name string  (optional)

The name of the file.

media_id string  (optional)

Media ID in-case of image citations, if applicable.

page_number integer  (optional)

Page number of the cited document, if applicable.

source string  (optional)

Source attributed for a portion of the text.

start_index integer  (optional)

Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.

type object  (required)

No description provided.

Always set to "file_citation".

PlaceCitation

A place citation annotation.

end_index integer  (optional)

End of the attributed segment, exclusive.

name string  (optional)

Title of the place.

place_id string  (optional)

The ID of the place, in `places/{place_id}` format.

review_snippets ReviewSnippet  (optional)

Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.

Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.

Fields

review_id string  (optional)

The ID of the review snippet.

title string  (optional)

Title of the review.

url string  (optional)

A link that corresponds to the user review on Google Maps.

start_index integer  (optional)

Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.

type object  (required)

No description provided.

Always set to "place_citation".

url string  (optional)

URI reference of the place.

WordInfo

Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution.

end_index integer  (optional)

End of the attributed segment, exclusive.

end_offset string  (optional)

End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".

speaker string  (optional)

Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.

start_index integer  (optional)

Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.

start_offset string  (optional)

Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".

text string  (optional)

The transcribed word.

type object  (required)

No description provided.

Always set to "word_info".

text string  (required)

Required. The text content.

type object  (required)

No description provided.

Always set to "text".

ImageContent

An image content block.

data string  (optional)

The image content.

mime_type enum (string)  (optional)

The mime type of the image.

Possible values:

  • image/png

    PNG image format

  • image/jpeg

    JPEG image format

  • image/webp

    WebP image format

  • image/heic

    HEIC image format

  • image/heif

    HEIF image format

  • image/gif

    GIF image format

  • image/bmp

    BMP image format

  • image/tiff

    TIFF image format

resolution MediaResolution  (optional)

The resolution of the media.

Possible values

  • low

    Low resolution.

  • medium

    Medium resolution.

  • high

    High resolution.

  • ultra_high

    Ultra high resolution.

type object  (required)

No description provided.

Always set to "image".

uri string  (optional)

The URI of the image.

AudioContent

An audio content block.

channels integer  (optional)

The number of audio channels.

data string  (optional)

The audio content.

mime_type enum (string)  (optional)

The mime type of the audio.

Possible values:

  • audio/wav

    WAV audio format

  • audio/mp3

    MP3 audio format

  • audio/aiff

    AIFF audio format

  • audio/aac

    AAC audio format

  • audio/ogg

    OGG audio format

  • audio/flac

    FLAC audio format

  • audio/mpeg

    MPEG audio format

  • audio/m4a

    M4A audio format

  • audio/l16

    L16 audio format

  • audio/opus

    OPUS audio format

  • audio/alaw

    ALAW audio format

  • audio/mulaw

    MULAW audio format

sample_rate integer  (optional)

The sample rate of the audio.

type object  (required)

No description provided.

Always set to "audio".

uri string  (optional)

The URI of the audio.

DocumentContent

A document content block.

data string  (optional)

The document content.

mime_type enum (string)  (optional)

The mime type of the document.

Possible values:

  • application/pdf

    PDF document format

  • text/csv

    CSV document format

type object  (required)

No description provided.

Always set to "document".

uri string  (optional)

The URI of the document.

VideoContent

A video content block.

data string  (optional)

The video content.

mime_type enum (string)  (optional)

The mime type of the video.

Possible values:

  • video/mp4

    MP4 video format

  • video/mpeg

    MPEG video format

  • video/mpg

    MPG video format

  • video/mov

    MOV video format

  • video/avi

    AVI video format

  • video/x-flv

    FLV video format

  • video/webm

    WebM video format

  • video/wmv

    WMV video format

  • video/3gpp

    3GPP video format

resolution MediaResolution  (optional)

The resolution of the media.

Possible values

  • low

    Low resolution.

  • medium

    Medium resolution.

  • high

    High resolution.

  • ultra_high

    Ultra high resolution.

type object  (required)

No description provided.

Always set to "video".

uri string  (optional)

The URI of the video.

type object  (required)

No description provided.

Always set to "user_input".

ModelOutputStep

Output generated by the model.

content Content  (optional)

No description provided.

The content of the response.

Possible Types

Polymorphic discriminator: type

TextContent

A text content block.

annotations Annotation  (optional)

Citation information for model-generated content.

Citation information for model-generated content.

Possible Types

Polymorphic discriminator: type

UrlCitation

A URL citation annotation.

end_index integer  (optional)

End of the attributed segment, exclusive.

start_index integer  (optional)

Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.

title string  (optional)

The title of the URL.

type object  (required)

No description provided.

Always set to "url_citation".

url string  (optional)

The URL.

FileCitation

A file citation annotation.

custom_metadata object  (optional)

User provided metadata about the retrieved context.

document_uri string  (optional)

The URI of the file.

end_index integer  (optional)

End of the attributed segment, exclusive.

file_name string  (optional)

The name of the file.

media_id string  (optional)

Media ID in-case of image citations, if applicable.

page_number integer  (optional)

Page number of the cited document, if applicable.

source string  (optional)

Source attributed for a portion of the text.

start_index integer  (optional)

Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.

type object  (required)

No description provided.

Always set to "file_citation".

PlaceCitation

A place citation annotation.

end_index integer  (optional)

End of the attributed segment, exclusive.

name string  (optional)

Title of the place.

place_id string  (optional)

The ID of the place, in `places/{place_id}` format.

review_snippets ReviewSnippet  (optional)

Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.

Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.

Fields

review_id string  (optional)

The ID of the review snippet.

title string  (optional)

Title of the review.

url string  (optional)

A link that corresponds to the user review on Google Maps.

start_index integer  (optional)

Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.

type object  (required)

No description provided.

Always set to "place_citation".

url string  (optional)

URI reference of the place.

WordInfo

Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution.

end_index integer  (optional)

End of the attributed segment, exclusive.

end_offset string  (optional)

End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".

speaker string  (optional)

Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.

start_index integer  (optional)

Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.

start_offset string  (optional)

Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".

text string  (optional)

The transcribed word.

type object  (required)

No description provided.

Always set to "word_info".

text string  (required)

Required. The text content.

type object  (required)

No description provided.

Always set to "text".

ImageContent

An image content block.

data string  (optional)

The image content.

mime_type enum (string)  (optional)

The mime type of the image.

Possible values:

  • image/png

    PNG image format

  • image/jpeg

    JPEG image format

  • image/webp

    WebP image format

  • image/heic

    HEIC image format

  • image/heif

    HEIF image format

  • image/gif

    GIF image format

  • image/bmp

    BMP image format

  • image/tiff

    TIFF image format

resolution MediaResolution  (optional)

The resolution of the media.

Possible values

  • low

    Low resolution.

  • medium

    Medium resolution.

  • high

    High resolution.

  • ultra_high

    Ultra high resolution.

type object  (required)

No description provided.

Always set to "image".

uri string  (optional)

The URI of the image.

AudioContent

An audio content block.

channels integer  (optional)

The number of audio channels.

data string  (optional)

The audio content.

mime_type enum (string)  (optional)

The mime type of the audio.

Possible values:

  • audio/wav

    WAV audio format

  • audio/mp3

    MP3 audio format

  • audio/aiff

    AIFF audio format

  • audio/aac

    AAC audio format

  • audio/ogg

    OGG audio format

  • audio/flac

    FLAC audio format

  • audio/mpeg

    MPEG audio format

  • audio/m4a

    M4A audio format

  • audio/l16

    L16 audio format

  • audio/opus

    OPUS audio format

  • audio/alaw

    ALAW audio format

  • audio/mulaw

    MULAW audio format

sample_rate integer  (optional)

The sample rate of the audio.

type object  (required)

No description provided.

Always set to "audio".

uri string  (optional)

The URI of the audio.

DocumentContent

A document content block.

data string  (optional)

The document content.

mime_type enum (string)  (optional)

The mime type of the document.

Possible values:

  • application/pdf

    PDF document format

  • text/csv

    CSV document format

type object  (required)

No description provided.

Always set to "document".

uri string  (optional)

The URI of the document.

VideoContent

A video content block.

data string  (optional)

The video content.

mime_type enum (string)  (optional)

The mime type of the video.

Possible values:

  • video/mp4

    MP4 video format

  • video/mpeg

    MPEG video format

  • video/mpg

    MPG video format

  • video/mov

    MOV video format

  • video/avi

    AVI video format

  • video/x-flv

    FLV video format

  • video/webm

    WebM video format

  • video/wmv

    WMV video format

  • video/3gpp

    3GPP video format

resolution MediaResolution  (optional)

The resolution of the media.

Possible values

  • low

    Low resolution.

  • medium

    Medium resolution.

  • high

    High resolution.

  • ultra_high

    Ultra high resolution.

type object  (required)

No description provided.

Always set to "video".

uri string  (optional)

The URI of the video.

error Status  (optional)

The error result of the operation in case of failure or cancellation.

The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).

Fields

code integer  (optional)

The status code, which should be an enum value of google.rpc.Code.

details array (object)  (optional)

A list of messages that carry the error details. There is a common set of message types for APIs to use.

message string  (optional)

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

type object  (required)

No description provided.

Always set to "model_output".

ThoughtStep

A thought step.

signature string  (optional)

A signature hash for backend validation.

summary ThoughtSummaryContent  (optional)

A summary of the thought.

Possible Types

Polymorphic discriminator: type

TextContent

A text content block.

annotations Annotation  (optional)

Citation information for model-generated content.

Citation information for model-generated content.

Possible Types

Polymorphic discriminator: type

UrlCitation

A URL citation annotation.

end_index integer  (optional)

End of the attributed segment, exclusive.

start_index integer  (optional)

Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.

title string  (optional)

The title of the URL.

type object  (required)

No description provided.

Always set to "url_citation".

url string  (optional)

The URL.

FileCitation

A file citation annotation.

custom_metadata object  (optional)

User provided metadata about the retrieved context.

document_uri string  (optional)

The URI of the file.

end_index integer  (optional)

End of the attributed segment, exclusive.

file_name string  (optional)

The name of the file.

media_id string  (optional)

Media ID in-case of image citations, if applicable.

page_number integer  (optional)

Page number of the cited document, if applicable.

source string  (optional)

Source attributed for a portion of the text.

start_index integer  (optional)

Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.

type object  (required)

No description provided.

Always set to "file_citation".

PlaceCitation

A place citation annotation.

end_index integer  (optional)

End of the attributed segment, exclusive.

name string  (optional)

Title of the place.

place_id string  (optional)

The ID of the place, in `places/{place_id}` format.

review_snippets ReviewSnippet  (optional)

Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.

Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.

Fields

review_id string  (optional)

The ID of the review snippet.

title string  (optional)

Title of the review.

url string  (optional)

A link that corresponds to the user review on Google Maps.

start_index integer  (optional)

Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.

type object  (required)

No description provided.

Always set to "place_citation".

url string  (optional)

URI reference of the place.

WordInfo

Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution.

end_index integer  (optional)

End of the attributed segment, exclusive.

end_offset string  (optional)

End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".

speaker string  (optional)

Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.

start_index integer  (optional)

Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.

start_offset string  (optional)

Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".

text string  (optional)

The transcribed word.

type object  (required)

No description provided.

Always set to "word_info".

text string  (required)

Required. The text content.

type object  (required)

No description provided.

Always set to "text".

ImageContent

An image content block.

data string  (optional)

The image content.

mime_type enum (string)  (optional)

The mime type of the image.

Possible values:

  • image/png

    PNG image format

  • image/jpeg

    JPEG image format

  • image/webp

    WebP image format

  • image/heic

    HEIC image format

  • image/heif

    HEIF image format

  • image/gif

    GIF image format

  • image/bmp

    BMP image format

  • image/tiff

    TIFF image format

resolution MediaResolution  (optional)

The resolution of the media.

Possible values

  • low

    Low resolution.

  • medium

    Medium resolution.

  • high

    High resolution.

  • ultra_high

    Ultra high resolution.

type object  (required)

No description provided.

Always set to "image".

uri string  (optional)

The URI of the image.

type object  (required)

No description provided.

Always set to "thought".

FunctionCallStep

A function tool call step.

arguments object  (required)

Required. The arguments to pass to the function.

id string  (required)

Required. A unique ID for this specific tool call.

name string  (required)

Required. The name of the tool to call.

type object  (required)

No description provided.

Always set to "function_call".

CodeExecutionCallStep

Code execution call step.

arguments CodeExecutionCallStepArguments  (required)

Required. The arguments to pass to the code execution.

The arguments to pass to the code execution.

Fields

code string  (optional)

The code to be executed.

language enum (string)  (optional)

Programming language of the `code`.

Possible values:

  • python

    Python >= 3.10, with numpy and simpy available.

id string  (required)

Required. A unique ID for this specific tool call.

signature string  (optional)

A signature hash for backend validation.

type object  (required)

No description provided.

Always set to "code_execution_call".

UrlContextCallStep

URL context call step.

arguments UrlContextCallArguments  (required)

Required. The arguments to pass to the URL context.

The arguments to pass to the URL context.

Fields

urls array (string)  (optional)

The URLs to fetch.

id string  (required)

Required. A unique ID for this specific tool call.

signature string  (optional)

A signature hash for backend validation.

type object  (required)

No description provided.

Always set to "url_context_call".

McpServerToolCallStep

MCPServer tool call step.

arguments object  (required)

Required. The JSON object of arguments for the function.

id string  (required)

Required. A unique ID for this specific tool call.

name string  (required)

Required. The name of the tool which was called.

server_name string  (required)

Required. The name of the used MCP server.

type object  (required)

No description provided.

Always set to "mcp_server_tool_call".

GoogleSearchCallStep

Google Search call step.

arguments GoogleSearchCallStepArguments  (required)

Required. The arguments to pass to Google Search.

The arguments to pass to Google Search.

Fields

queries array (string)  (optional)

Web search queries for the following-up web search.

id string  (required)

Required. A unique ID for this specific tool call.

search_type enum (string)  (optional)

The type of search grounding enabled.

Possible values:

  • web_search

    Setting this field enables web search. Only text results are returned.

  • image_search

    Setting this field enables image search. Image bytes are returned.

  • enterprise_web_search

    Setting this field enables enterprise web search.

signature string  (optional)

A signature hash for backend validation.

type object  (required)

No description provided.

Always set to "google_search_call".

FileSearchCallStep

File Search call step.

id string  (required)

Required. A unique ID for this specific tool call.

signature string  (optional)

A signature hash for backend validation.

type object  (required)

No description provided.

Always set to "file_search_call".

GoogleMapsCallStep

Google Maps call step.

arguments GoogleMapsCallStepArguments  (optional)

The arguments to pass to the Google Maps tool.

The arguments to pass to the Google Maps tool.

Fields

queries array (string)  (optional)

The queries to be executed.

id string  (required)

Required. A unique ID for this specific tool call.

signature string  (optional)

A signature hash for backend validation.

type object  (required)

No description provided.

Always set to "google_maps_call".

FunctionResultStep

Result of a function tool call.

call_id string  (required)

Required. ID to match the ID from the function call block.

is_error boolean  (optional)

Whether the tool call resulted in an error.

name string  (optional)

The name of the tool that was called.

result array (ImageContent or TextContent) or object or string  (required)

Required. The result of the tool call.

type object  (required)

No description provided.

Always set to "function_result".

CodeExecutionResultStep

Code execution result step.

call_id string  (required)

Required. ID to match the ID from the function call block.

is_error boolean  (optional)

Whether the code execution resulted in an error.

result string  (required)

Required. The output of the code execution.

signature string  (optional)

A signature hash for backend validation.

type object  (required)

No description provided.

Always set to "code_execution_result".

UrlContextResultStep

URL context result step.

call_id string  (required)

Required. ID to match the ID from the function call block.

is_error boolean  (optional)

Whether the URL context resulted in an error.

result UrlContextResult  (required)

Required. The results of the URL context.

The result of the URL context.

Fields

status enum (string)  (optional)

The status of the URL retrieval.

Possible values:

  • success

    Url retrieval is successful.

  • error

    Url retrieval is failed due to error.

  • paywall

    Url retrieval is failed because the content is behind paywall.

  • unsafe

    Url retrieval is failed because the content is unsafe.

url string  (optional)

The URL that was fetched.

signature string  (optional)

A signature hash for backend validation.

type object  (required)

No description provided.

Always set to "url_context_result".

GoogleSearchResultStep

Google Search result step.

call_id string  (required)

Required. ID to match the ID from the function call block.

is_error boolean  (optional)

Whether the Google Search resulted in an error.

result GoogleSearchResultItem  (required)

Required. The results of the Google Search.

The result of the Google Search.

Fields

search_suggestions string  (optional)

Web content snippet that can be embedded in a web page or an app webview.

signature string  (optional)

A signature hash for backend validation.

type object  (required)

No description provided.

Always set to "google_search_result".

McpServerToolResultStep

MCPServer tool result step.

call_id string  (required)

Required. ID to match the ID from the function call block.

name string  (optional)

Name of the tool which is called for this specific tool call.

result array (ImageContent or TextContent) or object or string  (required)

Required. The output from the MCP server call. Can be simple text or rich content.

server_name string  (optional)

The name of the used MCP server.

type object  (required)

No description provided.

Always set to "mcp_server_tool_result".

FileSearchResultStep

File Search result step.

call_id string  (required)

Required. ID to match the ID from the function call block.

signature string  (optional)

A signature hash for backend validation.

type object  (required)

No description provided.

Always set to "file_search_result".

GoogleMapsResultStep

Google Maps result step.

call_id string  (required)

Required. ID to match the ID from the function call block.

result GoogleMapsResultItem  (required)

No description provided.

The result of the Google Maps.

Fields

places GoogleMapsResultPlaces  (optional)

No description provided.

Fields

name string  (optional)

No description provided.

place_id string  (optional)

No description provided.

review_snippets ReviewSnippet  (optional)

No description provided.

Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.

Fields

review_id string  (optional)

The ID of the review snippet.

title string  (optional)

Title of the review.

url string  (optional)

A link that corresponds to the user review on Google Maps.

url string  (optional)

No description provided.

widget_context_token string  (optional)

No description provided.

signature string  (optional)

A signature hash for backend validation.

type object  (required)

No description provided.

Always set to "google_maps_result".

updated string  (optional)

Output only. The time at which the response was last updated in ISO 8601 format.

usage Usage  (optional)

Output only. Statistics on the interaction request's token usage.

Statistics on the interaction request's token usage.

Fields

cached_tokens_by_modality ModalityTokens  (optional)

A breakdown of cached token usage by modality.

The token count for a single response modality.

Fields

modality ResponseModality  (optional)

The modality associated with the token count.

Possible values

  • text

    Indicates the model should return text.

  • image

    Indicates the model should return images.

  • audio

    Indicates the model should return audio.

  • video

    Indicates the model should return video.

  • document

    Indicates the model should return documents.

tokens integer  (optional)

Number of tokens for the modality.

grounding_tool_count GroundingToolCount  (optional)

Grounding tool count.

The number of grounding tool counts.

Fields

count integer  (optional)

The number of grounding tool counts.

type enum (string)  (optional)

The grounding tool type associated with the count.

Possible values:

  • google_search

    Grounding with Google Web Search and Image Search, & Web Grounding for Enterprise.

  • google_maps

    Grounding with Google Maps.

  • retrieval

    Grounding with customer's data, for example, VertexAISearch.

input_tokens_by_modality ModalityTokens  (optional)

A breakdown of input token usage by modality.

The token count for a single response modality.

Fields

modality ResponseModality  (optional)

The modality associated with the token count.

Possible values

  • text

    Indicates the model should return text.

  • image

    Indicates the model should return images.

  • audio

    Indicates the model should return audio.

  • video

    Indicates the model should return video.

  • document

    Indicates the model should return documents.

tokens integer  (optional)

Number of tokens for the modality.

output_tokens_by_modality ModalityTokens  (optional)

A breakdown of output token usage by modality.

The token count for a single response modality.

Fields

modality ResponseModality  (optional)

The modality associated with the token count.

Possible values

  • text

    Indicates the model should return text.

  • image

    Indicates the model should return images.

  • audio

    Indicates the model should return audio.

  • video

    Indicates the model should return video.

  • document

    Indicates the model should return documents.

tokens integer  (optional)

Number of tokens for the modality.

tool_use_tokens_by_modality ModalityTokens  (optional)

A breakdown of tool-use token usage by modality.

The token count for a single response modality.

Fields

modality ResponseModality  (optional)

The modality associated with the token count.

Possible values

  • text

    Indicates the model should return text.

  • image

    Indicates the model should return images.

  • audio

    Indicates the model should return audio.

  • video

    Indicates the model should return video.

  • document

    Indicates the model should return documents.

tokens integer  (optional)

Number of tokens for the modality.

total_cached_tokens integer  (optional)

Number of tokens in the cached part of the prompt (the cached content).

total_input_tokens integer  (optional)

Number of tokens in the prompt (context).

total_output_tokens integer  (optional)

Total number of tokens across all the generated responses.

total_thought_tokens integer  (optional)

Number of tokens of thoughts for thinking models.

total_tokens integer  (optional)

Total token count for the interaction request (prompt + responses + other internal tokens).

total_tool_use_tokens integer  (optional)

Number of tokens present in tool-use prompt(s).

metadata StreamMetadata  (optional)

Optional metadata accompanying ANY streamed event.

Fields

total_usage Usage  (optional)

No description provided.

Statistics on the interaction request's token usage.

Fields

cached_tokens_by_modality ModalityTokens  (optional)

A breakdown of cached token usage by modality.

The token count for a single response modality.

Fields

modality ResponseModality  (optional)

The modality associated with the token count.

Possible values

  • text

    Indicates the model should return text.

  • image

    Indicates the model should return images.

  • audio

    Indicates the model should return audio.

  • video

    Indicates the model should return video.

  • document

    Indicates the model should return documents.

tokens integer  (optional)

Number of tokens for the modality.

grounding_tool_count GroundingToolCount  (optional)

Grounding tool count.

The number of grounding tool counts.

Fields

count integer  (optional)

The number of grounding tool counts.

type enum (string)  (optional)

The grounding tool type associated with the count.

Possible values:

  • google_search

    Grounding with Google Web Search and Image Search, & Web Grounding for Enterprise.

  • google_maps

    Grounding with Google Maps.

  • retrieval

    Grounding with customer's data, for example, VertexAISearch.

input_tokens_by_modality ModalityTokens  (optional)

A breakdown of input token usage by modality.

The token count for a single response modality.

Fields

modality ResponseModality  (optional)

The modality associated with the token count.

Possible values

  • text

    Indicates the model should return text.

  • image

    Indicates the model should return images.

  • audio

    Indicates the model should return audio.

  • video

    Indicates the model should return video.

  • document

    Indicates the model should return documents.

tokens integer  (optional)

Number of tokens for the modality.

output_tokens_by_modality ModalityTokens  (optional)

A breakdown of output token usage by modality.

The token count for a single response modality.

Fields

modality ResponseModality  (optional)

The modality associated with the token count.

Possible values

  • text

    Indicates the model should return text.

  • image

    Indicates the model should return images.

  • audio

    Indicates the model should return audio.

  • video

    Indicates the model should return video.

  • document

    Indicates the model should return documents.

tokens integer  (optional)

Number of tokens for the modality.

tool_use_tokens_by_modality ModalityTokens  (optional)

A breakdown of tool-use token usage by modality.

The token count for a single response modality.

Fields

modality ResponseModality  (optional)

The modality associated with the token count.

Possible values

  • text

    Indicates the model should return text.

  • image

    Indicates the model should return images.

  • audio

    Indicates the model should return audio.

  • video

    Indicates the model should return video.

  • document

    Indicates the model should return documents.

tokens integer  (optional)

Number of tokens for the modality.

total_cached_tokens integer  (optional)

Number of tokens in the cached part of the prompt (the cached content).

total_input_tokens integer  (optional)

Number of tokens in the prompt (context).

total_output_tokens integer  (optional)

Total number of tokens across all the generated responses.

total_thought_tokens integer  (optional)

Number of tokens of thoughts for thinking models.

total_tokens integer  (optional)

Total token count for the interaction request (prompt + responses + other internal tokens).

total_tool_use_tokens integer  (optional)

Number of tokens present in tool-use prompt(s).

InteractionCompletedEvent

event_id string  (optional)

The event_id token to be used to resume the interaction stream, from this event.

event_type object  (required)

No description provided.

Always set to "interaction.completed".

interaction InteractionSseEventInteraction  (required)

Partial completed interaction resource emitted at the end of the stream.

Partial interaction resource emitted by interaction lifecycle SSE events. Streaming lifecycle payloads may omit fields that are only available on full non-streaming Interaction responses.

Fields

agent string  (optional)

The agent to interact with.

created string  (optional)

Output only. The time at which the response was created in ISO 8601 format.

id string  (optional)

Required. Output only. A unique identifier for the interaction completion.

model string  (optional)

The model that will complete your prompt.

object string  (optional)

Output only. The resource type.

service_tier ServiceTier  (optional)

The service tier for the interaction.

Possible values

  • flex

    Flex service tier.

  • standard

    Standard service tier.

  • priority

    Priority service tier.

status enum (string)  (optional)

Required. Output only. The status of the interaction.

Possible values:

  • in_progress

    The interaction is in progress.

  • requires_action

    The interaction requires action/input from the user.

  • completed

    The interaction is completed.

  • failed

    The interaction failed.

  • cancelled

    The interaction was cancelled.

  • incomplete

    The interaction is completed, but contains incomplete results (e.g. hitting max_tokens).

steps Step  (optional)

Output only. The steps that make up the interaction, if included in this event.

A step in the interaction.

Possible Types

Polymorphic discriminator: type

UserInputStep

Input provided by the user.

content Content  (optional)

No description provided.

The content of the response.

Possible Types

Polymorphic discriminator: type

TextContent

A text content block.

annotations Annotation  (optional)

Citation information for model-generated content.

Citation information for model-generated content.

Possible Types

Polymorphic discriminator: type

UrlCitation

A URL citation annotation.

end_index integer  (optional)

End of the attributed segment, exclusive.

start_index integer  (optional)

Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.

title string  (optional)

The title of the URL.

type object  (required)

No description provided.

Always set to "url_citation".

url string  (optional)

The URL.

FileCitation

A file citation annotation.

custom_metadata object  (optional)

User provided metadata about the retrieved context.

document_uri string  (optional)

The URI of the file.

end_index integer  (optional)

End of the attributed segment, exclusive.

file_name string  (optional)

The name of the file.

media_id string  (optional)

Media ID in-case of image citations, if applicable.

page_number integer  (optional)

Page number of the cited document, if applicable.

source string  (optional)

Source attributed for a portion of the text.

start_index integer  (optional)

Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.

type object  (required)

No description provided.

Always set to "file_citation".

PlaceCitation

A place citation annotation.

end_index integer  (optional)

End of the attributed segment, exclusive.

name string  (optional)

Title of the place.

place_id string  (optional)

The ID of the place, in `places/{place_id}` format.

review_snippets ReviewSnippet  (optional)

Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.

Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.

Fields

review_id string  (optional)

The ID of the review snippet.

title string  (optional)

Title of the review.

url string  (optional)

A link that corresponds to the user review on Google Maps.

start_index integer  (optional)

Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.

type object  (required)

No description provided.

Always set to "place_citation".

url string  (optional)

URI reference of the place.

WordInfo

Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution.

end_index integer  (optional)

End of the attributed segment, exclusive.

end_offset string  (optional)

End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".

speaker string  (optional)

Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.

start_index integer  (optional)

Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.

start_offset string  (optional)

Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".

text string  (optional)

The transcribed word.

type object  (required)

No description provided.

Always set to "word_info".

text string  (required)

Required. The text content.

type object  (required)

No description provided.

Always set to "text".

ImageContent

An image content block.

data string  (optional)

The image content.

mime_type enum (string)  (optional)

The mime type of the image.

Possible values:

  • image/png

    PNG image format

  • image/jpeg

    JPEG image format

  • image/webp

    WebP image format

  • image/heic

    HEIC image format

  • image/heif

    HEIF image format

  • image/gif

    GIF image format

  • image/bmp

    BMP image format

  • image/tiff

    TIFF image format

resolution MediaResolution  (optional)

The resolution of the media.

Possible values

  • low

    Low resolution.

  • medium

    Medium resolution.

  • high

    High resolution.

  • ultra_high

    Ultra high resolution.

type object  (required)

No description provided.

Always set to "image".

uri string  (optional)

The URI of the image.

AudioContent

An audio content block.

channels integer  (optional)

The number of audio channels.

data string  (optional)

The audio content.

mime_type enum (string)  (optional)

The mime type of the audio.

Possible values:

  • audio/wav

    WAV audio format

  • audio/mp3

    MP3 audio format

  • audio/aiff

    AIFF audio format

  • audio/aac

    AAC audio format

  • audio/ogg

    OGG audio format

  • audio/flac

    FLAC audio format

  • audio/mpeg

    MPEG audio format

  • audio/m4a

    M4A audio format

  • audio/l16

    L16 audio format

  • audio/opus

    OPUS audio format

  • audio/alaw

    ALAW audio format

  • audio/mulaw

    MULAW audio format

sample_rate integer  (optional)

The sample rate of the audio.

type object  (required)

No description provided.

Always set to "audio".

uri string  (optional)

The URI of the audio.

DocumentContent

A document content block.

data string  (optional)

The document content.

mime_type enum (string)  (optional)

The mime type of the document.

Possible values:

  • application/pdf

    PDF document format

  • text/csv

    CSV document format

type object  (required)

No description provided.

Always set to "document".

uri string  (optional)

The URI of the document.

VideoContent

A video content block.

data string  (optional)

The video content.

mime_type enum (string)  (optional)

The mime type of the video.

Possible values:

  • video/mp4

    MP4 video format

  • video/mpeg

    MPEG video format

  • video/mpg

    MPG video format

  • video/mov

    MOV video format

  • video/avi

    AVI video format

  • video/x-flv

    FLV video format

  • video/webm

    WebM video format

  • video/wmv

    WMV video format

  • video/3gpp

    3GPP video format

resolution MediaResolution  (optional)

The resolution of the media.

Possible values

  • low

    Low resolution.

  • medium

    Medium resolution.

  • high

    High resolution.

  • ultra_high

    Ultra high resolution.

type object  (required)

No description provided.

Always set to "video".

uri string  (optional)

The URI of the video.

type object  (required)

No description provided.

Always set to "user_input".

ModelOutputStep

Output generated by the model.

content Content  (optional)

No description provided.

The content of the response.

Possible Types

Polymorphic discriminator: type

TextContent

A text content block.

annotations Annotation  (optional)

Citation information for model-generated content.

Citation information for model-generated content.

Possible Types

Polymorphic discriminator: type

UrlCitation

A URL citation annotation.

end_index integer  (optional)

End of the attributed segment, exclusive.

start_index integer  (optional)

Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.

title string  (optional)

The title of the URL.

type object  (required)

No description provided.

Always set to "url_citation".

url string  (optional)

The URL.

FileCitation

A file citation annotation.

custom_metadata object  (optional)

User provided metadata about the retrieved context.

document_uri string  (optional)

The URI of the file.

end_index integer  (optional)

End of the attributed segment, exclusive.

file_name string  (optional)

The name of the file.

media_id string  (optional)

Media ID in-case of image citations, if applicable.

page_number integer  (optional)

Page number of the cited document, if applicable.

source string  (optional)

Source attributed for a portion of the text.

start_index integer  (optional)

Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.

type object  (required)

No description provided.

Always set to "file_citation".

PlaceCitation

A place citation annotation.

end_index integer  (optional)

End of the attributed segment, exclusive.

name string  (optional)

Title of the place.

place_id string  (optional)

The ID of the place, in `places/{place_id}` format.

review_snippets ReviewSnippet  (optional)

Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.

Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.

Fields

review_id string  (optional)

The ID of the review snippet.

title string  (optional)

Title of the review.

url string  (optional)

A link that corresponds to the user review on Google Maps.

start_index integer  (optional)

Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.

type object  (required)

No description provided.

Always set to "place_citation".

url string  (optional)

URI reference of the place.

WordInfo

Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution.

end_index integer  (optional)

End of the attributed segment, exclusive.

end_offset string  (optional)

End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".

speaker string  (optional)

Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.

start_index integer  (optional)

Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.

start_offset string  (optional)

Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".

text string  (optional)

The transcribed word.

type object  (required)

No description provided.

Always set to "word_info".

text string  (required)

Required. The text content.

type object  (required)

No description provided.

Always set to "text".

ImageContent

An image content block.

data string  (optional)

The image content.

mime_type enum (string)  (optional)

The mime type of the image.

Possible values:

  • image/png

    PNG image format

  • image/jpeg

    JPEG image format

  • image/webp

    WebP image format

  • image/heic

    HEIC image format

  • image/heif

    HEIF image format

  • image/gif

    GIF image format

  • image/bmp

    BMP image format

  • image/tiff

    TIFF image format

resolution MediaResolution  (optional)

The resolution of the media.

Possible values

  • low

    Low resolution.

  • medium

    Medium resolution.

  • high

    High resolution.

  • ultra_high

    Ultra high resolution.

type object  (required)

No description provided.

Always set to "image".

uri string  (optional)

The URI of the image.

AudioContent

An audio content block.

channels integer  (optional)

The number of audio channels.

data string  (optional)

The audio content.

mime_type enum (string)  (optional)

The mime type of the audio.

Possible values:

  • audio/wav

    WAV audio format

  • audio/mp3

    MP3 audio format

  • audio/aiff

    AIFF audio format

  • audio/aac

    AAC audio format

  • audio/ogg

    OGG audio format

  • audio/flac

    FLAC audio format

  • audio/mpeg

    MPEG audio format

  • audio/m4a

    M4A audio format

  • audio/l16

    L16 audio format

  • audio/opus

    OPUS audio format

  • audio/alaw

    ALAW audio format

  • audio/mulaw

    MULAW audio format

sample_rate integer  (optional)

The sample rate of the audio.

type object  (required)

No description provided.

Always set to "audio".

uri string  (optional)

The URI of the audio.

DocumentContent

A document content block.

data string  (optional)

The document content.

mime_type enum (string)  (optional)

The mime type of the document.

Possible values:

  • application/pdf

    PDF document format

  • text/csv

    CSV document format

type object  (required)

No description provided.

Always set to "document".

uri string  (optional)

The URI of the document.

VideoContent

A video content block.

data string  (optional)

The video content.

mime_type enum (string)  (optional)

The mime type of the video.

Possible values:

  • video/mp4

    MP4 video format

  • video/mpeg

    MPEG video format

  • video/mpg

    MPG video format

  • video/mov

    MOV video format

  • video/avi

    AVI video format

  • video/x-flv

    FLV video format

  • video/webm

    WebM video format

  • video/wmv

    WMV video format

  • video/3gpp

    3GPP video format

resolution MediaResolution  (optional)

The resolution of the media.

Possible values

  • low

    Low resolution.

  • medium

    Medium resolution.

  • high

    High resolution.

  • ultra_high

    Ultra high resolution.

type object  (required)

No description provided.

Always set to "video".

uri string  (optional)

The URI of the video.

error Status  (optional)

The error result of the operation in case of failure or cancellation.

The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).

Fields

code integer  (optional)

The status code, which should be an enum value of google.rpc.Code.

details array (object)  (optional)

A list of messages that carry the error details. There is a common set of message types for APIs to use.

message string  (optional)

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

type object  (required)

No description provided.

Always set to "model_output".

ThoughtStep

A thought step.

signature string  (optional)

A signature hash for backend validation.

summary ThoughtSummaryContent  (optional)

A summary of the thought.

Possible Types

Polymorphic discriminator: type

TextContent

A text content block.

annotations Annotation  (optional)

Citation information for model-generated content.

Citation information for model-generated content.

Possible Types

Polymorphic discriminator: type

UrlCitation

A URL citation annotation.

end_index integer  (optional)

End of the attributed segment, exclusive.

start_index integer  (optional)

Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.

title string  (optional)

The title of the URL.

type object  (required)

No description provided.

Always set to "url_citation".

url string  (optional)

The URL.

FileCitation

A file citation annotation.

custom_metadata object  (optional)

User provided metadata about the retrieved context.

document_uri string  (optional)

The URI of the file.

end_index integer  (optional)

End of the attributed segment, exclusive.

file_name string  (optional)

The name of the file.

media_id string  (optional)

Media ID in-case of image citations, if applicable.

page_number integer  (optional)

Page number of the cited document, if applicable.

source string  (optional)

Source attributed for a portion of the text.

start_index integer  (optional)

Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.

type object  (required)

No description provided.

Always set to "file_citation".

PlaceCitation

A place citation annotation.

end_index integer  (optional)

End of the attributed segment, exclusive.

name string  (optional)

Title of the place.

place_id string  (optional)

The ID of the place, in `places/{place_id}` format.

review_snippets ReviewSnippet  (optional)

Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.

Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.

Fields

review_id string  (optional)

The ID of the review snippet.

title string  (optional)

Title of the review.

url string  (optional)

A link that corresponds to the user review on Google Maps.

start_index integer  (optional)

Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.

type object  (required)

No description provided.

Always set to "place_citation".

url string  (optional)

URI reference of the place.

WordInfo

Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution.

end_index integer  (optional)

End of the attributed segment, exclusive.

end_offset string  (optional)

End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".

speaker string  (optional)

Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.

start_index integer  (optional)

Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.

start_offset string  (optional)

Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".

text string  (optional)

The transcribed word.

type object  (required)

No description provided.

Always set to "word_info".

text string  (required)

Required. The text content.

type object  (required)

No description provided.

Always set to "text".

ImageContent

An image content block.

data string  (optional)

The image content.

mime_type enum (string)  (optional)

The mime type of the image.

Possible values:

  • image/png

    PNG image format

  • image/jpeg

    JPEG image format

  • image/webp

    WebP image format

  • image/heic

    HEIC image format

  • image/heif

    HEIF image format

  • image/gif

    GIF image format

  • image/bmp

    BMP image format

  • image/tiff

    TIFF image format

resolution MediaResolution  (optional)

The resolution of the media.

Possible values

  • low

    Low resolution.

  • medium

    Medium resolution.

  • high

    High resolution.

  • ultra_high

    Ultra high resolution.

type object  (required)

No description provided.

Always set to "image".

uri string  (optional)

The URI of the image.

type object  (required)

No description provided.

Always set to "thought".

FunctionCallStep

A function tool call step.

arguments object  (required)

Required. The arguments to pass to the function.

id string  (required)

Required. A unique ID for this specific tool call.

name string  (required)

Required. The name of the tool to call.

type object  (required)

No description provided.

Always set to "function_call".

CodeExecutionCallStep

Code execution call step.

arguments CodeExecutionCallStepArguments  (required)

Required. The arguments to pass to the code execution.

The arguments to pass to the code execution.

Fields

code string  (optional)

The code to be executed.

language enum (string)  (optional)

Programming language of the `code`.

Possible values:

  • python

    Python >= 3.10, with numpy and simpy available.

id string  (required)

Required. A unique ID for this specific tool call.

signature string  (optional)

A signature hash for backend validation.

type object  (required)

No description provided.

Always set to "code_execution_call".

UrlContextCallStep

URL context call step.

arguments UrlContextCallArguments  (required)

Required. The arguments to pass to the URL context.

The arguments to pass to the URL context.

Fields

urls array (string)  (optional)

The URLs to fetch.

id string  (required)

Required. A unique ID for this specific tool call.

signature string  (optional)

A signature hash for backend validation.

type object  (required)

No description provided.

Always set to "url_context_call".

McpServerToolCallStep

MCPServer tool call step.

arguments object  (required)

Required. The JSON object of arguments for the function.

id string  (required)

Required. A unique ID for this specific tool call.

name string  (required)

Required. The name of the tool which was called.

server_name string  (required)

Required. The name of the used MCP server.

type object  (required)

No description provided.

Always set to "mcp_server_tool_call".

GoogleSearchCallStep

Google Search call step.

arguments GoogleSearchCallStepArguments  (required)

Required. The arguments to pass to Google Search.

The arguments to pass to Google Search.

Fields

queries array (string)  (optional)

Web search queries for the following-up web search.

id string  (required)

Required. A unique ID for this specific tool call.

search_type enum (string)  (optional)

The type of search grounding enabled.

Possible values:

  • web_search

    Setting this field enables web search. Only text results are returned.

  • image_search

    Setting this field enables image search. Image bytes are returned.

  • enterprise_web_search

    Setting this field enables enterprise web search.

signature string  (optional)

A signature hash for backend validation.

type object  (required)

No description provided.

Always set to "google_search_call".

FileSearchCallStep

File Search call step.

id string  (required)

Required. A unique ID for this specific tool call.

signature string  (optional)

A signature hash for backend validation.

type object  (required)

No description provided.

Always set to "file_search_call".

GoogleMapsCallStep

Google Maps call step.

arguments GoogleMapsCallStepArguments  (optional)

The arguments to pass to the Google Maps tool.

The arguments to pass to the Google Maps tool.

Fields

queries array (string)  (optional)

The queries to be executed.

id string  (required)

Required. A unique ID for this specific tool call.

signature string  (optional)

A signature hash for backend validation.

type object  (required)

No description provided.

Always set to "google_maps_call".

FunctionResultStep

Result of a function tool call.

call_id string  (required)

Required. ID to match the ID from the function call block.

is_error boolean  (optional)

Whether the tool call resulted in an error.

name string  (optional)

The name of the tool that was called.

result array (ImageContent or TextContent) or object or string  (required)

Required. The result of the tool call.

type object  (required)

No description provided.

Always set to "function_result".

CodeExecutionResultStep

Code execution result step.

call_id string  (required)

Required. ID to match the ID from the function call block.

is_error boolean  (optional)

Whether the code execution resulted in an error.

result string  (required)

Required. The output of the code execution.

signature string  (optional)

A signature hash for backend validation.

type object  (required)

No description provided.

Always set to "code_execution_result".

UrlContextResultStep

URL context result step.

call_id string  (required)

Required. ID to match the ID from the function call block.

is_error boolean  (optional)

Whether the URL context resulted in an error.

result UrlContextResult  (required)

Required. The results of the URL context.

The result of the URL context.

Fields

status enum (string)  (optional)

The status of the URL retrieval.

Possible values:

  • success

    Url retrieval is successful.

  • error

    Url retrieval is failed due to error.

  • paywall

    Url retrieval is failed because the content is behind paywall.

  • unsafe

    Url retrieval is failed because the content is unsafe.

url string  (optional)

The URL that was fetched.

signature string  (optional)

A signature hash for backend validation.

type object  (required)

No description provided.

Always set to "url_context_result".

GoogleSearchResultStep

Google Search result step.

call_id string  (required)

Required. ID to match the ID from the function call block.

is_error boolean  (optional)

Whether the Google Search resulted in an error.

result GoogleSearchResultItem  (required)

Required. The results of the Google Search.

The result of the Google Search.

Fields

search_suggestions string  (optional)

Web content snippet that can be embedded in a web page or an app webview.

signature string  (optional)

A signature hash for backend validation.

type object  (required)

No description provided.

Always set to "google_search_result".

McpServerToolResultStep

MCPServer tool result step.

call_id string  (required)

Required. ID to match the ID from the function call block.

name string  (optional)

Name of the tool which is called for this specific tool call.

result array (ImageContent or TextContent) or object or string  (required)

Required. The output from the MCP server call. Can be simple text or rich content.

server_name string  (optional)

The name of the used MCP server.

type object  (required)

No description provided.

Always set to "mcp_server_tool_result".

FileSearchResultStep

File Search result step.

call_id string  (required)

Required. ID to match the ID from the function call block.

signature string  (optional)

A signature hash for backend validation.

type object  (required)

No description provided.

Always set to "file_search_result".

GoogleMapsResultStep

Google Maps result step.

call_id string  (required)

Required. ID to match the ID from the function call block.

result GoogleMapsResultItem  (required)

No description provided.

The result of the Google Maps.

Fields

places GoogleMapsResultPlaces  (optional)

No description provided.

Fields

name string  (optional)

No description provided.

place_id string  (optional)

No description provided.

review_snippets ReviewSnippet  (optional)

No description provided.

Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.

Fields

review_id string  (optional)

The ID of the review snippet.

title string  (optional)

Title of the review.

url string  (optional)

A link that corresponds to the user review on Google Maps.

url string  (optional)

No description provided.

widget_context_token string  (optional)

No description provided.

signature string  (optional)

A signature hash for backend validation.

type object  (required)

No description provided.

Always set to "google_maps_result".

updated string  (optional)

Output only. The time at which the response was last updated in ISO 8601 format.

usage Usage  (optional)

Output only. Statistics on the interaction request's token usage.

Statistics on the interaction request's token usage.

Fields

cached_tokens_by_modality ModalityTokens  (optional)

A breakdown of cached token usage by modality.

The token count for a single response modality.

Fields

modality ResponseModality  (optional)

The modality associated with the token count.

Possible values

  • text

    Indicates the model should return text.

  • image

    Indicates the model should return images.

  • audio

    Indicates the model should return audio.

  • video

    Indicates the model should return video.

  • document

    Indicates the model should return documents.

tokens integer  (optional)

Number of tokens for the modality.

grounding_tool_count GroundingToolCount  (optional)

Grounding tool count.

The number of grounding tool counts.

Fields

count integer  (optional)

The number of grounding tool counts.

type enum (string)  (optional)

The grounding tool type associated with the count.

Possible values:

  • google_search

    Grounding with Google Web Search and Image Search, & Web Grounding for Enterprise.

  • google_maps

    Grounding with Google Maps.

  • retrieval

    Grounding with customer's data, for example, VertexAISearch.

input_tokens_by_modality ModalityTokens  (optional)

A breakdown of input token usage by modality.

The token count for a single response modality.

Fields

modality ResponseModality  (optional)

The modality associated with the token count.

Possible values

  • text

    Indicates the model should return text.

  • image

    Indicates the model should return images.

  • audio

    Indicates the model should return audio.

  • video

    Indicates the model should return video.

  • document

    Indicates the model should return documents.

tokens integer  (optional)

Number of tokens for the modality.

output_tokens_by_modality ModalityTokens  (optional)

A breakdown of output token usage by modality.

The token count for a single response modality.

Fields

modality ResponseModality  (optional)

The modality associated with the token count.

Possible values

  • text

    Indicates the model should return text.

  • image

    Indicates the model should return images.

  • audio

    Indicates the model should return audio.

  • video

    Indicates the model should return video.

  • document

    Indicates the model should return documents.

tokens integer  (optional)

Number of tokens for the modality.

tool_use_tokens_by_modality ModalityTokens  (optional)

A breakdown of tool-use token usage by modality.

The token count for a single response modality.

Fields

modality ResponseModality  (optional)

The modality associated with the token count.

Possible values

  • text

    Indicates the model should return text.

  • image

    Indicates the model should return images.

  • audio

    Indicates the model should return audio.

  • video

    Indicates the model should return video.

  • document

    Indicates the model should return documents.

tokens integer  (optional)

Number of tokens for the modality.

total_cached_tokens integer  (optional)

Number of tokens in the cached part of the prompt (the cached content).

total_input_tokens integer  (optional)

Number of tokens in the prompt (context).

total_output_tokens integer  (optional)

Total number of tokens across all the generated responses.

total_thought_tokens integer  (optional)

Number of tokens of thoughts for thinking models.

total_tokens integer  (optional)

Total token count for the interaction request (prompt + responses + other internal tokens).

total_tool_use_tokens integer  (optional)

Number of tokens present in tool-use prompt(s).

metadata StreamMetadata  (optional)

Optional metadata accompanying ANY streamed event.

Fields

total_usage Usage  (optional)

No description provided.

Statistics on the interaction request's token usage.

Fields

cached_tokens_by_modality ModalityTokens  (optional)

A breakdown of cached token usage by modality.

The token count for a single response modality.

Fields

modality ResponseModality  (optional)

The modality associated with the token count.

Possible values

  • text

    Indicates the model should return text.

  • image

    Indicates the model should return images.

  • audio

    Indicates the model should return audio.

  • video

    Indicates the model should return video.

  • document

    Indicates the model should return documents.

tokens integer  (optional)

Number of tokens for the modality.

grounding_tool_count GroundingToolCount  (optional)

Grounding tool count.

The number of grounding tool counts.

Fields

count integer  (optional)

The number of grounding tool counts.

type enum (string)  (optional)

The grounding tool type associated with the count.

Possible values:

  • google_search

    Grounding with Google Web Search and Image Search, & Web Grounding for Enterprise.

  • google_maps

    Grounding with Google Maps.

  • retrieval

    Grounding with customer's data, for example, VertexAISearch.

input_tokens_by_modality ModalityTokens  (optional)

A breakdown of input token usage by modality.

The token count for a single response modality.

Fields

modality ResponseModality  (optional)

The modality associated with the token count.

Possible values

  • text

    Indicates the model should return text.

  • image

    Indicates the model should return images.

  • audio

    Indicates the model should return audio.

  • video

    Indicates the model should return video.

  • document

    Indicates the model should return documents.

tokens integer  (optional)

Number of tokens for the modality.

output_tokens_by_modality ModalityTokens  (optional)

A breakdown of output token usage by modality.

The token count for a single response modality.

Fields

modality ResponseModality  (optional)

The modality associated with the token count.

Possible values

  • text

    Indicates the model should return text.

  • image

    Indicates the model should return images.

  • audio

    Indicates the model should return audio.

  • video

    Indicates the model should return video.

  • document

    Indicates the model should return documents.

tokens integer  (optional)

Number of tokens for the modality.

tool_use_tokens_by_modality ModalityTokens  (optional)

A breakdown of tool-use token usage by modality.

The token count for a single response modality.

Fields

modality ResponseModality  (optional)

The modality associated with the token count.

Possible values

  • text

    Indicates the model should return text.

  • image

    Indicates the model should return images.

  • audio

    Indicates the model should return audio.

  • video

    Indicates the model should return video.

  • document

    Indicates the model should return documents.

tokens integer  (optional)

Number of tokens for the modality.

total_cached_tokens integer  (optional)

Number of tokens in the cached part of the prompt (the cached content).

total_input_tokens integer  (optional)

Number of tokens in the prompt (context).

total_output_tokens integer  (optional)

Total number of tokens across all the generated responses.

total_thought_tokens integer  (optional)

Number of tokens of thoughts for thinking models.

total_tokens integer  (optional)

Total token count for the interaction request (prompt + responses + other internal tokens).

total_tool_use_tokens integer  (optional)

Number of tokens present in tool-use prompt(s).

InteractionStatusUpdate

event_id string  (optional)

The event_id token to be used to resume the interaction stream, from this event.

event_type object  (required)

No description provided.

Always set to "interaction.status_update".

interaction_id string  (required)

No description provided.

metadata StreamMetadata  (optional)

Optional metadata accompanying ANY streamed event.

Fields

total_usage Usage  (optional)

No description provided.

Statistics on the interaction request's token usage.

Fields

cached_tokens_by_modality ModalityTokens  (optional)

A breakdown of cached token usage by modality.

The token count for a single response modality.

Fields

modality ResponseModality  (optional)

The modality associated with the token count.

Possible values

  • text

    Indicates the model should return text.

  • image

    Indicates the model should return images.

  • audio

    Indicates the model should return audio.

  • video

    Indicates the model should return video.

  • document

    Indicates the model should return documents.

tokens integer  (optional)

Number of tokens for the modality.

grounding_tool_count GroundingToolCount  (optional)

Grounding tool count.

The number of grounding tool counts.

Fields

count integer  (optional)

The number of grounding tool counts.

type enum (string)  (optional)

The grounding tool type associated with the count.

Possible values:

  • google_search

    Grounding with Google Web Search and Image Search, & Web Grounding for Enterprise.

  • google_maps

    Grounding with Google Maps.

  • retrieval

    Grounding with customer's data, for example, VertexAISearch.

input_tokens_by_modality ModalityTokens  (optional)

A breakdown of input token usage by modality.

The token count for a single response modality.

Fields

modality ResponseModality  (optional)

The modality associated with the token count.

Possible values

  • text

    Indicates the model should return text.

  • image

    Indicates the model should return images.

  • audio

    Indicates the model should return audio.

  • video

    Indicates the model should return video.

  • document

    Indicates the model should return documents.

tokens integer  (optional)

Number of tokens for the modality.

output_tokens_by_modality ModalityTokens  (optional)

A breakdown of output token usage by modality.

The token count for a single response modality.

Fields

modality ResponseModality  (optional)

The modality associated with the token count.

Possible values

  • text

    Indicates the model should return text.

  • image

    Indicates the model should return images.

  • audio

    Indicates the model should return audio.

  • video

    Indicates the model should return video.

  • document

    Indicates the model should return documents.

tokens integer  (optional)

Number of tokens for the modality.

tool_use_tokens_by_modality ModalityTokens  (optional)

A breakdown of tool-use token usage by modality.

The token count for a single response modality.

Fields

modality ResponseModality  (optional)

The modality associated with the token count.

Possible values

  • text

    Indicates the model should return text.

  • image

    Indicates the model should return images.

  • audio

    Indicates the model should return audio.

  • video

    Indicates the model should return video.

  • document

    Indicates the model should return documents.

tokens integer  (optional)

Number of tokens for the modality.

total_cached_tokens integer  (optional)

Number of tokens in the cached part of the prompt (the cached content).

total_input_tokens integer  (optional)

Number of tokens in the prompt (context).

total_output_tokens integer  (optional)

Total number of tokens across all the generated responses.

total_thought_tokens integer  (optional)

Number of tokens of thoughts for thinking models.

total_tokens integer  (optional)

Total token count for the interaction request (prompt + responses + other internal tokens).

total_tool_use_tokens integer  (optional)

Number of tokens present in tool-use prompt(s).

status enum (string)  (required)

No description provided.

Possible values:

  • in_progress

    The interaction is in progress.

  • requires_action

    The interaction requires action/input from the user.

  • completed

    The interaction is completed.

  • failed

    The interaction failed.

  • cancelled

    The interaction was cancelled.

  • incomplete

    The interaction is completed, but contains incomplete results (e.g. hitting max_tokens).

  • budget_exceeded

    The interaction was halted because the token budget was exceeded.

  • queued

    The interaction is queued, waiting for processing (e.g. waiting for off-peak capacity).

ErrorEvent

error Error  (optional)

No description provided.

Error message from an interaction.

Fields

code string  (optional)

A URI that identifies the error type.

message string  (optional)

A human-readable error message.

event_id string  (optional)

The event_id token to be used to resume the interaction stream, from this event.

event_type object  (required)

No description provided.

Always set to "error".

metadata StreamMetadata  (optional)

Optional metadata accompanying ANY streamed event.

Fields

total_usage Usage  (optional)

No description provided.

Statistics on the interaction request's token usage.

Fields

cached_tokens_by_modality ModalityTokens  (optional)

A breakdown of cached token usage by modality.

The token count for a single response modality.

Fields

modality ResponseModality  (optional)

The modality associated with the token count.

Possible values

  • text

    Indicates the model should return text.

  • image

    Indicates the model should return images.

  • audio

    Indicates the model should return audio.

  • video

    Indicates the model should return video.

  • document

    Indicates the model should return documents.

tokens integer  (optional)

Number of tokens for the modality.

grounding_tool_count GroundingToolCount  (optional)

Grounding tool count.

The number of grounding tool counts.

Fields

count integer  (optional)

The number of grounding tool counts.

type enum (string)  (optional)

The grounding tool type associated with the count.

Possible values:

  • google_search

    Grounding with Google Web Search and Image Search, & Web Grounding for Enterprise.

  • google_maps

    Grounding with Google Maps.

  • retrieval

    Grounding with customer's data, for example, VertexAISearch.

input_tokens_by_modality ModalityTokens  (optional)

A breakdown of input token usage by modality.

The token count for a single response modality.

Fields

modality ResponseModality  (optional)

The modality associated with the token count.

Possible values

  • text

    Indicates the model should return text.

  • image

    Indicates the model should return images.

  • audio

    Indicates the model should return audio.

  • video

    Indicates the model should return video.

  • document

    Indicates the model should return documents.

tokens integer  (optional)

Number of tokens for the modality.

output_tokens_by_modality ModalityTokens  (optional)

A breakdown of output token usage by modality.

The token count for a single response modality.

Fields

modality ResponseModality  (optional)

The modality associated with the token count.

Possible values

  • text

    Indicates the model should return text.

  • image

    Indicates the model should return images.

  • audio

    Indicates the model should return audio.

  • video

    Indicates the model should return video.

  • document

    Indicates the model should return documents.

tokens integer  (optional)

Number of tokens for the modality.

tool_use_tokens_by_modality ModalityTokens  (optional)

A breakdown of tool-use token usage by modality.

The token count for a single response modality.

Fields

modality ResponseModality  (optional)

The modality associated with the token count.

Possible values

  • text

    Indicates the model should return text.

  • image

    Indicates the model should return images.

  • audio

    Indicates the model should return audio.

  • video

    Indicates the model should return video.

  • document

    Indicates the model should return documents.

tokens integer  (optional)

Number of tokens for the modality.

total_cached_tokens integer  (optional)

Number of tokens in the cached part of the prompt (the cached content).

total_input_tokens integer  (optional)

Number of tokens in the prompt (context).

total_output_tokens integer  (optional)

Total number of tokens across all the generated responses.

total_thought_tokens integer  (optional)

Number of tokens of thoughts for thinking models.

total_tokens integer  (optional)

Total token count for the interaction request (prompt + responses + other internal tokens).

total_tool_use_tokens integer  (optional)

Number of tokens present in tool-use prompt(s).

StepStart

event_id string  (optional)

The event_id token to be used to resume the interaction stream, from this event.

event_type object  (required)

No description provided.

Always set to "step.start".

index integer  (required)

No description provided.

metadata StreamMetadata  (optional)

Optional metadata accompanying ANY streamed event.

Fields

total_usage Usage  (optional)

No description provided.

Statistics on the interaction request's token usage.

Fields

cached_tokens_by_modality ModalityTokens  (optional)

A breakdown of cached token usage by modality.

The token count for a single response modality.

Fields

modality ResponseModality  (optional)

The modality associated with the token count.

Possible values

  • text

    Indicates the model should return text.

  • image

    Indicates the model should return images.

  • audio

    Indicates the model should return audio.

  • video

    Indicates the model should return video.

  • document

    Indicates the model should return documents.

tokens integer  (optional)

Number of tokens for the modality.

grounding_tool_count GroundingToolCount  (optional)

Grounding tool count.

The number of grounding tool counts.

Fields

count integer  (optional)

The number of grounding tool counts.

type enum (string)  (optional)

The grounding tool type associated with the count.

Possible values:

  • google_search

    Grounding with Google Web Search and Image Search, & Web Grounding for Enterprise.

  • google_maps

    Grounding with Google Maps.

  • retrieval

    Grounding with customer's data, for example, VertexAISearch.

input_tokens_by_modality ModalityTokens  (optional)

A breakdown of input token usage by modality.

The token count for a single response modality.

Fields

modality ResponseModality  (optional)

The modality associated with the token count.

Possible values

  • text

    Indicates the model should return text.

  • image

    Indicates the model should return images.

  • audio

    Indicates the model should return audio.

  • video

    Indicates the model should return video.

  • document

    Indicates the model should return documents.

tokens integer  (optional)

Number of tokens for the modality.

output_tokens_by_modality ModalityTokens  (optional)

A breakdown of output token usage by modality.

The token count for a single response modality.

Fields

modality ResponseModality  (optional)

The modality associated with the token count.

Possible values

  • text

    Indicates the model should return text.

  • image

    Indicates the model should return images.

  • audio

    Indicates the model should return audio.

  • video

    Indicates the model should return video.

  • document

    Indicates the model should return documents.

tokens integer  (optional)

Number of tokens for the modality.

tool_use_tokens_by_modality ModalityTokens  (optional)

A breakdown of tool-use token usage by modality.

The token count for a single response modality.

Fields

modality ResponseModality  (optional)

The modality associated with the token count.

Possible values

  • text

    Indicates the model should return text.

  • image

    Indicates the model should return images.

  • audio

    Indicates the model should return audio.

  • video

    Indicates the model should return video.

  • document

    Indicates the model should return documents.

tokens integer  (optional)

Number of tokens for the modality.

total_cached_tokens integer  (optional)

Number of tokens in the cached part of the prompt (the cached content).

total_input_tokens integer  (optional)

Number of tokens in the prompt (context).

total_output_tokens integer  (optional)

Total number of tokens across all the generated responses.

total_thought_tokens integer  (optional)

Number of tokens of thoughts for thinking models.

total_tokens integer  (optional)

Total token count for the interaction request (prompt + responses + other internal tokens).

total_tool_use_tokens integer  (optional)

Number of tokens present in tool-use prompt(s).

step Step  (required)

No description provided.

A step in the interaction.

Possible Types

Polymorphic discriminator: type

UserInputStep

Input provided by the user.

content Content  (optional)

No description provided.

The content of the response.

Possible Types

Polymorphic discriminator: type

TextContent

A text content block.

annotations Annotation  (optional)

Citation information for model-generated content.

Citation information for model-generated content.

Possible Types

Polymorphic discriminator: type

UrlCitation

A URL citation annotation.

end_index integer  (optional)

End of the attributed segment, exclusive.

start_index integer  (optional)

Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.

title string  (optional)

The title of the URL.

type object  (required)

No description provided.

Always set to "url_citation".

url string  (optional)

The URL.

FileCitation

A file citation annotation.

custom_metadata object  (optional)

User provided metadata about the retrieved context.

document_uri string  (optional)

The URI of the file.

end_index integer  (optional)

End of the attributed segment, exclusive.

file_name string  (optional)

The name of the file.

media_id string  (optional)

Media ID in-case of image citations, if applicable.

page_number integer  (optional)

Page number of the cited document, if applicable.

source string  (optional)

Source attributed for a portion of the text.

start_index integer  (optional)

Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.

type object  (required)

No description provided.

Always set to "file_citation".

PlaceCitation

A place citation annotation.

end_index integer  (optional)

End of the attributed segment, exclusive.

name string  (optional)

Title of the place.

place_id string  (optional)

The ID of the place, in `places/{place_id}` format.

review_snippets ReviewSnippet  (optional)

Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.

Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.

Fields

review_id string  (optional)

The ID of the review snippet.

title string  (optional)

Title of the review.

url string  (optional)

A link that corresponds to the user review on Google Maps.

start_index integer  (optional)

Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.

type object  (required)

No description provided.

Always set to "place_citation".

url string  (optional)

URI reference of the place.

WordInfo

Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution.

end_index integer  (optional)

End of the attributed segment, exclusive.

end_offset string  (optional)

End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".

speaker string  (optional)

Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.

start_index integer  (optional)

Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.

start_offset string  (optional)

Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".

text string  (optional)

The transcribed word.

type object  (required)

No description provided.

Always set to "word_info".

text string  (required)

Required. The text content.

type object  (required)

No description provided.

Always set to "text".

ImageContent

An image content block.

data string  (optional)

The image content.

mime_type enum (string)  (optional)

The mime type of the image.

Possible values:

  • image/png

    PNG image format

  • image/jpeg

    JPEG image format

  • image/webp

    WebP image format

  • image/heic

    HEIC image format

  • image/heif

    HEIF image format

  • image/gif

    GIF image format

  • image/bmp

    BMP image format

  • image/tiff

    TIFF image format

resolution MediaResolution  (optional)

The resolution of the media.

Possible values

  • low

    Low resolution.

  • medium

    Medium resolution.

  • high

    High resolution.

  • ultra_high

    Ultra high resolution.

type object  (required)

No description provided.

Always set to "image".

uri string  (optional)

The URI of the image.

AudioContent

An audio content block.

channels integer  (optional)

The number of audio channels.

data string  (optional)

The audio content.

mime_type enum (string)  (optional)

The mime type of the audio.

Possible values:

  • audio/wav

    WAV audio format

  • audio/mp3

    MP3 audio format

  • audio/aiff

    AIFF audio format

  • audio/aac

    AAC audio format

  • audio/ogg

    OGG audio format

  • audio/flac

    FLAC audio format

  • audio/mpeg

    MPEG audio format

  • audio/m4a

    M4A audio format

  • audio/l16

    L16 audio format

  • audio/opus

    OPUS audio format

  • audio/alaw

    ALAW audio format

  • audio/mulaw

    MULAW audio format

sample_rate integer  (optional)

The sample rate of the audio.

type object  (required)

No description provided.

Always set to "audio".

uri string  (optional)

The URI of the audio.

DocumentContent

A document content block.

data string  (optional)

The document content.

mime_type enum (string)  (optional)

The mime type of the document.

Possible values:

  • application/pdf

    PDF document format

  • text/csv

    CSV document format

type object  (required)

No description provided.

Always set to "document".

uri string  (optional)

The URI of the document.

VideoContent

A video content block.

data string  (optional)

The video content.

mime_type enum (string)  (optional)

The mime type of the video.

Possible values:

  • video/mp4

    MP4 video format

  • video/mpeg

    MPEG video format

  • video/mpg

    MPG video format

  • video/mov

    MOV video format

  • video/avi

    AVI video format

  • video/x-flv

    FLV video format

  • video/webm

    WebM video format

  • video/wmv

    WMV video format

  • video/3gpp

    3GPP video format

resolution MediaResolution  (optional)

The resolution of the media.

Possible values

  • low

    Low resolution.

  • medium

    Medium resolution.

  • high

    High resolution.

  • ultra_high

    Ultra high resolution.

type object  (required)

No description provided.

Always set to "video".

uri string  (optional)

The URI of the video.

type object  (required)

No description provided.

Always set to "user_input".

ModelOutputStep

Output generated by the model.

content Content  (optional)

No description provided.

The content of the response.

Possible Types

Polymorphic discriminator: type

TextContent

A text content block.

annotations Annotation  (optional)

Citation information for model-generated content.

Citation information for model-generated content.

Possible Types

Polymorphic discriminator: type

UrlCitation

A URL citation annotation.

end_index integer  (optional)

End of the attributed segment, exclusive.

start_index integer  (optional)

Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.

title string  (optional)

The title of the URL.

type object  (required)

No description provided.

Always set to "url_citation".

url string  (optional)

The URL.

FileCitation

A file citation annotation.

custom_metadata object  (optional)

User provided metadata about the retrieved context.

document_uri string  (optional)

The URI of the file.

end_index integer  (optional)

End of the attributed segment, exclusive.

file_name string  (optional)

The name of the file.

media_id string  (optional)

Media ID in-case of image citations, if applicable.

page_number integer  (optional)

Page number of the cited document, if applicable.

source string  (optional)

Source attributed for a portion of the text.

start_index integer  (optional)

Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.

type object  (required)

No description provided.

Always set to "file_citation".

PlaceCitation

A place citation annotation.

end_index integer  (optional)

End of the attributed segment, exclusive.

name string  (optional)

Title of the place.

place_id string  (optional)

The ID of the place, in `places/{place_id}` format.

review_snippets ReviewSnippet  (optional)

Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.

Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.

Fields

review_id string  (optional)

The ID of the review snippet.

title string  (optional)

Title of the review.

url string  (optional)

A link that corresponds to the user review on Google Maps.

start_index integer  (optional)

Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.

type object  (required)

No description provided.

Always set to "place_citation".

url string  (optional)

URI reference of the place.

WordInfo

Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution.

end_index integer  (optional)

End of the attributed segment, exclusive.

end_offset string  (optional)

End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".

speaker string  (optional)

Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.

start_index integer  (optional)

Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.

start_offset string  (optional)

Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".

text string  (optional)

The transcribed word.

type object  (required)

No description provided.

Always set to "word_info".

text string  (required)

Required. The text content.

type object  (required)

No description provided.

Always set to "text".

ImageContent

An image content block.

data string  (optional)

The image content.

mime_type enum (string)  (optional)

The mime type of the image.

Possible values:

  • image/png

    PNG image format

  • image/jpeg

    JPEG image format

  • image/webp

    WebP image format

  • image/heic

    HEIC image format

  • image/heif

    HEIF image format

  • image/gif

    GIF image format

  • image/bmp

    BMP image format

  • image/tiff

    TIFF image format

resolution MediaResolution  (optional)

The resolution of the media.

Possible values

  • low

    Low resolution.

  • medium

    Medium resolution.

  • high

    High resolution.

  • ultra_high

    Ultra high resolution.

type object  (required)

No description provided.

Always set to "image".

uri string  (optional)

The URI of the image.

AudioContent

An audio content block.

channels integer  (optional)

The number of audio channels.

data string  (optional)

The audio content.

mime_type enum (string)  (optional)

The mime type of the audio.

Possible values:

  • audio/wav

    WAV audio format

  • audio/mp3

    MP3 audio format

  • audio/aiff

    AIFF audio format

  • audio/aac

    AAC audio format

  • audio/ogg

    OGG audio format

  • audio/flac

    FLAC audio format

  • audio/mpeg

    MPEG audio format

  • audio/m4a

    M4A audio format

  • audio/l16

    L16 audio format

  • audio/opus

    OPUS audio format

  • audio/alaw

    ALAW audio format

  • audio/mulaw

    MULAW audio format

sample_rate integer  (optional)

The sample rate of the audio.

type object  (required)

No description provided.

Always set to "audio".

uri string  (optional)

The URI of the audio.

DocumentContent

A document content block.

data string  (optional)

The document content.

mime_type enum (string)  (optional)

The mime type of the document.

Possible values:

  • application/pdf

    PDF document format

  • text/csv

    CSV document format

type object  (required)

No description provided.

Always set to "document".

uri string  (optional)

The URI of the document.

VideoContent

A video content block.

data string  (optional)

The video content.

mime_type enum (string)  (optional)

The mime type of the video.

Possible values:

  • video/mp4

    MP4 video format

  • video/mpeg

    MPEG video format

  • video/mpg

    MPG video format

  • video/mov

    MOV video format

  • video/avi

    AVI video format

  • video/x-flv

    FLV video format

  • video/webm

    WebM video format

  • video/wmv

    WMV video format

  • video/3gpp

    3GPP video format

resolution MediaResolution  (optional)

The resolution of the media.

Possible values

  • low

    Low resolution.

  • medium

    Medium resolution.

  • high

    High resolution.

  • ultra_high

    Ultra high resolution.

type object  (required)

No description provided.

Always set to "video".

uri string  (optional)

The URI of the video.

error Status  (optional)

The error result of the operation in case of failure or cancellation.

The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).

Fields

code integer  (optional)

The status code, which should be an enum value of google.rpc.Code.

details array (object)  (optional)

A list of messages that carry the error details. There is a common set of message types for APIs to use.

message string  (optional)

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

type object  (required)

No description provided.

Always set to "model_output".

ThoughtStep

A thought step.

signature string  (optional)

A signature hash for backend validation.

summary ThoughtSummaryContent  (optional)

A summary of the thought.

Possible Types

Polymorphic discriminator: type

TextContent

A text content block.

annotations Annotation  (optional)

Citation information for model-generated content.

Citation information for model-generated content.

Possible Types

Polymorphic discriminator: type

UrlCitation

A URL citation annotation.

end_index integer  (optional)

End of the attributed segment, exclusive.

start_index integer  (optional)

Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.

title string  (optional)

The title of the URL.

type object  (required)

No description provided.

Always set to "url_citation".

url string  (optional)

The URL.

FileCitation

A file citation annotation.

custom_metadata object  (optional)

User provided metadata about the retrieved context.

document_uri string  (optional)

The URI of the file.

end_index integer  (optional)

End of the attributed segment, exclusive.

file_name string  (optional)

The name of the file.

media_id string  (optional)

Media ID in-case of image citations, if applicable.

page_number integer  (optional)

Page number of the cited document, if applicable.

source string  (optional)

Source attributed for a portion of the text.

start_index integer  (optional)

Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.

type object  (required)

No description provided.

Always set to "file_citation".

PlaceCitation

A place citation annotation.

end_index integer  (optional)

End of the attributed segment, exclusive.

name string  (optional)

Title of the place.

place_id string  (optional)

The ID of the place, in `places/{place_id}` format.

review_snippets ReviewSnippet  (optional)

Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.

Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.

Fields

review_id string  (optional)

The ID of the review snippet.

title string  (optional)

Title of the review.

url string  (optional)

A link that corresponds to the user review on Google Maps.

start_index integer  (optional)

Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.

type object  (required)

No description provided.

Always set to "place_citation".

url string  (optional)

URI reference of the place.

WordInfo

Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution.

end_index integer  (optional)

End of the attributed segment, exclusive.

end_offset string  (optional)

End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".

speaker string  (optional)

Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.

start_index integer  (optional)

Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.

start_offset string  (optional)

Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".

text string  (optional)

The transcribed word.

type object  (required)

No description provided.

Always set to "word_info".

text string  (required)

Required. The text content.

type object  (required)

No description provided.

Always set to "text".

ImageContent

An image content block.

data string  (optional)

The image content.

mime_type enum (string)  (optional)

The mime type of the image.

Possible values:

  • image/png

    PNG image format

  • image/jpeg

    JPEG image format

  • image/webp

    WebP image format

  • image/heic

    HEIC image format

  • image/heif

    HEIF image format

  • image/gif

    GIF image format

  • image/bmp

    BMP image format

  • image/tiff

    TIFF image format

resolution MediaResolution  (optional)

The resolution of the media.

Possible values

  • low

    Low resolution.

  • medium

    Medium resolution.

  • high

    High resolution.

  • ultra_high

    Ultra high resolution.

type object  (required)

No description provided.

Always set to "image".

uri string  (optional)

The URI of the image.

type object  (required)

No description provided.

Always set to "thought".

FunctionCallStep

A function tool call step.

arguments object  (required)

Required. The arguments to pass to the function.

id string  (required)

Required. A unique ID for this specific tool call.

name string  (required)

Required. The name of the tool to call.

type object  (required)

No description provided.

Always set to "function_call".

CodeExecutionCallStep

Code execution call step.

arguments CodeExecutionCallStepArguments  (required)

Required. The arguments to pass to the code execution.

The arguments to pass to the code execution.

Fields

code string  (optional)

The code to be executed.

language enum (string)  (optional)

Programming language of the `code`.

Possible values:

  • python

    Python >= 3.10, with numpy and simpy available.

id string  (required)

Required. A unique ID for this specific tool call.

signature string  (optional)

A signature hash for backend validation.

type object  (required)

No description provided.

Always set to "code_execution_call".

UrlContextCallStep

URL context call step.

arguments UrlContextCallArguments  (required)

Required. The arguments to pass to the URL context.

The arguments to pass to the URL context.

Fields

urls array (string)  (optional)

The URLs to fetch.

id string  (required)

Required. A unique ID for this specific tool call.

signature string  (optional)

A signature hash for backend validation.

type object  (required)

No description provided.

Always set to "url_context_call".

McpServerToolCallStep

MCPServer tool call step.

arguments object  (required)

Required. The JSON object of arguments for the function.

id string  (required)

Required. A unique ID for this specific tool call.

name string  (required)

Required. The name of the tool which was called.

server_name string  (required)

Required. The name of the used MCP server.

type object  (required)

No description provided.

Always set to "mcp_server_tool_call".

GoogleSearchCallStep

Google Search call step.

arguments GoogleSearchCallStepArguments  (required)

Required. The arguments to pass to Google Search.

The arguments to pass to Google Search.

Fields

queries array (string)  (optional)

Web search queries for the following-up web search.

id string  (required)

Required. A unique ID for this specific tool call.

search_type enum (string)  (optional)

The type of search grounding enabled.

Possible values:

  • web_search

    Setting this field enables web search. Only text results are returned.

  • image_search

    Setting this field enables image search. Image bytes are returned.

  • enterprise_web_search

    Setting this field enables enterprise web search.

signature string  (optional)

A signature hash for backend validation.

type object  (required)

No description provided.

Always set to "google_search_call".

FileSearchCallStep

File Search call step.

id string  (required)

Required. A unique ID for this specific tool call.

signature string  (optional)

A signature hash for backend validation.

type object  (required)

No description provided.

Always set to "file_search_call".

GoogleMapsCallStep

Google Maps call step.

arguments GoogleMapsCallStepArguments  (optional)

The arguments to pass to the Google Maps tool.

The arguments to pass to the Google Maps tool.

Fields

queries array (string)  (optional)

The queries to be executed.

id string  (required)

Required. A unique ID for this specific tool call.

signature string  (optional)

A signature hash for backend validation.

type object  (required)

No description provided.

Always set to "google_maps_call".

FunctionResultStep

Result of a function tool call.

call_id string  (required)

Required. ID to match the ID from the function call block.

is_error boolean  (optional)

Whether the tool call resulted in an error.

name string  (optional)

The name of the tool that was called.

result array (ImageContent or TextContent) or object or string  (required)

Required. The result of the tool call.

type object  (required)

No description provided.

Always set to "function_result".

CodeExecutionResultStep

Code execution result step.

call_id string  (required)

Required. ID to match the ID from the function call block.

is_error boolean  (optional)

Whether the code execution resulted in an error.

result string  (required)

Required. The output of the code execution.

signature string  (optional)

A signature hash for backend validation.

type object  (required)

No description provided.

Always set to "code_execution_result".

UrlContextResultStep

URL context result step.

call_id string  (required)

Required. ID to match the ID from the function call block.

is_error boolean  (optional)

Whether the URL context resulted in an error.

result UrlContextResult  (required)

Required. The results of the URL context.

The result of the URL context.

Fields

status enum (string)  (optional)

The status of the URL retrieval.

Possible values:

  • success

    Url retrieval is successful.

  • error

    Url retrieval is failed due to error.

  • paywall

    Url retrieval is failed because the content is behind paywall.

  • unsafe

    Url retrieval is failed because the content is unsafe.

url string  (optional)

The URL that was fetched.

signature string  (optional)

A signature hash for backend validation.

type object  (required)

No description provided.

Always set to "url_context_result".

GoogleSearchResultStep

Google Search result step.

call_id string  (required)

Required. ID to match the ID from the function call block.

is_error boolean  (optional)

Whether the Google Search resulted in an error.

result GoogleSearchResultItem  (required)

Required. The results of the Google Search.

The result of the Google Search.

Fields

search_suggestions string  (optional)

Web content snippet that can be embedded in a web page or an app webview.

signature string  (optional)

A signature hash for backend validation.

type object  (required)

No description provided.

Always set to "google_search_result".

McpServerToolResultStep

MCPServer tool result step.

call_id string  (required)

Required. ID to match the ID from the function call block.

name string  (optional)

Name of the tool which is called for this specific tool call.

result array (ImageContent or TextContent) or object or string  (required)

Required. The output from the MCP server call. Can be simple text or rich content.

server_name string  (optional)

The name of the used MCP server.

type object  (required)

No description provided.

Always set to "mcp_server_tool_result".

FileSearchResultStep

File Search result step.

call_id string  (required)

Required. ID to match the ID from the function call block.

signature string  (optional)

A signature hash for backend validation.

type object  (required)

No description provided.

Always set to "file_search_result".

GoogleMapsResultStep

Google Maps result step.

call_id string  (required)

Required. ID to match the ID from the function call block.

result GoogleMapsResultItem  (required)

No description provided.

The result of the Google Maps.

Fields

places GoogleMapsResultPlaces  (optional)

No description provided.

Fields

name string  (optional)

No description provided.

place_id string  (optional)

No description provided.

review_snippets ReviewSnippet  (optional)

No description provided.

Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.

Fields

review_id string  (optional)

The ID of the review snippet.

title string  (optional)

Title of the review.

url string  (optional)

A link that corresponds to the user review on Google Maps.

url string  (optional)

No description provided.

widget_context_token string  (optional)

No description provided.

signature string  (optional)

A signature hash for backend validation.

type object  (required)

No description provided.

Always set to "google_maps_result".

StepDelta

delta StepDeltaData  (required)

No description provided.

Possible Types

Polymorphic discriminator: type

TextDelta

text string  (required)

No description provided.

type object  (required)

No description provided.

Always set to "text".

ImageDelta

data string  (optional)

No description provided.

mime_type enum (string)  (optional)

No description provided.

Possible values:

  • image/png

    PNG image format

  • image/jpeg

    JPEG image format

  • image/webp

    WebP image format

  • image/heic

    HEIC image format

  • image/heif

    HEIF image format

  • image/gif

    GIF image format

  • image/bmp

    BMP image format

  • image/tiff

    TIFF image format

resolution MediaResolution  (optional)

The resolution of the media.

Possible values

  • low

    Low resolution.

  • medium

    Medium resolution.

  • high

    High resolution.

  • ultra_high

    Ultra high resolution.

type object  (required)

No description provided.

Always set to "image".

uri string  (optional)

No description provided.

AudioDelta

channels integer  (optional)

The number of audio channels.

data string  (optional)

No description provided.

mime_type enum (string)  (optional)

No description provided.

Possible values:

  • audio/wav

    WAV audio format

  • audio/mp3

    MP3 audio format

  • audio/aiff

    AIFF audio format

  • audio/aac

    AAC audio format

  • audio/ogg

    OGG audio format

  • audio/flac

    FLAC audio format

  • audio/mpeg

    MPEG audio format

  • audio/m4a

    M4A audio format

  • audio/l16

    L16 audio format

  • audio/opus

    OPUS audio format

  • audio/alaw

    ALAW audio format

  • audio/mulaw

    MULAW audio format

sample_rate integer  (optional)

The sample rate of the audio.

type object  (required)

No description provided.

Always set to "audio".

uri string  (optional)

No description provided.

DocumentDelta

data string  (optional)

No description provided.

mime_type enum (string)  (optional)

No description provided.

Possible values:

  • application/pdf

    PDF document format

  • text/csv

    CSV document format

type object  (required)

No description provided.

Always set to "document".

uri string  (optional)

No description provided.

VideoDelta

data string  (optional)

No description provided.

mime_type enum (string)  (optional)

No description provided.

Possible values:

  • video/mp4

    MP4 video format

  • video/mpeg

    MPEG video format

  • video/mpg

    MPG video format

  • video/mov

    MOV video format

  • video/avi

    AVI video format

  • video/x-flv

    FLV video format

  • video/webm

    WebM video format

  • video/wmv

    WMV video format

  • video/3gpp

    3GPP video format

resolution MediaResolution  (optional)

The resolution of the media.

Possible values

  • low

    Low resolution.

  • medium

    Medium resolution.

  • high

    High resolution.

  • ultra_high

    Ultra high resolution.

type object  (required)

No description provided.

Always set to "video".

uri string  (optional)

No description provided.

ThoughtSummaryDelta

content Content  (optional)

A new summary item to be added to the thought.

The content of the response.

Possible Types

Polymorphic discriminator: type

TextContent

A text content block.

annotations Annotation  (optional)

Citation information for model-generated content.

Citation information for model-generated content.

Possible Types

Polymorphic discriminator: type

UrlCitation

A URL citation annotation.

end_index integer  (optional)

End of the attributed segment, exclusive.

start_index integer  (optional)

Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.

title string  (optional)

The title of the URL.

type object  (required)

No description provided.

Always set to "url_citation".

url string  (optional)

The URL.

FileCitation

A file citation annotation.

custom_metadata object  (optional)

User provided metadata about the retrieved context.

document_uri string  (optional)

The URI of the file.

end_index integer  (optional)

End of the attributed segment, exclusive.

file_name string  (optional)

The name of the file.

media_id string  (optional)

Media ID in-case of image citations, if applicable.

page_number integer  (optional)

Page number of the cited document, if applicable.

source string  (optional)

Source attributed for a portion of the text.

start_index integer  (optional)

Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.

type object  (required)

No description provided.

Always set to "file_citation".

PlaceCitation

A place citation annotation.

end_index integer  (optional)

End of the attributed segment, exclusive.

name string  (optional)

Title of the place.

place_id string  (optional)

The ID of the place, in `places/{place_id}` format.

review_snippets ReviewSnippet  (optional)

Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.

Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.

Fields

review_id string  (optional)

The ID of the review snippet.

title string  (optional)

Title of the review.

url string  (optional)

A link that corresponds to the user review on Google Maps.

start_index integer  (optional)

Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.

type object  (required)

No description provided.

Always set to "place_citation".

url string  (optional)

URI reference of the place.

WordInfo

Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution.

end_index integer  (optional)

End of the attributed segment, exclusive.

end_offset string  (optional)

End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".

speaker string  (optional)

Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.

start_index integer  (optional)

Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.

start_offset string  (optional)

Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".

text string  (optional)

The transcribed word.

type object  (required)

No description provided.

Always set to "word_info".

text string  (required)

Required. The text content.

type object  (required)

No description provided.

Always set to "text".

ImageContent

An image content block.

data string  (optional)

The image content.

mime_type enum (string)  (optional)

The mime type of the image.

Possible values:

  • image/png

    PNG image format

  • image/jpeg

    JPEG image format

  • image/webp

    WebP image format

  • image/heic

    HEIC image format

  • image/heif

    HEIF image format

  • image/gif

    GIF image format

  • image/bmp

    BMP image format

  • image/tiff

    TIFF image format

resolution MediaResolution  (optional)

The resolution of the media.

Possible values

  • low

    Low resolution.

  • medium

    Medium resolution.

  • high

    High resolution.

  • ultra_high

    Ultra high resolution.

type object  (required)

No description provided.

Always set to "image".

uri string  (optional)

The URI of the image.

AudioContent

An audio content block.

channels integer  (optional)

The number of audio channels.

data string  (optional)

The audio content.

mime_type enum (string)  (optional)

The mime type of the audio.

Possible values:

  • audio/wav

    WAV audio format

  • audio/mp3

    MP3 audio format

  • audio/aiff

    AIFF audio format

  • audio/aac

    AAC audio format

  • audio/ogg

    OGG audio format

  • audio/flac

    FLAC audio format

  • audio/mpeg

    MPEG audio format

  • audio/m4a

    M4A audio format

  • audio/l16

    L16 audio format

  • audio/opus

    OPUS audio format

  • audio/alaw

    ALAW audio format

  • audio/mulaw

    MULAW audio format

sample_rate integer  (optional)

The sample rate of the audio.

type object  (required)

No description provided.

Always set to "audio".

uri string  (optional)

The URI of the audio.

DocumentContent

A document content block.

data string  (optional)

The document content.

mime_type enum (string)  (optional)

The mime type of the document.

Possible values:

  • application/pdf

    PDF document format

  • text/csv

    CSV document format

type object  (required)

No description provided.

Always set to "document".

uri string  (optional)

The URI of the document.

VideoContent

A video content block.

data string  (optional)

The video content.

mime_type enum (string)  (optional)

The mime type of the video.

Possible values:

  • video/mp4

    MP4 video format

  • video/mpeg

    MPEG video format

  • video/mpg

    MPG video format

  • video/mov

    MOV video format

  • video/avi

    AVI video format

  • video/x-flv

    FLV video format

  • video/webm

    WebM video format

  • video/wmv

    WMV video format

  • video/3gpp

    3GPP video format

resolution MediaResolution  (optional)

The resolution of the media.

Possible values

  • low

    Low resolution.

  • medium

    Medium resolution.

  • high

    High resolution.

  • ultra_high

    Ultra high resolution.

type object  (required)

No description provided.

Always set to "video".

uri string  (optional)

The URI of the video.

type object  (required)

No description provided.

Always set to "thought_summary".

ThoughtSignatureDelta

signature string  (optional)

Signature to match the backend source to be part of the generation.

type object  (required)

No description provided.

Always set to "thought_signature".

TextAnnotationDelta

annotations Annotation  (optional)

Citation information for model-generated content.

Citation information for model-generated content.

Possible Types

Polymorphic discriminator: type

UrlCitation

A URL citation annotation.

end_index integer  (optional)

End of the attributed segment, exclusive.

start_index integer  (optional)

Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.

title string  (optional)

The title of the URL.

type object  (required)

No description provided.

Always set to "url_citation".

url string  (optional)

The URL.

FileCitation

A file citation annotation.

custom_metadata object  (optional)

User provided metadata about the retrieved context.

document_uri string  (optional)

The URI of the file.

end_index integer  (optional)

End of the attributed segment, exclusive.

file_name string  (optional)

The name of the file.

media_id string  (optional)

Media ID in-case of image citations, if applicable.

page_number integer  (optional)

Page number of the cited document, if applicable.

source string  (optional)

Source attributed for a portion of the text.

start_index integer  (optional)

Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.

type object  (required)

No description provided.

Always set to "file_citation".

PlaceCitation

A place citation annotation.

end_index integer  (optional)

End of the attributed segment, exclusive.

name string  (optional)

Title of the place.

place_id string  (optional)

The ID of the place, in `places/{place_id}` format.

review_snippets ReviewSnippet  (optional)

Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.

Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.

Fields

review_id string  (optional)

The ID of the review snippet.

title string  (optional)

Title of the review.

url string  (optional)

A link that corresponds to the user review on Google Maps.

start_index integer  (optional)

Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.

type object  (required)

No description provided.

Always set to "place_citation".

url string  (optional)

URI reference of the place.

WordInfo

Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution.

end_index integer  (optional)

End of the attributed segment, exclusive.

end_offset string  (optional)

End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".

speaker string  (optional)

Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.

start_index integer  (optional)

Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.

start_offset string  (optional)

Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".

text string  (optional)

The transcribed word.

type object  (required)

No description provided.

Always set to "word_info".

type object  (required)

No description provided.

Always set to "text_annotation_delta".

ArgumentsDelta

arguments string  (optional)

No description provided.

type object  (required)

No description provided.

Always set to "arguments_delta".

CodeExecutionCallDelta

arguments CodeExecutionCallArguments  (required)

No description provided.

The arguments to pass to the code execution.

Fields

code string  (optional)

The code to be executed.

language enum (string)  (optional)

Programming language of the `code`.

Possible values:

  • python

    Python >= 3.10, with numpy and simpy available.

signature string  (optional)

A signature hash for backend validation.

type object  (required)

No description provided.

Always set to "code_execution_call".

UrlContextCallDelta

arguments UrlContextCallArguments  (required)

No description provided.

The arguments to pass to the URL context.

Fields

urls array (string)  (optional)

The URLs to fetch.

signature string  (optional)

A signature hash for backend validation.

type object  (required)

No description provided.

Always set to "url_context_call".

GoogleSearchCallDelta

arguments GoogleSearchCallArguments  (required)

No description provided.

The arguments to pass to Google Search.

Fields

queries array (string)  (optional)

Web search queries for the following-up web search.

signature string  (optional)

A signature hash for backend validation.

type object  (required)

No description provided.

Always set to "google_search_call".

McpServerToolCallDelta

arguments object  (required)

No description provided.

name string  (required)

No description provided.

server_name string  (required)

No description provided.

type object  (required)

No description provided.

Always set to "mcp_server_tool_call".

FileSearchCallDelta

signature string  (optional)

A signature hash for backend validation.

type object  (required)

No description provided.

Always set to "file_search_call".

GoogleMapsCallDelta

arguments GoogleMapsCallArguments  (optional)

The arguments to pass to the Google Maps tool.

The arguments to pass to the Google Maps tool.

Fields

queries array (string)  (optional)

The queries to be executed.

signature string  (optional)

A signature hash for backend validation.

type object  (required)

No description provided.

Always set to "google_maps_call".

RetrievalCallDelta

Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. RetrievalType decides which tool is used.

arguments RetrievalStepArguments  (required)

Required. The arguments to pass to the Retrieval tool.

The arguments to pass to Retrieval tools.

Fields

queries array (string)  (optional)

Queries for Retrieval information.

retrieval_type enum (string)  (optional)

The type of retrieval tools.

Possible values:

  • rag_store

    The type of retrieval tools.

  • exa_ai_search

    The type of retrieval tools.

  • parallel_ai_search

    The type of retrieval tools.

signature string  (optional)

A signature hash for backend validation.

type object  (required)

No description provided.

Always set to "retrieval_call".

CodeExecutionResultDelta

is_error boolean  (optional)

No description provided.

result string  (required)

No description provided.

signature string  (optional)

A signature hash for backend validation.

type object  (required)

No description provided.

Always set to "code_execution_result".

UrlContextResultDelta

is_error boolean  (optional)

No description provided.

result UrlContextResult  (required)

No description provided.

The result of the URL context.

Fields

status enum (string)  (optional)

The status of the URL retrieval.

Possible values:

  • success

    Url retrieval is successful.

  • error

    Url retrieval is failed due to error.

  • paywall

    Url retrieval is failed because the content is behind paywall.

  • unsafe

    Url retrieval is failed because the content is unsafe.

url string  (optional)

The URL that was fetched.

signature string  (optional)

A signature hash for backend validation.

type object  (required)

No description provided.

Always set to "url_context_result".

GoogleSearchResultDelta

is_error boolean  (optional)

No description provided.

result GoogleSearchResult  (required)

No description provided.

The result of the Google Search.

Fields

search_suggestions string  (optional)

Web content snippet that can be embedded in a web page or an app webview.

signature string  (optional)

A signature hash for backend validation.

type object  (required)

No description provided.

Always set to "google_search_result".

McpServerToolResultDelta

name string  (optional)

No description provided.

result array (ImageContent or TextContent) or object or string  (required)

No description provided.

server_name string  (optional)

No description provided.

type object  (required)

No description provided.

Always set to "mcp_server_tool_result".

FileSearchResultDelta

result FileSearchResult  (required)

No description provided.

The result of the File Search.

signature string  (optional)

A signature hash for backend validation.

type object  (required)

No description provided.

Always set to "file_search_result".

GoogleMapsResultDelta

result GoogleMapsResult  (optional)

The results of the Google Maps.

The result of the Google Maps.

Fields

places Places  (optional)

The places that were found.

Fields

name string  (optional)

Title of the place.

place_id string  (optional)

The ID of the place, in `places/{place_id}` format.

review_snippets ReviewSnippet  (optional)

Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.

Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.

Fields

review_id string  (optional)

The ID of the review snippet.

title string  (optional)

Title of the review.

url string  (optional)

A link that corresponds to the user review on Google Maps.

url string  (optional)

URI reference of the place.

widget_context_token string  (optional)

Resource name of the Google Maps widget context token.

signature string  (optional)

A signature hash for backend validation.

type object  (required)

No description provided.

Always set to "google_maps_result".

RetrievalResultDelta

Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. ToolResultDelta.type

is_error boolean  (optional)

Whether the retrieval resulted in an error.

signature string  (optional)

A signature hash for backend validation.

type object  (required)

No description provided.

Always set to "retrieval_result".

FunctionResultDelta

call_id string  (required)

Required. ID to match the ID from the function call block.

is_error boolean  (optional)

No description provided.

name string  (optional)

No description provided.

result array (ImageContent or TextContent) or object or string  (required)

No description provided.

type object  (required)

No description provided.

Always set to "function_result".

event_id string  (optional)

The event_id token to be used to resume the interaction stream, from this event.

event_type object  (required)

No description provided.

Always set to "step.delta".

index integer  (required)

No description provided.

metadata StepDeltaMetadata  (optional)

Optional metadata accompanying ANY streamed event.

Optional metadata accompanying ANY streamed event.

Fields

total_usage Usage  (optional)

Statistics on the interaction request's token usage.

Statistics on the interaction request's token usage.

Fields

cached_tokens_by_modality ModalityTokens  (optional)

A breakdown of cached token usage by modality.

The token count for a single response modality.

Fields

modality ResponseModality  (optional)

The modality associated with the token count.

Possible values

  • text

    Indicates the model should return text.

  • image

    Indicates the model should return images.

  • audio

    Indicates the model should return audio.

  • video

    Indicates the model should return video.

  • document

    Indicates the model should return documents.

tokens integer  (optional)

Number of tokens for the modality.

grounding_tool_count GroundingToolCount  (optional)

Grounding tool count.

The number of grounding tool counts.

Fields

count integer  (optional)

The number of grounding tool counts.

type enum (string)  (optional)

The grounding tool type associated with the count.

Possible values:

  • google_search

    Grounding with Google Web Search and Image Search, & Web Grounding for Enterprise.

  • google_maps

    Grounding with Google Maps.

  • retrieval

    Grounding with customer's data, for example, VertexAISearch.

input_tokens_by_modality ModalityTokens  (optional)

A breakdown of input token usage by modality.

The token count for a single response modality.

Fields

modality ResponseModality  (optional)

The modality associated with the token count.

Possible values

  • text

    Indicates the model should return text.

  • image

    Indicates the model should return images.

  • audio

    Indicates the model should return audio.

  • video

    Indicates the model should return video.

  • document

    Indicates the model should return documents.

tokens integer  (optional)

Number of tokens for the modality.

output_tokens_by_modality ModalityTokens  (optional)

A breakdown of output token usage by modality.

The token count for a single response modality.

Fields

modality ResponseModality  (optional)

The modality associated with the token count.

Possible values

  • text

    Indicates the model should return text.

  • image

    Indicates the model should return images.

  • audio

    Indicates the model should return audio.

  • video

    Indicates the model should return video.

  • document

    Indicates the model should return documents.

tokens integer  (optional)

Number of tokens for the modality.

tool_use_tokens_by_modality ModalityTokens  (optional)

A breakdown of tool-use token usage by modality.

The token count for a single response modality.

Fields

modality ResponseModality  (optional)

The modality associated with the token count.

Possible values

  • text

    Indicates the model should return text.

  • image

    Indicates the model should return images.

  • audio

    Indicates the model should return audio.

  • video

    Indicates the model should return video.

  • document

    Indicates the model should return documents.

tokens integer  (optional)

Number of tokens for the modality.

total_cached_tokens integer  (optional)

Number of tokens in the cached part of the prompt (the cached content).

total_input_tokens integer  (optional)

Number of tokens in the prompt (context).

total_output_tokens integer  (optional)

Total number of tokens across all the generated responses.

total_thought_tokens integer  (optional)

Number of tokens of thoughts for thinking models.

total_tokens integer  (optional)

Total token count for the interaction request (prompt + responses + other internal tokens).

total_tool_use_tokens integer  (optional)

Number of tokens present in tool-use prompt(s).

StepStop

event_id string  (optional)

The event_id token to be used to resume the interaction stream, from this event.

event_type object  (required)

No description provided.

Always set to "step.stop".

index integer  (required)

No description provided.

metadata StreamMetadata  (optional)

Optional metadata accompanying ANY streamed event.

Fields

total_usage Usage  (optional)

No description provided.

Statistics on the interaction request's token usage.

Fields

cached_tokens_by_modality ModalityTokens  (optional)

A breakdown of cached token usage by modality.

The token count for a single response modality.

Fields

modality ResponseModality  (optional)

The modality associated with the token count.

Possible values

  • text

    Indicates the model should return text.

  • image

    Indicates the model should return images.

  • audio

    Indicates the model should return audio.

  • video

    Indicates the model should return video.

  • document

    Indicates the model should return documents.

tokens integer  (optional)

Number of tokens for the modality.

grounding_tool_count GroundingToolCount  (optional)

Grounding tool count.

The number of grounding tool counts.

Fields

count integer  (optional)

The number of grounding tool counts.

type enum (string)  (optional)

The grounding tool type associated with the count.

Possible values:

  • google_search

    Grounding with Google Web Search and Image Search, & Web Grounding for Enterprise.

  • google_maps

    Grounding with Google Maps.

  • retrieval

    Grounding with customer's data, for example, VertexAISearch.

input_tokens_by_modality ModalityTokens  (optional)

A breakdown of input token usage by modality.

The token count for a single response modality.

Fields

modality ResponseModality  (optional)

The modality associated with the token count.

Possible values

  • text

    Indicates the model should return text.

  • image

    Indicates the model should return images.

  • audio

    Indicates the model should return audio.

  • video

    Indicates the model should return video.

  • document

    Indicates the model should return documents.

tokens integer  (optional)

Number of tokens for the modality.

output_tokens_by_modality ModalityTokens  (optional)

A breakdown of output token usage by modality.

The token count for a single response modality.

Fields

modality ResponseModality  (optional)

The modality associated with the token count.

Possible values

  • text

    Indicates the model should return text.

  • image

    Indicates the model should return images.

  • audio

    Indicates the model should return audio.

  • video

    Indicates the model should return video.

  • document

    Indicates the model should return documents.

tokens integer  (optional)

Number of tokens for the modality.

tool_use_tokens_by_modality ModalityTokens  (optional)

A breakdown of tool-use token usage by modality.

The token count for a single response modality.

Fields

modality ResponseModality  (optional)

The modality associated with the token count.

Possible values

  • text

    Indicates the model should return text.

  • image

    Indicates the model should return images.

  • audio

    Indicates the model should return audio.

  • video

    Indicates the model should return video.

  • document

    Indicates the model should return documents.

tokens integer  (optional)

Number of tokens for the modality.

total_cached_tokens integer  (optional)

Number of tokens in the cached part of the prompt (the cached content).

total_input_tokens integer  (optional)

Number of tokens in the prompt (context).

total_output_tokens integer  (optional)

Total number of tokens across all the generated responses.

total_thought_tokens integer  (optional)

Number of tokens of thoughts for thinking models.

total_tokens integer  (optional)

Total token count for the interaction request (prompt + responses + other internal tokens).

total_tool_use_tokens integer  (optional)

Number of tokens present in tool-use prompt(s).

step_usage Usage  (optional)

Model usage stats for this specific step.

Statistics on the interaction request's token usage.

Fields

cached_tokens_by_modality ModalityTokens  (optional)

A breakdown of cached token usage by modality.

The token count for a single response modality.

Fields

modality ResponseModality  (optional)

The modality associated with the token count.

Possible values

  • text

    Indicates the model should return text.

  • image

    Indicates the model should return images.

  • audio

    Indicates the model should return audio.

  • video

    Indicates the model should return video.

  • document

    Indicates the model should return documents.

tokens integer  (optional)

Number of tokens for the modality.

grounding_tool_count GroundingToolCount  (optional)

Grounding tool count.

The number of grounding tool counts.

Fields

count integer  (optional)

The number of grounding tool counts.

type enum (string)  (optional)

The grounding tool type associated with the count.

Possible values:

  • google_search

    Grounding with Google Web Search and Image Search, & Web Grounding for Enterprise.

  • google_maps

    Grounding with Google Maps.

  • retrieval

    Grounding with customer's data, for example, VertexAISearch.

input_tokens_by_modality ModalityTokens  (optional)

A breakdown of input token usage by modality.

The token count for a single response modality.

Fields

modality ResponseModality  (optional)

The modality associated with the token count.

Possible values

  • text

    Indicates the model should return text.

  • image

    Indicates the model should return images.

  • audio

    Indicates the model should return audio.

  • video

    Indicates the model should return video.

  • document

    Indicates the model should return documents.

tokens integer  (optional)

Number of tokens for the modality.

output_tokens_by_modality ModalityTokens  (optional)

A breakdown of output token usage by modality.

The token count for a single response modality.

Fields

modality ResponseModality  (optional)

The modality associated with the token count.

Possible values

  • text

    Indicates the model should return text.

  • image

    Indicates the model should return images.

  • audio

    Indicates the model should return audio.

  • video

    Indicates the model should return video.

  • document

    Indicates the model should return documents.

tokens integer  (optional)

Number of tokens for the modality.

tool_use_tokens_by_modality ModalityTokens  (optional)

A breakdown of tool-use token usage by modality.

The token count for a single response modality.

Fields

modality ResponseModality  (optional)

The modality associated with the token count.

Possible values

  • text

    Indicates the model should return text.

  • image

    Indicates the model should return images.

  • audio

    Indicates the model should return audio.

  • video

    Indicates the model should return video.

  • document

    Indicates the model should return documents.

tokens integer  (optional)

Number of tokens for the modality.

total_cached_tokens integer  (optional)

Number of tokens in the cached part of the prompt (the cached content).

total_input_tokens integer  (optional)

Number of tokens in the prompt (context).

total_output_tokens integer  (optional)

Total number of tokens across all the generated responses.

total_thought_tokens integer  (optional)

Number of tokens of thoughts for thinking models.

total_tokens integer  (optional)

Total token count for the interaction request (prompt + responses + other internal tokens).

total_tool_use_tokens integer  (optional)

Number of tokens present in tool-use prompt(s).

usage Usage  (optional)

Cumulative model usage stats from the start of the session.

Statistics on the interaction request's token usage.

Fields

cached_tokens_by_modality ModalityTokens  (optional)

A breakdown of cached token usage by modality.

The token count for a single response modality.

Fields

modality ResponseModality  (optional)

The modality associated with the token count.

Possible values

  • text

    Indicates the model should return text.

  • image

    Indicates the model should return images.

  • audio

    Indicates the model should return audio.

  • video

    Indicates the model should return video.

  • document

    Indicates the model should return documents.

tokens integer  (optional)

Number of tokens for the modality.

grounding_tool_count GroundingToolCount  (optional)

Grounding tool count.

The number of grounding tool counts.

Fields

count integer  (optional)

The number of grounding tool counts.

type enum (string)  (optional)

The grounding tool type associated with the count.

Possible values:

  • google_search

    Grounding with Google Web Search and Image Search, & Web Grounding for Enterprise.

  • google_maps

    Grounding with Google Maps.

  • retrieval

    Grounding with customer's data, for example, VertexAISearch.

input_tokens_by_modality ModalityTokens  (optional)

A breakdown of input token usage by modality.

The token count for a single response modality.

Fields

modality ResponseModality  (optional)

The modality associated with the token count.

Possible values

  • text

    Indicates the model should return text.

  • image

    Indicates the model should return images.

  • audio

    Indicates the model should return audio.

  • video

    Indicates the model should return video.

  • document

    Indicates the model should return documents.

tokens integer  (optional)

Number of tokens for the modality.

output_tokens_by_modality ModalityTokens  (optional)

A breakdown of output token usage by modality.

The token count for a single response modality.

Fields

modality ResponseModality  (optional)

The modality associated with the token count.

Possible values

  • text

    Indicates the model should return text.

  • image

    Indicates the model should return images.

  • audio

    Indicates the model should return audio.

  • video

    Indicates the model should return video.

  • document

    Indicates the model should return documents.

tokens integer  (optional)

Number of tokens for the modality.

tool_use_tokens_by_modality ModalityTokens  (optional)

A breakdown of tool-use token usage by modality.

The token count for a single response modality.

Fields

modality ResponseModality  (optional)

The modality associated with the token count.

Possible values

  • text

    Indicates the model should return text.

  • image

    Indicates the model should return images.

  • audio

    Indicates the model should return audio.

  • video

    Indicates the model should return video.

  • document

    Indicates the model should return documents.

tokens integer  (optional)

Number of tokens for the modality.

total_cached_tokens integer  (optional)

Number of tokens in the cached part of the prompt (the cached content).

total_input_tokens integer  (optional)

Number of tokens in the prompt (context).

total_output_tokens integer  (optional)

Total number of tokens across all the generated responses.

total_thought_tokens integer  (optional)

Number of tokens of thoughts for thinking models.

total_tokens integer  (optional)

Total token count for the interaction request (prompt + responses + other internal tokens).

total_tool_use_tokens integer  (optional)

Number of tokens present in tool-use prompt(s).

Examples

Interaction Created

{
  "event_type": "interaction.created",
  "interaction": {
    "id": "v1_ChdXS0l4YWZXTk9xbk0xZThQczhEcmlROBIXV0tJeGFmV05PcW5NMWU4UHM4RHJpUTg",
    "model": "gemini-3.6-flash",
    "status": "in_progress",
    "created": "2025-12-04T15:01:45Z",
    "updated": "2025-12-04T15:01:45Z"
  },
  "event_id": "evt_123"
}

Interaction Created

{
  "event_type": "interaction.created",
  "interaction": {
    "id": "v1_ChdXS0l4YWZXTk9xbk0xZThQczhEcmlROBIXV0tJeGFmV05PcW5NMWU4UHM4RHJpUTg",
    "model": "gemini-3-flash-preview",
    "object": "interaction",
    "status": "in_progress"
  },
  "event_id": "evt_123"
}

Interaction Completed

{
  "event_type": "interaction.completed",
  "interaction": {
    "id": "v1_ChdXS0l4YWZXTk9xbk0xZThQczhEcmlROBIXV0tJeGFmV05PcW5NMWU4UHM4RHJpUTg",
    "model": "gemini-3.6-flash",
    "status": "completed",
    "created": "2025-12-04T15:01:45Z",
    "updated": "2025-12-04T15:01:45Z"
  },
  "event_id": "evt_123"
}

Interaction Completed

{
  "event_type": "interaction.completed",
  "interaction": {
    "id": "v1_ChdXS0l4YWZXTk9xbk0xZThQczhEcmlROBIXV0tJeGFmV05PcW5NMWU4UHM4RHJpUTg",
    "model": "gemini-3-flash-preview",
    "object": "interaction",
    "status": "completed",
    "created": "2025-12-04T15:01:45Z",
    "updated": "2025-12-04T15:01:45Z"
  },
  "event_id": "evt_123"
}

Interaction Status Update

{
  "event_type": "interaction.status_update",
  "interaction_id": "v1_ChdTMjQ0YWJ5TUF1TzcxZThQdjRpcnFRcxIXUzI0NGFieU1BdU83MWU4UHY0aXJxUXM",
  "status": "in_progress"
}

Error Event

{
  "event_type": "error",
  "error": {
    "message": "Failed to get completed interaction: Result not found.",
    "code": "not_found"
  }
}

Step Start

{
  "event_type": "step.start",
  "index": 0,
  "step": {
    "type": "model_output"
  }
}

Step Delta

{
  "event_type": "step.delta",
  "index": 0,
  "delta": {
    "type": "text",
    "text": "Hello"
  }
}

Step Stop

{
  "event_type": "step.stop",
  "index": 0
}