Gemini 官方字段完整对照

此页由 scripts/audit-gemini-docs.mjs 从官方 OpenAPI 快照生成。请通过修改快照并重新生成来更新此页。

对照日期：2026-10-07（北京时间）。范围为保存的官方 OpenAPI 中全部 20 个路径、37 个操作和全部组件：Interactions 创建 / 获取 / 取消 / 删除、agents、voices、environments、webhooks、triggers、credentials 等资源，以及请求、响应、错误和 SSE schema。快照未定义的独立 Files / models API 通过官方后端通用路由转发，使用流程见中文参考详解。

启用 gemini_api 后，官方路由完整转发本页全部字段、联合类型及未来扩展字段，由 Google 校验并执行，响应和 SSE 保留原结构。表内分别列出官方后端的支持情况和网页登录态 / OpenAI 兼容聊天的映射限制。配置与 SDK 示例见 官方后端接入，内部能力见 Gemini 参数与差距。

共覆盖 214 个 schema、722 个字段定义（共享字段按所属 schema 分别计数）、全部联合类型和枚举。自由对象的自定义键由调用方定义，不是可穷举的官方参数。

• 官方 OpenAPI 来源

• 官方 Markdown 来源

• 保存的 OpenAPI 快照

• 保存的官方 Markdown 快照

• 来源日期与校验值

OpenAPI SHA-256：6f3d064c9b711b84e8b71a9a03533aaf1f8ed006adcf7697ffacf8c192baa419。

阅读规则

字段是否必填、只读、废弃均按快照原样呈现；默认值仅在 schema 明确声明时填写。英文描述保留官方原文，中文用途见详解。schema 的 required 与“Output only”可能互相矛盾：尤其 ModelInteraction 的 created/id/status/updated 标为必填却是输出字段，steps 甚至在 required 中但不在 properties 中；这些字段不能据此加入创建请求。schema 与渲染版参考不一致时参阅差距页的待确认项。

端点和路径 / 查询参数

官方认证使用 x-goog-api-key；JSON 请求使用 Content-Type: application/json，SSE 可加 Accept: text/event-stream。这些头来自使用指南，不是请求体属性。Api-Revision 的历史变更见中文详解。

PUT /upload/{api_version}/environments/{environment}/files/{path}

Starts a resumable upload session for a file in an environment workspace. Upload the file bytes to the URL returned in the X-Goog-Upload-URL response header, using the resumable upload protocol.

参数	位置	类型 / 允许值	必填	官方说明	web2api
api_version	path	string	是	API version for request routing.	官方后端完整转发
environment	path	string	是	The ID of the environment that owns the destination file.	官方后端完整转发
path	path	string	是	The relative destination path inside the environment workspace.	官方后端完整转发
extract	query	boolean	否	Optional. If true, treats the uploaded file as a tar/tar.gz archive and unpacks it into path.	官方后端完整转发
overwrite	query	boolean	否	Optional. Whether to overwrite the destination file if it already exists.	官方后端完整转发
X-Goog-Upload-Command	header	"start"	是	Command that starts the resumable upload session.	官方后端完整转发
X-Goog-Upload-Header-Content-Length	header	integer (int64)	是	Total number of file bytes that will be uploaded to the session URL.	官方后端完整转发
X-Goog-Upload-Header-Content-Type	header	string	是	MIME type of the file that will be uploaded to the session URL.	官方后端完整转发
X-Goog-Upload-Protocol	header	"resumable"	是	Resumable upload protocol selector.	官方后端完整转发

请求体：无。

响应：200 Upload session created successfully. Send the file bytes to the returned upload URL.；4XX The upload session request failed with a client error.；5XX The upload session request failed with a server error.。

GET /{api_version}/agents

Lists all Agents.

参数	位置	类型 / 允许值	必填	官方说明	web2api
api_version	path	string	是	API version for request routing.	官方后端完整转发
page_size	query	integer (int32)	否		官方后端完整转发
page_token	query	string	否		官方后端完整转发
parent	query	string	否	Required. The parent resource to list agents from. Format: projects/{project}/locations/{location}	官方后端完整转发

请求体：无。

响应：default application/json → ListAgentsResponse。

POST /{api_version}/agents

Creates a new Agent (Typed version for SDK).

参数	位置	类型 / 允许值	必填	官方说明	web2api
api_version	path	string	是	API version for request routing.	官方后端完整转发

请求体：Agent。

响应：default application/json → Agent。

GET /{api_version}/agents/{agentsId}

Gets a specific Agent.

参数	位置	类型 / 允许值	必填	官方说明	web2api
api_version	path	string	是	API version for request routing.	官方后端完整转发
agentsId	path	string	是	Required. The name of the agent to retrieve.	官方后端完整转发

请求体：无。

响应：default application/json → Agent。

DELETE /{api_version}/agents/{agentsId}

Deletes an Agent.

参数	位置	类型 / 允许值	必填	官方说明	web2api
api_version	path	string	是	API version for request routing.	官方后端完整转发
agentsId	path	string	是	Required. The name of the agent to delete.	官方后端完整转发

请求体：无。

响应：default application/json → Empty。

GET /{api_version}/credentials

Lists credentials.

参数	位置	类型 / 允许值	必填	官方说明	web2api
api_version	path	string	是	API version for request routing.	官方后端完整转发
page_size	query	integer (int32)	否	Optional. Maximum number of credentials to return.	官方后端完整转发
page_token	query	string	否	Optional. Pagination token.	官方后端完整转发

请求体：无。

响应：default application/json → ListCredentialsResponse。

POST /{api_version}/credentials

Creates a new credential.

参数	位置	类型 / 允许值	必填	官方说明	web2api
api_version	path	string	是	API version for request routing.	官方后端完整转发

请求体：CredentialCreateParams。

响应：default application/json → Credential。

GET /{api_version}/credentials/{id}

Gets a credential by ID.

参数	位置	类型 / 允许值	必填	官方说明	web2api
api_version	path	string	是	API version for request routing.	官方后端完整转发
id	path	string	是	Required. Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.	官方后端完整转发

请求体：无。

响应：default application/json → Credential。

PATCH /{api_version}/credentials/{id}

Updates a credential.

参数	位置	类型 / 允许值	必填	官方说明	web2api
api_version	path	string	是	API version for request routing.	官方后端完整转发
id	path	string	是	Required. Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.	官方后端完整转发
update_mask	query	string	否	Optional. The list of fields to update.	官方后端完整转发

请求体：CredentialUpdateParams。

响应：default application/json → Credential。

DELETE /{api_version}/credentials/{id}

Deletes a credential.

参数	位置	类型 / 允许值	必填	官方说明	web2api
api_version	path	string	是	API version for request routing.	官方后端完整转发
id	path	string	是	Required. Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.	官方后端完整转发

请求体：无。

响应：default application/json → Empty。

GET /{api_version}/environments

Lists environments.

参数	位置	类型 / 允许值	必填	官方说明	web2api
api_version	path	string	是	API version for request routing.	官方后端完整转发
page_size	query	integer (int32)	否	Optional. Maximum number of environments to return. If unspecified, defaults to 50. Maximum is 1000.	官方后端完整转发
page_token	query	string	否	Optional. Pagination token.	官方后端完整转发

请求体：无。

响应：default application/json → ListEnvironmentsResponse。

POST /{api_version}/environments

Creates an environment.

参数	位置	类型 / 允许值	必填	官方说明	web2api
api_version	path	string	是	API version for request routing.	官方后端完整转发

请求体：CreateEnvironmentRequest。

响应：default application/json → Environment。

GET /{api_version}/environments/{environment}/files/{path}

Retrieves file metadata or directory contents from an environment's snapshot. To download file content, use the download URL returned in the response.

参数	位置	类型 / 允许值	必填	官方说明	web2api
api_version	path	string	是	API version for request routing.	官方后端完整转发
environment	path	string	是	The ID of the environment whose snapshot to read.	官方后端完整转发
path	path	string	是	Path of the file or directory inside the environment workspace, relative to its root (e.g. src).	官方后端完整转发
page_size	query	integer (int32)	否	Optional. Maximum number of entries to return per page (for directory listing).	官方后端完整转发
page_token	query	string	否	Optional. Pagination token for directory listing.	官方后端完整转发
recursive	query	boolean	否	Optional. If true and the path is a directory, recursively lists all files.	官方后端完整转发

请求体：无。

响应：200 application/json → GetEnvironmentFilesResponse。

GET /{api_version}/environments/{id}

Gets an environment.

参数	位置	类型 / 允许值	必填	官方说明	web2api
api_version	path	string	是	API version for request routing.	官方后端完整转发
id	path	string	是	Required. Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.	官方后端完整转发

请求体：无。

响应：default application/json → Environment。

DELETE /{api_version}/environments/{id}

Deletes an environment.

参数	位置	类型 / 允许值	必填	官方说明	web2api
api_version	path	string	是	API version for request routing.	官方后端完整转发
id	path	string	是	Required. Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.	官方后端完整转发

请求体：无。

响应：default application/json → Empty。

POST /{api_version}/interactions

Creates a new interaction.

参数	位置	类型 / 允许值	必填	官方说明	web2api
api_version	path	string	是	API version for request routing.	官方后端完整转发

请求体：AgentInteraction / ModelInteraction。

响应：200 application/json → Interaction；text/event-stream → InteractionSseStreamEnvelope；4XX application/json → object；5XX application/json → object。

内联响应字段（4XX application/json）：

字段	类型	必填	官方说明	官方后端	网页登录态 / OpenAI 聊天
error	Error	是		原样返回	不返回此官方包装

内联响应字段（5XX application/json）：

字段	类型	必填	官方说明	官方后端	网页登录态 / OpenAI 聊天
error	Error	是		原样返回	不返回此官方包装

GET /{api_version}/interactions/{interactionsId}

Retrieves the full details of a single interaction based on its Interaction.id.

参数	位置	类型 / 允许值	必填	官方说明	web2api
api_version	path	string	是	API version for request routing.	官方后端完整转发
include_input	query	boolean	否	If true, includes the input in the response.	官方后端完整转发
interactionsId	path	string	是	Required. The name of the interaction to retrieve.	官方后端完整转发
last_event_id	query	string	否	If set, resumes the interaction stream from the chunk after the event marked by the event id. Can only be used if stream is true.	官方后端完整转发
stream	query	boolean	否	If true, streams the interaction events as Server-Sent Events.	官方后端完整转发

请求体：无。

响应：200 application/json → Interaction；text/event-stream → InteractionSseStreamEnvelope；4XX application/json → object；5XX application/json → object。

内联响应字段（4XX application/json）：

字段	类型	必填	官方说明	官方后端	网页登录态 / OpenAI 聊天
error	Error	是		原样返回	不返回此官方包装

内联响应字段（5XX application/json）：

字段	类型	必填	官方说明	官方后端	网页登录态 / OpenAI 聊天
error	Error	是		原样返回	不返回此官方包装

DELETE /{api_version}/interactions/{interactionsId}

Deletes the interaction by id.

参数	位置	类型 / 允许值	必填	官方说明	web2api
api_version	path	string	是	API version for request routing.	官方后端完整转发
interactionsId	path	string	是	Required. The name of the interaction to delete.	官方后端完整转发

请求体：无。

响应：200 Successful deletion of the interaction.；4XX application/json → object；5XX application/json → object。

内联响应字段（4XX application/json）：

字段	类型	必填	官方说明	官方后端	网页登录态 / OpenAI 聊天
error	Error	是		原样返回	不返回此官方包装

内联响应字段（5XX application/json）：

字段	类型	必填	官方说明	官方后端	网页登录态 / OpenAI 聊天
error	Error	是		原样返回	不返回此官方包装

POST /{api_version}/interactions/{interactionsId}/cancel

Cancels an interaction by id. This only applies to background interactions that are still running.

参数	位置	类型 / 允许值	必填	官方说明	web2api
api_version	path	string	是	API version for request routing.	官方后端完整转发
interactionsId	path	string	是	Required. The name of the interaction to cancel.	官方后端完整转发

请求体：无。

响应：200 application/json → Interaction；4XX application/json → object；5XX application/json → object。

内联响应字段（4XX application/json）：

字段	类型	必填	官方说明	官方后端	网页登录态 / OpenAI 聊天
error	Error	是		原样返回	不返回此官方包装

内联响应字段（5XX application/json）：

字段	类型	必填	官方说明	官方后端	网页登录态 / OpenAI 聊天
error	Error	是		原样返回	不返回此官方包装

GET /{api_version}/triggers

Lists triggers for a project.

参数	位置	类型 / 允许值	必填	官方说明	web2api
api_version	path	string	是	API version for request routing.	官方后端完整转发
filter	query	string	否	Optional. Filter expression (e.g., by state).	官方后端完整转发
page_size	query	integer (int32)	否	Optional. The maximum number of triggers to return per page.	官方后端完整转发
page_token	query	string	否	Optional. A page token from a previous ListTriggers call.	官方后端完整转发

请求体：无。

响应：default application/json → ListTriggersResponse。

POST /{api_version}/triggers

Creates a new trigger that will invoke the specified agent on the given cron schedule.

参数	位置	类型 / 允许值	必填	官方说明	web2api
api_version	path	string	是	API version for request routing.	官方后端完整转发

请求体：TriggerCreateParams。

响应：default application/json → Trigger。

GET /{api_version}/triggers/{id}

Gets details of a single trigger.

参数	位置	类型 / 允许值	必填	官方说明	web2api
api_version	path	string	是	API version for request routing.	官方后端完整转发
id	path	string	是	Required. Resource name of the trigger.	官方后端完整转发

请求体：无。

响应：default application/json → Trigger。

PATCH /{api_version}/triggers/{id}

Updates a trigger.

参数	位置	类型 / 允许值	必填	官方说明	web2api
api_version	path	string	是	API version for request routing.	官方后端完整转发
id	path	string	是	Required. Resource name of the trigger.	官方后端完整转发

请求体：TriggerUpdate。

响应：default application/json → Trigger。

DELETE /{api_version}/triggers/{id}

Deletes a trigger.

参数	位置	类型 / 允许值	必填	官方说明	web2api
api_version	path	string	是	API version for request routing.	官方后端完整转发
id	path	string	是	Required. Resource name of the trigger.	官方后端完整转发

请求体：无。

响应：default application/json → Empty。

GET /{api_version}/triggers/{triggerId}/executions

Lists executions for a trigger.

参数	位置	类型 / 允许值	必填	官方说明	web2api
api_version	path	string	是	API version for request routing.	官方后端完整转发
page_size	query	integer (int32)	否	The maximum number of executions to return per page.	官方后端完整转发
page_token	query	string	否	A page token from a previous ListTriggerExecutions call.	官方后端完整转发
triggerId	path	string	是	Required. The trigger ID to list executions from.	官方后端完整转发

请求体：无。

响应：default application/json → ListTriggerExecutionsResponse。

POST /{api_version}/triggers/{triggerId}/executions

Runs a trigger immediately.

参数	位置	类型 / 允许值	必填	官方说明	web2api
api_version	path	string	是	API version for request routing.	官方后端完整转发
triggerId	path	string	是	Required. Resource name of the trigger.	官方后端完整转发

请求体：无。

响应：default application/json → TriggerExecution。

GET /{api_version}/voices

Lists custom stored voices owned by the caller (ordered newest first) followed by prebuilt system voices from Google's voice catalog.

参数	位置	类型 / 允许值	必填	官方说明	web2api
api_version	path	string	是	API version for request routing.	官方后端完整转发
accent	query	Array<string>	否	Optional. Filter by accent description (e.g. "American", "British"). Case-insensitive exact match. If multiple values are specified, matches voices with any of the specified accents (OR).	官方后端完整转发
context	query	Array<string>	否	Optional. Filter by intended context or domain (e.g. "News, Commercial"). Case-insensitive exact match. If multiple values are specified, matches voices with any of the specified contexts (OR).	官方后端完整转发
gender	query	Array<string>	否	Optional. Filter by gender presentation (e.g. "female", "male", "neutral"). Case-insensitive exact match. If multiple values are specified, matches voices with any of the specified genders (OR).	官方后端完整转发
language_code	query	Array<string>	否	Optional. Filter by BCP-47 language code (e.g. "en-US"). Case-insensitive exact match. If multiple values are specified, matches voices with any of the specified language codes (OR).	官方后端完整转发
page_size	query	integer (int32)	否	Optional. The maximum number of voices to return per page. The service may return fewer than this value. If unspecified, at most 50 voices are returned. The maximum value is 1000; values above 1000 are coerced to 1000.	官方后端完整转发
page_token	query	string	否	Optional. A page token received from a previous ListVoices call. Provide this to retrieve the subsequent page. When paginating, all filter query parameters (language_code, region_code, accent, persona, context, gender, pitch, type, and search) must match the call that returned this token; otherwise the request fails with INVALID_ARGUMENT. page_size may change between pages.	官方后端完整转发
persona	query	Array<string>	否	Optional. Filter by vocal persona (e.g. "Warm, Friendly"). Case-insensitive exact match. If multiple values are specified, matches voices with any of the specified personas (OR).	官方后端完整转发
pitch	query	Array<string>	否	Optional. Filter by vocal pitch. Accepts "low", "medium", "high" (case-insensitive). If multiple values are specified, matches voices with any of the specified pitches (OR).	官方后端完整转发
region_code	query	Array<string>	否	Optional. Filter by ISO 3166-1 alpha-2 or UN M.49 region code (e.g. "US", "001"). Case-insensitive exact match. If multiple values are specified, matches voices with any of the specified region codes (OR).	官方后端完整转发
search	query	string	否	Optional. Free-text substring search query matched case-insensitively against both display_name and description. Maximum 2048 bytes.	官方后端完整转发
type	query	Array<string>	否	Optional. Filter by voice type. Accepts "prebuilt", "replicated", "prompted" (case-insensitive). If multiple values are specified, matches voices with any of the specified types (OR).	官方后端完整转发

请求体：无。

响应：default application/json → ListVoicesResponse。

POST /{api_version}/voices

Creates a custom voice from a natural-language prompt (VOICE_TYPE_PROMPTED) or from reference and consent audio recordings (VOICE_TYPE_REPLICATED).

参数	位置	类型 / 允许值	必填	官方说明	web2api
api_version	path	string	是	API version for request routing.	官方后端完整转发

请求体：CreateVoiceRequest。

响应：default application/json → Voice。

GET /{api_version}/voices/{voicesId}

Gets a custom stored voice (store = true) by resource name. Prebuilt catalog voices (VOICE_TYPE_PREBUILT) cannot be retrieved via GetVoice; use ListVoices instead.

参数	位置	类型 / 允许值	必填	官方说明	web2api
api_version	path	string	是	API version for request routing.	官方后端完整转发
voicesId	path	string	是	Required. The resource name of the custom stored voice to retrieve (for example, voices/voice_abc123def456).	官方后端完整转发

请求体：无。

响应：default application/json → Voice。

DELETE /{api_version}/voices/{voicesId}

Deletes a custom stored voice (store = true) by resource name. Prebuilt catalog voices (VOICE_TYPE_PREBUILT) cannot be deleted.

参数	位置	类型 / 允许值	必填	官方说明	web2api
api_version	path	string	是	API version for request routing.	官方后端完整转发
voicesId	path	string	是	Required. The resource name of the custom stored voice to delete (for example, voices/voice_abc123def456).	官方后端完整转发

请求体：无。

响应：default application/json → DeleteVoiceResponse。

GET /{api_version}/webhooks

Lists all Webhooks.

参数	位置	类型 / 允许值	必填	官方说明	web2api
api_version	path	string	是	API version for request routing.	官方后端完整转发
page_size	query	integer (int32)	否	Optional. The maximum number of webhooks to return. The service may return fewer than this value. If unspecified, at most 50 webhooks will be returned. The maximum value is 1000.	官方后端完整转发
page_token	query	string	否	Optional. A page token, received from a previous ListWebhooks call. Provide this to retrieve the subsequent page.	官方后端完整转发

请求体：无。

响应：default application/json → ListWebhooksResponse。

POST /{api_version}/webhooks

Creates a new Webhook.

参数	位置	类型 / 允许值	必填	官方说明	web2api
api_version	path	string	是	API version for request routing.	官方后端完整转发

请求体：Webhook。

响应：default application/json → Webhook。

GET /{api_version}/webhooks/{id}

Gets a specific Webhook.

参数	位置	类型 / 允许值	必填	官方说明	web2api
api_version	path	string	是	API version for request routing.	官方后端完整转发
id	path	string	是	Required. The ID of the webhook to retrieve.	官方后端完整转发

请求体：无。

响应：default application/json → Webhook。

PATCH /{api_version}/webhooks/{id}

Updates an existing Webhook.

参数	位置	类型 / 允许值	必填	官方说明	web2api
api_version	path	string	是	API version for request routing.	官方后端完整转发
id	path	string	是	Required. The ID of the webhook to update.	官方后端完整转发
update_mask	query	string	否	Optional list of fields to update.	官方后端完整转发

请求体：WebhookUpdate。

响应：default application/json → Webhook。

DELETE /{api_version}/webhooks/{id}

Deletes a Webhook.

参数	位置	类型 / 允许值	必填	官方说明	web2api
api_version	path	string	是	API version for request routing.	官方后端完整转发
id	path	string	是	Required. The ID of the webhook to delete.	官方后端完整转发

请求体：无。

响应：default application/json → Empty。

POST /{api_version}/webhooks/{id}:ping

Sends a ping event to a Webhook.

参数	位置	类型 / 允许值	必填	官方说明	web2api
api_version	path	string	是	API version for request routing.	官方后端完整转发
id	path	string	是	Required. The ID of the webhook to ping.	官方后端完整转发

请求体：PingWebhookRequest。

响应：default application/json → PingWebhookResponse。

POST /{api_version}/webhooks/{id}:rotateSigningSecret

Generates a new signing secret for a Webhook.

参数	位置	类型 / 允许值	必填	官方说明	web2api
api_version	path	string	是	API version for request routing.	官方后端完整转发
id	path	string	是	Required. The ID of the webhook for which to generate a signing secret.	官方后端完整转发

请求体：RotateSigningSecretRequest。

响应：default application/json → RotateSigningSecretResponse。

Agent

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

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"} ] }

结构 / 允许值：object。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
agent_config	AntigravityAgentConfig	可选	未注明	Configuration parameters for the agent.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
base_agent	string	可选	未注明	The base agent to extend.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
base_environment	EnvironmentConfig / string	可选	未注明	The environment configuration for the agent.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
description	string	可选	未注明	Agent description for developers to quickly read and understand.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
id	string	可选	未注明	The unique identifier for the agent.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
system_instruction	string	可选	未注明	System instruction for the agent.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
tools	Array<AgentTool>	可选	未注明	The tools available to the agent.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

AgentInteraction

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

Interaction for generating the completion using agents.

结构 / 允许值：object。

官方 required：agent。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
agent	AgentOption	必填	未注明	The name of the Agent used for generating the interaction.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
agent_config	AntigravityAgentConfig / CodeMenderAgentConfig / DeepResearchAgentConfig / DynamicAgentConfig	可选	未注明	Configuration parameters for the agent interaction.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
background	boolean	可选	未注明	Input only. Whether to run the model interaction in the background.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
continuation_token	string (byte)	可选	未注明	Opaque token to resume a long decode. Output: set when status is INCOMPLETE and decoding can be resumed. Input: pass the latest token back unchanged in CreateInteraction to continue decoding.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
environment	EnvironmentConfig / string	可选	未注明	The environment configuration for the interaction. Can be an object specifying remote environment sources or a string referencing an existing environment ID.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
input	InteractionsInput	可选	未注明		完整转发，由 Google 校验	部分：messages 仅文本；没有 Content/Step JSON 接口
labels	Map<string, string>	可选	未注明	The labels with user-defined metadata for the request. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
previous_interaction_id	string	可选	未注明	The ID of the previous interaction, if any.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
response_format	ResponseFormat / Array<ResponseFormat>	可选	未注明	Enforces that the generated response is a JSON object that complies with the JSON schema specified in this field.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
response_mime_type	string	可选；废弃	未注明	The mime type of the response. This is required if response_format is set.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
response_modalities	Array<ResponseModality>	可选；废弃	未注明	The requested modalities of the response (TEXT, IMAGE, AUDIO).	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
safety_settings	Array<SafetySetting>	可选	未注明	Safety settings for the interaction.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
service_tier	ServiceTier	可选	未注明	The service tier for the interaction.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
store	boolean	可选	未注明	Input only. Whether to store the response and request for later retrieval.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
stream	boolean	可选	未注明	Input only. Whether the interaction will be streamed.	完整转发，由 Google 校验	部分：聊天 SSE；不是 Interactions 事件流
system_instruction	string	可选	未注明	System instruction for the interaction.	完整转发，由 Google 校验	映射：messages 中的 system 文本
tools	Array<Tool>	可选	未注明	A list of tool declarations the model may call during interaction.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
webhook_config	WebhookConfig	可选	未注明	Optional. Webhook configuration for receiving notifications when the interaction completes.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

AgentOption

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

The agent to interact with.

结构 / 允许值："deep-research-pro-preview-12-2025" / "deep-research-preview-04-2026" / "deep-research-max-preview-04-2026" / "antigravity-preview-05-2026"。

AgentTool

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

A tool that the agent can use.

结构 / 允许值：CodeExecution / Function / GoogleSearch / McpServer / UrlContext。

AllowedTools

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

The configuration for allowed tools.

结构 / 允许值：object。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
mode	"auto" / "any" / "none" / "validated"	可选	未注明	The mode of the tool choice.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
tools	Array<string>	可选	未注明	The names of the allowed tools.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

枚举含义（$.properties.mode）：

• auto：Auto tool choice.
• any：Any tool choice.
• none：No tool choice.
• validated：Validated tool choice.

Annotation

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

Citation information for model-generated content.

结构 / 允许值：FileCitation / PlaceCitation / SpeechAnnotation / UrlCitation / WordInfo。

AntigravityAgentConfig

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

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

结构 / 允许值：object。

官方 required：type。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
max_total_tokens	string (int64)	可选	未注明	Max total tokens for the agent run.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
model	string	可选	未注明	The model to use for agent reasoning.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
type	"antigravity"	必填	未注明		完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

ArgumentsDelta

出现位置：响应 / 错误 / SSE。

结构 / 允许值：object。

官方 required：type。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
arguments	string	可选	未注明		完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
type	"arguments_delta"	必填	未注明		完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务

AudioContent

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

An audio content block.

结构 / 允许值：object。

官方 required：type。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
channels	integer (int32)	可选	未注明	The number of audio channels.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
data	string (byte)	可选	未注明	The audio content.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
mime_type	"audio/wav" / "audio/mp3" / "audio/aiff" / "audio/aac" / "audio/ogg" / "audio/flac" / "audio/mpeg" / "audio/m4a" / "audio/l16" / "audio/opus" / "audio/alaw" / "audio/mulaw" / "audio/webm"	可选	未注明	The mime type of the audio.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
sample_rate	integer (int32)	可选	未注明	The sample rate of the audio.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
type	"audio"	必填	未注明		完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
uri	string	可选	未注明	The URI of the audio.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

枚举含义（$.properties.mime_type）：

• 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
• audio/webm：WebM audio format

AudioData

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

Audio payload used for voice creation.

结构 / 允许值：object。

官方 required：data、mime_type。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
data	string (byte)	必填	未注明	Required. The raw audio bytes.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
mime_type	string	必填	未注明	Required. The IANA MIME type of the audio data (for example, audio/wav or audio/mpeg).	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

AudioDelta

出现位置：响应 / 错误 / SSE。

结构 / 允许值：object。

官方 required：type。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
channels	integer (int32)	可选	未注明	The number of audio channels.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
data	string (byte)	可选	未注明		完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
mime_type	"audio/wav" / "audio/mp3" / "audio/aiff" / "audio/aac" / "audio/ogg" / "audio/flac" / "audio/mpeg" / "audio/m4a" / "audio/l16" / "audio/opus" / "audio/alaw" / "audio/mulaw" / "audio/webm"	可选	未注明		完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
rate	integer (int32)	可选；废弃	未注明	Deprecated. Use sample_rate instead. The value is ignored.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
sample_rate	integer (int32)	可选	未注明	The sample rate of the audio.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
type	"audio"	必填	未注明		完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
uri	string	可选	未注明		完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务

枚举含义（$.properties.mime_type）：

• 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
• audio/webm：WEBM audio format

AudioResponseFormat

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

Configuration for audio output format.

结构 / 允许值：object。

官方 required：type。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
bit_rate	integer (int32)	可选	未注明	Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus).	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
delivery	"inline" / "uri"	可选	未注明	The delivery mode for the audio output.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
mime_type	"audio/mp3" / "audio/ogg_opus" / "audio/l16" / "audio/wav" / "audio/alaw" / "audio/mulaw"	可选	未注明	The MIME type of the audio output.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
sample_rate	integer (int32)	可选	未注明	Sample rate in Hz.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
type	"audio"	必填	未注明		完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

枚举含义（$.properties.delivery）：

• inline：Audio data is returned inline in the response.
• uri：Audio data is returned as a URI.

枚举含义（$.properties.mime_type）：

• audio/mp3：MP3 audio format.
• audio/ogg_opus：OGG Opus audio format.
• audio/l16：Raw PCM (L16) audio format.
• audio/wav：WAV audio format.
• audio/alaw：A-law audio format.
• audio/mulaw：Mu-law audio format.

CodeExecution

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

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

结构 / 允许值：object。

官方 required：type。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
type	"code_execution"	必填	未注明		完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

CodeExecutionCallArguments

出现位置：响应 / 错误 / SSE。

The arguments to pass to the code execution.

结构 / 允许值：object。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
code	string	可选	未注明	The code to be executed.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
language	"python"	可选	未注明	Programming language of the code.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务

枚举含义（$.properties.language）：

• python：Python >= 3.10, with numpy and simpy available.

CodeExecutionCallDelta

出现位置：响应 / 错误 / SSE。

结构 / 允许值：object。

官方 required：arguments、type。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
arguments	CodeExecutionCallArguments	必填	未注明		完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
signature	string (byte)	可选	未注明	A signature hash for backend validation.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
type	"code_execution_call"	必填	未注明		完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务

CodeExecutionCallStep

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

Code execution call step.

结构 / 允许值：object。

官方 required：arguments、id、type。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
arguments	CodeExecutionCallStepArguments	必填	未注明	Required. The arguments to pass to the code execution.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
id	string	必填	未注明	Required. A unique ID for this specific tool call.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
signature	string (byte)	可选	未注明	A signature hash for backend validation.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
type	"code_execution_call"	必填	未注明		完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

CodeExecutionCallStepArguments

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

The arguments to pass to the code execution.

结构 / 允许值：object。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
code	string	可选	未注明	The code to be executed.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
language	"python"	可选	未注明	Programming language of the code.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

枚举含义（$.properties.language）：

• python：Python >= 3.10, with numpy and simpy available.

CodeExecutionResultDelta

出现位置：响应 / 错误 / SSE。

结构 / 允许值：object。

官方 required：result、type。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
is_error	boolean	可选	未注明		完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
result	string	必填	未注明		完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
signature	string (byte)	可选	未注明	A signature hash for backend validation.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
type	"code_execution_result"	必填	未注明		完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务

CodeExecutionResultStep

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

Code execution result step.

结构 / 允许值：object。

官方 required：call_id、result、type。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
call_id	string	必填	未注明	Required. ID to match the ID from the function call block.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
is_error	boolean	可选	未注明	Whether the code execution resulted in an error.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
result	string	必填	未注明	Required. The output of the code execution.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
signature	string (byte)	可选	未注明	A signature hash for backend validation.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
type	"code_execution_result"	必填	未注明		完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

CodeMenderAgentConfig

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

Configuration for the CodeMender agent.

结构 / 允许值：object。

官方 required：type。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
find_request	FindRequest	可选	未注明	Parameters for finding vulnerabilities.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
fix_request	FixRequest	可选	未注明	Parameters for fixing vulnerabilities.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
model	string	可选	未注明	The name of the model to use for the CodeMender agent. One CodeMender session will only use one model.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
session_config	SessionConfig	可选	未注明	Optional session-specific configurations to override default agent behavior.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
session_id	string	可选	未注明	Parameter for grouping multiple interactions that belong to the same CodeMender session.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
type	"code-mender"	必填	未注明		完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

ComputerUse

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

A tool that can be used by the model to interact with the computer.

结构 / 允许值：object。

官方 required：type。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
disabled_safety_policies	Array<"financial_transactions" / "sensitive_data_modification" / "communication_tool" / "account_creation" / "data_modification" / "user_consent_management" / "legal_terms_and_agreements">	可选	未注明	Optional. Disabled safety policies for computer use.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
enable_prompt_injection_detection	boolean	可选	未注明	Whether enable the prompt injection detection check on computer-use request.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
environment	"browser" / "mobile" / "desktop"	可选	未注明	The environment being operated.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
excluded_predefined_functions	Array<string>	可选	未注明	The list of predefined functions that are excluded from the model call.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
type	"computer_use"	必填	未注明		完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

枚举含义（$.properties.disabled_safety_policies.items）：

• financial_transactions：Safety policy for financial transactions.
• sensitive_data_modification：Safety policy for sensitive data modification.
• communication_tool：Safety policy for communication tools (e.g. Gmail, Chat, Meet).
• account_creation：Safety policy for account creation.
• data_modification：Safety policy for data modification.
• user_consent_management：Safety policy for user consent management.
• legal_terms_and_agreements：Safety policy for legal terms and agreements.

枚举含义（$.properties.environment）：

• browser：Operates in a web browser.
• mobile：Operates in a mobile environment.
• desktop：Operates in a desktop environment.

Content

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

The content of the response.

结构 / 允许值：AudioContent / DocumentContent / ImageContent / TextContent / VideoContent。

CreateEnvironmentRequest

出现位置：请求体（可能同时用于输出）。

Request for CreateEnvironment.

结构 / 允许值：object。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
from_environment	string	可选	未注明	Optional. The source environment to copy/fork from. Format: environments/{environment_id} or {environment_id}. When specified, sources and env must be empty.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
network	EnvironmentNetworkEgressAllowlist / "disabled"	可选	未注明	Network configuration for the environment.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
sources	Array<Source>	可选	未注明	Sources to be mounted into the environment.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

枚举含义（$.properties.network.oneOf.1）：

• disabled：All network egress is blocked.

CreateVoiceRequest

出现位置：请求体（可能同时用于输出）。

Request message for VoicesService.CreateVoice.

结构 / 允许值：object。

官方 required：voice。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
store	boolean	可选	未注明	Optional. Whether the created voice is persisted and managed by Google. * When true, Google stores the voice and returns Voice.id (for example, voice_abc123def456), which can be managed via GetVoice, ListVoices, and DeleteVoice and referenced by ID in synthesis requests. Stored voices expire after 1 year of inactivity; using a stored voice in speech synthesis or as a base_voice in CreateVoice extends its expire_time. Projects are subject to a maximum active stored voice quota; exceeding the quota returns RESOURCE_EXHAUSTED. * When false (default), the voice is not stored by Google and Voice.key (for example, voicekey_...) is returned for client-side storage and synthesis. Optional discovery metadata fields on voice are not persisted or returned when store is false. * Required to be true when voice.type is "prompted" (otherwise fails with INVALID_ARGUMENT).	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
voice	Voice	必填	未注明	Required. The voice to create. voice.model is optional; if omitted, the service selects the default voice creation model. Output-only fields on Voice (id, key, expire_time, usage) are ignored if set.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

CreateWebhookRequest

出现位置：官方保留组件。

Request message for WebhookService.CreateWebhook.

结构 / 允许值：object。

官方 required：webhook。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
webhook	Webhook	必填	未注明	Required. The webhook to create.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务

Credential

出现位置：响应 / 错误 / SSE。

Server-managed credential resource stored in Secret Manager.

结构 / 允许值：object。

官方 required：id。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
create_time	string (date-time)	可选；只读；官方描述：仅输出	未注明	Output only. The timestamp when the credential was created.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
id	string	必填；只读；官方描述：仅输出	未注明	Required. Output only. Identifier. Unique identifier for the credential.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
status	"active" / "revoked"	可选；只读；官方描述：仅输出	未注明	Output only. Current status of the credential.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
type	"bearer_token" / "oauth2" / "environment_variable"	可选；只读；官方描述：仅输出	未注明	Required. Output only. The type of credential.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
update_time	string (date-time)	可选；只读；官方描述：仅输出	未注明	Output only. The timestamp when the credential was last updated.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务

枚举含义（$.properties.status）：

• active：The credential is active and valid for use.
• revoked：The credential has been revoked and is no longer valid.

枚举含义（$.properties.type）：

• bearer_token：Static token injected as header. No refresh logic.
• oauth2：Auto-refresh expired access tokens using stored refresh token.
• environment_variable：Environment variable injected into sandbox container.

CredentialCreateParams

出现位置：请求体（可能同时用于输出）。

Represents the fields of a Credential provided on creation.

结构 / 允许值：EnvironmentVariableConfig / HttpBearerConfig / OAuth2Config。

CredentialUpdateParams

出现位置：请求体（可能同时用于输出）。

Represents the fields of a Credential that can be updated.

结构 / 允许值：EnvironmentVariableUpdateConfig / HttpBearerUpdateConfig / OAuth2UpdateConfig。

DeepResearchAgentConfig

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

Configuration for the Deep Research agent.

结构 / 允许值：object。

官方 required：type。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
collaborative_planning	boolean	可选	未注明	Enables human-in-the-loop planning for the Deep Research agent. If set to true, the Deep Research agent will provide a research plan in its response. The agent will then proceed only if the user confirms the plan in the next turn.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
enable_bigquery_tool	boolean	可选	未注明	Enables bigquery tool for the Deep Research agent.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
thinking_summaries	ThinkingSummaries	可选	未注明	Whether to include thought summaries in the response.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
type	"deep-research"	必填	未注明		完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
visualization	"off" / "auto"	可选	未注明	Whether to include visualizations in the response.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

枚举含义（$.properties.visualization）：

• off：Do not include visualizations.
• auto：Automatically include visualizations.

DeleteVoiceResponse

出现位置：响应 / 错误 / SSE。

Response message for VoicesService.DeleteVoice.

结构 / 允许值：object。

DocumentContent

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

A document content block.

结构 / 允许值：object。

官方 required：type。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
data	string (byte)	可选	未注明	The document content.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
mime_type	"application/pdf" / "text/csv"	可选	未注明	The mime type of the document.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
type	"document"	必填	未注明		完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
uri	string	可选	未注明	The URI of the document.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

枚举含义（$.properties.mime_type）：

• application/pdf：PDF document format
• text/csv：CSV document format

DocumentDelta

出现位置：响应 / 错误 / SSE。

结构 / 允许值：object。

官方 required：type。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
data	string (byte)	可选	未注明		完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
mime_type	"application/pdf" / "text/csv"	可选	未注明		完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
type	"document"	必填	未注明		完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
uri	string	可选	未注明		完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务

枚举含义（$.properties.mime_type）：

• application/pdf：PDF document format
• text/csv：CSV document format

DynamicAgentConfig

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

Configuration for dynamic agents.

结构 / 允许值：Map<string, any>。

官方 required：type。

自由属性：true。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
type	"dynamic"	必填	未注明		完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

EgressRule

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

A single domain allowlist rule with optional header injection.

结构 / 允许值：object。

官方 required：domain。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
credential	string	可选	未注明	Optional. Reference to a server-managed Credential resource by ID.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
domain	string	必填	未注明	Domain to allow outbound requests to. Supports wildcards (e.g. '.googleapis.com'). Use '' to allow all domains.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
transform	Array<Map<string, string>> / Map<string, string>	可选	未注明	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.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

Empty

出现位置：响应 / 错误 / SSE。

A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

结构 / 允许值：object。

EnvVar

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

An environment variable to set in the execution environment.

结构 / 允许值：object。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
credential	string	可选	未注明	Optional reference to a server-managed Credential resource by ID.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
value	string	可选	未注明	Direct string value for plain environment variables.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

Environment

出现位置：响应 / 错误 / SSE。

An execution environment for an agent.

结构 / 允许值：object。

官方 required：id。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
created	string	可选；只读；官方描述：仅输出	未注明	Output only. The time at which the environment was created in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
file_count	string (int64)	可选；只读；官方描述：仅输出	未注明	Output only. The number of files in the environment, output only.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
id	string	必填；只读；官方描述：仅输出	未注明	Required. Output only. The ID of the environment.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
last_accessed	string	可选；只读；官方描述：仅输出	未注明	Output only. The time at which the environment was last accessed in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
network	EnvironmentNetworkEgressAllowlist / "disabled"	可选	未注明	Network configuration for the environment.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
size_bytes	string (int64)	可选；只读；官方描述：仅输出	未注明	Output only. The total size of the environment files in bytes, output only.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
sources	Array<Source>	可选	未注明	Sources to be mounted into the environment.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
status	"active" / "expired"	可选；只读；官方描述：仅输出	未注明	Output only. The status of the environment container.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
updated	string	可选；只读；官方描述：仅输出	未注明	Output only. The time at which the environment was last updated in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务

枚举含义（$.properties.network.oneOf.1）：

• disabled：All network egress is blocked.

枚举含义（$.properties.status）：

• active：官方未说明
• expired：官方未说明

EnvironmentConfig

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

Configuration for a custom environment.

结构 / 允许值：object。

官方 required：type。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
env	Map<string, EnvVar> / string	可选	未注明	Environment variables to set in the sandbox environment.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
environment_id	string	可选	未注明	Optional. The environment ID for the interaction. If specified, the request will update the existing environment instead of creating a new one.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
network	EnvironmentNetworkEgressAllowlist / "disabled"	可选	未注明	Network configuration for the environment.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
sources	Array<Source>	可选	未注明		完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
type	"remote"	必填	未注明		完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

枚举含义（$.properties.network.oneOf.1）：

• disabled：All network egress is blocked.

EnvironmentFile

出现位置：响应 / 错误 / SSE。

Metadata for a file or directory within an environment.

结构 / 允许值：object。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
created	string (date-time)	可选；只读；官方描述：仅输出	未注明	Output only. The creation time of the file/directory.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
mime_type	string	可选；只读；官方描述：仅输出	未注明	Output only. The MIME type of the file (e.g., "text/python", "image/png"). Empty for directories. NOLINT	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
modified	string (date-time)	可选；只读；官方描述：仅输出	未注明	Output only. The modification time of the file/directory.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
name	string	可选；只读；官方描述：仅输出	未注明	Output only. The name of the file or directory (e.g., "main.py" or "src").	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
path	string	可选；只读；官方描述：仅输出	未注明	Output only. The full relative path within the environment (e.g., "workspace/src/main.py").	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
size_bytes	string (int64)	可选；只读；官方描述：仅输出	未注明	Output only. The size of the file/directory in bytes. NOLINT	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
type	"file" / "directory"	可选；只读；官方描述：仅输出	未注明	Output only. The type of the entry.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务

枚举含义（$.properties.type）：

• file：A regular file.
• directory：A directory.

EnvironmentNetworkEgressAllowlist

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

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.

结构 / 允许值：object / "disabled"。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
$ (oneOf[0]).allowlist	Array<EgressRule>	可选	未注明	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.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

枚举含义（$.oneOf.1）：

• disabled：All network egress is blocked.

EnvironmentVariableConfig

出现位置：请求体（可能同时用于输出）。

Configuration for environment variable credentials.

结构 / 允许值：object。

官方 required：id、injection_location、type、value。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
id	string	必填	未注明		完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
injection_location	InjectionLocation / Array<InjectionLocation>	必填	未注明	Required. Locations where the environment variable can be injected in outgoing HTTP requests. Must contain at least one location. Accepts either a single location (e.g. "header") or an array of locations.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
trusted_domains	Array<string>	可选	未注明	Optional. List of domains allowed to receive this environment variable value in HTTP requests.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
type	"environment_variable"	必填	未注明		完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
value	string	必填；仅输入	未注明	Required. Input only. Secret value of the environment variable. Write-only; never returned in responses.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

EnvironmentVariableUpdateConfig

出现位置：请求体（可能同时用于输出）。

Configuration for updating environment variable credentials.

结构 / 允许值：object。

官方 required：type。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
injection_location	InjectionLocation / Array<InjectionLocation>	可选	未注明	Optional. Locations where the environment variable can be injected in outgoing HTTP requests. Accepts either a single location (e.g. "header") or an array of locations.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
trusted_domains	Array<string>	可选	未注明	Optional. List of domains allowed to receive this environment variable value in HTTP requests.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
type	"environment_variable"	必填	未注明		完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
value	string	可选；仅输入	未注明	Optional. Input only. Secret value of the environment variable. Write-only; never returned in responses.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

Error

出现位置：响应 / 错误 / SSE。

Error message from an interaction.

结构 / 允许值：object。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
code	string	可选	未注明	A URI that identifies the error type.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
message	string	可选	未注明	A human-readable error message.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务

ErrorEvent

出现位置：响应 / 错误 / SSE。

结构 / 允许值：object。

官方 required：event_type。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
error	Error	可选	未注明		完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
event_id	string	可选	未注明	The event_id token to be used to resume the interaction stream, from this event.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
event_type	"error"	必填	未注明		完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务

ExaAISearchConfig

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

Used to specify configuration for ExaAISearch.

结构 / 允许值：object。

官方 required：api_key。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
api_key	string	必填	未注明	Required. The API key for ExaAiSearch.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
custom_config	Map<string, any>	可选	未注明	Optional. This field can be used to pass any parameter from the Exa.ai Search API.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

FileCitation

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

A file citation annotation.

结构 / 允许值：object。

官方 required：type。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
custom_metadata	Map<string, any>	可选	未注明	User provided metadata about the retrieved context.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
document_uri	string	可选	未注明	The URI of the file.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
end_index	integer (int32)	可选	未注明	End of the attributed segment, exclusive.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
file_name	string	可选	未注明	The name of the file.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
media_id	string	可选	未注明	Media ID in-case of image citations, if applicable.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
page_number	integer (int32)	可选	未注明	Page number of the cited document, if applicable.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
source	string	可选	未注明	Source attributed for a portion of the text.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
start_index	integer (int32)	可选	未注明	Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
type	"file_citation"	必填	未注明		完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

FileContent

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

Content of a single file in the codebase.

结构 / 允许值：object。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
content	string	可选	未注明	The UTF-8 encoded text content of the file.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
path	string	可选	未注明	The relative path of the file from the project root.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

FileSearch

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

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

结构 / 允许值：object。

官方 required：type。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
file_search_store_names	Array<string>	可选	未注明	The file search store names to search.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
metadata_filter	string	可选	未注明	Metadata filter to apply to the semantic retrieval documents and chunks.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
top_k	integer (int32)	可选	未注明	The number of semantic retrieval chunks to retrieve.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
type	"file_search"	必填	未注明		完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

FileSearchCallDelta

出现位置：响应 / 错误 / SSE。

结构 / 允许值：object。

官方 required：type。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
signature	string (byte)	可选	未注明	A signature hash for backend validation.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
type	"file_search_call"	必填	未注明		完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务

FileSearchCallStep

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

File Search call step.

结构 / 允许值：object。

官方 required：id、type。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
id	string	必填	未注明	Required. A unique ID for this specific tool call.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
signature	string (byte)	可选	未注明	A signature hash for backend validation.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
type	"file_search_call"	必填	未注明		完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

FileSearchResult

出现位置：响应 / 错误 / SSE。

The result of the File Search.

结构 / 允许值：object。

FileSearchResultDelta

出现位置：响应 / 错误 / SSE。

结构 / 允许值：object。

官方 required：result、type。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
result	Array<FileSearchResult>	必填	未注明		完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
signature	string (byte)	可选	未注明	A signature hash for backend validation.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
type	"file_search_result"	必填	未注明		完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务

FileSearchResultStep

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

File Search result step.

结构 / 允许值：object。

官方 required：call_id、type。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
call_id	string	必填	未注明	Required. ID to match the ID from the function call block.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
signature	string (byte)	可选	未注明	A signature hash for backend validation.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
type	"file_search_result"	必填	未注明		完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

Filter

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

Config for filters.

结构 / 允许值：object。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
metadata_filter	string	可选	未注明	Optional. String for metadata filtering.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
vector_distance_threshold	number (double)	可选	未注明	Optional. Only returns contexts with vector distance smaller than the threshold.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
vector_similarity_threshold	number (double)	可选	未注明	Optional. Only returns contexts with vector similarity larger than the threshold.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

FindRequest

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

Request parameters specific to FIND sessions, used for discovering vulnerabilities in a codebase.

结构 / 允许值：object。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
description	string	可选	未注明	Additional context or custom instructions provided by the user to guide the vulnerability analysis.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
finding_id	string	可选	未注明	The identifier of a specific finding to verify. This is primarily used in VERIFY mode to focus the agent's execution-based validation on a single vulnerability.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
mode	"scan" / "verify"	可选	未注明	The mode of the find session.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
source_files	Array<FileContent>	可选	未注明	A list of source files to provide as context for the scan.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

枚举含义（$.properties.mode）：

• scan：Fast scan using only the initial classifier.
• verify：Performs classification followed by detailed investigation.

FixRequest

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

Request parameters specific to FIX sessions, used for generating and validating security patches.

结构 / 允许值：object。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
description	string	可选	未注明	Additional context or custom instructions provided by the user to guide the patch generation process.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
finding_id	string	可选	未注明	The identifier of the specific security finding to be remediated. This ID maps to a previously discovered vulnerability.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
source_files	Array<FileContent>	可选	未注明	A list of source files providing context for the remediation. These files are typically the ones containing the identified vulnerability.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

Function

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

A tool that can be used by the model.

结构 / 允许值：object。

官方 required：type。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
description	string	可选	未注明	A description of the function.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
name	string	可选	未注明	The name of the function.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
parameters	any	可选	未注明	The JSON Schema for the function's parameters.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
type	"function"	必填	未注明		完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

FunctionCallStep

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

A function tool call step.

结构 / 允许值：object。

官方 required：arguments、id、name、type。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
arguments	Map<string, any>	必填	未注明	Required. The arguments to pass to the function.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
id	string	必填	未注明	Required. A unique ID for this specific tool call.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
name	string	必填	未注明	Required. The name of the tool to call.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
type	"function_call"	必填	未注明		完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

FunctionResultDelta

出现位置：响应 / 错误 / SSE。

结构 / 允许值：object。

官方 required：result、type。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
is_error	boolean	可选	未注明		完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
name	string	可选	未注明		完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
result	Array<FunctionResultSubContent> / object / string	必填	未注明		完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
type	"function_result"	必填	未注明		完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务

FunctionResultStep

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

Result of a function tool call.

结构 / 允许值：object。

官方 required：call_id、result、type。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
call_id	string	必填	未注明	Required. ID to match the ID from the function call block.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
is_error	boolean	可选	未注明	Whether the tool call resulted in an error.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
name	string	可选	未注明	The name of the tool that was called.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
result	Array<FunctionResultSubContent> / object / string	必填	未注明	Required. The result of the tool call.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
type	"function_result"	必填	未注明		完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

FunctionResultSubContent

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

结构 / 允许值：ImageContent / TextContent。

GenerationConfig

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

Configuration parameters for model interactions.

结构 / 允许值：object。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
image_config	ImageConfig	可选；废弃	未注明	Configuration for image interaction.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
max_output_tokens	integer (int32)	可选	未注明	The maximum number of tokens to include in the response.	完整转发，由 Google 校验	映射：聊天 max_tokens
seed	integer (int32)	可选	未注明	Seed used in decoding for reproducibility.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
speech_config	SpeakerConfig / Array<SpeechConfig>	可选	未注明	Optional. Speech and multi-speaker configuration.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
stop_sequences	Array<string>	可选	未注明	A list of character sequences that will stop output interaction.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
temperature	number (float)	可选；废弃	未注明	Controls the randomness of the output.	完整转发，由 Google 校验	旧字段：同名聊天参数传入私有协议；新官方字段已废弃
thinking_level	ThinkingLevel	可选	未注明	The level of thought tokens that the model should generate.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
thinking_summaries	ThinkingSummaries	可选	未注明	Whether to include thought summaries in the response.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
tool_choice	ToolChoiceConfig / "auto" / "any" / "none" / "validated"	可选	未注明	The tool choice configuration.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
top_p	number (float)	可选；废弃	未注明	The maximum cumulative probability of tokens to consider when sampling.	完整转发，由 Google 校验	旧字段：同名聊天参数传入私有协议；新官方字段已废弃
transcription_config	TranscriptionConfig	可选	未注明	Optional. Configuration for speech recognition (transcription). If present, ASR is enabled.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
video_config	VideoConfig	可选	未注明	Configuration for video generation.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

枚举含义（$.properties.tool_choice.oneOf.1）：

• auto：Auto tool choice.
• any：Any tool choice.
• none：No tool choice.
• validated：Validated tool choice.

GetEnvironmentFilesResponse

出现位置：响应 / 错误 / SSE。

Response for GetEnvironmentFiles.

结构 / 允许值：object。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
files	Array<EnvironmentFile>	可选	未注明	If the requested path is a directory, this contains its contents. If the requested path is a file, this contains a single entry with the file's metadata. If alt=media was specified, this is empty (content is served via blob).	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
next_page_token	string	可选	未注明	Pagination token for directory listing. NOLINT	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务

GetInteractionRequest

出现位置：官方保留组件。

Request for InteractionService.GetInteraction.

结构 / 允许值：object。

官方 required：name。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
include_input	boolean	可选；废弃	未注明	If true, includes the input in the response.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
last_event_id	string	可选	未注明	If set, resumes the interaction stream from the chunk after the event marked by the event id. Can only be used if stream is true.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
name	string	必填	未注明	Required. The name of the interaction to retrieve. Format: interactions/{interaction}	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
stream	boolean	可选	未注明	If true, streams the interaction events as Server-Sent Events.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务

GoogleMaps

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

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

结构 / 允许值：object。

官方 required：type。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
enable_widget	boolean	可选	未注明	Whether to return a widget context token in the tool call result of the response.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
latitude	number (double)	可选	未注明	The latitude of the user's location.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
longitude	number (double)	可选	未注明	The longitude of the user's location.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
type	"google_maps"	必填	未注明		完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

GoogleMapsCallArguments

出现位置：响应 / 错误 / SSE。

The arguments to pass to the Google Maps tool.

结构 / 允许值：object。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
queries	Array<string>	可选	未注明	The queries to be executed.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务

GoogleMapsCallDelta

出现位置：响应 / 错误 / SSE。

结构 / 允许值：object。

官方 required：type。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
arguments	GoogleMapsCallArguments	可选	未注明	The arguments to pass to the Google Maps tool.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
signature	string (byte)	可选	未注明	A signature hash for backend validation.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
type	"google_maps_call"	必填	未注明		完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务

GoogleMapsCallStep

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

Google Maps call step.

结构 / 允许值：object。

官方 required：id、type。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
arguments	GoogleMapsCallStepArguments	可选	未注明	The arguments to pass to the Google Maps tool.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
id	string	必填	未注明	Required. A unique ID for this specific tool call.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
signature	string (byte)	可选	未注明	A signature hash for backend validation.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
type	"google_maps_call"	必填	未注明		完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

GoogleMapsCallStepArguments

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

The arguments to pass to the Google Maps tool.

结构 / 允许值：object。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
queries	Array<string>	可选	未注明	The queries to be executed.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

GoogleMapsResult

出现位置：响应 / 错误 / SSE。

The result of the Google Maps.

结构 / 允许值：object。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
places	Array<Places>	可选	未注明	The places that were found.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
widget_context_token	string	可选	未注明	Resource name of the Google Maps widget context token.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务

GoogleMapsResultDelta

出现位置：响应 / 错误 / SSE。

结构 / 允许值：object。

官方 required：type。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
result	Array<GoogleMapsResult>	可选	未注明	The results of the Google Maps.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
signature	string (byte)	可选	未注明	A signature hash for backend validation.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
type	"google_maps_result"	必填	未注明		完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务

GoogleMapsResultItem

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

The result of the Google Maps.

结构 / 允许值：object。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
places	Array<GoogleMapsResultPlaces>	可选	未注明		完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
widget_context_token	string	可选	未注明		完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

GoogleMapsResultPlaces

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

结构 / 允许值：object。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
name	string	可选	未注明		完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
place_id	string	可选	未注明		完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
review_snippets	Array<ReviewSnippet>	可选	未注明		完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
url	string	可选	未注明		完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

GoogleMapsResultStep

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

Google Maps result step.

结构 / 允许值：object。

官方 required：call_id、result、type。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
call_id	string	必填	未注明	Required. ID to match the ID from the function call block.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
result	Array<GoogleMapsResultItem>	必填	未注明		完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
signature	string (byte)	可选	未注明	A signature hash for backend validation.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
type	"google_maps_result"	必填	未注明		完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

GoogleSearch

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

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

结构 / 允许值：object。

官方 required：type。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
search_types	Array<"web_search" / "image_search" / "enterprise_web_search">	可选	未注明	The types of search grounding to enable.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
type	"google_search"	必填	未注明		完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

枚举含义（$.properties.search_types.items）：

• 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.

GoogleSearchCallArguments

出现位置：响应 / 错误 / SSE。

The arguments to pass to Google Search.

结构 / 允许值：object。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
queries	Array<string>	可选	未注明	Web search queries for the following-up web search.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务

GoogleSearchCallDelta

出现位置：响应 / 错误 / SSE。

结构 / 允许值：object。

官方 required：arguments、type。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
arguments	GoogleSearchCallArguments	必填	未注明		完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
signature	string (byte)	可选	未注明	A signature hash for backend validation.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
type	"google_search_call"	必填	未注明		完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务

GoogleSearchCallStep

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

Google Search call step.

结构 / 允许值：object。

官方 required：arguments、id、type。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
arguments	GoogleSearchCallStepArguments	必填	未注明	Required. The arguments to pass to Google Search.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
id	string	必填	未注明	Required. A unique ID for this specific tool call.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
search_type	"web_search" / "image_search" / "enterprise_web_search"	可选	未注明	The type of search grounding enabled.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
signature	string (byte)	可选	未注明	A signature hash for backend validation.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
type	"google_search_call"	必填	未注明		完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

枚举含义（$.properties.search_type）：

• 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.

GoogleSearchCallStepArguments

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

The arguments to pass to Google Search.

结构 / 允许值：object。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
queries	Array<string>	可选	未注明	Web search queries for the following-up web search.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

GoogleSearchResult

出现位置：响应 / 错误 / SSE。

The result of the Google Search.

结构 / 允许值：object。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
search_suggestions	string	可选	未注明	Web content snippet that can be embedded in a web page or an app webview.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务

GoogleSearchResultDelta

出现位置：响应 / 错误 / SSE。

结构 / 允许值：object。

官方 required：result、type。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
is_error	boolean	可选	未注明		完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
result	Array<GoogleSearchResult>	必填	未注明		完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
signature	string (byte)	可选	未注明	A signature hash for backend validation.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
type	"google_search_result"	必填	未注明		完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务

GoogleSearchResultItem

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

The result of the Google Search.

结构 / 允许值：object。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
search_suggestions	string	可选	未注明	Web content snippet that can be embedded in a web page or an app webview.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

GoogleSearchResultStep

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

Google Search result step.

结构 / 允许值：object。

官方 required：call_id、result、type。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
call_id	string	必填	未注明	Required. ID to match the ID from the function call block.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
is_error	boolean	可选	未注明	Whether the Google Search resulted in an error.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
result	Array<GoogleSearchResultItem>	必填	未注明	Required. The results of the Google Search.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
signature	string (byte)	可选	未注明	A signature hash for backend validation.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
type	"google_search_result"	必填	未注明		完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

GroundingToolCount

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

The number of grounding tool counts.

结构 / 允许值：object。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
count	integer (int32)	可选	未注明	The number of grounding tool counts.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
type	"google_search" / "google_maps" / "retrieval"	可选	未注明	The grounding tool type associated with the count.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

枚举含义（$.properties.type）：

• 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.

HarmCategory

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

结构 / 允许值："hate_speech" / "dangerous_content" / "harassment" / "sexually_explicit" / "civic_integrity" / "image_hate" / "image_dangerous_content" / "image_harassment" / "image_sexually_explicit" / "jailbreak"。

枚举含义（$）：

• hate_speech：Content that promotes violence or incites hatred against individuals or groups based on certain attributes.
• dangerous_content：Content that promotes, facilitates, or enables dangerous activities.
• harassment：Abusive, threatening, or content intended to bully, torment, or ridicule.
• sexually_explicit：Content that contains sexually explicit material.
• civic_integrity：Deprecated: Election filter is not longer supported. The harm category is civic integrity.
• image_hate：Images that contain hate speech.
• image_dangerous_content：Images that contain dangerous content.
• image_harassment：Images that contain harassment.
• image_sexually_explicit：Images that contain sexually explicit content.
• jailbreak：Prompts designed to bypass safety filters.

HttpBearerConfig

出现位置：请求体（可能同时用于输出）。

Configuration for HTTP Bearer token credentials.

结构 / 允许值：object。

官方 required：id、token、type。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
header_name	string	可选	未注明	Optional. Header name to inject the token into. Defaults to 'Authorization'.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
id	string	必填	未注明		完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
prefix	string	可选	未注明	Optional. Prefix to prepend to the token. Defaults to 'Bearer'. Set to '' for no prefix.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
token	string	必填；仅输入	未注明	Required. Input only. The static bearer token. Write-only; never returned in responses.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
type	"bearer_token"	必填	未注明		完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

HttpBearerUpdateConfig

出现位置：请求体（可能同时用于输出）。

Configuration for updating HTTP Bearer token credentials.

结构 / 允许值：object。

官方 required：type。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
header_name	string	可选	未注明	Optional. Header name to inject the token into. Defaults to 'Authorization'.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
prefix	string	可选	未注明	Optional. Prefix to prepend to the token. Defaults to 'Bearer'. Set to '' for no prefix.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
token	string	可选；仅输入	未注明	Optional. Input only. The static bearer token. Write-only; never returned in responses.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
type	"bearer_token"	必填	未注明		完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

HttpBody

出现位置：官方保留组件。

Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.

结构 / 允许值：object。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
content_type	string	可选	未注明	The HTTP Content-Type header value specifying the content type of the body.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
data	string (byte)	可选	未注明	The HTTP request/response body as raw binary.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
extensions	Array<Map<string, any>>	可选	未注明	Application specific response metadata. Must be set in the first response for streaming APIs.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务

HybridSearch

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

Config for Hybrid Search.

结构 / 允许值：object。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
alpha	number (float)	可选	未注明	Optional. Alpha value controls the weight between dense and sparse vector search results.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

ImageConfig

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

The configuration for image interaction.

结构 / 允许值：object。

此 schema 已废弃。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
aspect_ratio	"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"	可选	未注明	The aspect ratio of the image to generate. Supported aspect ratios: 1:1, 2:3, 3:2, 3:4, 4:3, 9:16, 16:9, 21:9. If not specified, the model will choose a default aspect ratio based on any reference images provided.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
image_size	"1K" / "2K" / "4K" / "512"	可选	未注明	Specifies the size of generated images. Supported values are 1K, 2K, 4K. If not specified, the model will use default value 1K.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

枚举含义（$.properties.aspect_ratio）：

• 1:1：1:1 aspect ratio.
• 2:3：2:3 aspect ratio.
• 3:2：3:2 aspect ratio.
• 3:4：3:4 aspect ratio.
• 4:3：4:3 aspect ratio.
• 4:5：4:5 aspect ratio.
• 5:4：5:4 aspect ratio.
• 9:16：9:16 aspect ratio.
• 16:9：16:9 aspect ratio.
• 21:9：21:9 aspect ratio.
• 1:8：1:8 aspect ratio.
• 8:1：8:1 aspect ratio.
• 1:4：1:4 aspect ratio.
• 4:1：4:1 aspect ratio.

枚举含义（$.properties.image_size）：

• 1K：1K image size.
• 2K：2K image size.
• 4K：4K image size.
• 512：512 image size.

ImageContent

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

An image content block.

结构 / 允许值：object。

官方 required：type。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
data	string (byte)	可选	未注明	The image content.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
mime_type	"image/png" / "image/jpeg" / "image/webp" / "image/heic" / "image/heif" / "image/gif" / "image/bmp" / "image/tiff"	可选	未注明	The mime type of the image.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
resolution	MediaResolution	可选	未注明	The resolution of the media.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
type	"image"	必填	未注明		完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
uri	string	可选	未注明	The URI of the image.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

枚举含义（$.properties.mime_type）：

• 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

ImageDelta

出现位置：响应 / 错误 / SSE。

结构 / 允许值：object。

官方 required：type。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
data	string (byte)	可选	未注明		完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
mime_type	"image/png" / "image/jpeg" / "image/webp" / "image/heic" / "image/heif" / "image/gif" / "image/bmp" / "image/tiff"	可选	未注明		完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
resolution	MediaResolution	可选	未注明	The resolution of the media.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
type	"image"	必填	未注明		完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
uri	string	可选	未注明		完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务

枚举含义（$.properties.mime_type）：

• 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

ImageResponseFormat

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

Configuration for image output format.

结构 / 允许值：object。

官方 required：type。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
aspect_ratio	"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"	可选	未注明	The aspect ratio for the image output.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
delivery	"inline" / "uri"	可选	未注明	The delivery mode for the image output.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
image_size	"512" / "1K" / "2K" / "4K"	可选	未注明	The size of the image output.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
mime_type	"image/jpeg"	可选	未注明	The MIME type of the image output.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
type	"image"	必填	未注明		完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

枚举含义（$.properties.aspect_ratio）：

• 1:1：1:1 aspect ratio.
• 2:3：2:3 aspect ratio.
• 3:2：3:2 aspect ratio.
• 3:4：3:4 aspect ratio.
• 4:3：4:3 aspect ratio.
• 4:5：4:5 aspect ratio.
• 5:4：5:4 aspect ratio.
• 9:16：9:16 aspect ratio.
• 16:9：16:9 aspect ratio.
• 21:9：21:9 aspect ratio.
• 1:8：1:8 aspect ratio.
• 8:1：8:1 aspect ratio.
• 1:4：1:4 aspect ratio.
• 4:1：4:1 aspect ratio.

枚举含义（$.properties.delivery）：

• inline：Image data is returned inline in the response.
• uri：Image data is returned as a URI.

枚举含义（$.properties.image_size）：

• 512：512px image size.
• 1K：1K image size.
• 2K：2K image size.
• 4K：4K image size.

枚举含义（$.properties.mime_type）：

• image/jpeg：JPEG image format.

InjectionLocation

出现位置：请求体（可能同时用于输出）。

结构 / 允许值："header" / "query" / "body"。

枚举含义（$）：

• header：Injected into HTTP request headers.
• query：Injected into HTTP URL query parameters.
• body：Injected into HTTP request body.

Interaction

出现位置：响应 / 错误 / SSE。

The Interaction resource.

结构 / 允许值：object。

官方 required：status。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
agent	AgentOption	可选	未注明	The name of the Agent used for generating the interaction.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
agent_config	AntigravityAgentConfig / CodeMenderAgentConfig / DeepResearchAgentConfig / DynamicAgentConfig	可选	未注明	Configuration parameters for the agent interaction.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
background	boolean	可选；仅输入	未注明	Input only. Whether to run the model interaction in the background.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
cached_content	string	可选；废弃	未注明	The name of the cached content used as context to serve the prediction. Note: only used in explicit caching, where users can have control over caching (e.g. what content to cache) and enjoy guaranteed cost savings. Format: cachedContents/{cachedContent}	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
continuation_token	string (byte)	可选	未注明	Opaque token to resume a long decode. Output: set when status is INCOMPLETE and decoding can be resumed. Input: pass the latest token back unchanged in CreateInteraction to continue decoding.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
created	string	可选；只读；官方描述：仅输出	未注明	Required. Output only. The time at which the response was created in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
environment	EnvironmentConfig / string	可选	未注明	The environment configuration for the interaction. Can be an object specifying remote environment sources or a string referencing an existing environment ID.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
environment_id	string	可选；只读；官方描述：仅输出	未注明	Output only. The environment ID for the interaction. Only populated if environment config is set in the request.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
errors	Array<Error>	可选；只读；官方描述：仅输出	未注明	Output only. Diagnostic faults / platform errors recorded on the interaction.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
generation_config	GenerationConfig	可选；仅输入	未注明	Input only. Configuration parameters for the model interaction.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
id	string	可选；只读；官方描述：仅输出	default=""	Required. Output only. A unique identifier for the interaction completion.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
input	InteractionsInput	可选	未注明		完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
labels	Map<string, string>	可选	未注明	The labels with user-defined metadata for the request. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
model	ModelOption	可选	未注明	The name of the Model used for generating the interaction.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
previous_interaction_id	string	可选	未注明	The ID of the previous interaction, if any.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
response_format	ResponseFormat / Array<ResponseFormat>	可选	未注明	Enforces that the generated response is a JSON object that complies with the JSON schema specified in this field.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
response_mime_type	string	可选；废弃	未注明	The mime type of the response. This is required if response_format is set.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
response_modalities	Array<ResponseModality>	可选；废弃	未注明	The requested modalities of the response (TEXT, IMAGE, AUDIO).	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
safety_settings	Array<SafetySetting>	可选	未注明	Safety settings for the interaction.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
service_tier	ServiceTier	可选	未注明	The service tier for the interaction.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
status	"in_progress" / "requires_action" / "completed" / "failed" / "cancelled" / "incomplete" / "budget_exceeded" / "queued"	必填；只读；官方描述：仅输出	未注明	Required. Output only. The status of the interaction.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
steps	Array<Step>	可选；只读；官方描述：仅输出	未注明	Required. Output only. The steps that make up the interaction, when included in the response.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
store	boolean	可选；仅输入	未注明	Input only. Whether to store the response and request for later retrieval.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
stream	boolean	可选；仅输入	未注明	Input only. Whether the interaction will be streamed.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
system_instruction	string	可选	未注明	System instruction for the interaction.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
tools	Array<Tool>	可选	未注明	A list of tool declarations the model may call during interaction.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
updated	string	可选；只读；官方描述：仅输出	未注明	Required. Output only. The time at which the response was last updated in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
usage	Usage	可选；只读；官方描述：仅输出	未注明	Output only. Statistics on the interaction request's token usage.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
webhook_config	WebhookConfig	可选	未注明	Optional. Webhook configuration for receiving notifications when the interaction completes.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务

枚举含义（$.properties.status）：

• 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：Deprecated: Token and execution budget exhaustion returns INCOMPLETE (11).
• queued：The interaction is queued, waiting for processing (e.g. waiting for off-peak capacity).

InteractionCompletedEvent

出现位置：响应 / 错误 / SSE。

Signals that the Interaction completed. Sent when the Interaction receives Complete/Cancel or naturally terminates. No more input can be sent to the Interaction after this.

结构 / 允许值：object。

官方 required：event_type、interaction。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
event_id	string	可选	未注明	The event_id token to be used to resume the interaction stream, from this event.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
event_type	"interaction.completed"	必填	未注明		完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
interaction	InteractionSseEventInteraction	必填	未注明	Required. Partial completed interaction resource emitted at the end of the stream.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务

InteractionCreatedEvent

出现位置：响应 / 错误 / SSE。

Server response confirming that a new interaction was created.

结构 / 允许值：object。

官方 required：event_type、interaction。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
event_id	string	可选	未注明	The event_id token to be used to resume the interaction stream, from this event.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
event_type	"interaction.created"	必填	未注明		完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
interaction	InteractionSseEventInteraction	必填	未注明	Required. Partial interaction resource emitted when the stream is created.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务

InteractionSseEventInteraction

出现位置：响应 / 错误 / SSE。

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.

结构 / 允许值：object。

官方 required：id、status。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
agent	string	可选	未注明	The agent to interact with.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
continuation_token	string (byte)	可选；只读；官方描述：仅输出	未注明	Output only. Opaque token to resume a long decode when status is incomplete.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
created	string	可选；只读；官方描述：仅输出	未注明	Output only. The time at which the response was created in ISO 8601 format.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
id	string	必填；只读；官方描述：仅输出	未注明	Required. Output only. A unique identifier for the interaction completion.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
model	string	可选	未注明	The model that will complete your prompt.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
object	string	可选；只读；官方描述：仅输出	未注明	Output only. The resource type.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
service_tier	ServiceTier	可选	未注明	The service tier for the interaction.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
status	"in_progress" / "requires_action" / "completed" / "failed" / "cancelled" / "incomplete"	必填；只读；官方描述：仅输出	未注明	Required. Output only. The status of the interaction.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
steps	Array<Step>	可选；只读；官方描述：仅输出	未注明	Output only. The steps that make up the interaction, if included in this event.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
updated	string	可选；只读；官方描述：仅输出	未注明	Output only. The time at which the response was last updated in ISO 8601 format.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
usage	Usage	可选；只读；官方描述：仅输出	未注明	Output only. Statistics on the interaction request's token usage.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务

枚举含义（$.properties.status）：

• 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).

InteractionSseStreamEnvelope

出现位置：响应 / 错误 / SSE。

结构 / 允许值：object。

官方 required：data。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
data	InteractionSseStreamEvent	必填	未注明		完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务

InteractionSseStreamEvent

出现位置：响应 / 错误 / SSE。

结构 / 允许值：ErrorEvent / InteractionCompletedEvent / InteractionCreatedEvent / InteractionStatusUpdate / StepDelta / StepStart / StepStop。

InteractionStatusUpdate

出现位置：响应 / 错误 / SSE。

结构 / 允许值：object。

官方 required：event_type、interaction_id、status。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
event_id	string	可选	未注明	The event_id token to be used to resume the interaction stream, from this event.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
event_type	"interaction.status_update"	必填	未注明		完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
interaction_id	string	必填	未注明		完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
status	"in_progress" / "requires_action" / "completed" / "failed" / "cancelled" / "incomplete" / "budget_exceeded" / "queued"	必填	未注明		完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务

枚举含义（$.properties.status）：

• 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：Deprecated: Token and execution budget exhaustion returns INCOMPLETE (11).
• queued：The interaction is queued, waiting for processing (e.g. waiting for off-peak capacity).

InteractionsInput

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

The input for the interaction.

结构 / 允许值：Content / Array<Step> / Array<Content> / string。

ListAgentsResponse

出现位置：响应 / 错误 / SSE。

结构 / 允许值：object。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
agents	Array<Agent>	可选	未注明	The list of agents.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
next_page_token	string	可选	未注明	A token to retrieve the next page of results.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务

ListCredentialsResponse

出现位置：响应 / 错误 / SSE。

结构 / 允许值：object。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
credentials	Array<Credential>	可选	未注明		完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
next_page_token	string	可选	未注明		完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务

ListEnvironmentsResponse

出现位置：响应 / 错误 / SSE。

Response for ListEnvironments.

结构 / 允许值：object。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
environments	Array<Environment>	可选	未注明	Environments belonging to the provided project.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
next_page_token	string	可选	未注明	Pagination token.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务

ListTriggerExecutionsResponse

出现位置：响应 / 错误 / SSE。

Response message for TriggerService.ListTriggerExecutions.

结构 / 允许值：object。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
next_page_token	string	可选	未注明	A page token, received from a previous ListTriggerExecutions call. Provide this to retrieve the subsequent page.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
trigger_executions	Array<TriggerExecution>	可选	未注明	The list of trigger executions.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务

ListTriggersResponse

出现位置：响应 / 错误 / SSE。

Response message for TriggerService.ListTriggers.

结构 / 允许值：object。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
next_page_token	string	可选	未注明	A page token, received from a previous ListTriggers call. Provide this to retrieve the subsequent page.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
triggers	Array<Trigger>	可选	未注明	The list of triggers.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务

ListVoicesResponse

出现位置：响应 / 错误 / SSE。

Response message for VoicesService.ListVoices.

结构 / 允许值：object。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
next_page_token	string	可选	未注明	A token that can be sent as page_token to retrieve the next page. If empty, there are no subsequent pages.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
voices	Array<Voice>	可选	未注明	The voices from the specified collection.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务

ListWebhooksResponse

出现位置：响应 / 错误 / SSE。

Response message for WebhookService.ListWebhooks.

结构 / 允许值：object。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
next_page_token	string	可选	未注明	A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
webhooks	Array<Webhook>	可选	未注明	The webhooks.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务

McpServer

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

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

结构 / 允许值：object。

官方 required：type。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
allowed_tools	Array<AllowedTools>	可选	未注明	The allowed tools.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
headers	Map<string, string>	可选	未注明	Optional: Fields for authentication headers, timeouts, etc., if needed.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
name	string	可选	未注明	The name of the MCPServer.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
type	"mcp_server"	必填	未注明		完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
url	string	可选	未注明	The full URL for the MCPServer endpoint. Example: "https://api.example.com/mcp"	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

McpServerToolCallDelta

出现位置：响应 / 错误 / SSE。

结构 / 允许值：object。

官方 required：arguments、name、server_name、type。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
arguments	Map<string, any>	必填	未注明		完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
name	string	必填	未注明		完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
server_name	string	必填	未注明		完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
type	"mcp_server_tool_call"	必填	未注明		完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务

McpServerToolCallStep

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

MCPServer tool call step.

结构 / 允许值：object。

官方 required：arguments、id、name、server_name、type。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
arguments	Map<string, any>	必填	未注明	Required. The JSON object of arguments for the function.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
id	string	必填	未注明	Required. A unique ID for this specific tool call.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
name	string	必填	未注明	Required. The name of the tool which was called.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
server_name	string	必填	未注明	Required. The name of the used MCP server.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
type	"mcp_server_tool_call"	必填	未注明		完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

McpServerToolResultDelta

出现位置：响应 / 错误 / SSE。

结构 / 允许值：object。

官方 required：result、type。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
name	string	可选	未注明		完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
result	Array<FunctionResultSubContent> / object / string	必填	未注明		完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
server_name	string	可选	未注明		完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
type	"mcp_server_tool_result"	必填	未注明		完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务

McpServerToolResultStep

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

MCPServer tool result step.

结构 / 允许值：object。

官方 required：call_id、result、type。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
call_id	string	必填	未注明	Required. ID to match the ID from the function call block.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
name	string	可选	未注明	Name of the tool which is called for this specific tool call.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
result	Array<FunctionResultSubContent> / object / string	必填	未注明	Required. The output from the MCP server call. Can be simple text or rich content.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
server_name	string	可选	未注明	The name of the used MCP server.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
type	"mcp_server_tool_result"	必填	未注明		完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

MediaProcessing

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

结构 / 允许值：StaticMediaProcessing。

MediaResolution

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

结构 / 允许值："low" / "medium" / "high" / "ultra_high"。

枚举含义（$）：

• low：Low resolution.
• medium：Medium resolution.
• high：High resolution.
• ultra_high：Ultra high resolution.

ModalityTokens

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

The token count for a single response modality.

结构 / 允许值：object。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
modality	ResponseModality	可选	未注明	The modality associated with the token count.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
tokens	integer (int32)	可选	未注明	Number of tokens for the modality.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

ModelInteraction

出现位置：请求体（可能同时用于输出）。

Interaction for generating the completion using models.

结构 / 允许值：object。

官方 required：created、id、model、status、steps、updated。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
background	boolean	可选；仅输入	未注明	Input only. Whether to run the model interaction in the background.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
cached_content	string	可选；废弃	未注明	The name of the cached content used as context to serve the prediction. Note: only used in explicit caching, where users can have control over caching (e.g. what content to cache) and enjoy guaranteed cost savings. Format: cachedContents/{cachedContent}	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
continuation_token	string (byte)	可选	未注明	Opaque token to resume a long decode. Output: set when status is INCOMPLETE and decoding can be resumed. Input: pass the latest token back unchanged in CreateInteraction to continue decoding.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
created	string	必填；只读；官方描述：仅输出	未注明	Required. Output only. The time at which the response was created in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
environment	EnvironmentConfig / string	可选	未注明	The environment configuration for the interaction. Can be an object specifying remote environment sources or a string referencing an existing environment ID.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
environment_id	string	可选；只读；官方描述：仅输出	未注明	Output only. The environment ID for the interaction. Only populated if environment config is set in the request.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
generation_config	GenerationConfig	可选；仅输入	未注明	Input only. Configuration parameters for the model interaction.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
id	string	必填；只读；官方描述：仅输出	未注明	Required. Output only. A unique identifier for the interaction completion.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
input	InteractionsInput	可选	未注明		完整转发，由 Google 校验	部分：messages 仅文本；没有 Content/Step JSON 接口
labels	Map<string, string>	可选	未注明	The labels with user-defined metadata for the request. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
model	ModelOption	必填	未注明	The name of the Model used for generating the interaction.	完整转发，由 Google 校验	映射：聊天 model（实际模型目录决定）
previous_interaction_id	string	可选	未注明	The ID of the previous interaction, if any.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
response_format	ResponseFormat / Array<ResponseFormat>	可选	未注明	Enforces that the generated response is a JSON object that complies with the JSON schema specified in this field.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
response_mime_type	string	可选；废弃	未注明	The mime type of the response. This is required if response_format is set.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
response_modalities	Array<ResponseModality>	可选；废弃	未注明	The requested modalities of the response (TEXT, IMAGE, AUDIO).	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
safety_settings	Array<SafetySetting>	可选	未注明	Safety settings for the interaction.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
service_tier	ServiceTier	可选	未注明	The service tier for the interaction.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
status	"in_progress" / "requires_action" / "completed" / "failed" / "cancelled" / "incomplete" / "budget_exceeded" / "queued"	必填；只读；官方描述：仅输出	未注明	Required. Output only. The status of the interaction.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
store	boolean	可选；仅输入	未注明	Input only. Whether to store the response and request for later retrieval.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
stream	boolean	可选；仅输入	未注明	Input only. Whether the interaction will be streamed.	完整转发，由 Google 校验	部分：聊天 SSE；不是 Interactions 事件流
system_instruction	string	可选	未注明	System instruction for the interaction.	完整转发，由 Google 校验	映射：messages 中的 system 文本
tools	Array<Tool>	可选	未注明	A list of tool declarations the model may call during interaction.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
updated	string	必填；只读；官方描述：仅输出	未注明	Required. Output only. The time at which the response was last updated in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
webhook_config	WebhookConfig	可选	未注明	Optional. Webhook configuration for receiving notifications when the interaction completes.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

枚举含义（$.properties.status）：

• 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：Deprecated: Token and execution budget exhaustion returns INCOMPLETE (11).
• queued：The interaction is queued, waiting for processing (e.g. waiting for off-peak capacity).

ModelOption

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

The model that will complete your prompt.\n\nSee models for additional details.

结构 / 允许值："gemini-2.5-flash" / "gemini-2.5-pro" / "gemma-4-26b-a4b-it" / "gemma-4-31b-it" / "gemini-flash-latest" / "gemini-flash-lite-latest" / "gemini-pro-latest" / "gemini-2.5-flash-lite" / "gemini-2.5-flash-image" / "gemini-3-flash-preview" / "gemini-3.1-pro-preview" / "gemini-3.1-pro-preview-customtools" / "gemini-3.1-flash-lite" / "gemini-3-pro-image" / "nano-banana-pro-preview" / "gemini-3.1-flash-image" / "gemini-3.1-flash-tts-preview" / "gemini-3.5-flash" / "gemini-3.6-flash" / "gemini-3.7-flash" / "gemini-3.8-flash" / "gemini-3.8-flash-tts" / "gemini-3.8-flash-lite-tts" / "lyria-3-clip-preview" / "lyria-3-pro-preview" / "gemini-robotics-er-1.6-preview" / "gemini-robotics-er-2-preview" / "lyria-3.5" / "gemini-omni-1.1-flash" / "gemini-omni-flash-preview"。

ModelOutputStep

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

Output generated by the model.

结构 / 允许值：object。

官方 required：type。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
content	Array<Content>	可选	未注明		完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
error	Status	可选；废弃	未注明	The error result of the operation in case of failure or cancellation.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
type	"model_output"	必填	未注明		完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

OAuth2Config

出现位置：请求体（可能同时用于输出）。

Configuration for OAuth2 credentials with automatic token refresh.

结构 / 允许值：object。

官方 required：client_id、client_secret、id、refresh_token、token_url、type。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
client_id	string	必填	未注明	Required. OAuth2 client ID.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
client_secret	string	必填；仅输入	未注明	Required. Input only. OAuth2 client secret. Write-only; never returned in responses.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
id	string	必填	未注明		完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
refresh_token	string	必填；仅输入	未注明	Required. Input only. OAuth2 refresh token. Write-only; never returned in responses.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
scopes	Array<string>	可选	未注明	Optional. List of OAuth2 scopes.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
token_url	string	必填	未注明	Required. OAuth2 token endpoint URL for refreshing access tokens.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
type	"oauth2"	必填	未注明		完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

OAuth2UpdateConfig

出现位置：请求体（可能同时用于输出）。

Configuration for updating OAuth2 credentials.

结构 / 允许值：object。

官方 required：type。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
client_id	string	可选	未注明	Optional. OAuth2 client ID.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
client_secret	string	可选；仅输入	未注明	Optional. Input only. OAuth2 client secret. Write-only; never returned in responses.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
refresh_token	string	可选；仅输入	未注明	Optional. Input only. OAuth2 refresh token. Write-only; never returned in responses.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
scopes	Array<string>	可选	未注明	Optional. List of OAuth2 scopes.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
token_url	string	可选	未注明	Optional. OAuth2 token endpoint URL for refreshing access tokens.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
type	"oauth2"	必填	未注明		完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

ParallelAISearchConfig

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

Used to specify configuration for ParallelAISearch.

结构 / 允许值：object。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
api_key	string	可选	未注明	Optional. The API key for ParallelAiSearch.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
custom_config	Map<string, any>	可选	未注明	Optional. Custom configs for ParallelAiSearch.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

PingWebhookRequest

出现位置：请求体（可能同时用于输出）。

Request message for WebhookService.PingWebhook.

结构 / 允许值：object。

PingWebhookResponse

出现位置：响应 / 错误 / SSE。

Response message for WebhookService.PingWebhook.

结构 / 允许值：object。

Pitch

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

结构 / 允许值："low" / "medium" / "high"。

枚举含义（$）：

• low：Lower pitch voice.
• medium：Medium pitch voice.
• high：Higher pitch voice.

PlaceCitation

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

A place citation annotation.

结构 / 允许值：object。

官方 required：type。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
end_index	integer (int32)	可选	未注明	End of the attributed segment, exclusive.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
name	string	可选	未注明	Title of the place.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
place_id	string	可选	未注明	The ID of the place, in places/{place_id} format.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
review_snippets	Array<ReviewSnippet>	可选	未注明	Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
start_index	integer (int32)	可选	未注明	Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
type	"place_citation"	必填	未注明		完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
url	string	可选	未注明	URI reference of the place.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

Places

出现位置：响应 / 错误 / SSE。

结构 / 允许值：object。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
name	string	可选	未注明	Title of the place.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
place_id	string	可选	未注明	The ID of the place, in places/{place_id} format.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
review_snippets	Array<ReviewSnippet>	可选	未注明	Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
url	string	可选	未注明	URI reference of the place.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务

ProcessingCallDelta

出现位置：响应 / 错误 / SSE。

Streaming delta for a server-initiated media processing step.

结构 / 允许值：object。

官方 required：type。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
signature	string (byte)	可选	未注明	A signature hash for backend validation.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
type	"processing_call"	必填	未注明		完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务

ProcessingCallStep

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

A server-initiated processing step for media analysis (e.g. video understanding).

结构 / 允许值：object。

官方 required：id、type。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
id	string	必填	未注明	Required. A unique ID for this specific tool call.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
signature	string (byte)	可选	未注明	A signature hash for backend validation.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
type	"processing_call"	必填	未注明		完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

ProcessingResultDelta

出现位置：响应 / 错误 / SSE。

Streaming delta for the result of a server-initiated media processing step.

结构 / 允许值：object。

官方 required：type。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
signature	string (byte)	可选	未注明	A signature hash for backend validation.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
type	"processing_result"	必填	未注明		完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务

ProcessingResultStep

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

The result of a server-initiated media processing step.

结构 / 允许值：object。

官方 required：call_id、type。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
call_id	string	必填	未注明	Required. ID to match the ID from the function call block.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
signature	string (byte)	可选	未注明	A signature hash for backend validation.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
type	"processing_result"	必填	未注明		完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

PromptedVoice

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

Parameters for prompted voice generation. Required in CreateVoice when type is "prompted". Returned in CreateVoice, GetVoice, and ListVoices responses for prompted voices.

结构 / 允许值：object。

官方 required：input。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
input	string	必填	未注明	Required. The natural-language prompt describing the desired voice, e.g. "A deep, booming male voice of a massive evil ogre in his middle years."	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

RagResource

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

The definition of the Rag resource.

结构 / 允许值：object。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
rag_corpus	string	可选	未注明	Optional. RagCorpora resource name.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
rag_file_ids	Array<string>	可选	未注明	Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

RagRetrievalConfig

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

Specifies the context retrieval config.

结构 / 允许值：object。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
filter	Filter	可选	未注明	Optional. Config for filters.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
hybrid_search	HybridSearch	可选	未注明	Optional. Config for Hybrid Search.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
ranking	Ranking	可选	未注明	Optional. Config for ranking and reranking.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
top_k	integer (int32)	可选	未注明	Optional. The number of contexts to retrieve.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

RagStoreConfig

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

Use to specify configuration for RAG Store.

结构 / 允许值：object。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
rag_resources	Array<RagResource>	可选	未注明	Optional. The representation of the rag source.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
rag_retrieval_config	RagRetrievalConfig	可选	未注明	Optional. The retrieval config for the Rag query.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
similarity_top_k	integer (int32)	可选；废弃	未注明	Optional. Number of top k results to return from the selected corpora.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
vector_distance_threshold	number (double)	可选；废弃	未注明	Optional. Only return results with vector distance smaller than the threshold.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

RankService

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

Config for Rank Service.

结构 / 允许值：object。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
model_name	string	可选	未注明	Optional. The model name of the rank service.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

Ranking

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

Config for ranking and reranking.

结构 / 允许值：object。

官方 required：ranking_config。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
model_name	string	可选	未注明	Optional. The model name of the rank service.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
rank_service	RankService	可选	未注明	Config for Rank Service.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
ranking_config	"rank_service"	必填	未注明		完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

ReplicatedVoice

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

Input only. Parameters for replicated voice generation. Required on input when type is "replicated". Not returned in responses.

结构 / 允许值：object。

官方 required：consent_audio、source_audio。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
consent_audio	AudioData	必填	未注明	Required. Audio recording of the same speaker reading the required consent phrase, confirming authorization to replicate the voice.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
source_audio	AudioData	必填	未注明	Required. The reference audio sample of the speaker's voice to replicate. Must be an unmodified recording of an adult human voice.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

ResponseFormat

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

结构 / 允许值：AudioResponseFormat / ImageResponseFormat / TextResponseFormat / VideoResponseFormat / Map<string, any>。

ResponseModality

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

结构 / 允许值："text" / "image" / "audio" / "video" / "document"。

枚举含义（$）：

• 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.

Retrieval

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

A tool that can be used by the model to retrieve files.

结构 / 允许值：object。

官方 required：type。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
exa_ai_search_config	ExaAISearchConfig	可选	未注明	Used to specify configuration for ExaAISearch.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
parallel_ai_search_config	ParallelAISearchConfig	可选	未注明	Used to specify configuration for ParallelAISearch.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
rag_store_config	RagStoreConfig	可选	未注明	Used to specify configuration for RagStore.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
retrieval_types	Array<"vertex_ai_search" / "rag_store" / "exa_ai_search" / "parallel_ai_search">	可选	未注明	The types of file retrieval to enable.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
type	"retrieval"	必填	未注明		完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
vertex_ai_search_config	VertexAISearchConfig	可选	未注明	Used to specify configuration for VertexAISearch.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

枚举含义（$.properties.retrieval_types.items）：

• vertex_ai_search：官方未说明
• rag_store：官方未说明
• exa_ai_search：官方未说明
• parallel_ai_search：官方未说明

RetrievalCallDelta

出现位置：响应 / 错误 / SSE。

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

结构 / 允许值：object。

官方 required：arguments、type。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
arguments	RetrievalStepArguments	必填	未注明	Required. The arguments to pass to the Retrieval tool.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
retrieval_type	"vertex_ai_search" / "rag_store" / "exa_ai_search" / "parallel_ai_search"	可选	未注明	The type of retrieval tools.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
signature	string (byte)	可选	未注明	A signature hash for backend validation.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
type	"retrieval_call"	必填	未注明		完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务

枚举含义（$.properties.retrieval_type）：

• vertex_ai_search：官方未说明
• rag_store：官方未说明
• exa_ai_search：官方未说明
• parallel_ai_search：官方未说明

RetrievalCallStep

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

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

结构 / 允许值：object。

官方 required：arguments、id、type。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
arguments	RetrievalStepArguments	必填	未注明	Required. The arguments to pass to the retrieval tool.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
id	string	必填	未注明	Required. A unique ID for this specific tool call.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
retrieval_type	"vertex_ai_search" / "rag_store" / "exa_ai_search" / "parallel_ai_search"	可选	未注明	The type of retrieval tools.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
signature	string (byte)	可选	未注明	A signature hash for backend validation.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
type	"retrieval_call"	必填	未注明		完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

枚举含义（$.properties.retrieval_type）：

• vertex_ai_search：官方未说明
• rag_store：官方未说明
• exa_ai_search：官方未说明
• parallel_ai_search：官方未说明

RetrievalResultDelta

出现位置：响应 / 错误 / SSE。

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

结构 / 允许值：object。

官方 required：type。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
is_error	boolean	可选	未注明	Whether the retrieval resulted in an error.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
signature	string (byte)	可选	未注明	A signature hash for backend validation.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
type	"retrieval_result"	必填	未注明		完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务

RetrievalResultStep

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

Vertex Retrieval result step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc.

结构 / 允许值：object。

官方 required：call_id、type。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
call_id	string	必填	未注明	Required. ID to match the ID from the function call block.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
is_error	boolean	可选	未注明	Whether the retrieval resulted in an error.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
signature	string (byte)	可选	未注明	A signature hash for backend validation.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
type	"retrieval_result"	必填	未注明		完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

RetrievalStepArguments

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

The arguments to pass to Retrieval tools.

结构 / 允许值：object。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
queries	Array<string>	可选	未注明	Queries for Retrieval information.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

ReviewSnippet

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

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

结构 / 允许值：object。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
review_id	string	可选	未注明	The ID of the review snippet.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
title	string	可选	未注明	Title of the review.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
url	string	可选	未注明	A link that corresponds to the user review on Google Maps.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

RotateSigningSecretRequest

出现位置：请求体（可能同时用于输出）。

Request message for WebhookService.RotateSigningSecret.

结构 / 允许值：object。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
revocation_behavior	"revoke_previous_secrets_after_h24" / "revoke_previous_secrets_immediately"	可选	未注明	Optional. The revocation behavior for previous signing secrets.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

枚举含义（$.properties.revocation_behavior）：

• revoke_previous_secrets_after_h24：Generate a new signing secret and revoke all previous secrets after 24 hours. Default and safest option for migrations.
• revoke_previous_secrets_immediately：Revoke all previous secrets immediately. Use with caution as this can interrupt ongoing notifications.

RotateSigningSecretResponse

出现位置：响应 / 错误 / SSE。

Response message for WebhookService.RotateSigningSecret.

结构 / 允许值：object。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
secret	string	可选；只读；官方描述：仅输出	未注明	Output only. The newly generated signing secret.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务

RunTriggerRequest

出现位置：官方保留组件。

Request message for TriggerService.RunTrigger.

结构 / 允许值：object。

官方 required：id。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
id	string	必填	未注明	Required. The ID of the trigger to run immediately.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务

SafetySetting

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

A safety setting that affects the safety-blocking behavior. A SafetySetting consists of a harm category and a threshold for that category.

结构 / 允许值：object。

官方 required：threshold、type。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
method	"severity" / "probability"	可选	未注明	Optional. The method for blocking content. If not specified, the default behavior is to use the probability score.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
threshold	"block_low_and_above" / "block_medium_and_above" / "block_only_high" / "block_none" / "off"	必填	未注明	Required. The threshold for blocking content. If the harm probability exceeds this threshold, the content will be blocked.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
type	HarmCategory	必填	未注明	Required. The type of harm category to be blocked.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

枚举含义（$.properties.method）：

• severity：The harm block method uses both probability and severity scores.
• probability：The harm block method uses the probability score.

枚举含义（$.properties.threshold）：

• block_low_and_above：Block content with a low harm probability or higher.
• block_medium_and_above：Block content with a medium harm probability or higher.
• block_only_high：Block content with a high harm probability.
• block_none：Do not block any content, regardless of its harm probability.
• off：Turn off the safety filter entirely.

ServiceTier

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

结构 / 允许值："flex" / "standard" / "priority" / "deferred"。

枚举含义（$）：

• flex：Flex service tier.
• standard：Standard service tier.
• priority：Priority service tier.
• deferred：Deferred service tier.

SessionConfig

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

The configuration of CodeMender sessions.

结构 / 允许值：object。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
max_rounds	integer (int32)	可选	未注明	The maximum number of interaction rounds the agent is allowed to perform before reaching a timeout.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

SigningSecret

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

Represents a signing secret used to verify webhook payloads.

结构 / 允许值：object。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
expire_time	string (date-time)	可选；只读；官方描述：仅输出	未注明	Output only. The expiration date of the signing secret.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
truncated_secret	string	可选；只读；官方描述：仅输出	未注明	Output only. The truncated version of the signing secret.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

SmartTranscriptionMode

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

Configuration for smart transcription mode.

结构 / 允许值：object。

官方 required：type。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
type	"smart"	必填	未注明		完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

Source

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

A source to be mounted into the environment.

结构 / 允许值：object。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
content	string	可选	未注明	The inline content if type is INLINE.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
encoding	string	可选	未注明	Optional encoding for inline content (e.g. base64).	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
source	string	可选	未注明	The source of the environment. For Cloud Storage, this is the Cloud Storage path. For GitHub, this is the GitHub path.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
target	string	可选	未注明	Where the source should appear in the environment.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
type	"gcs" / "inline" / "repository" / "skill_registry"	可选	未注明		完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

枚举含义（$.properties.type）：

• gcs：A Cloud Storage 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.

SpeakerConfig

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

Configuration for multi-speaker and speech generation.

结构 / 允许值：object。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
speakers	Array<SpeechConfig>	可选	未注明	Individual speaker configurations.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

SpeechAnnotation

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

Speech annotation for text content.

结构 / 允许值：object。

官方 required：type。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
end_index	integer (int32)	可选	未注明	End of the attributed segment, exclusive.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
speaker	string	可选	未注明	The speaker to associate with this turn.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
start_index	integer (int32)	可选	未注明	Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
style	string	可选	未注明	Style instruction for the speech synthesis.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
type	"speech_metadata"	必填	未注明		完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

SpeechConfig

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

The configuration for speech interaction.

结构 / 允许值：object。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
language	string	可选	未注明	The language of the speech.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
speaker	string	可选	未注明	The speaker's name, it should match the speaker name given in the prompt.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
voice	string	可选	未注明	The voice of the speaker.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

StaticMediaProcessing

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

结构 / 允许值：object。

官方 required：type。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
end_offset	string (google-duration)	可选	未注明	Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than start_offset if start_offset is set.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
fps	number (double)	可选	未注明	Optional. Video frame-rate sampling density.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
start_offset	string (google-duration)	可选	未注明	Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
type	"static"	必填	未注明		完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

Status

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

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. 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.

结构 / 允许值：object。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
code	integer (int32)	可选	未注明	The status code, which should be an enum value of google.rpc.Code.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
details	Array<Map<string, any>>	可选	未注明	A list of messages that carry the error details. There is a common set of message types for APIs to use.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
message	string	可选	未注明	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.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

Step

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

A step in the interaction.

结构 / 允许值：CodeExecutionCallStep / CodeExecutionResultStep / FileSearchCallStep / FileSearchResultStep / FunctionCallStep / FunctionResultStep / GoogleMapsCallStep / GoogleMapsResultStep / GoogleSearchCallStep / GoogleSearchResultStep / McpServerToolCallStep / McpServerToolResultStep / ModelOutputStep / ProcessingCallStep / ProcessingResultStep / RetrievalCallStep / RetrievalResultStep / ThoughtStep / UrlContextCallStep / UrlContextResultStep / UserInputStep。

StepDelta

出现位置：响应 / 错误 / SSE。

结构 / 允许值：object。

官方 required：delta、event_type、index。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
delta	StepDeltaData	必填	未注明		完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
event_id	string	可选	未注明	The event_id token to be used to resume the interaction stream, from this event.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
event_type	"step.delta"	必填	未注明		完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
index	integer (int32)	必填	未注明		完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
metadata	StepDeltaMetadata	可选	未注明		完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务

StepDeltaData

出现位置：响应 / 错误 / SSE。

结构 / 允许值：ArgumentsDelta / AudioDelta / CodeExecutionCallDelta / CodeExecutionResultDelta / DocumentDelta / FileSearchCallDelta / FileSearchResultDelta / FunctionResultDelta / GoogleMapsCallDelta / GoogleMapsResultDelta / GoogleSearchCallDelta / GoogleSearchResultDelta / ImageDelta / McpServerToolCallDelta / McpServerToolResultDelta / ProcessingCallDelta / ProcessingResultDelta / RetrievalCallDelta / RetrievalResultDelta / TextAnnotationDelta / TextDelta / ThoughtSignatureDelta / ThoughtSummaryDelta / UrlContextCallDelta / UrlContextResultDelta / VideoDelta。

StepDeltaMetadata

出现位置：响应 / 错误 / SSE。

Optional metadata accompanying ANY streamed event.

结构 / 允许值：object。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
total_usage	Usage	可选	未注明	Statistics on the interaction request's token usage.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务

StepStart

出现位置：响应 / 错误 / SSE。

结构 / 允许值：object。

官方 required：event_type、index、step。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
event_id	string	可选	未注明	The event_id token to be used to resume the interaction stream, from this event.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
event_type	"step.start"	必填	未注明		完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
index	integer (int32)	必填	未注明		完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
step	Step	必填	未注明		完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务

StepStop

出现位置：响应 / 错误 / SSE。

结构 / 允许值：object。

官方 required：event_type、index。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
event_id	string	可选	未注明	The event_id token to be used to resume the interaction stream, from this event.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
event_type	"step.stop"	必填	未注明		完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
index	integer (int32)	必填	未注明		完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
step_usage	Usage	可选	未注明	Model usage stats for this specific step.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
usage	Usage	可选	未注明	Cumulative model usage stats from the start of the session.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务

TextAnnotationDelta

出现位置：响应 / 错误 / SSE。

结构 / 允许值：object。

官方 required：type。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
annotations	Array<Annotation>	可选	未注明	Citation information for model-generated content.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
type	"text_annotation_delta"	必填	未注明		完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务

TextContent

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

A text content block.

结构 / 允许值：object。

官方 required：text、type。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
annotations	Array<Annotation>	可选	未注明	Citation information for model-generated content.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
text	string	必填	未注明	Required. The text content.	完整转发，由 Google 校验	部分：messages.content 文本 / 输出 content 文本
type	"text"	必填	未注明		完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

TextDelta

出现位置：响应 / 错误 / SSE。

结构 / 允许值：object。

官方 required：text、type。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
text	string	必填	未注明		完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
type	"text"	必填	未注明		完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务

TextResponseFormat

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

Configuration for text output format.

结构 / 允许值：object。

官方 required：type。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
mime_type	"application/json" / "text/plain"	可选	未注明	The MIME type of the text output.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
schema	Map<string, any>	可选	未注明	The JSON schema that the output should conform to. Only applicable when mime_type is application/json.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
type	"text"	必填	未注明		完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

枚举含义（$.properties.mime_type）：

• application/json：JSON output format.
• text/plain：Plain text output format.

ThinkingLevel

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

结构 / 允许值："minimal" / "low" / "medium" / "high"。

枚举含义（$）：

• minimal：Little to no thinking.
• low：Low thinking level.
• medium：Medium thinking level.
• high：High thinking level.

ThinkingSummaries

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

结构 / 允许值："auto" / "none"。

枚举含义（$）：

• auto：Auto thinking summaries.
• none：No thinking summaries.

ThoughtContent

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

结构 / 允许值：ImageContent / TextContent。

ThoughtSignatureDelta

出现位置：响应 / 错误 / SSE。

结构 / 允许值：object。

官方 required：type。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
signature	string (byte)	可选	未注明	Signature to match the backend source to be part of the generation.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
type	"thought_signature"	必填	未注明		完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务

ThoughtStep

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

A thought step.

结构 / 允许值：object。

官方 required：type。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
signature	string (byte)	可选	未注明	A signature hash for backend validation.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
summary	Array<ThoughtContent>	可选	未注明	A summary of the thought.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
type	"thought"	必填	未注明		完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

ThoughtSummaryDelta

出现位置：响应 / 错误 / SSE。

结构 / 允许值：object。

官方 required：type。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
content	Content	可选	未注明	A new summary item to be added to the thought.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
type	"thought_summary"	必填	未注明		完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务

Tool

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

A tool that can be used by the model.

结构 / 允许值：CodeExecution / ComputerUse / FileSearch / Function / GoogleMaps / GoogleSearch / McpServer / Retrieval / UrlContext。

ToolChoiceConfig

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

The tool choice configuration containing allowed tools.

结构 / 允许值：object。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
allowed_tools	AllowedTools	可选	未注明	The allowed tools.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

TranscriptionConfig

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

Configuration for speech recognition (transcription).

结构 / 允许值：object。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
adaptation_phrases	Array<string>	可选；废弃	未注明	Optional. A list of phrases to bias the ASR model towards.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
custom_vocabulary	Array<string>	可选	未注明	Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
diarization_mode	string	可选；废弃	未注明	Optional. Configures speaker diarization. Supported values: "speaker".	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
language_codes	Array<string>	可选	未注明	Optional. BCP-47 language codes providing hints about the languages present in the audio. If omitted or empty, defaults to automatic language detection.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
language_hints	Array<string>	可选；废弃	未注明	Deprecated: use language_codes. BCP-47 language codes providing hints about the languages present in the audio.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
mode	TranscriptionMode / "verbatim" / "smart"	可选	未注明	Discriminated transcription mode options or enum.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
timestamp_granularities	Array<string>	可选；废弃	未注明	Optional. The granularity of timestamps to include in the transcription output. Supported values: "word". If empty, no timestamps are generated.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

枚举含义（$.properties.mode.oneOf.1）：

• verbatim：Verbatim transcription mode.
• smart：Smart transcription mode.

TranscriptionMode

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

Configuration for transcription mode.

结构 / 允许值：SmartTranscriptionMode / VerbatimTranscriptionMode。

Trigger

出现位置：响应 / 错误 / SSE。

A trigger configuration that is scheduled to run an agent.

结构 / 允许值：object。

官方 required：id、interaction、schedule、time_zone。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
consecutive_failure_count	integer (int32)	可选；只读；官方描述：仅输出	未注明	Output only. The number of consecutive failures that have occurred since the last successful execution.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
create_time	string (date-time)	可选；只读；官方描述：仅输出	未注明	Output only. The time when the trigger was created.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
display_name	string	可选	未注明	Optional. The display name of the trigger.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
environment_id	string	可选	未注明	Optional. The environment ID for the trigger execution.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
execution_timeout_seconds	integer (int32)	可选	未注明	Optional. The execution timeout for the triggered interaction.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
id	string	必填；只读；官方描述：仅输出	未注明	Required. Output only. Identifier. The ID of the trigger.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
interaction	AgentInteraction	必填	未注明	Required. The interaction request template to be executed.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
last_pause_time	string (date-time)	可选；只读；官方描述：仅输出	未注明	Output only. The time when the trigger was last paused.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
last_resume_time	string (date-time)	可选；只读；官方描述：仅输出	未注明	Output only. The time when the trigger was last resumed.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
last_run_time	string (date-time)	可选；只读；官方描述：仅输出	未注明	Output only. The time when the trigger was last run.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
max_consecutive_failures	integer (int32)	可选	未注明	Optional. The maximum number of consecutive failures allowed before the trigger is automatically paused (status becomes ERROR).	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
next_run_time	string (date-time)	可选；只读；官方描述：仅输出	未注明	Output only. The time when the trigger is scheduled to run next.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
previous_interaction_id	string	可选；只读；官方描述：仅输出	未注明	Output only. The ID of the last interaction created by this trigger.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
schedule	string	必填	未注明	Required. The cron schedule on which the trigger should run. Standard cron format.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
status	"active" / "paused" / "error"	可选；只读；官方描述：仅输出	未注明	Output only. The current status of the trigger.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
time_zone	string	必填	未注明	Required. Time zone in which the schedule should be interpreted.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
update_time	string (date-time)	可选；只读；官方描述：仅输出	未注明	Output only. The time when the trigger was last updated.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务

枚举含义（$.properties.status）：

• active：The trigger is active and will fire on schedule.
• paused：The trigger is paused and will not fire.
• error：The trigger has entered an error state due to consecutive failures.

TriggerCreateParams

出现位置：请求体（可能同时用于输出）。

Parameters for creating a trigger.

结构 / 允许值：object。

官方 required：interaction、schedule、time_zone。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
display_name	string	可选	未注明	Optional. The display name of the trigger.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
environment_id	string	可选	未注明	Optional. The environment ID for the trigger execution.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
execution_timeout_seconds	integer (int32)	可选	未注明	Optional. The execution timeout for the triggered interaction.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
interaction	AgentInteraction	必填	未注明	Required. The interaction request template to be executed.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
max_consecutive_failures	integer (int32)	可选	未注明	Optional. The maximum number of consecutive failures allowed before the trigger is automatically paused (status becomes ERROR).	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
schedule	string	必填	未注明	Required. The cron schedule on which the trigger should run. Standard cron format.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
time_zone	string	必填	未注明	Required. Time zone in which the schedule should be interpreted.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

TriggerExecution

出现位置：响应 / 错误 / SSE。

An execution instance of a trigger.

结构 / 允许值：object。

官方 required：id、trigger_id。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
end_time	string (date-time)	可选；只读；官方描述：仅输出	未注明	Output only. The time when the execution finished.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
environment_id	string	可选；只读；官方描述：仅输出	未注明	Output only. The environment ID used for the execution.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
error	string	可选；只读；官方描述：仅输出	未注明	Output only. The error message if the execution failed.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
id	string	必填；只读；官方描述：仅输出	未注明	Required. Output only. Identifier. The ID of the trigger execution.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
interaction_id	string	可选；只读；官方描述：仅输出	未注明	Output only. The ID of the interaction created by this execution, if any.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
scheduled_time	string (date-time)	可选；只读；官方描述：仅输出	未注明	Output only. The time when the execution was scheduled to run.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
start_time	string (date-time)	可选；只读；官方描述：仅输出	未注明	Output only. The time when the execution started.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
status	"in_progress" / "completed" / "failed" / "skipped" / "timed_out"	可选；只读；官方描述：仅输出	未注明	Output only. The status of the execution.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
trigger_id	string	必填；只读；官方描述：仅输出	未注明	Required. Output only. Identifier. The ID of the trigger that created this execution.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务

枚举含义（$.properties.status）：

• in_progress：The execution is currently in progress.
• completed：The execution completed successfully.
• failed：The execution failed.
• skipped：The execution was skipped (e.g., previous execution still running).
• timed_out：The execution timed out.

TriggerUpdate

出现位置：请求体（可能同时用于输出）。

Represents the fields of a Trigger that can be updated.

结构 / 允许值：object。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
display_name	string	可选	未注明	Optional. The display name of the trigger.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
status	"active" / "paused" / "error"	可选	未注明	Optional. The status of the trigger.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

枚举含义（$.properties.status）：

• active：The trigger is active and will fire on schedule.
• paused：The trigger is paused and will not fire.
• error：The trigger has entered an error state due to consecutive failures.

UpdateTriggerRequest

出现位置：官方保留组件。

Request message for TriggerService.UpdateTrigger.

结构 / 允许值：object。

官方 required：id、trigger。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
id	string	必填	未注明	Required. The ID of the trigger to update.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
trigger	TriggerUpdate	必填	未注明	Required. The trigger to update.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
update_mask	string (google-fieldmask)	可选	pattern="^(\s*[^,\s.]+(\s*[,.]\s*[^,\s.]+)*)?$"	Optional. The update mask applies to the resource.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务

UpdateWebhookRequest

出现位置：官方保留组件。

Request message for WebhookService.UpdateWebhook.

结构 / 允许值：object。

官方 required：id、webhook。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
id	string	必填	未注明	Required. The ID of the webhook to update.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
update_mask	string (google-fieldmask)	可选	pattern="^(\s*[^,\s.]+(\s*[,.]\s*[^,\s.]+)*)?$"	Optional. The list of fields to update.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
webhook	WebhookUpdate	必填	未注明	Required. The webhook to update.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务

UploadEnvironmentFileRequest

出现位置：官方保留组件。

Request for UploadEnvironmentFile.

结构 / 允许值：object。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
extract	boolean	可选	未注明	Optional. If true, treats the uploaded file as a tar/tar.gz archive and unpacks it into path.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
overwrite	boolean	可选	未注明	Optional. Whether to overwrite the destination file if it already exists.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务

UploadEnvironmentFileResponse

出现位置：官方保留组件。

Response for UploadEnvironmentFile.

结构 / 允许值：object。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
files	Array<EnvironmentFile>	可选	未注明	List of files created or extracted in the environment.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务

UrlCitation

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

A URL citation annotation.

结构 / 允许值：object。

官方 required：type。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
end_index	integer (int32)	可选	未注明	End of the attributed segment, exclusive.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
start_index	integer (int32)	可选	未注明	Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
title	string	可选	未注明	The title of the URL.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
type	"url_citation"	必填	未注明		完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
url	string	可选	未注明	The URL.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

UrlContext

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

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

结构 / 允许值：object。

官方 required：type。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
type	"url_context"	必填	未注明		完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

UrlContextCallArguments

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

The arguments to pass to the URL context.

结构 / 允许值：object。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
urls	Array<string>	可选	未注明	The URLs to fetch.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

UrlContextCallDelta

出现位置：响应 / 错误 / SSE。

结构 / 允许值：object。

官方 required：arguments、type。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
arguments	UrlContextCallArguments	必填	未注明		完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
signature	string (byte)	可选	未注明	A signature hash for backend validation.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
type	"url_context_call"	必填	未注明		完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务

UrlContextCallStep

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

URL context call step.

结构 / 允许值：object。

官方 required：arguments、id、type。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
arguments	UrlContextCallArguments	必填	未注明	Required. The arguments to pass to the URL context.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
id	string	必填	未注明	Required. A unique ID for this specific tool call.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
signature	string (byte)	可选	未注明	A signature hash for backend validation.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
type	"url_context_call"	必填	未注明		完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

UrlContextCallStepArguments

出现位置：官方保留组件。

The arguments to pass to the URL context.

结构 / 允许值：object。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
urls	Array<string>	可选	未注明	The URLs to fetch.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务

UrlContextResult

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

The result of the URL context.

结构 / 允许值：object。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
status	"success" / "error" / "paywall" / "unsafe"	可选	未注明	The status of the URL retrieval.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
url	string	可选	未注明	The URL that was fetched.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

枚举含义（$.properties.status）：

• 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.

UrlContextResultDelta

出现位置：响应 / 错误 / SSE。

结构 / 允许值：object。

官方 required：result、type。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
is_error	boolean	可选	未注明		完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
result	Array<UrlContextResult>	必填	未注明		完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
signature	string (byte)	可选	未注明	A signature hash for backend validation.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
type	"url_context_result"	必填	未注明		完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务

UrlContextResultItem

出现位置：官方保留组件。

The result of the URL context.

结构 / 允许值：object。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
status	"success" / "error" / "paywall" / "unsafe"	可选	未注明	The status of the URL retrieval.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
url	string	可选	未注明	The URL that was fetched.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务

枚举含义（$.properties.status）：

• success：官方未说明
• error：官方未说明
• paywall：官方未说明
• unsafe：官方未说明

UrlContextResultStep

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

URL context result step.

结构 / 允许值：object。

官方 required：call_id、result、type。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
call_id	string	必填	未注明	Required. ID to match the ID from the function call block.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
is_error	boolean	可选	未注明	Whether the URL context resulted in an error.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
result	Array<UrlContextResult>	必填	未注明	Required. The results of the URL context.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
signature	string (byte)	可选	未注明	A signature hash for backend validation.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
type	"url_context_result"	必填	未注明		完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

Usage

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

Statistics on the interaction request's token usage.

结构 / 允许值：object。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
cached_tokens_by_modality	Array<ModalityTokens>	可选	未注明	A breakdown of cached token usage by modality.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
grounding_tool_count	Array<GroundingToolCount>	可选	未注明	Grounding tool count.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
input_tokens_by_modality	Array<ModalityTokens>	可选	未注明	A breakdown of input token usage by modality.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
output_tokens_by_modality	Array<ModalityTokens>	可选	未注明	A breakdown of output token usage by modality.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
tool_use_tokens_by_modality	Array<ModalityTokens>	可选	未注明	A breakdown of tool-use token usage by modality.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
total_cached_tokens	integer (int32)	可选	未注明	Number of tokens in the cached part of the prompt (the cached content).	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
total_input_tokens	integer (int32)	可选	未注明	Number of tokens in the prompt (context).	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
total_output_tokens	integer (int32)	可选	未注明	Total number of tokens across all the generated responses.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
total_thought_tokens	integer (int32)	可选	未注明	Number of tokens of thoughts for thinking models.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
total_tokens	integer (int32)	可选	未注明	Total token count for the interaction request (prompt + responses + other internal tokens).	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
total_tool_use_tokens	integer (int32)	可选	未注明	Number of tokens present in tool-use prompt(s).	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

UserInputStep

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

Input provided by the user.

结构 / 允许值：object。

官方 required：type。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
content	Array<Content>	可选	未注明		完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
type	"user_input"	必填	未注明		完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

VerbatimTranscriptionMode

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

Configuration for verbatim transcription mode.

结构 / 允许值：object。

官方 required：type。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
diarization_mode	string	可选	未注明	Optional. Configures speaker diarization. Supported values: "speaker".	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
timestamp_granularities	Array<string>	可选	未注明	Optional. The granularity of timestamps to include in the transcription output. Supported values: "word". If empty, no timestamps are generated.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
type	"verbatim"	必填	未注明		完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

VertexAISearchConfig

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

Used to specify configuration for VertexAISearch.

结构 / 允许值：object。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
datastores	Array<string>	可选	未注明	Optional. Used to specify Vertex AI Search datastores.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
engine	string	可选	未注明	Optional. Used to specify Vertex AI Search engine.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

VideoConfig

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

Configuration options for video generation.

结构 / 允许值：object。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
task	"text_to_video" / "image_to_video" / "reference_to_video" / "edit" / "extend"	可选	未注明	Optional task mode for video generation. If not specified, the model automatically determines the appropriate mode based on the provided text prompt and input media.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

枚举含义（$.properties.task）：

• text_to_video：Generates video solely from a text prompt.
• image_to_video：Generates video from one or two source images. The first image defines the starting frame, and the optional second image defines the ending frame.
• reference_to_video：Generates video using reference media (such as images, audio, or video).
• edit：Modifies an existing input video.
• extend：Extends an existing input video.

VideoContent

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

A video content block.

结构 / 允许值：object。

官方 required：type。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
data	string (byte)	可选	未注明	The video content.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
mime_type	"video/mp4" / "video/mpeg" / "video/mpg" / "video/mov" / "video/avi" / "video/x-flv" / "video/webm" / "video/wmv" / "video/3gpp"	可选	未注明	The mime type of the video.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
name	string	可选	未注明	A user-defined name for this content block. Can be referenced by the model in the final response.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
processing	MediaProcessing / "static" / "agentic"	可选	未注明	How the model processes this video for understanding.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
resolution	MediaResolution	可选	未注明	The resolution of the media.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
type	"video"	必填	未注明		完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
uri	string	可选	未注明	The URI of the video.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

枚举含义（$.properties.mime_type）：

• 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

枚举含义（$.properties.processing.oneOf.1）：

• static：Fixed-rate frame extraction. All frames placed in context.
• agentic：Model-driven dynamic navigation.

VideoDelta

出现位置：响应 / 错误 / SSE。

结构 / 允许值：object。

官方 required：type。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
data	string (byte)	可选	未注明		完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
mime_type	"video/mp4" / "video/mpeg" / "video/mpg" / "video/mov" / "video/avi" / "video/x-flv" / "video/webm" / "video/wmv" / "video/3gpp" / "video/jpeg2000"	可选	未注明		完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
resolution	MediaResolution	可选	未注明	The resolution of the media.	完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
type	"video"	必填	未注明		完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务
uri	string	可选	未注明		完整转发，由 Google 校验	未返回此结构：网关只返回聊天文本/媒体链接、兼容 usage 或 Veo 任务

枚举含义（$.properties.mime_type）：

• 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
• video/jpeg2000：JPEG 2000 video format

VideoResponseFormat

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

Configuration for video output format.

结构 / 允许值：object。

官方 required：type。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
aspect_ratio	"16:9" / "9:16"	可选	未注明	The aspect ratio for the video output.	完整转发，由 Google 校验	相似能力：Veo aspect_ratio / resolution / seconds；没有此对象映射
delivery	"inline" / "uri"	可选	未注明	The delivery mode for the video output.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
duration	string (google-duration)	可选	未注明	The duration for the video output.	完整转发，由 Google 校验	相似能力：Veo aspect_ratio / resolution / seconds；没有此对象映射
gcs_uri	string	可选	未注明	The Cloud Storage URI to store the video output. Required for Vertex if delivery mode is URI.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
resolution	"360p" / "720p" / "1080p" / "4k"	可选	未注明	The video output resolution. Defaults to 720p.	完整转发，由 Google 校验	相似能力：Veo aspect_ratio / resolution / seconds；没有此对象映射
type	"video"	必填	未注明		完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

枚举含义（$.properties.aspect_ratio）：

• 16:9：16:9 aspect ratio.
• 9:16：9:16 aspect ratio.

枚举含义（$.properties.delivery）：

• inline：Video data is returned inline in the response.
• uri：Video data is returned as a URI.

枚举含义（$.properties.resolution）：

• 360p：360p resolution.
• 720p：720p resolution.
• 1080p：1080p resolution.
• 4k：4K resolution.

Voice

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

A voice resource representing either a custom voice (created via CreateVoice) or a prebuilt system voice (returned by ListVoices).

结构 / 允许值：object。

官方 required：type。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
accent	string	可选	未注明	Optional. Regional accent descriptor (e.g. "American", "British").	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
context	string	可选	未注明	Optional. Optimal usage context or domain (e.g. "Conversational", "Audiobook", "News").	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
description	string	可选	未注明	Optional. Descriptive summary of vocal timbre, personality, and tone.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
display_name	string	可选	未注明	Optional. User-provided display name for a stored voice (store = true), or the catalog name for a prebuilt voice.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
expire_time	string (date-time)	可选；只读；官方描述：仅输出	未注明	Output only. The timestamp at which a custom stored voice (store = true) or replicated voice key (store = false) expires. For custom stored voices (store = true), this expiration time is extended when the voice is used for speech synthesis or as a base_voice in CreateVoice. Unset for prebuilt catalog voices ("prebuilt"), which do not expire.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
gender	string	可选	未注明	Optional. Perceived voice gender presentation (e.g. "female", "male", "neutral").	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
id	string	可选；只读；官方描述：仅输出	未注明	Output only. The unique identifier of the voice. * For Google-managed custom voices (store = true), this is a generated ID with prefix voice_ (for example, voice_abc123def456). Pass voices/{id} as the name in GetVoice and DeleteVoice, and pass {id} directly to SpeechConfig.voice_config.voice (or SpeechConfig.voice) during speech synthesis. * For prebuilt catalog voices ("prebuilt" returned by ListVoices), this is the speaker name (for example, Puck or Charon). * Unset when CreateVoice is called with store = false.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
key	string	可选；只读；官方描述：仅输出	未注明	Output only. The client-managed voice replication key (with prefix voicekey_). Returned only by CreateVoice when type is "replicated" and store is false. Pass this key to SpeechConfig.voice_config.voice (or SpeechConfig.voice) during speech synthesis.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
language_code	string	可选	未注明	Optional. Primary BCP-47 language tag (e.g. "en-US", "fr-FR").	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
model	string	可选	未注明	Optional. The model used to design or replicate the voice. If omitted in CreateVoice, defaults to the latest supported voice design model. Returned in CreateVoice, GetVoice, and ListVoices responses for custom voices ("prompted" and "replicated"); unset for "prebuilt" voices. Created voices can be synthesized across any supported TTS synthesis model.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
persona	string	可选	未注明	Optional. Intended persona or character archetype (e.g. "Warm, Friendly", "Narrator").	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
pitch	Pitch	可选	未注明	Optional. Voice pitch classification.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
prompted	PromptedVoice	可选	未注明	Parameters for prompted voice generation. Required in CreateVoice when type is "prompted". Returned in CreateVoice, GetVoice, and ListVoices responses for prompted voices.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
region_code	string	可选	未注明	Optional. ISO 3166-1 alpha-2 or UN M.49 geographic region code (e.g. "US", "GB", "001").	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
replicated	ReplicatedVoice	可选；仅输入	未注明	Input only. Parameters for replicated voice generation. Required on input when type is "replicated". Not returned in responses.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
sample_audio	AudioData	可选；只读；官方描述：仅输出	未注明	Output only. Sample audio (synthesizer prompt audio) generated for a prompted voice. Populated only in CreateVoice and GetVoice responses when type is "prompted"; unset in ListVoices responses and for "replicated" or "prebuilt" voices.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
type	VoiceType	必填	未注明	Required. The type of the voice. In CreateVoice, must be "replicated" or "prompted". In ListVoices responses, may also be "prebuilt".	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
usage	Usage	可选；只读；官方描述：仅输出	未注明	Output only. Token usage statistics for the voice creation request. Populated only in the response of CreateVoice when type is "prompted"; unset for "replicated" and in GetVoice and ListVoices responses.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

VoiceType

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

结构 / 允许值："replicated" / "prompted" / "prebuilt"。

枚举含义（$）：

• replicated：A custom voice replicated from a reference audio sample and speaker consent recording.
• prompted：A custom voice generated from a natural-language text prompt (optionally editing or remixing a base_voice).
• prebuilt：A built-in system voice from Google's voice catalog (e.g., Puck, Charon). Returned in responses; cannot be specified as the type in CreateVoice.

Webhook

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

A Webhook resource.

结构 / 允许值：object。

官方 required：subscribed_events、uri。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
create_time	string (date-time)	可选；只读；官方描述：仅输出	未注明	Output only. The timestamp when the webhook was created.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
id	string	可选；只读；官方描述：仅输出	未注明	Output only. The ID of the webhook.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
name	string	可选	未注明	Optional. The user-provided name of the webhook.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
new_signing_secret	string	可选；只读；官方描述：仅输出	未注明	Output only. The new signing secret for the webhook. Only populated on create.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
signing_secrets	Array<SigningSecret>	可选；只读；官方描述：仅输出	未注明	Output only. The signing secrets associated with this webhook.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
state	"enabled" / "disabled" / "disabled_due_to_failed_deliveries"	可选；只读；官方描述：仅输出	未注明	Output only. The state of the webhook.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
subscribed_events	Array<"batch.succeeded" / "batch.expired" / "batch.failed" / "interaction.requires_action" / "interaction.completed" / "interaction.failed" / "video.generated">	必填	未注明	Required. The events that the webhook is subscribed to. Available events: - batch.succeeded - batch.expired - batch.failed - interaction.requires_action - interaction.completed - interaction.failed - video.generated	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
update_time	string (date-time)	可选；只读；官方描述：仅输出	未注明	Output only. The timestamp when the webhook was last updated.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
uri	string	必填	未注明	Required. The URI to which webhook events will be sent.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

枚举含义（$.properties.state）：

• enabled：The webhook is enabled.
• disabled：The webhook is disabled by the user.
• disabled_due_to_failed_deliveries：The webhook is disabled due to failed deliveries.

WebhookConfig

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

Message for configuring webhook events for a request.

结构 / 允许值：object。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
uris	Array<string>	可选	未注明	Optional. If set, these webhook URIs will be used for webhook events instead of the registered webhooks.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
user_metadata	Map<string, any>	可选	未注明	Optional. The user metadata that will be returned on each event emission to the webhooks.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

WebhookUpdate

出现位置：请求体（可能同时用于输出）。

结构 / 允许值：object。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
name	string	可选	未注明	Optional. The user-provided name of the webhook.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
state	"enabled" / "disabled" / "disabled_due_to_failed_deliveries"	可选	未注明	Optional. The state of the webhook.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
subscribed_events	Array<"batch.succeeded" / "batch.expired" / "batch.failed" / "interaction.requires_action" / "interaction.completed" / "interaction.failed" / "video.generated">	可选	未注明	Optional. The events that the webhook is subscribed to. Available events: - batch.succeeded - batch.expired - batch.failed - interaction.requires_action - interaction.completed - interaction.failed - video.generated	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
uri	string	可选	未注明	Optional. The URI to which webhook events will be sent.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明

枚举含义（$.properties.state）：

• enabled：The webhook is enabled.
• disabled：The webhook is disabled by the user.
• disabled_due_to_failed_deliveries：The webhook is disabled due to failed deliveries.

WordInfo

出现位置：请求体（可能同时用于输出）；响应 / 错误 / SSE。

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

结构 / 允许值：object。

官方 required：type。

字段	类型 / 允许值	必填 / 只读 / 废弃	默认值 / 约束	官方说明	官方后端	网页登录态 / OpenAI 聊天
end_index	integer (int32)	可选	未注明	End of the attributed segment, exclusive.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
end_offset	string (google-duration)	可选	未注明	End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
speaker	string	可选	未注明	Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
start_index	integer (int32)	可选	未注明	Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
start_offset	string (google-duration)	可选	未注明	Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
text	string	可选	未注明	The transcribed word.	完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明
type	"word_info"	必填	未注明		完整转发，由 Google 校验	未开放：聊天 HTTP 不接收此官方结构；见差距说明