Gemini API

Gemini Interactions API 是一项实验性 API,可让开发者使用 Gemini 模型构建生成式 AI 应用。Gemini 是我们迄今为止最强大的模型,专为多模态应用而生。它不仅能理解和处理语言、图像、音频、视频和代码等各种信息,更能跨越不同模态,实现信息的融会贯通。您可以使用 Gemini API 来实现各种用例,例如跨文本和图像进行推理、生成内容、构建对话代理、开发总结和分类系统等。

创建互动

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

创建新的互动。

请求正文

请求正文中包含结构如下的数据:

model ModelOption  (可选)

用于生成互动的 `Model` 的名称。
如果未提供“agent”,则此属性为必需属性。

可能的值:

  • gemini-2.5-computer-use-preview-10-2025

    一种旨在实现直接界面交互的智能体功能模型,可让 Gemini 感知和浏览数字环境。

  • gemini-2.5-flash

    我们的首款混合推理模型,支持 100 万个 token 的上下文窗口,并具有思考预算。

  • gemini-2.5-flash-image

    我们的原生图片生成模型,在速度、灵活性和上下文理解方面经过优化。文本输入和输出的定价与 2.5 Flash 相同。

  • gemini-2.5-flash-lite

    Google 旗下最小巧且最具成本效益的模型,专为大规模使用而打造。

  • gemini-2.5-flash-lite-preview-09-2025

    基于 Gemini 2.5 Flash Lite 的最新模型,经过优化,可实现高成本效益、高吞吐量和高画质。

  • gemini-2.5-flash-native-audio-preview-12-2025

    我们的原生音频模型经过优化,可提供更高质量的音频输出,并能更好地控制语速、声音自然度、表达详略和情绪。

  • gemini-2.5-flash-preview-09-2025

    基于 2.5 Flash 模型的最新模型。2.5 Flash 预览版最适合大规模处理、低延迟、高数据量任务,以及智能体应用场景。

  • gemini-2.5-flash-preview-tts

    我们的 2.5 Flash 文字转语音模型经过优化,可生成强大的低延迟可控语音。

  • gemini-2.5-pro

    Google 旗下先进的多用途模型,擅长处理编码和复杂的推理任务。

  • gemini-2.5-pro-preview-tts

    我们的 2.5 Pro 文字转语音音频模型经过优化,可实现强大的低延迟语音生成,从而提供更自然的输出,并更轻松地引导提示。

  • gemini-3-flash-preview

    我们打造的最智能的模型,专为速度而生,将前沿智能技术与出色的搜索和事实依据能力相结合。

  • gemini-3-pro-image-preview

    先进的图片生成和编辑模型。

  • gemini-3-pro-preview

    我们最为智能的模型,在推理和多模态理解方面表现卓越,并具备强大的智能体和氛围编程 (vibe coding) 功能。

  • gemini-3.1-pro-preview

    我们最新的 SOTA 推理模型,具有前所未有的深度和细致度,以及强大的多模态理解和编码能力。

  • gemini-3.1-flash-image-preview

    专业级视觉智能,兼具闪电级效率和贴近现实的生成能力。

  • gemini-3.1-flash-lite-preview

    Google 旗下最具成本效益的模型,针对高容量智能体任务、翻译和简单的数据处理进行了优化。

  • gemini-3.1-flash-tts-preview

    Gemini 3.1 Flash TTS:功能强大,可生成低延迟的语音。享受自然流畅的输出、可控的提示,以及用于精确控制旁白的新颖的表达性音频标记。

  • lyria-3-clip-preview

    我们的低延迟音乐生成模型经过优化,可生成高保真音频片段并实现精准的节奏控制。

  • lyria-3-pro-preview

    我们先进的全曲生成模型,具有深厚的作曲理解能力,经过优化,可实现精准的结构控制,并在各种音乐风格之间实现复杂的过渡。

将完成提示的模型。\n\n 如需了解详情,请参阅 [模型](https://ai.google.dev/gemini-api/docs/models)。

agent AgentOption  (可选)

用于生成互动的“代理”的名称。
如果未提供“model”,则为必需属性。

可能的值:

  • deep-research-pro-preview-12-2025

    Gemini Deep Research Agent

  • deep-research-preview-04-2026

    Gemini Deep Research Agent

  • deep-research-max-preview-04-2026

    Gemini Deep Research Max Agent

要与之互动的代理。

input 内容或数组(内容)或数组(轮次)或字符串  (必需)

交互的输入(模型和代理共用)。

system_instruction string  (可选)

互动方面的系统指令。

tools 数组 (Tool)  (可选)

模型在互动期间可能会调用的工具声明列表。

response_format object  (可选)

强制生成的回答是符合此字段中指定的 JSON 架构的 JSON 对象。

response_mime_type string  (可选)

响应的 MIME 类型。如果设置了 response_format,则必须设置此字段。

stream boolean  (选填)

仅限输入。互动是否会以流式传输方式进行。

store boolean  (选填)

仅限输入。是否存储响应和请求以供日后检索。

background boolean  (可选)

仅限输入。是否在后台运行模型交互。

generation_config GenerationConfig  (可选)

模型配置
模型互动的配置参数。
`agent_config` 的替代方案。仅在设置了 `model` 时适用。

模型互动的配置参数。

字段

温度 数字  (可选)

控制输出的随机性。

top_p number  (可选)

抽样时要考虑的 token 的最大累积概率。

seed integer  (可选)

解码中使用的种子,用于实现可重现性。

stop_sequences 数组(字符串)  (选填)

将停止输出互动的字符序列列表。

thinking_level ThinkingLevel  (可选)

模型应生成的思维令牌的级别。

可能的值:

  • minimal
  • low
  • medium
  • high

thinking_summaries ThinkingSummaries  (可选)

是否在回答中包含思维总结。

可能的值:

  • auto
  • none

max_output_tokens integer  (可选)

响应中包含的令牌数量上限。

speech_config SpeechConfig  (可选)

语音互动的配置。

语音互动配置。

字段

voice string  (选填)

说话者的声音。

language string  (选填)

语音的语言。

speaker string  (选填)

说话者的姓名,应与提示中给出的说话者姓名一致。

image_config ImageConfig  (可选)

图片互动的配置。

图片互动的配置。

字段

aspect_ratio enum (string)  (选填)

没有提供说明。

可能的值:

  • 1:1
  • 2:3
  • 3:2
  • 3:4
  • 4:3
  • 4:5
  • 5:4
  • 9:16
  • 16:9
  • 21:9
  • 1:8
  • 8:1
  • 1:4
  • 4:1
image_size enum (string)  (选填)

没有提供说明。

可能的值:

  • 1K
  • 2K
  • 4K
  • 512
tool_choice ToolChoiceConfigToolChoiceType  (可选)

工具选择配置。

agent_config object  (可选)

代理配置
代理的配置。
`generation_config` 的替代方案。仅在设置了 `agent` 时适用。

可能的类型

多态鉴别器:type

DynamicAgentConfig

动态代理的配置。

type object  (必需)

没有提供说明。

一律设置为 "dynamic"

DeepResearchAgentConfig

Deep Research 代理的配置。

type object  (必需)

没有提供说明。

一律设置为 "deep-research"

thinking_summaries ThinkingSummaries  (可选)

是否在回答中包含思维总结。

可能的值:

  • auto
  • none

可视化图表 枚举(字符串)  (可选)

是否在回答中包含可视化图表。

可能的值:

  • off
  • auto
collaborative_planning boolean  (可选)

为 Deep Research 智能体启用人机协同规划。如果设置为 true,Deep Research 智能体将在其回答中提供研究计划。然后,只有在用户在下一轮对话中确认方案后,代理才会继续。

previous_interaction_id string  (可选)

上一次互动的 ID(如果有)。

response_modalities ResponseModality  (可选)

请求的回答模态(TEXT、IMAGE、AUDIO)。

可能的值:

  • text
  • image
  • audio
  • video
  • document

service_tier enum (string)  (选填)

互动的服务层级。

可能的值:

  • flex
  • standard
  • priority

响应

返回 Interaction 资源。

简单请求

示例响应

{
  "created": "2025-11-26T12:25:15Z",
  "id": "v1_ChdPU0F4YWFtNkFwS2kxZThQZ05lbXdROBIXT1NBeGFhbTZBcEtpMWU4UGdOZW13UTg",
  "model": "gemini-3-flash-preview",
  "object": "interaction",
  "outputs": [
    {
      "text": "Hello! I'm functioning perfectly and ready to assist you.\n\nHow are you doing today?",
      "type": "text"
    }
  ],
  "role": "model",
  "status": "completed",
  "updated": "2025-11-26T12:25:15Z",
  "usage": {
    "input_tokens_by_modality": [
      {
        "modality": "text",
        "tokens": 7
      }
    ],
    "total_cached_tokens": 0,
    "total_input_tokens": 7,
    "total_output_tokens": 20,
    "total_thought_tokens": 22,
    "total_tokens": 49,
    "total_tool_use_tokens": 0
  }
}

多轮

示例响应

{
  "id": "v1_ChdPU0F4YWFtNkFwS2kxZThQZ05lbXdROBIXT1NBeGFhbTZBcEtpMWU4UGdOZW13UTg",
  "model": "gemini-3-flash-preview",
  "status": "completed",
  "object": "interaction",
  "created": "2025-11-26T12:22:47Z",
  "updated": "2025-11-26T12:22:47Z",
  "role": "model",
  "outputs": [
    {
      "type": "text",
      "text": "The capital of France is Paris."
    }
  ],
  "usage": {
    "input_tokens_by_modality": [
      {
        "modality": "text",
        "tokens": 50
      }
    ],
    "total_cached_tokens": 0,
    "total_input_tokens": 50,
    "total_output_tokens": 10,
    "total_thought_tokens": 0,
    "total_tokens": 60,
    "total_tool_use_tokens": 0
  }
}

图片输入

示例响应

{
  "id": "v1_ChdPU0F4YWFtNkFwS2kxZThQZ05lbXdROBIXT1NBeGFhbTZBcEtpMWU4UGdOZW13UTg",
  "model": "gemini-3-flash-preview",
  "status": "completed",
  "object": "interaction",
  "created": "2025-11-26T12:22:47Z",
  "updated": "2025-11-26T12:22:47Z",
  "role": "model",
  "outputs": [
    {
      "type": "text",
      "text": "A white humanoid robot with glowing blue eyes stands holding a red skateboard."
    }
  ],
  "usage": {
    "input_tokens_by_modality": [
      {
        "modality": "text",
        "tokens": 10
      },
      {
        "modality": "image",
        "tokens": 258
      }
    ],
    "total_cached_tokens": 0,
    "total_input_tokens": 268,
    "total_output_tokens": 20,
    "total_thought_tokens": 0,
    "total_tokens": 288,
    "total_tool_use_tokens": 0
  }
}

函数调用

示例响应

{
  "id": "v1_ChdPU0F4YWFtNkFwS2kxZThQZ05lbXdROBIXT1NBeGFhbTZBcEtpMWU4UGdOZW13UTg",
  "model": "gemini-3-flash-preview",
  "status": "requires_action",
  "object": "interaction",
  "created": "2025-11-26T12:22:47Z",
  "updated": "2025-11-26T12:22:47Z",
  "role": "model",
  "outputs": [
    {
      "type": "function_call",
      "id": "gth23981",
      "name": "get_weather",
      "arguments": {
        "location": "Boston, MA"
      }
    }
  ],
  "usage": {
    "input_tokens_by_modality": [
      {
        "modality": "text",
        "tokens": 100
      }
    ],
    "total_cached_tokens": 0,
    "total_input_tokens": 100,
    "total_output_tokens": 25,
    "total_thought_tokens": 0,
    "total_tokens": 125,
    "total_tool_use_tokens": 50
  }
}

Deep Research

示例响应

{
  "id": "v1_ChdPU0F4YWFtNkFwS2kxZThQZ05lbXdROBIXT1NBeGFhbTZBcEtpMWU4UGdOZW13UTg",
  "agent": "deep-research-pro-preview-12-2025",
  "status": "completed",
  "object": "interaction",
  "created": "2025-11-26T12:22:47Z",
  "updated": "2025-11-26T12:22:47Z",
  "role": "agent",
  "outputs": [
    {
      "type": "text",
      "text": "Here is a comprehensive research report on the current state of cancer research..."
    }
  ],
  "usage": {
    "input_tokens_by_modality": [
      {
        "modality": "text",
        "tokens": 20
      }
    ],
    "total_cached_tokens": 0,
    "total_input_tokens": 20,
    "total_output_tokens": 1000,
    "total_thought_tokens": 500,
    "total_tokens": 1520,
    "total_tool_use_tokens": 0
  }
}

检索互动

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

根据单个互动的 `Interaction.id` 检索其完整详细信息。

路径 / 查询参数

id string  (必需)

要检索的互动的唯一标识符。

stream boolean  (选填)

如果设置为 true,则会以增量方式流式传输生成的内容。

默认为:False

last_event_id string  (选填)

可选。如果设置,则从由事件 ID 标记的事件之后的下一个块恢复互动流。仅当“stream”为 true 时才可使用。

include_input 布尔值  (可选)

如果设置为 true,则在回答中包含输入内容。

默认为:False

api_version string  (选填)

要使用的 API 版本。

响应

返回 Interaction 资源。

获取互动

示例响应

{
  "id": "v1_ChdPU0F4YWFtNkFwS2kxZThQZ05lbXdROBIXT1NBeGFhbTZBcEtpMWU4UGdOZW13UTg",
  "model": "gemini-3-flash-preview",
  "status": "completed",
  "object": "interaction",
  "created": "2025-11-26T12:25:15Z",
  "updated": "2025-11-26T12:25:15Z",
  "role": "model",
  "outputs": [
    {
      "type": "text",
      "text": "I'm doing great, thank you for asking! How can I help you today?"
    }
  ]
}

删除互动

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

按 ID 删除互动。

路径 / 查询参数

id string  (必需)

要删除的互动的唯一标识符。

api_version string  (选填)

要使用的 API 版本。

响应

如果成功,则响应为空。

删除互动

取消互动

post https://generativelanguage.googleapis.com/v1beta/interactions/{id}/cancel

按 ID 取消互动。这仅适用于仍在运行的后台互动。

路径 / 查询参数

id string  (必需)

要取消的互动的唯一标识符。

api_version string  (选填)

要使用的 API 版本。

响应

返回 Interaction 资源。

取消互动

示例响应

{
  "id": "v1_ChdPU0F4YWFtNkFwS2kxZThQZ05lbXdROBIXT1NBeGFhbTZBcEtpMWU4UGdOZW13UTg",
  "agent": "deep-research-pro-preview-12-2025",
  "status": "cancelled",
  "object": "interaction",
  "created": "2025-11-26T12:25:15Z",
  "updated": "2025-11-26T12:25:15Z",
  "role": "agent"
}

资源

互动

Interaction 资源。

字段

model ModelOption  (可选)

用于生成互动的 `Model` 的名称。

可能的值:

  • gemini-2.5-computer-use-preview-10-2025

    一种旨在实现直接界面交互的智能体功能模型,可让 Gemini 感知和浏览数字环境。

  • gemini-2.5-flash

    我们的首款混合推理模型,支持 100 万个 token 的上下文窗口,并具有思考预算。

  • gemini-2.5-flash-image

    我们的原生图片生成模型,在速度、灵活性和上下文理解方面经过优化。文本输入和输出的定价与 2.5 Flash 相同。

  • gemini-2.5-flash-lite

    Google 旗下最小巧且最具成本效益的模型,专为大规模使用而打造。

  • gemini-2.5-flash-lite-preview-09-2025

    基于 Gemini 2.5 Flash Lite 的最新模型,经过优化,可实现高成本效益、高吞吐量和高画质。

  • gemini-2.5-flash-native-audio-preview-12-2025

    我们的原生音频模型经过优化,可提供更高质量的音频输出,并能更好地控制语速、声音自然度、表达详略和情绪。

  • gemini-2.5-flash-preview-09-2025

    基于 2.5 Flash 模型的最新模型。2.5 Flash 预览版最适合大规模处理、低延迟、高数据量任务,以及智能体应用场景。

  • gemini-2.5-flash-preview-tts

    我们的 2.5 Flash 文字转语音模型经过优化,可生成强大的低延迟可控语音。

  • gemini-2.5-pro

    Google 旗下先进的多用途模型,擅长处理编码和复杂的推理任务。

  • gemini-2.5-pro-preview-tts

    我们的 2.5 Pro 文字转语音音频模型经过优化,可实现强大的低延迟语音生成,从而提供更自然的输出,并更轻松地引导提示。

  • gemini-3-flash-preview

    我们打造的最智能的模型,专为速度而生,将前沿智能技术与出色的搜索和事实依据能力相结合。

  • gemini-3-pro-image-preview

    先进的图片生成和编辑模型。

  • gemini-3-pro-preview

    我们最为智能的模型,在推理和多模态理解方面表现卓越,并具备强大的智能体和氛围编程 (vibe coding) 功能。

  • gemini-3.1-pro-preview

    我们最新的 SOTA 推理模型,具有前所未有的深度和细致度,以及强大的多模态理解和编码能力。

  • gemini-3.1-flash-image-preview

    专业级视觉智能,兼具闪电级效率和贴近现实的生成能力。

  • gemini-3.1-flash-lite-preview

    Google 旗下最具成本效益的模型,针对高容量智能体任务、翻译和简单的数据处理进行了优化。

  • gemini-3.1-flash-tts-preview

    Gemini 3.1 Flash TTS:功能强大,可生成低延迟的语音。享受自然流畅的输出、可控的提示,以及用于精确控制旁白的新颖的表达性音频标记。

  • lyria-3-clip-preview

    我们的低延迟音乐生成模型经过优化,可生成高保真音频片段并实现精准的节奏控制。

  • lyria-3-pro-preview

    我们先进的全曲生成模型,具有深厚的作曲理解能力,经过优化,可实现精准的结构控制,并在各种音乐风格之间实现复杂的过渡。

将完成提示的模型。\n\n 如需了解详情,请参阅 [模型](https://ai.google.dev/gemini-api/docs/models)。

agent AgentOption  (可选)

用于生成互动的“代理”的名称。

可能的值:

  • deep-research-pro-preview-12-2025

    Gemini Deep Research Agent

  • deep-research-preview-04-2026

    Gemini Deep Research Agent

  • deep-research-max-preview-04-2026

    Gemini Deep Research Max Agent

要与之互动的代理。

id string  (选填)

必需。仅限输出。互动完成的唯一标识符。

状态 枚举(字符串)  (选填)

必需。仅限输出。互动的状态。

可能的值:

  • in_progress
  • requires_action
  • completed
  • failed
  • cancelled
  • incomplete
创建 字符串  (选填)

必需。仅限输出。回答的创建时间,采用 ISO 8601 格式 (YYYY-MM-DDThh:mm:ssZ)。

更新 字符串  (选填)

必需。仅限输出。回答的上次更新时间,采用 ISO 8601 格式 (YYYY-MM-DDThh:mm:ssZ)。

角色 字符串  (选填)

仅限输出。互动的角色。

outputs 数组(内容  (可选)

仅限输出。模型给出的回答。

system_instruction string  (可选)

互动方面的系统指令。

tools 数组 (Tool)  (可选)

模型在互动期间可能会调用的工具声明列表。

使用情况 使用情况  (可选)

仅限输出。互动请求的令牌使用情况统计信息。

互动请求的令牌使用情况统计信息。

字段

total_input_tokens integer  (可选)

提示(上下文)中的 token 数量。

input_tokens_by_modality ModalityTokens  (可选)

按模态划分的输入令牌用量细分。

单个回答模态的 token 数。

字段

modality ResponseModality  (可选)

与令牌数量关联的模态。

可能的值:

  • text
  • image
  • audio
  • video
  • document

token 整数  (可选)

模态的令牌数量。

total_cached_tokens integer  (可选)

提示的缓存部分(即缓存的内容)中的 token 数量。

cached_tokens_by_modality ModalityTokens  (可选)

按模态划分的缓存令牌使用情况细分。

单个回答模态的 token 数。

字段

modality ResponseModality  (可选)

与令牌数量关联的模态。

可能的值:

  • text
  • image
  • audio
  • video
  • document

token 整数  (可选)

模态的令牌数量。

total_output_tokens integer  (可选)

所有生成的回答中的 token 总数。

output_tokens_by_modality ModalityTokens  (可选)

按模态划分的输出 token 用量细分。

单个回答模态的 token 数。

字段

modality ResponseModality  (可选)

与令牌数量关联的模态。

可能的值:

  • text
  • image
  • audio
  • video
  • document

token 整数  (可选)

模态的令牌数量。

total_tool_use_tokens integer  (可选)

工具使用提示中的 token 数量。

tool_use_tokens_by_modality ModalityTokens  (可选)

按模态划分的工具使用情况令牌用量细分。

单个回答模态的 token 数。

字段

modality ResponseModality  (可选)

与令牌数量关联的模态。

可能的值:

  • text
  • image
  • audio
  • video
  • document

token 整数  (可选)

模态的令牌数量。

total_thought_tokens integer  (可选)

思考模型的想法的令牌数量。

total_tokens integer  (可选)

互动请求(提示 + 回答 + 其他内部 token)的总 token 数。

response_modalities ResponseModality  (可选)

请求的回答模态(TEXT、IMAGE、AUDIO)。

可能的值:

  • text
  • image
  • audio
  • video
  • document

response_format object  (可选)

强制生成的回答是符合此字段中指定的 JSON 架构的 JSON 对象。

response_mime_type string  (可选)

响应的 MIME 类型。如果设置了 response_format,则必须设置此字段。

previous_interaction_id string  (可选)

上一次互动的 ID(如果有)。

service_tier enum (string)  (选填)

互动的服务层级。

可能的值:

  • flex
  • standard
  • priority
input 内容或数组(内容)或数组(对话轮次)或字符串  (可选)

互动的输入。

agent_config object  (可选)

代理互动的配置参数。

可能的类型

多态鉴别器:type

DynamicAgentConfig

动态代理的配置。

type object  (必需)

没有提供说明。

一律设置为 "dynamic"

DeepResearchAgentConfig

Deep Research 代理的配置。

type object  (必需)

没有提供说明。

一律设置为 "deep-research"

thinking_summaries ThinkingSummaries  (可选)

是否在回答中包含思维总结。

可能的值:

  • auto
  • none

可视化图表 枚举(字符串)  (可选)

是否在回答中包含可视化图表。

可能的值:

  • off
  • auto
collaborative_planning boolean  (可选)

为 Deep Research 智能体启用人机协同规划。如果设置为 true,Deep Research 智能体将在其回答中提供研究计划。然后,只有在用户在下一轮对话中确认方案后,代理才会继续。

示例

示例

{
  "created": "2025-12-04T15:01:45Z",
  "id": "v1_ChdXS0l4YWZXTk9xbk0xZThQczhEcmlROBIXV0tJeGFmV05PcW5NMWU4UHM4RHJpUTg",
  "model": "gemini-3-flash-preview",
  "object": "interaction",
  "outputs": [
    {
      "text": "Hello! I'm doing well, functioning as expected. Thank you for asking! How are you doing today?",
      "type": "text"
    }
  ],
  "role": "model",
  "status": "completed",
  "updated": "2025-12-04T15:01:45Z",
  "usage": {
    "input_tokens_by_modality": [
      {
        "modality": "text",
        "tokens": 7
      }
    ],
    "total_cached_tokens": 0,
    "total_input_tokens": 7,
    "total_output_tokens": 23,
    "total_thought_tokens": 49,
    "total_tokens": 79,
    "total_tool_use_tokens": 0
  }
}

数据模型

内容

回答的内容。

可能的类型

多态鉴别器:type

TextContent

文本内容块。

type object  (必需)

没有提供说明。

一律设置为 "text"

文本 字符串  (必填)

必需。文本内容。

注释 注释  (可选)

模型生成的内容的引用信息。

模型生成的内容的引用信息。

可能的类型

多态鉴别器:type

UrlCitation

网址引用注释。

type object  (必需)

没有提供说明。

一律设置为 "url_citation"

url string  (选填)

网址。

标题 字符串  (选填)

相应网址的标题。

start_index integer  (可选)

归因于相应来源的响应部分的起始位置。 索引指示段落的开始,以字节为单位衡量。

end_index integer  (可选)

归因段落的结束,不包括此索引。

FileCitation

文件引用注释。

type object  (必需)

没有提供说明。

一律设置为 "file_citation"

document_uri 字符串  (可选)

文件的 URI。

file_name string  (可选)

相应文件的名称。

source string  (选填)

文本部分的归因来源。

start_index integer  (可选)

归因于相应来源的响应部分的起始位置。 索引指示段落的开始,以字节为单位衡量。

end_index integer  (可选)

归因段落的结束,不包括此索引。

PlaceCitation

地点引用注释。

type object  (必需)

没有提供说明。

一律设置为 "place_citation"

place_id string  (选填)

地点的 ID,格式为 `places/{place_id}`。

名称 字符串  (可选)

地点的标题。

url string  (选填)

地点的 URI 引用。

review_snippets ReviewSnippet  (可选)

用于生成有关 Google 地图中指定地点的特征的回答的评价摘要。

封装了用户评价的一段内容,其中回答了有关 Google 地图中特定地点的功能的问题。

字段

标题 字符串  (选填)

评价的标题。

url string  (选填)

与 Google 地图上的用户评价对应的链接。

review_id 字符串  (选填)

评价摘要的 ID。

start_index integer  (可选)

归因于相应来源的响应部分的起始位置。 索引指示段落的开始,以字节为单位衡量。

end_index integer  (可选)

归因段落的结束,不包括此索引。

ImageContent

图片内容块。

type object  (必需)

没有提供说明。

一律设置为 "image"

data string  (选填)

图片内容。

uri string  (选填)

图片的 URI。

mime_type enum (string)  (选填)

图片的 MIME 类型。

可能的值:

  • image/png
  • image/jpeg
  • image/webp
  • image/heic
  • image/heif
  • image/gif
  • image/bmp
  • image/tiff
分辨率 MediaResolution  (可选)

媒体的分辨率。

可能的值:

  • low
  • medium
  • high
  • ultra_high

AudioContent

音频内容块。

type object  (必需)

没有提供说明。

一律设置为 "audio"

data string  (选填)

音频内容。

uri string  (选填)

音频的 URI。

mime_type enum (string)  (选填)

音频的 MIME 类型。

可能的值:

  • audio/wav
  • audio/mp3
  • audio/aiff
  • audio/aac
  • audio/ogg
  • audio/flac
  • audio/mpeg
  • audio/m4a
  • audio/l16
  • audio/opus
  • audio/alaw
  • audio/mulaw
rate integer  (可选)

音频的采样率。

channels integer  (可选)

音频声道数。

DocumentContent

文档内容块。

type object  (必需)

没有提供说明。

一律设置为 "document"

data string  (选填)

文档内容。

uri string  (选填)

文档的 URI。

mime_type enum (string)  (选填)

文档的 MIME 类型。

可能的值:

  • application/pdf
VideoContent

视频内容块。

type object  (必需)

没有提供说明。

一律设置为 "video"

data string  (选填)

视频内容。

uri string  (选填)

视频的 URI。

mime_type enum (string)  (选填)

视频的 MIME 类型。

可能的值:

  • video/mp4
  • video/mpeg
  • video/mpg
  • video/mov
  • video/avi
  • video/x-flv
  • video/webm
  • video/wmv
  • video/3gpp
分辨率 MediaResolution  (可选)

媒体的分辨率。

可能的值:

  • low
  • medium
  • high
  • ultra_high

ThoughtContent

一个想法内容块。

type object  (必需)

没有提供说明。

一律设置为 "thought"

签名 字符串  (选填)

与要纳入生成内容的后端来源相匹配的签名。

总结 ThoughtSummaryContent  (可选)

想法的总结。

可能的类型

多态鉴别器:type

TextContent

文本内容块。

type object  (必需)

没有提供说明。

一律设置为 "text"

文本 字符串  (必填)

必需。文本内容。

注释 注释  (可选)

模型生成的内容的引用信息。

模型生成的内容的引用信息。

可能的类型

多态鉴别器:type

UrlCitation

网址引用注释。

type object  (必需)

没有提供说明。

一律设置为 "url_citation"

url string  (选填)

网址。

标题 字符串  (选填)

相应网址的标题。

start_index integer  (可选)

归因于相应来源的响应部分的起始位置。 索引指示段落的开始,以字节为单位衡量。

end_index integer  (可选)

归因段落的结束,不包括此索引。

FileCitation

文件引用注释。

type object  (必需)

没有提供说明。

一律设置为 "file_citation"

document_uri 字符串  (可选)

文件的 URI。

file_name string  (可选)

相应文件的名称。

source string  (选填)

文本部分的归因来源。

start_index integer  (可选)

归因于相应来源的响应部分的起始位置。 索引指示段落的开始,以字节为单位衡量。

end_index integer  (可选)

归因段落的结束,不包括此索引。

PlaceCitation

地点引用注释。

type object  (必需)

没有提供说明。

一律设置为 "place_citation"

place_id string  (选填)

地点的 ID,格式为 `places/{place_id}`。

名称 字符串  (可选)

地点的标题。

url string  (选填)

地点的 URI 引用。

review_snippets ReviewSnippet  (可选)

用于生成有关 Google 地图中指定地点的特征的回答的评价摘要。

封装了用户评价的一段内容,其中回答了有关 Google 地图中特定地点的功能的问题。

字段

标题 字符串  (选填)

评价的标题。

url string  (选填)

与 Google 地图上的用户评价对应的链接。

review_id 字符串  (选填)

评价摘要的 ID。

start_index integer  (可选)

归因于相应来源的响应部分的起始位置。 索引指示段落的开始,以字节为单位衡量。

end_index integer  (可选)

归因段落的结束,不包括此索引。

ImageContent

图片内容块。

type object  (必需)

没有提供说明。

一律设置为 "image"

data string  (选填)

图片内容。

uri string  (选填)

图片的 URI。

mime_type enum (string)  (选填)

图片的 MIME 类型。

可能的值:

  • image/png
  • image/jpeg
  • image/webp
  • image/heic
  • image/heif
  • image/gif
  • image/bmp
  • image/tiff
分辨率 MediaResolution  (可选)

媒体的分辨率。

可能的值:

  • low
  • medium
  • high
  • ultra_high

FunctionCallContent

函数工具调用内容块。

type object  (必需)

没有提供说明。

一律设置为 "function_call"

name string  (必填)

必需。要调用的工具的名称。

实参 对象  (必需)

必需。要传递给函数的实参。

id string  (必需)

必需。此特定工具调用的唯一 ID。

签名 字符串  (选填)

用于后端验证的签名哈希。

CodeExecutionCallContent

代码执行内容。

type object  (必需)

没有提供说明。

一律设置为 "code_execution_call"

实参 CodeExecutionCallArguments  (必需)

必需。要传递给代码执行的实参。

要传递给代码执行的实参。

字段

language enum (string)  (选填)

相应 `code` 的编程语言。

可能的值:

  • python
代码 字符串  (选填)

要执行的代码。

id string  (必需)

必需。此特定工具调用的唯一 ID。

签名 字符串  (选填)

用于后端验证的签名哈希。

UrlContextCallContent

网址上下文内容。

type object  (必需)

没有提供说明。

一律设置为 "url_context_call"

实参 UrlContextCallArguments  (必需)

必需。要传递给网址上下文的实参。

要传递给网址上下文的实参。

字段

urls array (string)  (选填)

要提取的网址。

id string  (必需)

必需。此特定工具调用的唯一 ID。

签名 字符串  (选填)

用于后端验证的签名哈希。

McpServerToolCallContent

MCPServer 工具调用内容。

type object  (必需)

没有提供说明。

一律设置为 "mcp_server_tool_call"

name string  (必填)

必需。被调用的工具的名称。

server_name string  (必需)

必需。所用 MCP 服务器的名称。

实参 对象  (必需)

必需。函数的实参 JSON 对象。

id string  (必需)

必需。此特定工具调用的唯一 ID。

签名 字符串  (选填)

用于后端验证的签名哈希。

GoogleSearchCallContent

Google 搜索内容。

type object  (必需)

没有提供说明。

一律设置为 "google_search_call"

实参 GoogleSearchCallArguments  (必需)

必需。要传递给 Google 搜索的实参。

要传递给 Google 搜索的实参。

字段

查询 数组(字符串)  (选填)

后续网络搜索的网页搜索查询。

search_type enum (string)  (选填)

已启用的搜索接地类型。

可能的值:

  • web_search
  • image_search
  • enterprise_web_search
id string  (必需)

必需。此特定工具调用的唯一 ID。

签名 字符串  (选填)

用于后端验证的签名哈希。

FileSearchCallContent

文件搜索内容。

type object  (必需)

没有提供说明。

一律设置为 "file_search_call"

id string  (必需)

必需。此特定工具调用的唯一 ID。

签名 字符串  (选填)

用于后端验证的签名哈希。

GoogleMapsCallContent

Google 地图内容。

type object  (必需)

没有提供说明。

一律设置为 "google_maps_call"

arguments GoogleMapsCallArguments  (可选)

要传递给 Google 地图工具的实参。

要传递给 Google 地图工具的实参。

字段

查询 数组(字符串)  (选填)

要执行的查询。

id string  (必需)

必需。此特定工具调用的唯一 ID。

签名 字符串  (选填)

用于后端验证的签名哈希。

FunctionResultContent

函数工具结果内容块。

type object  (必需)

没有提供说明。

一律设置为 "function_result"

名称 字符串  (可选)

所调用工具的名称。

is_error boolean  (选填)

工具调用是否导致了错误。

call_id string  (必需)

必需。用于与函数调用块中的 ID 相匹配的 ID。

签名 字符串  (选填)

用于后端验证的签名哈希。

result array (FunctionResultSubcontent) or string  (required)

工具调用的结果。

CodeExecutionResultContent

代码执行结果内容。

type object  (必需)

没有提供说明。

一律设置为 "code_execution_result"

结果 字符串  (必需)

必需。代码执行的输出。

is_error boolean  (选填)

代码执行是否导致了错误。

call_id string  (必需)

必需。用于与函数调用块中的 ID 相匹配的 ID。

签名 字符串  (选填)

用于后端验证的签名哈希。

UrlContextResultContent

网址上下文结果内容。

type object  (必需)

没有提供说明。

一律设置为 "url_context_result"

result UrlContextResult  (必需)

必需。网址上下文的结果。

网址上下文的结果。

字段

url string  (选填)

提取的网址。

状态 枚举(字符串)  (选填)

网址检索的状态。

可能的值:

  • success
  • error
  • paywall
  • unsafe
is_error boolean  (选填)

网址上下文是否导致了错误。

call_id string  (必需)

必需。用于与函数调用块中的 ID 相匹配的 ID。

签名 字符串  (选填)

用于后端验证的签名哈希。

GoogleSearchResultContent

Google 搜索结果内容。

type object  (必需)

没有提供说明。

一律设置为 "google_search_result"

result GoogleSearchResult  (必需)

必需。Google 搜索的结果。

Google 搜索的结果。

字段

search_suggestions string  (可选)

可嵌入网页或应用 WebView 中的 Web 内容代码段。

is_error boolean  (选填)

Google 搜索是否导致了错误。

call_id string  (必需)

必需。用于与函数调用块中的 ID 相匹配的 ID。

签名 字符串  (选填)

用于后端验证的签名哈希。

McpServerToolResultContent

MCPServer 工具结果内容。

type object  (必需)

没有提供说明。

一律设置为 "mcp_server_tool_result"

名称 字符串  (可选)

相应工具调用的工具名称。

server_name string  (选填)

所用 MCP 服务器的名称。

call_id string  (必需)

必需。用于与函数调用块中的 ID 相匹配的 ID。

签名 字符串  (选填)

用于后端验证的签名哈希。

result array (FunctionResultSubcontent) or string  (required)

MCP 服务器调用的输出。可以是纯文本,也可以是富媒体内容。

FileSearchResultContent

文件搜索结果内容。

type object  (必需)

没有提供说明。

一律设置为 "file_search_result"

result FileSearchResult  (必需)

必需。文件搜索的结果。

文件搜索的结果。

字段

custom_metadata array (object)  (可选)

用户提供的有关 FileSearchResult 的元数据。

call_id string  (必需)

必需。用于与函数调用块中的 ID 相匹配的 ID。

签名 字符串  (选填)

用于后端验证的签名哈希。

GoogleMapsResultContent

Google 地图搜索结果内容。

type object  (必需)

没有提供说明。

一律设置为 "google_maps_result"

result GoogleMapsResult  (必需)

必需。Google 地图的搜索结果。

Google 地图的结果。

字段

地点 地点  (可选)

找到的地点。

字段

place_id string  (选填)

地点的 ID,格式为 `places/{place_id}`。

名称 字符串  (可选)

地点的标题。

url string  (选填)

地点的 URI 引用。

review_snippets ReviewSnippet  (可选)

用于生成有关 Google 地图中指定地点的特征的回答的评价摘要。

封装了用户评价的一段内容,其中回答了有关 Google 地图中特定地点的功能的问题。

字段

标题 字符串  (选填)

评价的标题。

url string  (选填)

与 Google 地图上的用户评价对应的链接。

review_id 字符串  (选填)

评价摘要的 ID。

widget_context_token string  (选填)

Google 地图 widget 上下文令牌的资源名称。

call_id string  (必需)

必需。用于与函数调用块中的 ID 相匹配的 ID。

签名 字符串  (选填)

用于后端验证的签名哈希。

示例

文本

{
  "type": "text",
  "text": "Hello, how are you?"
}

图片

{
  "type": "image",
  "data": "BASE64_ENCODED_IMAGE",
  "mime_type": "image/png"
}

音频

{
  "type": "audio",
  "data": "BASE64_ENCODED_AUDIO",
  "mime_type": "audio/wav"
}

文档

{
  "type": "document",
  "data": "BASE64_ENCODED_DOCUMENT",
  "mime_type": "application/pdf"
}

视频

{
  "type": "video",
  "uri": "https://www.youtube.com/watch?v=9hE5-98ZeCg"
}

思考

{
  "type": "thought",
  "summary": [
    {
      "type": "text",
      "text": "The user is asking about the weather. I should use the get_weather tool."
    }
  ],
  "signature": "CoMDAXLI2nynRYojJIy6B1Jh9os2crpWLfB0+19xcLsGG46bd8wjkF/6RNlRUdvHrXyjsHkG0BZFcuO/bPOyA6Xh5jANNgx82wPHjGExN8A4ZQn56FlMwyZoqFVQz0QyY1lfibFJ2zU3J87uw26OewzcuVX0KEcs+GIsZa3EA6WwqhbsOd3wtZB3Ua2Qf98VAWZTS5y/tWpql7jnU3/CU7pouxQr/Bwft3hwnJNesQ9/dDJTuaQ8Zprh9VRWf1aFFjpIueOjBRrlT3oW6/y/eRl/Gt9BQXCYTqg/38vHFUU4Wo/d9dUpvfCe/a3o97t2Jgxp34oFKcsVb4S5WJrykIkw+14DzVnTpCpbQNFckqvFLuqnJCkL0EQFtunBXI03FJpPu3T1XU6id8S7ojoJQZSauGUCgmaLqUGdMrd08oo81ecoJSLs51Re9N/lISGmjWFPGpqJLoGq6uo4FHz58hmeyXCgHG742BHz2P3MiH1CXHUT2J8mF6zLhf3SR9Qb3lkrobAh"
}

函数调用

{
  "type": "function_call",
  "name": "get_weather",
  "id": "gth23981",
  "arguments": {
    "location": "Boston, MA"
  }
}

代码执行调用

{
  "type": "code_execution_call",
  "id": "call_123456",
  "arguments": {
    "language": "python",
    "code": "print('hello world')"
  }
}

网址上下文调用

{
  "type": "url_context_call",
  "id": "call_123456",
  "arguments": {
    "urls": [
      "https://www.example.com"
    ]
  }
}

MCP 服务器工具调用

{
  "type": "mcp_server_tool_call",
  "id": "call_123456",
  "name": "get_forecast",
  "server_name": "weather_server",
  "arguments": {
    "city": "London"
  }
}

Google 搜索通话

{
  "type": "google_search_call",
  "id": "call_123456",
  "arguments": {
    "queries": [
      "weather in Boston"
    ]
  }
}

文件搜索调用

{
  "type": "file_search_call",
  "id": "call_123456"
}

Google 地图通话

{
  "type": "google_maps_call",
  "id": "call_123456",
  "arguments": {
    "query": "best food near me"
  }
}

函数结果

{
  "type": "function_result",
  "name": "get_weather",
  "call_id": "gth23981",
  "result": [
    {
      "type": "text",
      "text": "{\"weather\":\"sunny\"}"
    }
  ]
}

代码执行结果

{
  "type": "code_execution_result",
  "call_id": "call_123456",
  "result": "hello world"
}

网址上下文结果

{
  "type": "url_context_result",
  "call_id": "call_123456",
  "result": [
    {
      "url": "https://www.example.com",
      "status": "SUCCESS"
    }
  ]
}

Google 搜索结果

{
  "type": "google_search_result",
  "call_id": "call_123456",
  "result": [
    {
      "url": "https://www.google.com/search?q=weather+in+Boston",
      "title": "Weather in Boston"
    }
  ]
}

MCP 服务器工具结果

{
  "type": "mcp_server_tool_result",
  "name": "get_forecast",
  "server_name": "weather_server",
  "call_id": "call_123456",
  "result": "sunny"
}

文件搜索结果

{
  "type": "file_search_result",
  "call_id": "call_123456",
  "result": [
    {
      "text": "search result chunk",
      "file_search_store": "file_search_store"
    }
  ]
}

Google 地图结果

{
  "type": "google_maps_result",
  "call_id": "call_123456",
  "result": [
    {
      "places": [
        {
          "url": "https://www.google.com/maps/search/best+food+near+me",
          "name": "Tasty Restaurant"
        }
      ]
    }
  ]
}

工具

可供模型使用的工具。

可能的类型

多态鉴别器:type

函数

可供模型使用的工具。

type object  (必需)

没有提供说明。

一律设置为 "function"

名称 字符串  (可选)

函数的名称。

说明 字符串  (选填)

函数的说明。

参数 对象  (可选)

函数的参数的 JSON 架构。

CodeExecution

一种可供模型用来执行代码的工具。

type object  (必需)

没有提供说明。

一律设置为 "code_execution"

UrlContext

一种可供模型用来提取网址上下文的工具。

type object  (必需)

没有提供说明。

一律设置为 "url_context"

ComputerUse

一种可供模型用于与计算机互动的工具。

type object  (必需)

没有提供说明。

一律设置为 "computer_use"

environment enum (string)  (选填)

正在运行的环境。

可能的值:

  • browser
excludedPredefinedFunctions array (string)  (可选)

从模型调用中排除的预定义函数列表。

McpServer

MCPServer 是可由模型调用以执行操作的服务器。

type object  (必需)

没有提供说明。

一律设置为 "mcp_server"

名称 字符串  (可选)

MCPServer 的名称。

url string  (选填)

MCPServer 端点的完整网址。 示例:“https://api.example.com/mcp”

headers object  (可选)

可选:身份验证标头、超时等字段(如果需要)。

allowed_tools AllowedTools  (可选)

允许使用的工具。

允许的工具的配置。

字段

mode ToolChoiceType  (可选)

工具选择的模式。

可能的值:

  • auto
  • any
  • none
  • validated

工具 数组(字符串)  (可选)

允许使用的工具的名称。

GoogleSearch

模型可用于搜索 Google 的工具。

type object  (必需)

没有提供说明。

一律设置为 "google_search"

search_types 数组(枚举 [字符串])  (可选)

要启用的搜索接地类型。

可能的值:

  • web_search
  • image_search
  • enterprise_web_search
FileSearch

一种可供模型用来搜索文件的工具。

type object  (必需)

没有提供说明。

一律设置为 "file_search"

file_search_store_names 数组(字符串)  (可选)

要搜索的文件搜索存储区名称。

top_k integer  (可选)

要检索的语义检索块数量。

metadata_filter string  (可选)

要应用于语义检索文档和块的元数据过滤条件。

GoogleMaps

一种可供模型用来调用 Google 地图的工具。

type object  (必需)

没有提供说明。

一律设置为 "google_maps"

enable_widget 布尔值  (选填)

是否在响应的工具调用结果中返回 widget 上下文令牌。

latitude number  (optional)

用户所在位置的纬度。

longitude number  (可选)

用户所在位置的经度。

检索

一种可供模型用来检索文件的工具。

type object  (必需)

没有提供说明。

一律设置为 "retrieval"

retrieval_types 数组(枚举 [字符串])  (选填)

要启用的文件检索类型。

可能的值:

  • vertex_ai_search
vertex_ai_search_config VertexAISearchConfig  (可选)

用于指定 VertexAISearch 的配置。

用于指定 VertexAISearch 的配置。

字段

引擎 字符串  (选填)

可选。用于指定 Vertex AI Search 引擎。

datastores 数组(字符串)  (选填)

可选。用于指定 Vertex AI Search 数据存储区。

示例

函数

CodeExecution

UrlContext

ComputerUse

McpServer

GoogleSearch

FileSearch

GoogleMaps

检索

此类型没有可用的示例。

Turn

字段

角色 字符串  (选填)

相应回合的发起者。对于输入,必须为“user”;对于模型输出,必须为“model”。

content 数组(内容)或字符串  (可选)

没有提供说明。

示例

用户回合

{
  "role": "user",
  "content": [
    {
      "type": "text",
      "text": "user turn"
    }
  ]
}

模型旋转

{
  "role": "model",
  "content": [
    {
      "type": "text",
      "text": "model turn"
    }
  ]
}

InteractionSseEvent

可能的类型

多态鉴别器:event_type

InteractionStartEvent

event_type object  (必需)

没有提供说明。

一律设置为 "interaction.start"

互动 互动  (必需)

没有提供说明。

event_id string  (选填)

用于从相应事件恢复互动流的 event_id 令牌。

InteractionCompleteEvent

event_type object  (必需)

没有提供说明。

一律设置为 "interaction.complete"

互动 互动  (必需)

必需。已完成的互动,输出为空,以减少载荷大小。 使用上述 ContentDelta 事件作为实际输出。

event_id string  (选填)

用于从相应事件恢复互动流的 event_id 令牌。

InteractionStatusUpdate

event_type object  (必需)

没有提供说明。

一律设置为 "interaction.status_update"

interaction_id string  (必需)

没有提供说明。

状态 枚举(字符串)  (必需)

没有提供说明。

可能的值:

  • in_progress
  • requires_action
  • completed
  • failed
  • cancelled
  • incomplete
event_id string  (选填)

用于从相应事件恢复互动流的 event_id 令牌。

ContentStart

event_type object  (必需)

没有提供说明。

一律设置为 "content.start"

index integer  (必需)

没有提供说明。

内容 内容  (必需)

没有提供说明。

event_id string  (选填)

用于从相应事件恢复互动流的 event_id 令牌。

ContentDelta

event_type object  (必需)

没有提供说明。

一律设置为 "content.delta"

index integer  (必需)

没有提供说明。

delta ContentDeltaData  (必需)

没有提供说明。

内容块的增量内容数据。

可能的类型

多态鉴别器:type

TextDelta

type object  (必需)

没有提供说明。

一律设置为 "text"

文本 字符串  (必填)

没有提供说明。

ImageDelta

type object  (必需)

没有提供说明。

一律设置为 "image"

data string  (选填)

没有提供说明。

uri string  (选填)

没有提供说明。

mime_type enum (string)  (选填)

没有提供说明。

可能的值:

  • image/png
  • image/jpeg
  • image/webp
  • image/heic
  • image/heif
  • image/gif
  • image/bmp
  • image/tiff
分辨率 MediaResolution  (可选)

媒体的分辨率。

可能的值:

  • low
  • medium
  • high
  • ultra_high

AudioDelta

type object  (必需)

没有提供说明。

一律设置为 "audio"

data string  (选填)

没有提供说明。

uri string  (选填)

没有提供说明。

mime_type enum (string)  (选填)

没有提供说明。

可能的值:

  • audio/wav
  • audio/mp3
  • audio/aiff
  • audio/aac
  • audio/ogg
  • audio/flac
  • audio/mpeg
  • audio/m4a
  • audio/l16
  • audio/opus
  • audio/alaw
  • audio/mulaw
rate integer  (可选)

音频的采样率。

channels integer  (可选)

音频声道数。

DocumentDelta

type object  (必需)

没有提供说明。

一律设置为 "document"

data string  (选填)

没有提供说明。

uri string  (选填)

没有提供说明。

mime_type enum (string)  (选填)

没有提供说明。

可能的值:

  • application/pdf
VideoDelta

type object  (必需)

没有提供说明。

一律设置为 "video"

data string  (选填)

没有提供说明。

uri string  (选填)

没有提供说明。

mime_type enum (string)  (选填)

没有提供说明。

可能的值:

  • video/mp4
  • video/mpeg
  • video/mpg
  • video/mov
  • video/avi
  • video/x-flv
  • video/webm
  • video/wmv
  • video/3gpp
分辨率 MediaResolution  (可选)

媒体的分辨率。

可能的值:

  • low
  • medium
  • high
  • ultra_high

ThoughtSummaryDelta

type object  (必需)

没有提供说明。

一律设置为 "thought_summary"

content ThoughtSummaryContent  (可选)

要添加到想法中的新总结项。

可能的类型

多态鉴别器:type

TextContent

文本内容块。

type object  (必需)

没有提供说明。

一律设置为 "text"

文本 字符串  (必填)

必需。文本内容。

注释 注释  (可选)

模型生成的内容的引用信息。

模型生成的内容的引用信息。

可能的类型

多态鉴别器:type

UrlCitation

网址引用注释。

type object  (必需)

没有提供说明。

一律设置为 "url_citation"

url string  (选填)

网址。

标题 字符串  (选填)

相应网址的标题。

start_index integer  (可选)

归因于相应来源的响应部分的起始位置。 索引指示段落的开始,以字节为单位衡量。

end_index integer  (可选)

归因段落的结束,不包括此索引。

FileCitation

文件引用注释。

type object  (必需)

没有提供说明。

一律设置为 "file_citation"

document_uri 字符串  (可选)

文件的 URI。

file_name string  (可选)

相应文件的名称。

source string  (选填)

文本部分的归因来源。

start_index integer  (可选)

归因于相应来源的响应部分的起始位置。 索引指示段落的开始,以字节为单位衡量。

end_index integer  (可选)

归因段落的结束,不包括此索引。

PlaceCitation

地点引用注释。

type object  (必需)

没有提供说明。

一律设置为 "place_citation"

place_id string  (选填)

地点的 ID,格式为 `places/{place_id}`。

名称 字符串  (可选)

地点的标题。

url string  (选填)

地点的 URI 引用。

review_snippets ReviewSnippet  (可选)

用于生成有关 Google 地图中指定地点的特征的回答的评价摘要。

封装了用户评价的一段内容,其中回答了有关 Google 地图中特定地点的功能的问题。

字段

标题 字符串  (选填)

评价的标题。

url string  (选填)

与 Google 地图上的用户评价对应的链接。

review_id 字符串  (选填)

评价摘要的 ID。

start_index integer  (可选)

归因于相应来源的响应部分的起始位置。 索引指示段落的开始,以字节为单位衡量。

end_index integer  (可选)

归因段落的结束,不包括此索引。

ImageContent

图片内容块。

type object  (必需)

没有提供说明。

一律设置为 "image"

data string  (选填)

图片内容。

uri string  (选填)

图片的 URI。

mime_type enum (string)  (选填)

图片的 MIME 类型。

可能的值:

  • image/png
  • image/jpeg
  • image/webp
  • image/heic
  • image/heif
  • image/gif
  • image/bmp
  • image/tiff
分辨率 MediaResolution  (可选)

媒体的分辨率。

可能的值:

  • low
  • medium
  • high
  • ultra_high

ThoughtSignatureDelta

type object  (必需)

没有提供说明。

一律设置为 "thought_signature"

签名 字符串  (选填)

用于匹配要纳入生成范围的后端来源的签名。

FunctionCallDelta

type object  (必需)

没有提供说明。

一律设置为 "function_call"

name string  (必填)

没有提供说明。

实参 对象  (必需)

没有提供说明。

id string  (必需)

必需。此特定工具调用的唯一 ID。

签名 字符串  (选填)

用于后端验证的签名哈希。

CodeExecutionCallDelta

type object  (必需)

没有提供说明。

一律设置为 "code_execution_call"

实参 CodeExecutionCallArguments  (必需)

没有提供说明。

要传递给代码执行的实参。

字段

language enum (string)  (选填)

相应 `code` 的编程语言。

可能的值:

  • python
代码 字符串  (选填)

要执行的代码。

id string  (必需)

必需。此特定工具调用的唯一 ID。

签名 字符串  (选填)

用于后端验证的签名哈希。

UrlContextCallDelta

type object  (必需)

没有提供说明。

一律设置为 "url_context_call"

实参 UrlContextCallArguments  (必需)

没有提供说明。

要传递给网址上下文的实参。

字段

urls array (string)  (选填)

要提取的网址。

id string  (必需)

必需。此特定工具调用的唯一 ID。

签名 字符串  (选填)

用于后端验证的签名哈希。

GoogleSearchCallDelta

type object  (必需)

没有提供说明。

一律设置为 "google_search_call"

实参 GoogleSearchCallArguments  (必需)

没有提供说明。

要传递给 Google 搜索的实参。

字段

查询 数组(字符串)  (选填)

后续网络搜索的网页搜索查询。

id string  (必需)

必需。此特定工具调用的唯一 ID。

签名 字符串  (选填)

用于后端验证的签名哈希。

McpServerToolCallDelta

type object  (必需)

没有提供说明。

一律设置为 "mcp_server_tool_call"

name string  (必填)

没有提供说明。

server_name string  (必需)

没有提供说明。

实参 对象  (必需)

没有提供说明。

id string  (必需)

必需。此特定工具调用的唯一 ID。

签名 字符串  (选填)

用于后端验证的签名哈希。

FileSearchCallDelta

type object  (必需)

没有提供说明。

一律设置为 "file_search_call"

id string  (必需)

必需。此特定工具调用的唯一 ID。

签名 字符串  (选填)

用于后端验证的签名哈希。

GoogleMapsCallDelta

type object  (必需)

没有提供说明。

一律设置为 "google_maps_call"

arguments GoogleMapsCallArguments  (可选)

要传递给 Google 地图工具的实参。

要传递给 Google 地图工具的实参。

字段

查询 数组(字符串)  (选填)

要执行的查询。

id string  (必需)

必需。此特定工具调用的唯一 ID。

签名 字符串  (选填)

用于后端验证的签名哈希。

FunctionResultDelta

type object  (必需)

没有提供说明。

一律设置为 "function_result"

名称 字符串  (可选)

没有提供说明。

is_error boolean  (选填)

没有提供说明。

call_id string  (必需)

必需。用于与函数调用块中的 ID 相匹配的 ID。

签名 字符串  (选填)

用于后端验证的签名哈希。

result array (FunctionResultSubcontent) or string  (required)

没有提供说明。

CodeExecutionResultDelta

type object  (必需)

没有提供说明。

一律设置为 "code_execution_result"

结果 字符串  (必需)

没有提供说明。

is_error boolean  (选填)

没有提供说明。

call_id string  (必需)

必需。用于与函数调用块中的 ID 相匹配的 ID。

签名 字符串  (选填)

用于后端验证的签名哈希。

UrlContextResultDelta

type object  (必需)

没有提供说明。

一律设置为 "url_context_result"

result UrlContextResult  (必需)

没有提供说明。

网址上下文的结果。

字段

url string  (选填)

提取的网址。

状态 枚举(字符串)  (选填)

网址检索的状态。

可能的值:

  • success
  • error
  • paywall
  • unsafe
is_error boolean  (选填)

没有提供说明。

call_id string  (必需)

必需。用于与函数调用块中的 ID 相匹配的 ID。

签名 字符串  (选填)

用于后端验证的签名哈希。

GoogleSearchResultDelta

type object  (必需)

没有提供说明。

一律设置为 "google_search_result"

result GoogleSearchResult  (必需)

没有提供说明。

Google 搜索的结果。

字段

search_suggestions string  (可选)

可嵌入网页或应用 WebView 中的 Web 内容代码段。

is_error boolean  (选填)

没有提供说明。

call_id string  (必需)

必需。用于与函数调用块中的 ID 相匹配的 ID。

签名 字符串  (选填)

用于后端验证的签名哈希。

McpServerToolResultDelta

type object  (必需)

没有提供说明。

一律设置为 "mcp_server_tool_result"

名称 字符串  (可选)

没有提供说明。

server_name string  (选填)

没有提供说明。

call_id string  (必需)

必需。用于与函数调用块中的 ID 相匹配的 ID。

签名 字符串  (选填)

用于后端验证的签名哈希。

result array (FunctionResultSubcontent) or string  (required)

没有提供说明。

FileSearchResultDelta

type object  (必需)

没有提供说明。

一律设置为 "file_search_result"

result FileSearchResult  (必需)

没有提供说明。

文件搜索的结果。

字段

custom_metadata array (object)  (可选)

用户提供的有关 FileSearchResult 的元数据。

call_id string  (必需)

必需。用于与函数调用块中的 ID 相匹配的 ID。

签名 字符串  (选填)

用于后端验证的签名哈希。

GoogleMapsResultDelta

type object  (必需)

没有提供说明。

一律设置为 "google_maps_result"

result GoogleMapsResult  (可选)

Google 地图的搜索结果。

Google 地图的结果。

字段

地点 地点  (可选)

找到的地点。

字段

place_id string  (选填)

地点的 ID,格式为 `places/{place_id}`。

名称 字符串  (可选)

地点的标题。

url string  (选填)

地点的 URI 引用。

review_snippets ReviewSnippet  (可选)

用于生成有关 Google 地图中指定地点的特征的回答的评价摘要。

封装了用户评价的一段内容,其中回答了有关 Google 地图中特定地点的功能的问题。

字段

标题 字符串  (选填)

评价的标题。

url string  (选填)

与 Google 地图上的用户评价对应的链接。

review_id 字符串  (选填)

评价摘要的 ID。

widget_context_token string  (选填)

Google 地图 widget 上下文令牌的资源名称。

call_id string  (必需)

必需。用于与函数调用块中的 ID 相匹配的 ID。

签名 字符串  (选填)

用于后端验证的签名哈希。

TextAnnotationDelta

type object  (必需)

没有提供说明。

一律设置为 "text_annotation"

注释 注释  (可选)

模型生成的内容的引用信息。

模型生成的内容的引用信息。

可能的类型

多态鉴别器:type

UrlCitation

网址引用注释。

type object  (必需)

没有提供说明。

一律设置为 "url_citation"

url string  (选填)

网址。

标题 字符串  (选填)

相应网址的标题。

start_index integer  (可选)

归因于相应来源的响应部分的起始位置。 索引指示段落的开始,以字节为单位衡量。

end_index integer  (可选)

归因段落的结束,不包括此索引。

FileCitation

文件引用注释。

type object  (必需)

没有提供说明。

一律设置为 "file_citation"

document_uri 字符串  (可选)

文件的 URI。

file_name string  (可选)

相应文件的名称。

source string  (选填)

文本部分的归因来源。

start_index integer  (可选)

归因于相应来源的响应部分的起始位置。 索引指示段落的开始,以字节为单位衡量。

end_index integer  (可选)

归因段落的结束,不包括此索引。

PlaceCitation

地点引用注释。

type object  (必需)

没有提供说明。

一律设置为 "place_citation"

place_id string  (选填)

地点的 ID,格式为 `places/{place_id}`。

名称 字符串  (可选)

地点的标题。

url string  (选填)

地点的 URI 引用。

review_snippets ReviewSnippet  (可选)

用于生成有关 Google 地图中指定地点的特征的回答的评价摘要。

封装了用户评价的一段内容,其中回答了有关 Google 地图中特定地点的功能的问题。

字段

标题 字符串  (选填)

评价的标题。

url string  (选填)

与 Google 地图上的用户评价对应的链接。

review_id 字符串  (选填)

评价摘要的 ID。

start_index integer  (可选)

归因于相应来源的响应部分的起始位置。 索引指示段落的开始,以字节为单位衡量。

end_index integer  (可选)

归因段落的结束,不包括此索引。

event_id string  (选填)

用于从相应事件恢复互动流的 event_id 令牌。

ContentStop

event_type object  (必需)

没有提供说明。

一律设置为 "content.stop"

index integer  (必需)

没有提供说明。

event_id string  (选填)

用于从相应事件恢复互动流的 event_id 令牌。

ErrorEvent

event_type object  (必需)

没有提供说明。

一律设置为 "error"

error Error  (optional)

没有提供说明。

互动中的错误消息。

字段

代码 字符串  (选填)

用于标识错误类型的 URI。

message string  (选填)

人类可读的错误消息。

event_id string  (选填)

用于从相应事件恢复互动流的 event_id 令牌。

示例

互动开始

{
  "event_type": "interaction.start",
  "interaction": {
    "id": "v1_ChdTMjQ0YWJ5TUF1TzcxZThQdjRpcnFRcxIXUzI0NGFieU1BdU83MWU4UHY0aXJxUXM",
    "model": "gemini-3-flash-preview",
    "object": "interaction",
    "status": "in_progress"
  }
}

互动完成

{
  "event_type": "interaction.complete",
  "interaction": {
    "created": "2025-12-09T18:45:40Z",
    "id": "v1_ChdTMjQ0YWJ5TUF1TzcxZThQdjRpcnFRcxIXUzI0NGFieU1BdU83MWU4UHY0aXJxUXM",
    "model": "gemini-3-flash-preview",
    "object": "interaction",
    "role": "model",
    "status": "completed",
    "updated": "2025-12-09T18:45:40Z",
    "usage": {
      "input_tokens_by_modality": [
        {
          "modality": "text",
          "tokens": 11
        }
      ],
      "total_cached_tokens": 0,
      "total_input_tokens": 11,
      "total_output_tokens": 364,
      "total_thought_tokens": 1120,
      "total_tokens": 1495,
      "total_tool_use_tokens": 0
    }
  }
}

互动状态更新

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

内容开始

{
  "event_type": "content.start",
  "content": {
    "type": "text"
  },
  "index": 1
}

内容增量

{
  "event_type": "content.delta",
  "delta": {
    "type": "text",
    "text": "Elara\u2019s life was a symphony of quiet moments. A librarian, she found solace in the hushed aisles, the scent of aged paper, and the predictable rhythm of her days. Her small apartment, meticulously ordered, reflected this internal calm, save"
  },
  "index": 1
}

内容停止

{
  "event_type": "content.stop",
  "index": 1
}

错误事件

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