Package google.cloud.ces.v1

索引

• AgentService（接口）
• SessionService（接口）
• ToolService（接口）
• WidgetService（接口）
• Action（消息）
• Action.EntityOperation（消息）
• Action.EntityOperation.OperationType（枚举）
• Agent（消息）
• Agent.AgentToolset（消息）
• Agent.LlmAgent（消息）
• Agent.RemoteDialogflowAgent（消息）
• AgentTransfer（消息）
• AmbientSoundConfig（消息）
• AmbientSoundConfig.PrebuiltAmbientNoise（枚举）
• ApiAuthentication（消息）
• ApiKeyConfig（消息）
• ApiKeyConfig.RequestLocation（枚举）
• App（消息）
• App.ToolExecutionMode（枚举）
• App.VariableDeclaration（消息）
• AppSnapshot（消息）
• AppVersion（消息）
• AudioEncoding（枚举）
• AudioProcessingConfig（消息）
• AudioRecordingConfig（消息）
• BargeInConfig（消息）
• BatchDeleteConversationsRequest（消息）
• BatchDeleteConversationsResponse（消息）
• BearerTokenConfig（消息）
• BidiSessionClientMessage（消息）
• BidiSessionServerMessage（消息）
• BigQueryExportSettings（消息）
• Blob（消息）
• Callback（消息）
• Changelog（消息）
• ChannelProfile（消息）
• ChannelProfile.ChannelType（枚举）
• ChannelProfile.PersonaProperty（消息）
• ChannelProfile.PersonaProperty.Persona（枚举）
• ChannelProfile.WebWidgetConfig（消息）
• ChannelProfile.WebWidgetConfig.Modality（枚举）
• ChannelProfile.WebWidgetConfig.SecuritySettings（消息）
• ChannelProfile.WebWidgetConfig.Theme（枚举）
• Chunk（消息）
• Citations（消息）
• Citations.CitedChunk（消息）
• ClientCertificateSettings（消息）
• ClientFunction（消息）
• CloudLoggingSettings（消息）
• CodeBlock（消息）
• ConnectorTool（消息）
• ConnectorToolset（消息）
• Conversation（消息）
• Conversation.ChannelType（枚举）
• Conversation.InputType（枚举）
• Conversation.Source（枚举）
• Conversation.Turn（消息）
• ConversationLoggingSettings（消息）
• CreateAgentRequest（消息）
• CreateAppRequest（消息）
• CreateAppVersionRequest（消息）
• CreateDeploymentRequest（消息）
• CreateExampleRequest（消息）
• CreateGuardrailRequest（消息）
• CreateToolRequest（消息）
• CreateToolsetRequest（消息）
• DataStore（消息）
• DataStore.ConnectorConfig（消息）
• DataStore.DataStoreType（枚举）
• DataStore.DocumentProcessingMode（枚举）
• DataStoreSettings（消息）
• DataStoreSettings.Engine（消息）
• DataStoreSettings.Engine.Type（枚举）
• DataStoreTool（消息）
• DataStoreTool.BoostSpec（消息）
• DataStoreTool.BoostSpec.ConditionBoostSpec（消息）
• DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec（消息）
• DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec.AttributeType（枚举）
• DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPoint（消息）
• DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec.InterpolationType（枚举）
• DataStoreTool.BoostSpecs（消息）
• DataStoreTool.DataStoreSource（消息）
• DataStoreTool.EngineSource（消息）
• DataStoreTool.FilterParameterBehavior（枚举）
• DataStoreTool.GroundingConfig（消息）
• DataStoreTool.ModalityConfig（消息）
• DataStoreTool.ModalityConfig.ModalityType（枚举）
• DataStoreTool.RewriterConfig（消息）
• DataStoreTool.SummarizationConfig（消息）
• DeleteAgentRequest（消息）
• DeleteAppRequest（消息）
• DeleteAppVersionRequest（消息）
• DeleteConversationRequest（消息）
• DeleteDeploymentRequest（消息）
• DeleteExampleRequest（消息）
• DeleteGuardrailRequest（消息）
• DeleteToolRequest（消息）
• DeleteToolsetRequest（消息）
• Deployment（消息）
• EndSession（消息）
• EndUserAuthConfig（消息）
• EndUserAuthConfig.Oauth2AuthCodeConfig（消息）
• EndUserAuthConfig.Oauth2JwtBearerConfig（消息）
• ErrorHandlingSettings（消息）
• ErrorHandlingSettings.ErrorHandlingStrategy（枚举）
• EvaluationMetricsThresholds（消息）
• EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds（消息）
• EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.ExpectationLevelMetricsThresholds（消息）
• EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.TurnLevelMetricsThresholds（消息）
• EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.TurnLevelMetricsThresholds.SemanticSimilarityChannel（枚举）
• EvaluationMetricsThresholds.HallucinationMetricBehavior（枚举）
• EvaluationMetricsThresholds.ToolMatchingSettings（消息）
• EvaluationMetricsThresholds.ToolMatchingSettings.ExtraToolCallBehavior（枚举）
• Event（消息）
• Example（消息）
• ExecuteToolRequest（消息）
• ExecuteToolResponse（消息）
• ExecutionType（枚举）
• ExportAppRequest（消息）
• ExportAppRequest.ExportFormat（枚举）
• ExportAppResponse（消息）
• ExpressionCondition（消息）
• FileSearchTool（消息）
• FileSearchTool.CorpusType（枚举）
• GenerateChatTokenRequest（消息）
• GenerateChatTokenResponse（消息）
• GetAgentRequest（消息）
• GetAppRequest（消息）
• GetAppVersionRequest（消息）
• GetChangelogRequest（消息）
• GetConversationRequest（消息）
• GetDeploymentRequest（消息）
• GetExampleRequest（消息）
• GetGuardrailRequest（消息）
• GetToolRequest（消息）
• GetToolsetRequest（消息）
• GoAway（消息）
• GoogleSearchSuggestions（消息）
• GoogleSearchTool（消息）
• GoogleSearchTool.PromptConfig（消息）
• Guardrail（消息）
• Guardrail.CodeCallback（消息）
• Guardrail.ContentFilter（消息）
• Guardrail.ContentFilter.MatchType（枚举）
• Guardrail.LlmPolicy（消息）
• Guardrail.LlmPolicy.PolicyScope（枚举）
• Guardrail.LlmPromptSecurity（消息）
• Guardrail.LlmPromptSecurity.DefaultSecuritySettings（消息）
• Guardrail.ModelSafety（消息）
• Guardrail.ModelSafety.HarmBlockThreshold（枚举）
• Guardrail.ModelSafety.HarmCategory（枚举）
• Guardrail.ModelSafety.SafetySetting（消息）
• Image（消息）
• ImportAppRequest（消息）
• ImportAppRequest.ImportOptions（消息）
• ImportAppRequest.ImportOptions.ConflictResolutionStrategy（枚举）
• ImportAppResponse（消息）
• InputAudioConfig（消息）
• InterruptionSignal（消息）
• LanguageSettings（消息）
• ListAgentsRequest（消息）
• ListAgentsResponse（消息）
• ListAppVersionsRequest（消息）
• ListAppVersionsResponse（消息）
• ListAppsRequest（消息）
• ListAppsResponse（消息）
• ListChangelogsRequest（消息）
• ListChangelogsResponse（消息）
• ListConversationsRequest（消息）
• ListConversationsResponse（消息）
• ListDeploymentsRequest（消息）
• ListDeploymentsResponse（消息）
• ListExamplesRequest（消息）
• ListExamplesResponse（消息）
• ListGuardrailsRequest（消息）
• ListGuardrailsResponse（消息）
• ListToolsRequest（消息）
• ListToolsResponse（消息）
• ListToolsetsRequest（消息）
• ListToolsetsResponse（消息）
• LoggingSettings（消息）
• McpTool（消息）
• McpToolset（消息）
• Message（消息）
• MetricAnalysisSettings（消息）
• ModelSettings（消息）
• OAuthConfig（消息）
• OAuthConfig.OauthGrantType（枚举）
• Omnichannel（消息）
• OmnichannelIntegrationConfig（消息）
• OmnichannelIntegrationConfig.CesAppConfig（消息）
• OmnichannelIntegrationConfig.ChannelConfig（消息）
• OmnichannelIntegrationConfig.RoutingConfig（消息）
• OmnichannelIntegrationConfig.SubscriberConfig（消息）
• OmnichannelIntegrationConfig.WhatsappConfig（消息）
• OmnichannelOperationMetadata（消息）
• OpenApiTool（消息）
• OpenApiToolset（消息）
• OperationMetadata（消息）
• OutputAudioConfig（消息）
• PythonCodeCondition（消息）
• PythonFunction（消息）
• RecognitionResult（消息）
• RedactionConfig（消息）
• RestoreAppVersionRequest（消息）
• RestoreAppVersionResponse（消息）
• RetrieveToolSchemaRequest（消息）
• RetrieveToolSchemaResponse（消息）
• RetrieveToolsRequest（消息）
• RetrieveToolsResponse（消息）
• RunSessionRequest（消息）
• RunSessionResponse（消息）
• Schema（消息）
• Schema.Type（枚举）
• ServiceAccountAuthConfig（消息）
• ServiceAgentIdTokenAuthConfig（消息）
• ServiceDirectoryConfig（消息）
• SessionConfig（消息）
• SessionConfig.RemoteDialogflowQueryParameters（消息）
• SessionInput（消息）
• SessionOutput（消息）
• SessionOutput.DiagnosticInfo（消息）
• Span（消息）
• SynthesizeSpeechConfig（消息）
• SystemTool（消息）
• TimeZoneSettings（消息）
• TlsConfig（消息）
• TlsConfig.CaCert（消息）
• Tool（消息）
• ToolCall（消息）
• ToolCalls（消息）
• ToolFakeConfig（消息）
• ToolResponse（消息）
• ToolResponses（消息）
• Toolset（消息）
• ToolsetTool（消息）
• TransferRule（消息）
• TransferRule.DeterministicTransfer（消息）
• TransferRule.Direction（枚举）
• TransferRule.DisablePlannerTransfer（消息）
• TriggerAction（消息）
• TriggerAction.GenerativeAnswer（消息）
• TriggerAction.RespondImmediately（消息）
• TriggerAction.Response（消息）
• TriggerAction.TransferAgent（消息）
• UpdateAgentRequest（消息）
• UpdateAppRequest（消息）
• UpdateDeploymentRequest（消息）
• UpdateExampleRequest（消息）
• UpdateGuardrailRequest（消息）
• UpdateToolRequest（消息）
• UpdateToolsetRequest（消息）
• WebSearchQuery（消息）
• WidgetTool（消息）
• WidgetTool.WidgetType（枚举）

AgentService

用于在 Gemini Enterprise for Customer Engagement (CES) 中管理与代理相关的资源的服务。

BatchDeleteConversations
rpc BatchDeleteConversations(BatchDeleteConversationsRequest) returns (Operation) 批量删除指定的对话。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 parent 资源的以下 IAM 权限： ces.conversations.delete 如需了解详情，请参阅 IAM 文档。

CreateAgent
rpc CreateAgent(CreateAgentRequest) returns (Agent) 在指定应用中创建新代理。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 parent 资源的以下 IAM 权限： ces.agents.create 如需了解详情，请参阅 IAM 文档。

CreateApp
rpc CreateApp(CreateAppRequest) returns (Operation) 在指定项目和位置中创建新应用。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 parent 资源的以下 IAM 权限： ces.apps.create 如需了解详情，请参阅 IAM 文档。

CreateAppVersion
rpc CreateAppVersion(CreateAppVersionRequest) returns (AppVersion) 在给定应用中创建新的应用版本。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 parent 资源的以下 IAM 权限： ces.appVersions.create 如需了解详情，请参阅 IAM 文档。

CreateDeployment
rpc CreateDeployment(CreateDeploymentRequest) returns (Deployment) 在指定应用中创建新部署。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 parent 资源的以下 IAM 权限： ces.deployments.create 如需了解详情，请参阅 IAM 文档。

CreateExample
rpc CreateExample(CreateExampleRequest) returns (Example) 在指定应用中创建新示例。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 parent 资源的以下 IAM 权限： ces.examples.create 如需了解详情，请参阅 IAM 文档。

CreateGuardrail
rpc CreateGuardrail(CreateGuardrailRequest) returns (Guardrail) 在指定应用中创建新的安全屏障。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 parent 资源的以下 IAM 权限： ces.guardrails.create 如需了解详情，请参阅 IAM 文档。

CreateTool
rpc CreateTool(CreateToolRequest) returns (Tool) 在给定应用中创建新工具。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 parent 资源的以下 IAM 权限： ces.tools.create 如需了解详情，请参阅 IAM 文档。

CreateToolset
rpc CreateToolset(CreateToolsetRequest) returns (Toolset) 在给定应用中创建新工具集。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 parent 资源的以下 IAM 权限： ces.toolsets.create 如需了解详情，请参阅 IAM 文档。

DeleteAgent
rpc DeleteAgent(DeleteAgentRequest) returns (Empty) 删除指定的代理。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 name 资源的以下 IAM 权限： ces.agents.delete 如需了解详情，请参阅 IAM 文档。

DeleteApp
rpc DeleteApp(DeleteAppRequest) returns (Operation) 删除指定的应用。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 name 资源的以下 IAM 权限： ces.apps.delete 如需了解详情，请参阅 IAM 文档。

DeleteAppVersion
rpc DeleteAppVersion(DeleteAppVersionRequest) returns (Empty) 删除指定的应用版本。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 name 资源的以下 IAM 权限： ces.appVersions.delete 如需了解详情，请参阅 IAM 文档。

DeleteConversation
rpc DeleteConversation(DeleteConversationRequest) returns (Empty) 删除指定的对话。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 name 资源的以下 IAM 权限： ces.conversations.delete 如需了解详情，请参阅 IAM 文档。

DeleteDeployment
rpc DeleteDeployment(DeleteDeploymentRequest) returns (Empty) 删除指定的部署。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 name 资源的以下 IAM 权限： ces.deployments.delete 如需了解详情，请参阅 IAM 文档。

DeleteExample
rpc DeleteExample(DeleteExampleRequest) returns (Empty) 删除指定的示例。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 name 资源的以下 IAM 权限： ces.examples.delete 如需了解详情，请参阅 IAM 文档。

DeleteGuardrail
rpc DeleteGuardrail(DeleteGuardrailRequest) returns (Empty) 删除指定的安全屏障。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 name 资源的以下 IAM 权限： ces.guardrails.delete 如需了解详情，请参阅 IAM 文档。

DeleteTool
rpc DeleteTool(DeleteToolRequest) returns (Empty) 删除指定的工具。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 name 资源的以下 IAM 权限： ces.tools.delete 如需了解详情，请参阅 IAM 文档。

DeleteToolset
rpc DeleteToolset(DeleteToolsetRequest) returns (Empty) 删除指定的工具集。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 name 资源的以下 IAM 权限： ces.toolsets.delete 如需了解详情，请参阅 IAM 文档。

ExportApp
rpc ExportApp(ExportAppRequest) returns (Operation) 导出指定应用。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 name 资源的以下 IAM 权限： ces.apps.export 如需了解详情，请参阅 IAM 文档。

GetAgent
rpc GetAgent(GetAgentRequest) returns (Agent) 获取指定代理的详细信息。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 name 资源的以下 IAM 权限： ces.agents.get 如需了解详情，请参阅 IAM 文档。

GetApp
rpc GetApp(GetAppRequest) returns (App) 获取指定应用的详细信息。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 name 资源的以下 IAM 权限： ces.apps.get 如需了解详情，请参阅 IAM 文档。

GetAppVersion
rpc GetAppVersion(GetAppVersionRequest) returns (AppVersion) 获取指定应用版本的详细信息。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 name 资源的以下 IAM 权限： ces.appVersions.get 如需了解详情，请参阅 IAM 文档。

GetChangelog
rpc GetChangelog(GetChangelogRequest) returns (Changelog) 获取指定的更改日志。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 name 资源的以下 IAM 权限： ces.changelogs.get 如需了解详情，请参阅 IAM 文档。

GetConversation
rpc GetConversation(GetConversationRequest) returns (Conversation) 获取指定对话的详细信息。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 name 资源的以下 IAM 权限： ces.conversations.get 如需了解详情，请参阅 IAM 文档。

GetDeployment
rpc GetDeployment(GetDeploymentRequest) returns (Deployment) 获取指定部署的详细信息。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 name 资源的以下 IAM 权限： ces.deployments.get 如需了解详情，请参阅 IAM 文档。

GetExample
rpc GetExample(GetExampleRequest) returns (Example) 获取指定示例的详细信息。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 name 资源的以下 IAM 权限： ces.examples.get 如需了解详情，请参阅 IAM 文档。

GetGuardrail
rpc GetGuardrail(GetGuardrailRequest) returns (Guardrail) 获取指定安全屏障的详细信息。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 name 资源的以下 IAM 权限： ces.guardrails.get 如需了解详情，请参阅 IAM 文档。

GetTool
rpc GetTool(GetToolRequest) returns (Tool) 获取指定工具的详细信息。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 name 资源的以下 IAM 权限： ces.tools.get 如需了解详情，请参阅 IAM 文档。

GetToolset
rpc GetToolset(GetToolsetRequest) returns (Toolset) 获取指定工具集的详细信息。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 name 资源的以下 IAM 权限： ces.toolsets.get 如需了解详情，请参阅 IAM 文档。

ImportApp
rpc ImportApp(ImportAppRequest) returns (Operation) 导入指定应用。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 parent 资源的以下 IAM 权限： ces.apps.import 如需了解详情，请参阅 IAM 文档。

ListAgents
rpc ListAgents(ListAgentsRequest) returns (ListAgentsResponse) 列出指定应用中的代理。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 parent 资源的以下 IAM 权限： ces.agents.list 如需了解详情，请参阅 IAM 文档。

ListAppVersions
rpc ListAppVersions(ListAppVersionsRequest) returns (ListAppVersionsResponse) 列出指定应用中的所有应用版本。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 parent 资源的以下 IAM 权限： ces.appVersions.list 如需了解详情，请参阅 IAM 文档。

ListApps
rpc ListApps(ListAppsRequest) returns (ListAppsResponse) 列出给定项目和位置中的应用。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 parent 资源的以下 IAM 权限： ces.apps.list 如需了解详情，请参阅 IAM 文档。

ListChangelogs
rpc ListChangelogs(ListChangelogsRequest) returns (ListChangelogsResponse) 列出指定应用的更改日志。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 parent 资源的以下 IAM 权限： ces.changelogs.list 如需了解详情，请参阅 IAM 文档。

ListConversations
rpc ListConversations(ListConversationsRequest) returns (ListConversationsResponse) 列出给定应用中的对话。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 parent 资源的以下 IAM 权限： ces.conversations.list 如需了解详情，请参阅 IAM 文档。

ListDeployments
rpc ListDeployments(ListDeploymentsRequest) returns (ListDeploymentsResponse) 列出给定应用中的部署。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 parent 资源的以下 IAM 权限： ces.deployments.list 如需了解详情，请参阅 IAM 文档。

ListExamples
rpc ListExamples(ListExamplesRequest) returns (ListExamplesResponse) 列出给定应用中的示例。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 parent 资源的以下 IAM 权限： ces.examples.list 如需了解详情，请参阅 IAM 文档。

ListGuardrails
rpc ListGuardrails(ListGuardrailsRequest) returns (ListGuardrailsResponse) 列出给定应用中的安全屏障。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 parent 资源的以下 IAM 权限： ces.guardrails.list 如需了解详情，请参阅 IAM 文档。

ListTools
rpc ListTools(ListToolsRequest) returns (ListToolsResponse) 列出指定应用中的工具。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 parent 资源的以下 IAM 权限： ces.tools.list 如需了解详情，请参阅 IAM 文档。

ListToolsets
rpc ListToolsets(ListToolsetsRequest) returns (ListToolsetsResponse) 列出指定应用中的工具集。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 parent 资源的以下 IAM 权限： ces.toolsets.list 如需了解详情，请参阅 IAM 文档。

RestoreAppVersion
rpc RestoreAppVersion(RestoreAppVersionRequest) returns (Operation) 恢复指定的应用版本。这将基于当前草稿应用创建新的应用版本，并使用指定的应用版本覆盖当前草稿。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 name 资源的以下 IAM 权限： ces.appVersions.restore 如需了解详情，请参阅 IAM 文档。

UpdateAgent
rpc UpdateAgent(UpdateAgentRequest) returns (Agent) 更新指定的代理。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 name 资源的以下 IAM 权限： ces.agents.update 如需了解详情，请参阅 IAM 文档。

UpdateApp
rpc UpdateApp(UpdateAppRequest) returns (App) 更新指定的应用。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 name 资源的以下 IAM 权限： ces.apps.update 如需了解详情，请参阅 IAM 文档。

UpdateDeployment
rpc UpdateDeployment(UpdateDeploymentRequest) returns (Deployment) 更新指定的部署。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 name 资源的以下 IAM 权限： ces.deployments.update 如需了解详情，请参阅 IAM 文档。

UpdateExample
rpc UpdateExample(UpdateExampleRequest) returns (Example) 更新指定的示例。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 name 资源的以下 IAM 权限： ces.examples.update 如需了解详情，请参阅 IAM 文档。

UpdateGuardrail
rpc UpdateGuardrail(UpdateGuardrailRequest) returns (Guardrail) 更新指定的安全防护措施。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 name 资源的以下 IAM 权限： ces.guardrails.update 如需了解详情，请参阅 IAM 文档。

UpdateTool
rpc UpdateTool(UpdateToolRequest) returns (Tool) 更新指定的工具。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 name 资源的以下 IAM 权限： ces.tools.update 如需了解详情，请参阅 IAM 文档。

UpdateToolset
rpc UpdateToolset(UpdateToolsetRequest) returns (Toolset) 更新指定的工具集。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 name 资源的以下 IAM 权限： ces.toolsets.update 如需了解详情，请参阅 IAM 文档。

SessionService

会话服务提供用于与 CES 代理交互的 API。

BidiRunSession

rpc BidiRunSession(BidiSessionClientMessage) returns (BidiSessionServerMessage) 与 CES 代理建立双向流式传输连接。该代理会处理连续的多模态输入（例如文本、音频），并生成实时多模态输出流。 --- 客户端请求流 --- 客户端按以下顺序流式传输请求： 初始化：第一条消息必须包含 SessionConfig。对于音频会话，此参数还应包含 InputAudioConfig 和 OutputAudioConfig，以定义音频处理和合成参数。 互动：后续消息流 SessionInput，包含实时用户输入数据。 终止：当没有更多用户输入时，客户端应半关闭流。此外，当从代理收到 EndSession 或 GoAway 时，它应处于半关闭状态。 --- 服务器响应流 --- 对于每个互动回合，代理会按以下顺序流式传输消息： 语音识别（前 N 条消息）：包含 RecognitionResult，表示目前捕获的用户语音段的串联。仅针对音频会话填充。 响应（接下来 M 条消息）：包含 SessionOutput，用于以各种模态（例如文本、音频）传递代理的响应。 对话轮次完成（对话轮次的最终消息）：包含 SessionOutput，并将 turn_completed 设置为 true。表示当前回合结束，并包含执行详细信息的 DiagnosticInfo。 --- 音频广告最佳实践 --- 1. 流式传输：audio data 持续播放，即使在无声期间也是如此。建议的数据块大小：40-120 毫秒（在延迟时间和效率之间实现平衡）。 播放和中断：收到时播放 audio responses。如果收到 InterruptionSignal（例如，用户插话或新代理回答），请立即停止播放。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 session 资源的以下 IAM 权限： ces.sessions.bidiRunSession 如需了解详情，请参阅 IAM 文档。

RunSession
rpc RunSession(RunSessionRequest) returns (RunSessionResponse) 在会话中启动与 CES 代理的单轮互动。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 session 资源的以下 IAM 权限： ces.sessions.runSession 如需了解详情，请参阅 IAM 文档。

ToolService

工具服务提供用于与 CES 工具交互的 API。

ExecuteTool
rpc ExecuteTool(ExecuteToolRequest) returns (ExecuteToolResponse) 使用给定的实参执行给定的工具。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 parent 资源的以下 IAM 权限： ces.tools.execute 如需了解详情，请参阅 IAM 文档。

RetrieveToolSchema
rpc RetrieveToolSchema(RetrieveToolSchemaRequest) returns (RetrieveToolSchemaResponse) 检索给定工具的架构。系统会针对工具的给定实例实时计算架构。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 parent 资源的以下 IAM 权限： ces.tools.get 如需了解详情，请参阅 IAM 文档。

RetrieveTools
rpc RetrieveTools(RetrieveToolsRequest) returns (RetrieveToolsResponse) 检索指定工具集中包含的工具列表。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 toolset 资源的以下 IAM 权限： ces.toolsets.get 如需了解详情，请参阅 IAM 文档。

WidgetService

提供 API，供 widget 与 CES API 互动。

GenerateChatToken
rpc GenerateChatToken(GenerateChatTokenRequest) returns (GenerateChatTokenResponse) 为聊天微件生成会话范围的令牌，以便通过会话 API 进行身份验证。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 如需了解详情，请参阅 Authentication Overview。

操作

供工具使用的操作的配置。注意：可以是 Action 或 Operation。如需了解详情，请参阅 https://cloud.google.com/integration-connectors/docs/entities-operation-action。

字段
input_fields[]	string 可选。要用作操作输入的实体字段。如果未指定任何字段，则将使用实体的所有字段。
output_fields[]	string 可选。要从操作中返回的实体字段。如果未指定任何字段，则返回实体的所有字段。
联合字段 action_spec。要配置供工具使用的操作的规范。action_spec 只能是下列其中一项：
connection_action_id	string 供工具使用的连接操作的 ID。
entity_operation	Action.EntityOperation 供工具使用的实体操作配置。

EntityOperation

实体 CRUD 操作规范。

字段
entity_id	string 必需。实体的 ID。
operation	Action.EntityOperation.OperationType 必需。要对实体执行的操作。

OperationType

要对实体执行的操作。

枚举
OPERATION_TYPE_UNSPECIFIED	未指定操作类型。无效，ConnectorTool 创建/更新将失败。
LIST	列出操作。
GET	获取操作。
CREATE	创建操作。
UPDATE	更新操作。
DELETE	删除操作。

代理

智能体充当基本构建块，为大语言模型 (LLM) 提供执行特定任务的指令。

字段
name	string 标识符。代理的唯一标识符。格式：projects/{project}/locations/{location}/apps/{app}/agents/{agent}
display_name	string 必需。代理的显示名称。
description	string 可选。代理的人类可读说明。
model_settings	ModelSettings 可选。LLM 模型的配置。
instruction	string 可选。用于指导代理行为的 LLM 模型指令。
tools[]	string 可选。代理可用的工具列表。格式：projects/{project}/locations/{location}/apps/{app}/tools/{tool}
child_agents[]	string 可选。代理树中的子代理列表。格式：projects/{project}/locations/{location}/apps/{app}/agents/{agent}
before_agent_callbacks[]	Callback 可选。在调用代理之前要执行的回调。所提供的回调会按列表中的顺序依次执行。如果回调返回了替换的响应，则执行会停止，并跳过所有剩余的回调。
after_agent_callbacks[]	Callback 可选。在调用代理后要执行的回调。所提供的回调会按列表中的顺序依次执行。如果回调返回了替换的响应，则执行会停止，并跳过所有剩余的回调。
before_model_callbacks[]	Callback 可选。在调用模型之前要执行的回调。如果多次调用模型，则回调将执行多次。所提供的回调会按列表中的顺序依次执行。如果回调返回了替换的响应，则执行会停止，并跳过所有剩余的回调。
after_model_callbacks[]	Callback 可选。在调用模型后要执行的回调。如果多次调用模型，则回调将执行多次。所提供的回调会按列表中的顺序依次执行。如果回调返回了替换的响应，则执行会停止，并跳过所有剩余的回调。
before_tool_callbacks[]	Callback 可选。在调用工具之前要执行的回调。如果存在多次工具调用，则回调将执行多次。所提供的回调会按列表中的顺序依次执行。如果回调返回了替换的响应，则执行会停止，并跳过所有剩余的回调。
after_tool_callbacks[]	Callback 可选。在调用工具后要执行的回调。如果存在多次工具调用，则回调将执行多次。所提供的回调会按列表中的顺序依次执行。如果回调返回了替换的响应，则执行会停止，并跳过所有剩余的回调。
create_time	Timestamp 仅限输出。创建代理时的时间戳。
update_time	Timestamp 仅限输出。代理上次更新时的时间戳。
guardrails[]	string 可选。代理的护栏列表。格式：projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}
etag	string 用于确保对象在读取-修改-写入操作期间未发生更改的 ETag。如果 etag 为空，则更新会覆盖任何并发更改。
toolsets[]	Agent.AgentToolset 可选。代理的工具集列表。
generated_summary	string 仅限输出。如果代理由 LLM 助理生成，此字段会包含生成内容的描述性摘要。
transfer_rules[]	TransferRule 可选。客服人员转移规则。如果多个规则匹配，系统将使用列表中的第一个规则。
联合字段 agent_type。代理的类型。agent_type 只能是下列其中一项：
llm_agent	Agent.LlmAgent 可选。默认代理类型。
remote_dialogflow_agent	Agent.RemoteDialogflowAgent 可选。用于执行代理的远程 Dialogflow 代理。如果设置了此字段，系统将忽略所有其他代理级属性。 注意：如果 Dialogflow 代理与应用位于不同的项目中，您应向 CES 服务代理 service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com 授予 roles/dialogflow.client 权限。

AgentToolset

包含部分工具的工具集。

字段
toolset	string 必需。工具集的资源名称。格式：projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}
tool_ids[]	string 可选。用于过滤工具集的工具 ID。

LlmAgent

此类型没有字段。

默认代理类型。智能体使用智能体中指定的指令和回调，通过大语言模型执行任务。

RemoteDialogflowAgent

将执行转移到远程 Dialogflow CX 代理的代理。Dialogflow 代理会处理后续的用户查询，直到会话结束或流程结束，并将控制权转回父 CES 代理。

字段
agent	string 必需。Dialogflow 代理资源名称。格式：projects/{project}/locations/{location}/agents/{agent}
flow_id	string 可选。Dialogflow 代理中相应流的流 ID。
environment_id	string 可选。要用于代理执行的 Dialogflow 代理的环境 ID。如果未指定，则使用草稿环境。
input_variable_mapping	map<string, string> 可选。应用变量名称与要作为输入发送给 Dialogflow 代理的 Dialogflow 会话参数名称之间的映射。
output_variable_mapping	map<string, string> 可选。Dialogflow 会话参数名称与应用变量名称的映射，用于在 Dialogflow 代理执行结束后发送回 CES 代理。
respect_response_interruption_settings	bool 可选。指示是否遵循在 Dialogflow 代理中配置的消息级中断设置。 如果为 false：Dialogflow 代理的所有响应消息都遵循应用级抢占设置。 如果为 true：只有将 allow_playback_interruption 设置为 true 的响应消息可以被中断，所有其他消息都遵循应用级抢占设置。

AgentTransfer

表示将对话转移给其他客服人员的事件。

字段
target_agent	string 必需。对话要转移到的代理。智能体将从这一刻起接管对话。格式：projects/{project}/locations/{location}/apps/{app}/agents/{agent}
display_name	string 仅限输出。代理的显示名称。

AmbientSoundConfig

配置与合成的代理回答一起播放的环境音，以增强对话的自然感。

字段
volume_gain_db	double 可选。环境噪声支持的正常原生音量的音量增益（以分贝为单位），范围为 [-96.0, 16.0]。如果未设置，或设置为 0.0 (dB) 的值，则以正常的原生信号振幅播放。如果值为 -6.0 (dB)，将使用约为正常原生信号幅度一半的幅度进行播放。如果值为 +6.0 (dB)，将使用约为正常原生信号幅度一倍的幅度进行播放。我们强烈建议不要超过 +10 (dB)，因为通常情况下，任何大于此值的响度都不会产生实际的响度增加效果。
联合字段 source。与合成的代理响应一起播放的环境噪音，以增强对话的自然感。source 只能是下列其中一项：
prebuilt_ambient_noise (deprecated)	AmbientSoundConfig.PrebuiltAmbientNoise 此项已弃用！ 可选。已弃用：prebuilt_ambient_noise 已弃用，取而代之的是 prebuilt_ambient_sound。
gcs_uri	string 可选。作为单声道 16kHz WAV 文件存储在 Cloud Storage 中的环境噪声。 注意：请确保 CES 服务代理 service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com 具有对 Cloud Storage 对象的 storage.objects.get 权限。
prebuilt_ambient_sound	string 可选。预建环境音效的名称。有效值为：- "coffee_shop" - "keyboard" - "keypad" - "hum" - "office_1" - "office_2" - "office_3" - "room_1" - "room_2" - "room_3" - "room_4" - "room_5" - "air_conditioner"

PrebuiltAmbientNoise

预建的环境噪音。

枚举
PREBUILT_AMBIENT_NOISE_UNSPECIFIED	未指定。
RETAIL_STORE	零售店的环境噪声。
CONVENTION_HALL	会议大厅的环境噪声。
OUTDOOR	街道的环境噪音。

ApiAuthentication

API 调用所需的身份验证信息。

字段
联合字段 auth_config。身份验证配置。auth_config 只能是下列其中一项：
api_key_config	ApiKeyConfig 可选。API 密钥身份验证的配置。
oauth_config	OAuthConfig 可选。OAuth 的配置。
service_agent_id_token_auth_config	ServiceAgentIdTokenAuthConfig 可选。从 CES 服务代理生成的 ID 令牌身份验证配置。
service_account_auth_config	ServiceAccountAuthConfig 可选。服务账号身份验证的配置。
bearer_token_config	BearerTokenConfig 可选。不记名令牌身份验证的配置。

ApiKeyConfig

使用 API 密钥进行身份验证的配置。

字段
key_name	string 必需。API 密钥的参数名称或标头名称。例如，如果 API 请求为“https://example.com/act?X-Api-Key=”，则“X-Api-Key”为参数名称。
api_key_secret_version	string 必需。存储 API 密钥的 SecretManager Secret 版本资源的名称。格式：projects/{project}/secrets/{secret}/versions/{version} 注意：您应向 CES 服务代理 service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com 授予 roles/secretmanager.secretAccessor 角色。
request_location	ApiKeyConfig.RequestLocation 必需。请求中的密钥位置。

RequestLocation

请求中 API 密钥的位置。

枚举
REQUEST_LOCATION_UNSPECIFIED	未指定。不应使用此值。
HEADER	表示 HTTP 标头中的键。
QUERY_STRING	表示查询字符串中的键。

应用

应用可用作一组代理（包括根代理及其子代理）以及相关联配置的顶层容器。这些代理协同工作，以在应用环境中实现特定目标。

字段
name	string 标识符。应用的唯一标识符。格式：projects/{project}/locations/{location}/apps/{app}
display_name	string 必需。应用的显示名称。
description	string 可选。应用的人类可读说明。
pinned	bool 可选。应用是否固定在应用列表中。
root_agent	string 可选。根代理是应用的入口点。格式：projects/{project}/locations/{location}/apps/{app}/agents/{agent}
language_settings	LanguageSettings 可选。应用的语言设置。
time_zone_settings	TimeZoneSettings 可选。应用的 TimeZone 设置。
audio_processing_config	AudioProcessingConfig 可选。应用的音频处理配置。
logging_settings	LoggingSettings 可选。应用的日志记录设置。
error_handling_settings	ErrorHandlingSettings 可选。应用错误处理设置。
model_settings	ModelSettings 可选。应用的默认 LLM 模型设置。各个资源（例如代理、安全屏障）可以根据需要替换这些配置。
tool_execution_mode	App.ToolExecutionMode 可选。应用的工具执行模式。如果未提供，将默认为 PARALLEL。
evaluation_metrics_thresholds	EvaluationMetricsThresholds 可选。应用的评估阈值。
variable_declarations[]	App.VariableDeclaration 可选。变量的声明。
predefined_variable_declarations[]	App.VariableDeclaration 仅限输出。应用的预定义变量的声明。
global_instruction	string 可选。应用中所有代理的指令。您可以使用此指令为所有代理设置稳定的身份或个性。
guardrails[]	string 可选。应用的防护栏列表。格式：projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}
data_store_settings	DataStoreSettings 可选。应用的数据存储区设置。
default_channel_profile	ChannelProfile 可选。应用使用的默认渠道配置文件。
metadata	map<string, string> 可选。有关应用的元数据。此字段可用于存储与应用详情或预期用途相关的其他信息。
create_time	Timestamp 仅限输出。应用创建时的时间戳。
update_time	Timestamp 仅限输出。上次更新应用时的时间戳。
etag	string 仅限输出。用于确保对象在读取-修改-写入操作期间未发生更改的 ETag。如果 etag 为空，则更新会覆盖任何并发更改。
deployment_count	int32 仅限输出。应用中的部署数量。
client_certificate_settings	ClientCertificateSettings 可选。应用的默认客户端证书设置。
locked	bool 可选。指示应用是否已锁定以防止更改。如果应用处于锁定状态，对应用资源的修改将被拒绝。

ToolExecutionMode

定义代理同时选择多个工具时的工具执行行为。

枚举
TOOL_EXECUTION_MODE_UNSPECIFIED	未指定的工具执行模式。默认为 PARALLEL。
PARALLEL	如果选择了多个工具，它们将并行执行，并使用相同的 ToolContext。
SEQUENTIAL	如果选择了多个工具，系统将按顺序执行这些工具。下一个工具只有在之前的工具完成执行后才会执行，并且可以看到之前工具更新的 ToolContext。

VariableDeclaration

定义变量的结构和元数据。

字段
name	string 必需。变量的名称。名称必须以字母或下划线开头，并且只能包含字母、数字或下划线。
description	string 必需。变量的说明。
schema	Schema 必需。变量的架构。

AppSnapshot

应用的快照。

字段
app	App 可选。应用的基本设置。
agents[]	Agent 可选。应用中的代理列表。
tools[]	Tool 可选。应用中的工具列表。
examples[]	Example 可选。应用中的示例列表。
guardrails[]	Guardrail 可选。应用中的安全措施列表。
toolsets[]	Toolset 可选。应用中的工具集列表。

AppVersion

在 Customer Engagement Suite (CES) 中，应用版本是指应用在特定时间点的快照。该名称是不可变的，一经创建便无法修改。

字段
name	string 标识符。应用版本的唯一标识符。格式：projects/{project}/locations/{location}/apps/{app}/versions/{version}
display_name	string 可选。应用版本的显示名称。
description	string 可选。应用版本的说明。
creator	string 仅限输出。创建应用版本的用户的电子邮件地址。
create_time	Timestamp 仅限输出。应用版本创建时间的时间戳。
snapshot	AppSnapshot 仅限输出。创建版本时应用的快照。
etag	string 仅限输出。用于确保对象在读取-修改-写入操作期间未发生更改的 ETag。如果 etag 为空，则更新会覆盖任何并发更改。

AudioEncoding

AudioEncoding 用于指定音频数据的编码格式。

枚举
AUDIO_ENCODING_UNSPECIFIED	未指定音频编码。
LINEAR16	16 位线性 PCM 音频编码。
MULAW	8 位采样，使用 G.711 PCMU/mu-law 压缩 14 位音频采样。
ALAW	8 位采样，使用 G.711 PCMU/A-law 压缩 14 位音频采样。

AudioProcessingConfig

有关如何处理和传送输入和输出音频的配置。

字段
synthesize_speech_configs	map<string, SynthesizeSpeechConfig> 可选。代理响应的合成方式配置，从语言代码到 SynthesizeSpeechConfig 的映射。 如果找不到指定语言代码的配置，系统将使用根语言代码的配置。例如，如果该映射包含“en-us”和“en”，并且指定的语言代码为“en-gb”，则将使用“en”配置。 注意：语言代码不区分大小写。
barge_in_config	BargeInConfig 可选。配置用户抢占活动的代理行为。
inactivity_timeout	Duration 可选。在代理提示用户重新互动之前，用户处于非活跃状态（无语音或互动）的时长。如果未设置，代理将不会提示用户重新互动。
ambient_sound_config	AmbientSoundConfig 可选。配置与合成的代理回答一起播放的环境音，以增强对话的自然感。

AudioRecordingConfig

有关如何记录音频互动的配置。

字段
gcs_bucket	string 可选。用于存储会话音频录音的 Cloud Storage 存储桶。URI 必须以“gs://”开头。 请选择符合数据驻留要求的存储桶位置。 注意：如果 Cloud Storage 存储桶与应用位于不同的项目中，您应向 CES 服务代理 service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com 授予 storage.objects.create 权限。
gcs_path_prefix	string 可选。音频录制的 Cloud Storage 路径前缀。 此前缀可以包含以下占位符，这些占位符将在投放时动态替换： - $project：项目 ID - $location：应用位置 - $app：应用 ID - $date：会话日期（采用 YYYY-MM-DD 格式） - $session：会话 ID 如果未指定路径前缀，系统将使用默认前缀 $project/$location/$app/$date/$session/。

BargeInConfig

有关如何处理用户抢占活动的配置。

字段
disable_barge_in (deprecated)	bool 此项已弃用！ 可选。在代理说话时禁止用户插话。如果为 true，则在代理回答播放期间，系统会忽略用户输入。 已弃用：disable_barge_in 已弃用，取而代之的是 ChannelProfile 中的 disable_barge_in_control。
barge_in_awareness	bool 可选。如果启用此功能，代理会根据用户未听到之前代理消息的全部内容这一假设来调整其下一次响应。在以视觉方式显示代理响应的场景中，不应使用此属性。

BatchDeleteConversationsRequest

AgentService.BatchDeleteConversations 的请求消息。

字段
parent	string 必需。要删除对话的应用的资源名称。格式：projects/{project}/locations/{location}/apps/{app}
conversations[]	string 必需。要删除的对话的资源名称。

BatchDeleteConversationsResponse

AgentService.BatchDeleteConversations 的响应消息。

字段
deleted_conversations[]	string 已成功删除的对话列表。
failed_conversations[]	string 未能成功删除的对话列表。
error_messages[]	string 可选。与未能删除的对话相关联的错误消息列表。

BearerTokenConfig

使用不记名令牌进行身份验证的配置。

字段
token	string 必需。不记名令牌。必须采用 $context.variables.<name_of_variable> 格式。

BidiSessionClientMessage

客户端为 SessionService.BidiRunSession 方法发送的顶级消息。

字段
联合字段 message_type。消息的类型。message_type 只能是下列其中一项：
config	SessionConfig 可选。会话的初始配置消息。
realtime_input	SessionInput 可选。会话的实时输入。

BidiSessionServerMessage

从 SessionService.BidiRunSession 方法返回的顶级消息。

字段
联合字段 message_type。消息的类型。message_type 只能是下列其中一项：
session_output	SessionOutput 可选。来自 CES 代理的处理结果。
recognition_result	RecognitionResult 可选。音频输入的实时语音识别结果。
interruption_signal	InterruptionSignal 可选。表示代理的音频回答已被中断。
end_session	EndSession 可选。表示会话已结束。
go_away	GoAway 可选。表示服务器即将断开连接，客户端应半关闭并重新启动连接。

BigQueryExportSettings

用于描述应用的 BigQuery 导出行为的设置。

字段
enabled	bool 可选。指示是否已启用 BigQuery 导出。
project	string 可选。要将数据导出到的 BigQuery 数据集的项目 ID。 注意：如果 BigQuery 数据集与应用不在同一项目中，您应向 CES 服务代理 service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com 授予 roles/bigquery.admin 角色。
dataset	string 可选。要将数据导出到的 BigQuery 数据集。

Blob

表示对话中的 blob 输入或输出。

字段
mime_type	string 必需。来源数据的 IANA 标准 MIME 类型。
data	bytes 必需。相应 blob 的原始字节。

回调

回调定义了在代理互动的不同阶段执行的自定义逻辑。

字段
description	string 可选。回调的人类可读说明。
disabled	bool 可选。回调是否已停用。代理会忽略已停用的回调。
proactive_execution_enabled	bool 可选。如果启用，回调也会在中间模型输出上执行。此设置仅在模型回调后生效。请谨慎启用。通常，after_model_callback 仅需在收到所有模型回答后执行。启用主动执行可能会对执行费用和延迟时间产生负面影响，因此仅应在极少数情况下启用。
联合字段 callback。要执行的回调。callback 只能是下列其中一项：
python_code	string 必需。要为回调执行的 Python 代码。

更新日志

更改日志表示对应用或应用内资源所做的更改。

字段
name	string 标识符。更改日志的唯一标识符。格式：projects/{project}/locations/{location}/apps/{app}/changelogs/{changelog}
author	string 仅限输出。更改作者的电子邮件地址。
display_name	string 仅限输出。相应变更的显示名称。它通常应该是已更改资源的显示名称。
description	string 仅限输出。更改的说明，通常会捕获资源中已更改的字段。
resource	string 仅限输出。已更改的资源。
resource_type	string 仅限输出。已更改的资源类型。
action	string 仅限输出。对资源执行的操作。
original_resource	Struct 仅限输出。更改前的原始资源。
new_resource	Struct 仅限输出。更改后的新资源。
dependent_resources[]	Struct 仅限输出。已更改的相关资源。
create_time	Timestamp 仅限输出。做出更改的时间。
sequence_number	int64 仅限输出。变更日志的单调递增的序列号。

ChannelProfile

ChannelProfile 用于配置代理在特定通信渠道（例如 Web 界面或电话）中的行为。

字段
profile_id	string 可选。频道配置的唯一标识符。
channel_type	ChannelProfile.ChannelType 可选。渠道配置文件的类型。
persona_property	ChannelProfile.PersonaProperty 可选。频道资料的身份属性。
disable_dtmf	bool 可选。是否停用 DTMF（双音多频）。
disable_barge_in_control	bool 可选。是否在对话中停用用户抢占控制。- true：在代理说话时，系统会停用用户中断。- false：智能体保留对用户何时可以中断的自动控制权。
web_widget_config	ChannelProfile.WebWidgetConfig 可选。Web widget 的配置。
noise_suppression_level	string 可选。渠道配置文件的降噪级别。可选的值包括“low”“moderate”“high”“very_high”。

ChannelType

渠道配置文件的类型。

枚举
UNKNOWN	未知渠道类型。
WEB_UI	网页界面渠道。
API	API 渠道。
TWILIO	Twilio 渠道。
GOOGLE_TELEPHONY_PLATFORM	Google Telephony Platform 频道。
CONTACT_CENTER_AS_A_SERVICE	联络中心即服务 (CCaaS) 渠道。
FIVE9	Five9 渠道。
CONTACT_CENTER_INTEGRATION	第三方联络中心集成渠道。

PersonaProperty

表示频道的角色属性。

字段
persona	ChannelProfile.PersonaProperty.Persona 可选。频道的角色。

角色

频道的角色。

枚举
UNKNOWN	未知角色。
CONCISE	代理会保持回答简洁明了
CHATTY	代理会提供更多背景信息、说明和详细信息

WebWidgetConfig

网页 widget 的配置消息。

字段
modality	ChannelProfile.WebWidgetConfig.Modality 可选。网络 widget 的模态。
theme	ChannelProfile.WebWidgetConfig.Theme 可选。网络微件的主题。
web_widget_title	string 可选。网络 widget 的标题。
security_settings	ChannelProfile.WebWidgetConfig.SecuritySettings 可选。Web widget 的安全设置。

模态

Web widget 的模态。

枚举
MODALITY_UNSPECIFIED	未知模态。
CHAT_AND_VOICE	微件支持聊天和语音输入。
VOICE_ONLY	该 widget 仅支持语音输入。
CHAT_ONLY	微件仅支持聊天输入。

SecuritySettings

Web widget 的安全设置。

字段
enable_public_access	bool 可选。指示是否已启用对 Web widget 的公开访问权限。如果为 true，则 Web widget 将可公开访问。如果为 false，则必须将 Web widget 与您自己的身份验证和授权系统集成，以返回用于访问 CES 代理的有效凭据。
enable_origin_check	bool 可选。指示是否为 Web widget 启用了来源检查。如果值为 true，则 Web widget 将检查加载该 Web widget 的网站的来源，并且仅允许在同一来源或任何允许的来源中加载该 Web widget。
allowed_origins[]	string 可选。允许托管 Web widget 的来源。来源由 RFC 6454 定义。如果为空，则允许所有来源。最多允许 100 个来源。示例：“https://example.com”
enable_recaptcha	bool 可选。指示是否已启用 Web widget 的 reCAPTCHA 验证。

主题

网络微件的主题。

枚举
THEME_UNSPECIFIED	未知主题。
LIGHT	浅色主题。
DARK	深色主题。

块

消息中的内容块。

字段
联合字段 data。数据块数据。data 只能是下列其中一项：
text	string 可选。文本数据。
transcript	string 可选。与音频关联的转写内容。
blob	Blob 可选。Blob 数据。
payload	Struct 可选。自定义载荷数据。
image	Image 可选。图片数据。
tool_call	ToolCall 可选。工具执行请求。
tool_response	ToolResponse 可选。工具执行响应。
agent_transfer	AgentTransfer 可选。代理转移事件。
updated_variables	Struct 一个结构体，表示对话中更新的变量，按变量名称键控。
default_variables	Struct 结构体表示对话开始时的默认变量，按变量名称键控。

引用

与代理回答关联的引用。

字段
cited_chunks[]	Citations.CitedChunk 引用信息列表。

CitedChunk

引用信息。

字段
uri	string 用于引用的 URI。
title	string 被引用文档的标题。
text	string 用于引用的文本。

ClientCertificateSettings

自定义客户端证书的设置。

字段
tls_certificate	string 必需。采用 PEM 格式编码的 TLS 证书。此字符串必须包含起始标题行和结束页脚行。
private_key	string 必需。存储以 PEM 格式编码的私钥的 SecretManager 密文版本资源名称。格式：projects/{project}/secrets/{secret}/versions/{version}
passphrase	string 可选。用于存储解密私钥的口令的 SecretManager 密文版本资源的名称。如果私钥未加密，则应保持未设置状态。格式：projects/{project}/secrets/{secret}/versions/{version}

ClientFunction

表示代理可以调用的客户端函数。当代理选择工具时，控制权会移交给客户端。客户端负责执行函数并以 ToolResponse 的形式返回结果，以便继续与代理互动。

字段
name	string 必需。函数名称。
description	string 可选。函数说明。
parameters	Schema 可选。函数参数的架构。
response	Schema 可选。函数响应的架构。

CloudLoggingSettings

用于描述应用的 Cloud Logging 行为的设置。

字段
enable_cloud_logging	bool 可选。是否为会话启用 Cloud Logging。

CodeBlock

要执行的代码块，而不是实际的工具调用。

字段
python_code	string 必需。将在工具伪造模式下调用的 Python 代码。预期 Python 函数签名 - 捕获所有工具调用：def fake_tool_call(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]] 捕获特定工具调用：def fake_{tool_id}(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]] 如果函数返回 None，则会改为调用实际工具。

ConnectorTool

ConnectorTool 允许连接到不同的集成。请参阅：https://cloud.google.com/integration-connectors/docs/overview。

字段
connection	string 必需。所引用集成连接器连接的完整资源名称。格式：projects/{project}/locations/{location}/connections/{connection}
action	Action 必需。工具要使用的操作。
auth_config	EndUserAuthConfig 可选。配置 Integration Connectors 中身份验证的处理方式。默认情况下，管理员身份验证会在 Integration Connectors API 请求中传递。您可以使用其他最终用户身份验证配置来替换它。注意：连接必须启用身份验证替换，才能在此处指定 EUC 配置；否则，ConnectorTool 创建将会失败。如需了解详情，请参阅 https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override。
name	string 可选。代理可用于决定是否调用此 ConnectorTool 的工具的名称。
description	string 可选。工具的说明，代理可以使用此说明来决定是否调用此 ConnectorTool。

ConnectorToolset

一种可从 Integration Connectors 连接生成工具的工具集。

字段
connection	string 必需。所引用集成连接器连接的完整资源名称。格式：projects/{project}/locations/{location}/connections/{connection}
auth_config	EndUserAuthConfig 可选。配置 Integration Connectors 中身份验证的处理方式。默认情况下，管理员身份验证会在 Integration Connectors API 请求中传递。您可以使用其他最终用户身份验证配置来替换它。注意：连接必须启用身份验证替换，才能在此处指定 EUC 配置；否则，工具集创建将失败。请参阅：https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override
connector_actions[]	Action 必需。要为其生成工具的连接器操作/实体操作的列表。

对话

对话表示最终用户与 CES 应用之间的互动。

字段
name	string 标识符。对话的唯一标识符。格式：projects/{project}/locations/{location}/apps/{app}/conversations/{conversation}
start_time	Timestamp 仅限输出。对话的创建时间戳。
end_time	Timestamp 仅限输出。对话结束时的时间戳。
turns[]	Conversation.Turn 必需。对话中的回合。
turn_count	int32 仅限输出。对话中的回合数。
channel_type (deprecated)	Conversation.ChannelType 此项已弃用！ 已弃用。请改用 input_types。
source	Conversation.Source 仅限输出。指明对话的来源。
input_types[]	Conversation.InputType 仅限输出。对话的输入类型。
entry_agent	string 仅限输出。最初处理对话的代理。如果未指定，则对话由根代理处理。格式：projects/{project}/locations/{location}/apps/{app}/agents/{agent}
deployment	string 仅限输出。用于处理对话的应用的部署。格式：projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
app_version	string 仅限输出。用于处理对话的应用版本。格式：projects/{project}/locations/{location}/apps/{app}/versions/{version}
language_code	string 仅限输出。对话的语言代码。
messages[] (deprecated)	Message 此项已弃用！ 已弃用。请改用 turn。

ChannelType

对话的渠道类型。

枚举
CHANNEL_TYPE_UNSPECIFIED	未指定渠道类型。
TEXT	对话仅包含最终用户与代理之间的文本消息。
AUDIO	对话包含最终用户与代理之间的音频消息。
MULTIMODAL	最终用户与代理之间的对话多模态消息（例如图片）。

InputType

输入消息的类型。

枚举
INPUT_TYPE_UNSPECIFIED	未指定输入类型。
INPUT_TYPE_TEXT	输入消息是文本。
INPUT_TYPE_AUDIO	输入消息是音频。
INPUT_TYPE_IMAGE	输入消息是图片。
INPUT_TYPE_BLOB	输入消息是 blob 文件。
INPUT_TYPE_TOOL_RESPONSE	输入消息是客户端函数工具响应。
INPUT_TYPE_VARIABLES	输入消息是变量。

来源

对话的来源。

枚举
SOURCE_UNSPECIFIED	未指定来源。
LIVE	对话来自实时最终用户。
SIMULATOR	对话来自模拟器。
EVAL	对话来自评估。

Turn

对话中单个轮次的所有信息。

字段
messages[]	Message 可选。对话回合中的消息列表，包括用户输入、代理响应和处理期间的中间事件。
root_span	Span 可选。操作处理的根 span。

ConversationLoggingSettings

用于描述应用的对话记录行为的设置。

字段
disable_conversation_logging	bool 可选。是否为会话停用对话日志记录。

CreateAgentRequest

AgentService.CreateAgent 的请求消息。

字段
parent	string 必需。要在其中创建代理的应用的资源名称。
agent_id	string 可选。要用于代理的 ID，该 ID 将成为代理资源名称的最后一个组成部分。如果未提供，系统会自动为代理分配唯一 ID。
agent	Agent 必需。要创建的代理。

CreateAppRequest

AgentService.CreateApp 的请求消息。

字段
parent	string 必需。要在其中创建应用的营业地点的资源名称。
app_id	string 可选。要用于应用的 ID，该 ID 将成为应用资源名称的最后一个组成部分。如果未提供，系统会自动为应用分配唯一 ID。
app	App 必需。要创建的应用。

CreateAppVersionRequest

AgentService.CreateAppVersion 的请求消息

字段
parent	string 必需。要在其中创建应用版本的应用的资源名称。
app_version_id	string 可选。要用于应用版本的 ID，该 ID 将成为应用版本资源名称的最后一个组成部分。如果未提供，系统会自动为应用版本分配唯一 ID。
app_version	AppVersion 必需。要创建的应用版本。

CreateDeploymentRequest

AgentService.CreateDeployment 的请求消息。

字段
parent	string 必需。父应用。格式：projects/{project}/locations/{location}/apps/{app}
deployment_id	string 可选。要用于部署的 ID，该 ID 将成为部署资源名称的最后一个组成部分。如果未提供，系统会自动为部署分配唯一 ID。
deployment	Deployment 必需。要创建的部署。

CreateExampleRequest

AgentService.CreateExample 的请求消息。

字段
parent	string 必需。要创建示例的应用的资源名称。
example_id	string 可选。要用于示例的 ID，该 ID 将成为示例资源名称的最后一个组成部分。如果未提供，系统会自动为示例分配唯一 ID。
example	Example 必需。要创建的示例。

CreateGuardrailRequest

AgentService.CreateGuardrail 的请求消息。

字段
parent	string 必需。要创建安全屏障的应用的资源名称。
guardrail_id	string 可选。要用于安全护栏的 ID，该 ID 将成为安全护栏资源名称的最后一个组成部分。如果未提供，系统会自动为安全屏障分配唯一 ID。
guardrail	Guardrail 必需。要创建的护栏。

CreateToolRequest

AgentService.CreateTool 的请求消息。

字段
parent	string 必需。要在其中创建工具的应用的资源名称。
tool_id	string 可选。要用于工具的 ID，该 ID 将成为工具资源名称的最后一个组成部分。如果未提供，系统会自动为该工具分配唯一 ID。
tool	Tool 必需。要创建的工具。

CreateToolsetRequest

AgentService.CreateToolset 的请求消息。

字段
parent	string 必需。要在其中创建工具集的应用的资源名称。
toolset_id	string 可选。要用于工具集的 ID，该 ID 将成为工具集资源名称的最后一个组成部分。如果未提供，系统会自动为工具集分配唯一 ID。
toolset	Toolset 必需。要创建的工具集。

DataStore

Vertex AI Search 中的 DataStore 资源。

字段
name	string 必需。数据存储区的完整资源名称。格式：projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}
type	DataStore.DataStoreType 仅限输出。数据存储区的类型。此字段为只读字段，由服务器填充。
document_processing_mode	DataStore.DocumentProcessingMode 仅限输出。数据存储区连接的文档处理模式。仅针对 PUBLIC_WEB 和 UNSTRUCTURED 数据存储区设置。
display_name	string 仅限输出。数据存储区的显示名称。
create_time	Timestamp 仅限输出。数据存储区的创建时间戳。
connector_config	DataStore.ConnectorConfig 仅限输出。数据存储区连接的连接器配置。

ConnectorConfig

数据存储区连接的连接器配置。

字段
collection	string 数据存储区所属集合的资源名称。
collection_display_name	string 数据存储区所属集合的显示名称。
data_source	string 数据源的名称。示例：salesforce、jira、confluence、bigquery。

DataStoreType

数据存储区的类型。

枚举
DATA_STORE_TYPE_UNSPECIFIED	未指定。此值表示未指定数据存储区类型，因此在搜索期间不会使用该类型。
PUBLIC_WEB	包含公开网络内容的数据存储区。
UNSTRUCTURED	包含非结构化私有数据的数据存储区。
FAQ	包含用作 FAQ 的结构化数据的数据存储区。
CONNECTOR	一种数据存储区，可连接到第一方或第三方服务。

DocumentProcessingMode

数据存储区的文档处理模式。

枚举
DOCUMENT_PROCESSING_MODE_UNSPECIFIED	未指定。
DOCUMENTS	文档会作为文档进行处理。
CHUNKS	文档会转换为块。

DataStoreSettings

应用的数据存储区相关设置。

字段
engines[]	DataStoreSettings.Engine 仅限输出。应用的引擎。

引擎

数据存储区所连接到的引擎。请参阅 Vertex AI Search：https://cloud.google.com/generative-ai-app-builder/docs/enterprise-search-introduction。

字段
name	string 仅限输出。引擎的资源名称。格式：projects/{project}/locations/{location}/collections/{collection}/engines/{engine}
type	DataStoreSettings.Engine.Type 仅限输出。引擎的类型。

类型

引擎的类型。请参阅以下文档：https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1/SolutionType 和 https://cloud.google.com/generative-ai-app-builder/docs/create-datastore-ingest。

枚举
TYPE_UNSPECIFIED	未指定引擎类型。
ENGINE_TYPE_SEARCH	应用的 SOLUTION_TYPE_SEARCH 引擎。添加到应用的所有连接器数据存储区都将添加到此引擎。
ENGINE_TYPE_CHAT	Chat 引擎类型。应用的 SOLUTION_TYPE_CHAT 引擎。添加到应用的所有连接器数据存储区都将添加到此引擎。

DataStoreTool

用于从 Vertex AI Search 数据存储区或引擎中检索信息以作为依据的工具。接受数据存储区或引擎，但不能同时接受这两者。请参阅 Vertex AI Search：https://cloud.google.com/generative-ai-app-builder/docs/enterprise-search-introduction。

字段
name	string 必需。数据存储区工具名称。
description	string 可选。工具说明。
boost_specs[]	DataStoreTool.BoostSpecs 可选。用于提升特定文档的提升规范。
modality_configs[]	DataStoreTool.ModalityConfig 可选。数据存储区的模态配置。
filter_parameter_behavior	DataStoreTool.FilterParameterBehavior 可选。过滤条件参数行为。
联合字段 search_source。定义搜索来源，可以是单个 DataStore 或引擎。search_source 只能是下列其中一项：
data_store_source	DataStoreTool.DataStoreSource 可选。在单个特定数据存储区中搜索。
engine_source	DataStoreTool.EngineSource 可选。在引擎内（可能跨多个数据存储区）进行搜索。

BoostSpec

用于提升特定文档的提升规范。

字段
condition_boost_specs[]	DataStoreTool.BoostSpec.ConditionBoostSpec 必需。提升规范列表。

ConditionBoostSpec

条件的提升规范。

字段
condition	string 必需。用于指定提升条件的表达式。语法与过滤表达式语法相同。目前，唯一支持的条件是 BCP-47 语言代码列表。示例：提升英语或法语建议的效果：(lang_code: ANY("en", "fr"))
boost	float 可选。提升的强度，应介于 [-1, 1] 之间。设为负值代表降位。 默认值为 0.0。 设置为 1.0 可大幅提升建议的权重。不过，这并不一定意味着最佳结果会是提升后的建议。 设置为 -1.0 会大幅降低建议的权重。不过，系统可能仍会显示其他相关建议。 设置为 0.0 表示不应用任何提升。系统会忽略提升条件。
boost_control_spec	DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec 可选。基于客户定义的属性值的自定义排名复杂规范。

BoostControlSpec

基于客户指定的属性值的自定义排名规范。与上述简单的（条件、提升）组合相比，它可提供更多用于自定义排名的控件。

字段
field_name	string 可选。将用于确定提升幅度的字段的名称。
attribute_type	DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec.AttributeType 可选。用于确定提升幅度的属性类型。属性值可以从指定 field_name 的字段值派生而来。对于数值，这很简单，即 attribute_value = numerical_field_value。不过，对于新鲜度，attribute_value = (time.now() - datetime_field_value)。
interpolation_type	DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec.InterpolationType 可选。用于连接下列控制点的插值类型。
control_points[]	DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPoint 可选。用于定义曲线的控制点。单调函数（通过上面的 interpolation_type 定义）会通过此处列出的控制点。

AttributeType

要针对其应用自定义排名的属性（或函数）。

枚举
ATTRIBUTE_TYPE_UNSPECIFIED	未指定 AttributeType。
NUMERICAL	数值字段的值将用于动态更新提升幅度。在这种情况下，控制点的 attribute_value（即 x 值）将是指定了 boost_amount 的数值字段的实际值。
FRESHNESS	对于新鲜度应用场景，属性值将是当前时间与指定日期时间字段中的日期之间的时长。该值必须采用 XSD dayTimeDuration 值（ISO 8601 时长值的受限子集）的格式。该值的格式为：[nD][T[nH][nM][nS]]。例如 5D、3DT12H30M、T24H。

ControlPoint

用于定义曲线的控制点。通过这些控制点定义的曲线只能单调递增或递减（可接受常量值）。

字段
attribute_value	string 可选。可以是以下值之一：1. 数值字段值。2. 新鲜度对应的时长规范：该值必须采用 XSD dayTimeDuration 值（ISO 8601 时长值的受限子集）的格式。该值的格式为：[nD][T[nH][nM][nS]]。
boost_amount	float 可选。如果 attribute_value 的求值结果为上述指定的值，则该字段的值用于提升得分（介于 -1 到 1 之间）。

InterpolationType

要应用的插值类型。默认值为线性（分段线性）。

枚举
INTERPOLATION_TYPE_UNSPECIFIED	插值类型未指定。在这种情况下，该字段会默认设置为线性。
LINEAR	系统将应用分段线性插值。

BoostSpecs

用于提升特定文档的提升规范。如需了解详情，请参阅 https://cloud.google.com/generative-ai-app-builder/docs/boosting。

字段
data_stores[]	string 必需。应用了提升配置的数据存储区。数据存储区的完整资源名称，例如 projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}。
spec[]	DataStoreTool.BoostSpec 必需。提升规范列表。

DataStoreSource

在特定 DataStore 中进行搜索的配置。

字段
filter	string 可选。数据存储区的过滤条件规范。请参阅：https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata
data_store	DataStore 可选。数据存储区。

EngineSource

在引擎内进行搜索的配置，可能会定位到特定的 DataStore。

字段
engine	string 必需。引擎的完整资源名称。格式：projects/{project}/locations/{location}/collections/{collection}/engines/{engine}
data_store_sources[]	DataStoreTool.DataStoreSource 可选。用于定位引擎中的特定 DataStore。如果为空，则搜索适用于与 Engine 关联的所有数据存储区。
filter	string 可选。应用于整个引擎搜索的过滤条件。如果提供了“data_store_sources”，则此参数不相关且不会使用。请参阅：https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata

FilterParameterBehavior

过滤条件参数行为。

枚举
FILTER_PARAMETER_BEHAVIOR_UNSPECIFIED	默认过滤行为。为连接器数据存储区添加了过滤条件参数。对于其余数据存储区类型，过滤条件输入参数会被省略。
ALWAYS_INCLUDE	始终为所有数据存储区类型添加过滤条件参数。
NEVER_INCLUDE	无论数据存储区类型如何，过滤条件参数都绝不会包含在工具参数列表中。

GroundingConfig

接地配置。

字段
grounding_level	float 可选。根据检索到的来源得出的回答接地性阈值。该值的可配置范围为 [1, 5]。该级别用于设置回答接地程度的阈值，这意味着接地程度得分低于该阈值的所有回答都将回退到仅返回相关摘要。 例如，如果将此参数设置为 3，则只有当回答的依据充分性得分达到 3 或更高时，系统才会返回回答。
disabled	bool 可选。接地是否已停用。

ModalityConfig

如果指定，将为指定模态应用给定配置。

字段
modality_type	DataStoreTool.ModalityConfig.ModalityType 必需。模态类型。
rewriter_config	DataStoreTool.RewriterConfig 可选。重写器配置。
summarization_config	DataStoreTool.SummarizationConfig 可选。总结配置。
grounding_config	DataStoreTool.GroundingConfig 可选。接地配置。

ModalityType

模态类型。

枚举
MODALITY_TYPE_UNSPECIFIED	未指定的模态类型。
TEXT	文本模态。
AUDIO	音频模态。

RewriterConfig

重写器配置。

字段
model_settings	ModelSettings 必需。LLM 模型的配置。
prompt	string 可选。提示定义。如果未设置，系统将使用默认提示。
disabled	bool 可选。重写器是否已停用。

SummarizationConfig

摘要配置。

字段
model_settings	ModelSettings 可选。LLM 模型的配置。
prompt	string 可选。提示定义。如果未设置，系统将使用默认提示。
disabled	bool 可选。是否已停用总结功能。

DeleteAgentRequest

AgentService.DeleteAgent 的请求消息。

字段
name	string 必需。要删除的代理的资源名称。
force	bool 可选。指示是否强制删除代理，即使该代理仍被其他应用/代理/示例引用也是如此。 如果值为 force = false，则当其他代理/示例引用该实体时，删除操作会失败。 如果值为 force = true，则删除代理并将其从所有引用应用/代理/示例中移除。
etag	string 可选。代理的当前 etag。如果未提供 etag，删除操作将覆盖任何并发更改。如果提供的 etag 与代理的当前 etag 不匹配，删除操作将被阻止并返回 ABORTED 错误。

DeleteAppRequest

AgentService.DeleteApp 的请求消息。

字段
name	string 必需。要删除的应用的资源名称。
etag	string 可选。应用的当前 etag。如果未提供 etag，删除操作将覆盖任何并发更改。如果提供的 etag 与应用的当前 etag 不匹配，删除操作将被阻止并返回 ABORTED 错误。

DeleteAppVersionRequest

AgentService.DeleteAppVersion 的请求消息。

字段
name	string 必需。要删除的应用版本的资源名称。
etag	string 可选。应用版本的当前 ETag。如果未提供 etag，删除操作将覆盖任何并发更改。如果提供的 etag 与应用版本的当前 etag 不匹配，删除操作将被阻止并返回 ABORTED 错误。

DeleteConversationRequest

AgentService.DeleteConversation 的请求消息。

字段
name	string 必需。要删除的对话的资源名称。
source (deprecated)	Conversation.Source 此项已弃用！ 可选。指明对话的来源。如果未设置，系统将默认应用 Source.Live。

DeleteDeploymentRequest

AgentService.DeleteDeployment 的请求消息。

字段
name	string 必需。要删除的部署的名称。格式：projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
etag	string 可选。相应部署的 ETag。如果提供的 etag 与部署的当前 etag 不匹配，删除操作将被阻止并返回 ABORTED 错误。

DeleteExampleRequest

AgentService.DeleteExample 的请求消息。

字段
name	string 必需。要删除的示例的资源名称。
etag	string 可选。示例的当前 etag。如果未提供 etag，删除操作将覆盖任何并发更改。如果提供的 etag 与示例的当前 etag 不匹配，删除操作将被阻止并返回 ABORTED 错误。

DeleteGuardrailRequest

AgentService.DeleteGuardrail 的请求消息。

字段
name	string 必需。要删除的护栏的资源名称。
force	bool 可选。指示是否强制删除安全护栏，即使应用/代理仍引用该安全护栏也是如此。 如果为 force = false，则当任何应用/代理仍引用安全护栏时，删除操作会失败。 如果值为 force = true，则会移除应用/代理中的所有现有引用，并删除安全护栏。
etag	string 可选。防护栏的当前 etag。如果未提供 etag，删除操作将覆盖任何并发更改。如果提供的 etag 与安全措施的当前 etag 不匹配，删除操作将被阻止并返回 ABORTED 错误。

DeleteToolRequest

AgentService.DeleteTool 的请求消息。

字段
name	string 必需。要删除的工具的资源名称。
force	bool 可选。指示是否强制删除工具，即使该工具仍被代理/示例引用也是如此。 如果值为 force = false，则当任何代理仍引用该工具时，删除操作将失败。 如果选择 force = true，系统将移除代理的所有现有引用，并删除该工具。
etag	string 可选。工具的当前 etag。如果未提供 etag，删除操作将覆盖任何并发更改。如果提供的 etag 与工具的当前 etag 不匹配，删除操作将被阻止并返回 ABORTED 错误。

DeleteToolsetRequest

AgentService.DeleteToolset 的请求消息。

字段
name	string 必需。要删除的工具集的资源名称。
force	bool 可选。指示是否强制删除工具集，即使应用/代理仍引用该工具集也是如此。 如果值为 force = false，则当任何代理仍引用该工具集时，删除操作会失败。 如果选择 force = true，系统将移除代理的所有现有引用，并删除该工具集。
etag	string 可选。工具集的当前 etag。如果未提供 etag，删除操作将覆盖任何并发更改。如果提供的 etag 与工具集的当前 etag 不匹配，删除操作将被阻止并返回 ABORTED 错误。

部署

部署表示应用的不可变且可查询的版本。它用于部署具有特定渠道配置的应用版本。

字段
name	string 标识符。相应部署的资源名称。格式：projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
display_name	string 必需。部署的显示名称。
app_version	string 可选。要部署的应用版本的资源名称。格式：projects/{project}/locations/{location}/apps/{app}/versions/{version} 使用 projects/{project}/locations/{location}/apps/{app}/versions/- 来使用草稿应用。
channel_profile	ChannelProfile 必需。部署中使用的渠道配置文件。
create_time	Timestamp 仅限输出。相应部署的创建时间戳。
update_time	Timestamp 仅限输出。相应部署上次更新时的时间戳。
etag	string 仅限输出。用于确保对象在读取-修改-写入操作期间未发生更改的 ETag。如果 etag 为空，则更新会覆盖任何并发更改。

EndSession

表示会话已终止，原因可能是成功完成（例如，用户说“再见！”）或转接给客服人员。

会话终止后，代理将不再处理任何进一步的输入，并且客户端应在收到代理发送的所有剩余响应后半关闭并断开连接。

字段
metadata	Struct 可选。提供有关结束会话信号的其他信息，例如结束会话的原因。

EndUserAuthConfig

用于连接调用的最终用户身份验证配置。字段值必须是 $context.variables.<name_of_variable> 格式的上下文变量名称。

字段
联合字段 auth_config。身份验证配置。auth_config 只能是下列其中一项：
oauth2_auth_code_config	EndUserAuthConfig.Oauth2AuthCodeConfig Oauth 2.0 授权代码身份验证。
oauth2_jwt_bearer_config	EndUserAuthConfig.Oauth2JwtBearerConfig JWT 配置文件 OAuth 2.0 授权许可身份验证。

Oauth2AuthCodeConfig

Oauth 2.0 授权代码身份验证配置。

字段
oauth_token	string 必需。要传递的 OAuth 令牌形参名称。必须采用 $context.variables.<name_of_variable> 格式。

Oauth2JwtBearerConfig

JWT 配置文件 OAuth 2.0 授权许可身份验证配置。

字段
issuer	string 必需。要传递的提供方形参名称。必须采用 $context.variables.<name_of_variable> 格式。
subject	string 必需。要传递的主题形参名称。必须采用 $context.variables.<name_of_variable> 格式。
client_key	string 必需。要传递的客户端参数名称。必须采用 $context.variables.<name_of_variable> 格式。

ErrorHandlingSettings

用于描述应用中应如何处理错误的设置。

字段
error_handling_strategy	ErrorHandlingSettings.ErrorHandlingStrategy 可选。用于错误处理的策略。

ErrorHandlingStrategy

定义了处理错误的策略。

枚举
ERROR_HANDLING_STRATEGY_UNSPECIFIED	未指定错误处理策略。默认值为 FALLBACK_RESPONSE。
NONE	未启用任何特定处理。
FALLBACK_RESPONSE	如果出现 LLM 错误，系统会向用户返回后备消息。

EvaluationMetricsThresholds

评估中指标的阈值设置。

字段
golden_evaluation_metrics_thresholds	EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds 可选。黄金评估指标阈值。
hallucination_metric_behavior (deprecated)	EvaluationMetricsThresholds.HallucinationMetricBehavior 此项已弃用！ 可选。已弃用：请改用 golden_hallucination_metric_behavior。目前，幻觉指标行为用于黄金评估。
golden_hallucination_metric_behavior	EvaluationMetricsThresholds.HallucinationMetricBehavior 可选。黄金评估的幻觉指标行为。
scenario_hallucination_metric_behavior	EvaluationMetricsThresholds.HallucinationMetricBehavior 可选。用于评估方案的幻觉指标行为。

GoldenEvaluationMetricsThresholds

黄金评估的设置。

字段
turn_level_metrics_thresholds	EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.TurnLevelMetricsThresholds 可选。对话轮次级指标阈值。
expectation_level_metrics_thresholds	EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.ExpectationLevelMetricsThresholds 可选。预期级别指标阈值。
tool_matching_settings	EvaluationMetricsThresholds.ToolMatchingSettings 可选。工具匹配设置。额外的工具调用是指在执行中存在但在黄金预期中没有任何匹配的工具调用。

ExpectationLevelMetricsThresholds

预期水平指标阈值。

字段
tool_invocation_parameter_correctness_threshold	float 可选。单个工具调用参数正确性的成功阈值。必须是介于 0 到 1 之间的浮点数。默认值为 1.0。

TurnLevelMetricsThresholds

开启关卡级指标阈值。

字段
semantic_similarity_channel	EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.TurnLevelMetricsThresholds.SemanticSimilarityChannel 可选。用于评估的语义相似度渠道。
semantic_similarity_success_threshold	int32 可选。语义相似度的成功阈值。必须是介于 0 到 4 之间的整数。默认值为 >= 3。
overall_tool_invocation_correctness_threshold	float 可选。工具调用的总体正确性成功阈值。必须是介于 0 到 1 之间的浮点数。默认值为 1.0。

SemanticSimilarityChannel

要使用的语义相似性渠道。

枚举
SEMANTIC_SIMILARITY_CHANNEL_UNSPECIFIED	未指定指标。默认值为 TEXT。
TEXT	使用文本语义相似度。
AUDIO	使用音频语义相似度。

HallucinationMetricBehavior

幻觉指标行为。无论采用哪种行为，系统都会始终计算该指标。不同之处在于，如果停用某个指标，则该指标不会用于计算总体评估得分。

枚举
HALLUCINATION_METRIC_BEHAVIOR_UNSPECIFIED	未指定幻觉指标行为。
DISABLED	停用幻觉指标。
ENABLED	启用幻觉指标。

ToolMatchingSettings

匹配工具调用的设置。

字段
extra_tool_call_behavior	EvaluationMetricsThresholds.ToolMatchingSettings.ExtraToolCallBehavior 可选。针对额外工具调用的行为。默认值为 FAIL。

ExtraToolCallBehavior

定义遇到额外的工具调用时的行为。额外的工具调用是指在执行中存在但在黄金预期中没有任何匹配的工具调用。

枚举
EXTRA_TOOL_CALL_BEHAVIOR_UNSPECIFIED	未指定行为。默认值为 FAIL。
FAIL	如果遇到额外的工具调用，则评估失败。
ALLOW	允许额外的工具调用。

事件

活动输入。

字段
event	string 必需。事件的名称。

示例

示例表示用户与代理之间的一段对话。

字段
name	string 标识符。示例的唯一标识符。格式：projects/{project}/locations/{location}/apps/{app}/examples/{example}
display_name	string 必需。示例的显示名称。
description	string 可选。示例的人类可读说明。
entry_agent	string 可选。最初处理对话的代理。如果未指定，则该示例表示由根代理处理的对话。格式：projects/{project}/locations/{location}/apps/{app}/agents/{agent}
messages[]	Message 可选。构成对话的消息集合。
create_time	Timestamp 仅限输出。示例的创建时间戳。
update_time	Timestamp 仅限输出。上次更新示例时的时间戳。
invalid	bool 仅限输出。如果引用的资源被删除，示例可能会失效。无效示例不会用作少样本示例。
etag	string 用于确保对象在读取-修改-写入操作期间未发生更改的 ETag。如果 etag 为空，则更新会覆盖任何并发更改。

ExecuteToolRequest

ToolService.ExecuteTool 的请求消息。

字段
parent	string 必需。工具/工具集所属应用的资源名称。格式：projects/{project}/locations/{location}/apps/{app}
args	Struct 可选。以 JSON 对象格式表示的工具的输入参数和值。
variables	Struct 可选。工具执行可用的变量。
联合字段 tool_identifier。要执行的工具的标识符。它可以是持久化工具，也可以是工具集中的工具。tool_identifier 只能是下列其中一项：
tool	string 可选。要执行的工具的名称。格式：projects/{project}/locations/{location}/apps/{app}/tools/{tool}
toolset_tool	ToolsetTool 可选。要执行的工具集工具。工具集中只能有一个工具与谓词匹配。否则，系统将返回错误。

ExecuteToolResponse

ToolService.ExecuteTool 的响应消息。

字段
response	Struct 以 JSON 对象格式表示的工具执行结果。使用“output”键指定工具响应，使用“error”键指定错误详情（如有）。如果未指定“output”和“error”键，则整个“response”都被视为工具执行结果。
variables	Struct 工具执行结束时的变量值。
联合字段 tool_identifier。已执行的工具的标识符。tool_identifier 只能是下列其中一项：
tool	string 已执行的工具的名称。格式：projects/{project}/locations/{location}/apps/{app}/tools/{tool}
toolset_tool	ToolsetTool 已执行的工具集工具。

ExecutionType

工具或工具集的执行类型。

枚举
EXECUTION_TYPE_UNSPECIFIED	执行类型未指定。如果未指定，则默认为 SYNCHRONOUS。
SYNCHRONOUS	该工具以同步方式执行。会话会被阻塞，直到工具返回。
ASYNCHRONOUS	该工具以异步方式执行。在工具执行期间，会话将继续。

ExportAppRequest

AgentService.ExportApp 的请求消息。

字段
name	string 必需。要导出的应用的资源名称。
export_format	ExportAppRequest.ExportFormat 必需。导出应用的格式。
gcs_uri	string 可选。要将应用导出到的 Google Cloud Storage URI。此 URI 的格式必须为 gs://<bucket-name>/<object-name>。导出的应用归档将直接写入指定的 GCS 对象。

ExportFormat

应用的导出格式。

枚举
EXPORT_FORMAT_UNSPECIFIED	未指定导出格式。
JSON	导出格式为 JSON。
YAML	导出格式为 YAML。

ExportAppResponse

AgentService.ExportApp 的响应消息。

字段
联合字段 app。导出的应用。app 只能是下列其中一项：
app_content	bytes 压缩为 zip 文件的应用文件夹。
app_uri	string 应用导出到的 Google Cloud Storage URI。

ExpressionCondition

基于会话状态的表达式条件。

字段
expression	string 必需。cloud.api.Expression 条件的字符串表示形式。

FileSearchTool

文件搜索工具可让智能体搜索应用/智能体开发者上传的文件。它具有预设功能，可针对上传的文件提供相对优质的搜索结果，并对检索到的结果进行总结。

字段
corpus_type	FileSearchTool.CorpusType 可选。语料库的类型。默认值为 FULLY_MANAGED。
name	string 必需。工具名称。
description	string 可选。工具说明。
file_corpus	string 可选。存储文件的语料库。格式：projects/{project}/locations/{location}/ragCorpora/{rag_corpus}

CorpusType

Vertex RAG 语料库的类型。

枚举
CORPUS_TYPE_UNSPECIFIED	未指定的语料库类型。
USER_OWNED	语料库由用户创建并归用户所有。
FULLY_MANAGED	语料库由代理创建。

GenerateChatTokenRequest

WidgetService.GenerateChatToken 的请求消息。

字段
name	string 必需。要为其生成聊天令牌的会话名称。格式：projects/{project}/locations/{location}/apps/{app}/sessions/{session}
deployment	string 必需。会话要使用的应用部署。格式：projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
recaptcha_token	string 可选。由客户端聊天 widget 生成的 reCAPTCHA 令牌。

GenerateChatTokenResponse

WidgetService.GenerateChatToken 的响应消息。

字段
chat_token	string 聊天微件的会话范围令牌，用于通过会话 API 进行身份验证。
expire_time	Timestamp 聊天令牌的过期时间。

GetAgentRequest

AgentService.GetAgent 的请求消息。

字段
name	string 必需。要检索的代理的资源名称。

GetAppRequest

AgentService.GetApp 的请求消息。

字段
name	string 必需。要检索的应用的资源名称。

GetAppVersionRequest

AgentService.GetAppVersion 的请求消息。

字段
name	string 必需。要检索的应用版本的资源名称。

GetChangelogRequest

AgentService.GetChangelog 的请求消息。

字段
name	string 必需。要检索的更改日志的资源名称。

GetConversationRequest

AgentService.GetConversation 的请求消息。

字段
name	string 必需。要检索的对话的资源名称。
source (deprecated)	Conversation.Source 此项已弃用！ 可选。指明对话的来源。如果未设置，则搜索所有来源。

GetDeploymentRequest

AgentService.GetDeployment 的请求消息。

字段
name	string 必需。部署的名称。 格式：projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}

GetExampleRequest

AgentService.GetExample 的请求消息。

字段
name	string 必需。要检索的示例的资源名称。

GetGuardrailRequest

AgentService.GetGuardrail 的请求消息。

字段
name	string 必需。要检索的安全措施的资源名称。

GetToolRequest

AgentService.GetTool 的请求消息。

字段
name	string 必需。要检索的工具的资源名称。

GetToolsetRequest

AgentService.GetToolset 的请求消息。

字段
name	string 必需。要检索的工具集的资源名称。

GoAway

此类型没有字段。

表示服务器即将断开连接，客户端应半关闭并重新启动连接。

GoogleSearchSuggestions

来自 Google Search Tool 的搜索建议。

字段
htmls[]	string 搜索建议的合规 HTML 和 CSS 样式。提供的 HTML 和 CSS 会自动适应您的设备设置，根据 @media(prefers-color-scheme) 所指示的偏好设置以浅色或深色模式显示。
web_search_queries[]	WebSearchQuery 用于执行 Google 搜索的查询的列表，以及构成搜索建议的搜索结果 URI。

GoogleSearchTool

表示用于执行 Google 网页搜索以进行溯源的工具。请参阅 https://cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool#google-search。

字段
name	string 必需。工具的名称。
description	string 可选。工具用途的说明。
context_urls[]	string 可选。系统会直接从这些网址提取内容，以用于上下文和接地。示例：“https://example.com/path.html”。最多允许添加 20 个网址。
preferred_domains[]	string 可选。指定要将搜索结果限制在哪些网域中。示例：“example.com”“another.site”。最多可以指定 20 个网域。
exclude_domains[]	string 可选。要从搜索结果中排除的网域列表。示例：“example.com”。最多可排除 2,000 个网域。
prompt_config	GoogleSearchTool.PromptConfig 可选。传递给规划器的提示指令，用于说明应如何处理文本和语音搜索结果。

PromptConfig

模型在处理或总结 Google 搜索结果时使用的提示设置。

字段
text_prompt	string 可选。定义在聊天对话中与代理互动时用于系统指令的提示。如果未设置，系统将使用默认提示。
voice_prompt	string 可选。定义在语音对话中与代理互动时用于系统指令的提示。如果未设置，系统将使用默认提示。

保护措施

安全护栏包含一系列检查和平衡措施，旨在确保代理安全无虞。

字段
name	string 标识符。安全屏障的唯一标识符。格式：projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}
display_name	string 必需。安全屏障的显示名称。
description	string 可选。安全屏障的说明。
enabled	bool 可选。安全防护措施是否已启用。
action	TriggerAction 可选。触发安全护栏时要采取的操作。
create_time	Timestamp 仅限输出。安全措施的创建时间戳。
update_time	Timestamp 仅限输出。安全措施上次更新的时间戳。
etag	string 用于确保对象在读取-修改-写入操作期间未发生更改的 ETag。如果 etag 为空，则更新会覆盖任何并发更改。
联合字段 guardrail_type。安全护栏类型。guardrail_type 只能是下列其中一项：
content_filter	Guardrail.ContentFilter 可选。禁止在对话中使用某些内容的护栏。
llm_prompt_security	Guardrail.LlmPromptSecurity 可选。如果根据 LLM 分类，提示被认为不安全，则会阻止对话的保护措施。
llm_policy	Guardrail.LlmPolicy 可选。如果 LLM 回答根据 LLM 分类被视为违反政策，则阻止对话的安全屏障。
model_safety	Guardrail.ModelSafety 可选。如果 LLM 回答根据模型安全设置被视为不安全，则阻止对话的安全屏障。
code_callback	Guardrail.CodeCallback 可选。根据回调执行结果可能会屏蔽对话的护栏。

CodeCallback

根据提供的代码回调阻止对话的安全屏障。

字段
before_agent_callback	Callback 可选。在调用代理之前要执行的回调。每个回调函数都应返回一个包含至少以下内容的结构（例如，字典或对象）：-“decision”：可以是“OK”或“TRIGGER”。-“reason”：说明决定的字符串。“触发”决定可能会停止进一步处理。
after_agent_callback	Callback 可选。在调用代理后要执行的回调。每个回调函数都应返回一个包含至少以下内容的结构（例如，字典或对象）：-“decision”：可以是“OK”或“TRIGGER”。-“reason”：说明决定的字符串。“触发”决定可能会停止进一步处理。
before_model_callback	Callback 可选。在调用模型之前要执行的回调。如果多次调用模型，则回调将执行多次。每个回调函数都应返回一个包含至少以下内容的结构（例如，字典或对象）：-“decision”：可以是“OK”或“TRIGGER”。-“reason”：说明决定的字符串。“触发”决定可能会停止进一步处理。
after_model_callback	Callback 可选。在调用模型后执行的回调。如果多次调用模型，则回调将执行多次。每个回调函数都应返回一个包含至少以下内容的结构（例如，字典或对象）：-“decision”：可以是“OK”或“TRIGGER”。-“reason”：说明决定的字符串。“触发”决定可能会停止进一步处理。

ContentFilter

禁止在对话中使用某些内容的护栏。

字段
banned_contents[]	string 可选。禁用短语列表。适用于用户输入和代理回答。
banned_contents_in_user_input[]	string 可选。禁用短语列表。仅适用于用户输入。
banned_contents_in_agent_response[]	string 可选。禁用短语列表。仅适用于代理回答。
match_type	Guardrail.ContentFilter.MatchType 必需。内容过滤器的匹配类型。
disregard_diacritics	bool 可选。如果为 true，则在匹配期间忽略变音符号。

MatchType

内容过滤器的匹配类型。

枚举
MATCH_TYPE_UNSPECIFIED	未指定匹配类型。
SIMPLE_STRING_MATCH	系统会逐个字符地匹配子字符串的内容。
WORD_BOUNDARY_STRING_MATCH	只有当文本中找到的模式被字词定界符包围时，内容才会匹配。禁用短语也可以包含字词定界符。
REGEXP_MATCH	内容是使用正则表达式语法进行匹配的。

LlmPolicy

如果 LLM 回答根据 LLM 分类被视为违反政策，则阻止对话的安全屏障。

字段
max_conversation_messages	int32 可选。检查此政策时，请考虑对话中的最后“n”条消息。如果未设置，则使用默认值 10。
model_settings	ModelSettings 可选。模型设置。
prompt	string 必需。政策提示。
policy_scope	Guardrail.LlmPolicy.PolicyScope 必需。定义在对话期间何时应用政策检查。如果设为 POLICY_SCOPE_UNSPECIFIED，此政策将应用于用户输入。将政策应用于代理响应时，代理在响应之前会产生额外的延迟。
fail_open	bool 可选。如果在政策检查期间发生错误，则会失败打开，并且不会触发安全防护栏。
allow_short_utterance	bool 可选。默认情况下，系统会针对简短话语绕过 LLM 政策检查。启用此设置后，系统会对所有话语（包括通常会跳过的话语）执行政策检查。

PolicyScope

定义在对话期间何时应用政策检查。

枚举
POLICY_SCOPE_UNSPECIFIED	未指定政策范围。
USER_QUERY	在用户输入时触发政策检查。
AGENT_RESPONSE	政策检查会在代理响应时触发。应用此政策范围会在代理能够响应之前引入额外的延迟。
USER_QUERY_AND_AGENT_RESPONSE	系统会在用户输入和代理回答时触发政策检查。应用此政策范围会在代理能够响应之前引入额外的延迟。

LlmPromptSecurity

如果根据 LLM 分类，输入被认为不安全，则阻止对话的防护栏。

字段
fail_open	bool 可选。确定安全屏障遇到 LLM 错误时的行为。- 如果为 true：则绕过安全护栏。- 如果为 false（默认值）：安全措施会触发/屏蔽。 注意：如果提供了自定义政策，系统会忽略此字段，而采用相应政策的“fail_open”配置。
联合字段 security_config。定义安全配置模式。用户必须选择以下配置之一。security_config 只能是下列其中一项：
default_settings	Guardrail.LlmPromptSecurity.DefaultSecuritySettings 可选。使用系统预定义的默认安全设置。如需选择此模式，请在请求中添加空的“default_settings”消息。其中的“default_prompt_template”字段将由服务器在响应中填充。
custom_policy	Guardrail.LlmPolicy 可选。使用用户定义的 LlmPolicy 配置安全防护措施。

DefaultSecuritySettings

默认系统安全设置的配置。

字段
default_prompt_template	string 仅限输出。系统使用的默认提示模板。此字段用于显示目的，以向用户展示系统默认使用的提示。此字段为 OUTPUT_ONLY。

ModelSafety

模型安全设置替换项。如果设置了此参数，它会替换默认设置，并在回答被认为不安全时触发安全屏障。

字段
safety_settings[]	Guardrail.ModelSafety.SafetySetting 必需。安全设置列表。

HarmBlockThreshold

用于屏蔽的基于概率的阈值级别。

枚举
HARM_BLOCK_THRESHOLD_UNSPECIFIED	未指定的有害屏蔽阈值。
BLOCK_LOW_AND_ABOVE	屏蔽低阈值及以上的内容（即屏蔽较多的内容）。
BLOCK_MEDIUM_AND_ABOVE	屏蔽中等阈值及以上。
BLOCK_ONLY_HIGH	仅屏蔽高阈值内容（即屏蔽较少的内容）。
BLOCK_NONE	全部不屏蔽。
OFF	关闭安全过滤条件。

HarmCategory

危害类别。

枚举
HARM_CATEGORY_UNSPECIFIED	未指定有害类别。
HARM_CATEGORY_HATE_SPEECH	有害类别为仇恨言论。
HARM_CATEGORY_DANGEROUS_CONTENT	有害类别为危险内容。
HARM_CATEGORY_HARASSMENT	有害类别为骚扰。
HARM_CATEGORY_SEXUALLY_EXPLICIT	有害类别为露骨色情内容。

SafetySetting

安全设置。

字段
category	Guardrail.ModelSafety.HarmCategory 必需。有害类别。
threshold	Guardrail.ModelSafety.HarmBlockThreshold 必需。有害内容屏蔽阈值。

图片

表示对话中的图片输入或输出。

字段
mime_type	string 必需。来源数据的 IANA 标准 MIME 类型。支持的图片类型包括： * image/png * image/jpeg * image/webp
data	bytes 必需。图片的原始字节。

ImportAppRequest

AgentService.ImportApp 的请求消息。

字段
parent	string 必需。要导入的应用的父级资源名称，其中包含应用的位置信息。
display_name	string 可选。要导入的应用的显示名称。* 如果应用是在导入时创建的，并且指定了显示名称，则导入的应用将使用此显示名称。如果检测到与现有应用存在冲突，系统会在显示名称中附加时间戳，使其成为唯一名称。* 如果应用是重新导入的，则不应设置此字段。在重新导入期间提供显示名称会导致 INVALID_ARGUMENT 错误。
app_id	string 可选。要用于导入的应用的 ID。* 如果未指定，系统会自动为应用分配一个唯一 ID。* 否则，导入的应用将使用此 ID 作为其资源名称的最后一个组成部分。如果项目中的指定位置已存在具有相同 ID 的应用，则现有应用的内容将被替换。
import_options	ImportAppRequest.ImportOptions 可选。用于控制应用导入流程的选项。
ignore_app_lock	bool 可选。用于在导入期间替换应用锁定的标志。如果设置为 true，导入进程将忽略应用锁定。
联合字段 app。要导入的应用。app 只能是下列其中一项：
gcs_uri	string 要从中导入应用的 Google Cloud Storage URI。此 URI 的格式必须为 gs://<bucket-name>/<object-name>。
app_content	bytes 表示包含应用文件夹结构的压缩 ZIP 文件的原始字节。

ImportOptions

应用导入流程的配置选项。这些选项用于控制导入行为，尤其是在与现有应用数据发生冲突时。

字段
conflict_resolution_strategy	ImportAppRequest.ImportOptions.ConflictResolutionStrategy 可选。在导入期间解决冲突时要使用的策略。

ConflictResolutionStrategy

定义了在以下情况下处理冲突的策略：已存在具有相同 ID 的应用，或者导入的资源（例如代理、工具等）与相应应用中的现有资源具有相同的显示名称。

枚举
CONFLICT_RESOLUTION_STRATEGY_UNSPECIFIED	未指定冲突解决策略。
REPLACE	使用导入的数据替换现有数据。如果已存在具有相同 app_id 的应用，则其内容将根据导入的应用进行更新。- 导入的应用中与现有资源具有相同显示名称的资源（应用、代理、工具、示例、安全措施、工具集）将覆盖现有资源。- 系统将创建具有新显示名称的导入资源。- 如果现有资源在导入的应用中没有匹配的显示名称，则不会受到影响。
OVERWRITE	使用导入的数据覆盖现有数据。如果已存在具有相同 app_id 的应用，则其内容将被导入的应用覆盖。- 应用中现有的资源（代理、工具、示例、安全屏障、工具集）将被删除。- 导入的资源将作为新资源创建。

ImportAppResponse

AgentService.ImportApp 的响应消息。

字段
name	string 已导入应用的资源名称。
warnings[]	string 在导入过程中生成的警告消息。如果特定资源出现错误，则不会将其纳入导入的应用中，并且此处会提及相应错误。

InputAudioConfig

InputAudioConfig 用于配置 CES 代理应如何解读传入的音频数据。

字段
audio_encoding	AudioEncoding 必需。输入音频数据的编码。
sample_rate_hertz	int32 必需。输入音频数据的采样率（以赫兹为单位）。
noise_suppression_level	string 可选。是否对输入音频启用噪声抑制。可选的值包括“low”“moderate”“high”“very_high”。

InterruptionSignal

表示代理的音频回答已被中断。客户端应立即停止任何当前的音频播放（例如，由于用户插话或正在生成新的代理响应）。

字段
barge_in	bool 中断是否由用户抢占事件引起。

LanguageSettings

应用的语言设置。

字段
default_language_code	string 可选。应用的默认语言代码。
supported_language_codes[]	string 可选。应用支持的语言代码列表（除 default_language_code 之外）。
enable_multilingual_support	bool 可选。启用多语言支持。如果为 true，应用中的代理将使用预构建的指令来改进对多语言输入的处理。
fallback_action	string 可选。当代理收到不受支持的语言的输入时要执行的操作。 可以是预定义的操作，也可以是自定义的工具调用。有效值包括：- 工具的完整资源名称，用于触发特定工具执行。- 预定义的系统操作，例如“升级”或“退出”，此类操作会触发具有相应 metadata 的 EndSession 信号来终止对话。

ListAgentsRequest

AgentService.ListAgents 的请求消息。

字段
parent	string 必需。要列出代理的应用的资源名称。
page_size	int32 可选。请求的页面大小。 服务器返回的项可能要比请求的少。如果未指定，服务器将选择合适的默认值。
page_token	string 可选。从上一次列表 AgentService.ListAgents 调用返回的 next_page_token 值。
filter	string 可选。列出代理时要应用的过滤条件。如需了解详情，请参阅 https://google.aip.dev/160。
order_by	string 可选。要排序的字段。仅支持“name”和“create_time”。如需了解详情，请参阅 https://google.aip.dev/132#ordering。

ListAgentsResponse

AgentService.ListAgents 的响应消息。

字段
agents[]	Agent 代理列表。
next_page_token	string 可作为 ListAgentsRequest.page_token 发送并用于检索下一页的令牌。如果缺少此字段，则表示没有后续页面。

ListAppVersionsRequest

AgentService.ListAppVersions 的请求消息。

字段
parent	string 必需。要列出应用版本的应用的资源名称。
page_size	int32 可选。请求的页面大小。 服务器返回的项可能要比请求的少。如果未指定，服务器将选择合适的默认值。
page_token	string 可选。从上一次列表 AgentService.ListAppVersions 调用返回的 next_page_token 值。
filter	string 可选。列出应用版本时要应用的过滤条件。如需了解详情，请参阅 https://google.aip.dev/160。
order_by	string 可选。要排序的字段。仅支持“name”和“create_time”。如需了解详情，请参阅 https://google.aip.dev/132#ordering。

ListAppVersionsResponse

AgentService.ListAppVersions 的响应消息。

字段
app_versions[]	AppVersion 应用版本列表。
next_page_token	string 可作为 ListAppVersionsRequest.page_token 发送并用于检索下一页的令牌。如果缺少此字段，则表示没有后续页面。

ListAppsRequest

AgentService.ListApps 的请求消息。

字段
parent	string 必需。要列出应用的营业地点的资源名称。
page_size	int32 可选。请求的页面大小。 服务器返回的项可能要比请求的少。如果未指定，服务器将选择合适的默认值。
page_token	string 可选。从上一次列表 AgentService.ListApps 调用返回的 next_page_token 值。
filter	string 可选。列出应用时要应用的过滤条件。如需了解详情，请参阅 https://google.aip.dev/160。
order_by	string 可选。要排序的字段。仅支持“name”和“create_time”。如需了解详情，请参阅 https://google.aip.dev/132#ordering。

ListAppsResponse

AgentService.ListApps 的响应消息。

字段
apps[]	App 应用列表。
next_page_token	string 可作为 ListAppsRequest.page_token 发送并用于检索下一页的令牌。如果缺少此字段，则表示没有后续页面。
unreachable[]	string 无序列表。无法到达的位置。

ListChangelogsRequest

AgentService.ListChangelogs 的请求消息。

字段
parent	string 必需。要列出相应应用的更改日志的应用的资源名称。
page_size	int32 可选。请求的页面大小。 服务器返回的项可能要比请求的少。如果未指定，服务器将选择合适的默认值。
page_token	string 可选。从上一次列表 AgentService.ListChangelogs 调用返回的 next_page_token 值。
filter	string 可选。列出更改日志时要应用的过滤条件。如需了解详情，请参阅 https://google.aip.dev/160。 过滤字符串可用于按 action、resource_type、resource_name、author 和 create_time 进行过滤。: 比较器可用于对字符串字段进行不区分大小写的部分匹配，而 = 则执行区分大小写的完全匹配。 示例：* action:update（不区分大小写的部分匹配）* action="Create"（区分大小写的完全匹配）* resource_type:agent * resource_name:my-agent * author:[e-mail] * create_time > "2025-01-01T00:00:00Z" * create_time <= "2025-01-01T00:00:00Z" AND resource_type:tool
order_by	string 可选。要排序的字段。仅支持“name”和“create_time”。如需了解详情，请参阅 https://google.aip.dev/132#ordering。

ListChangelogsResponse

AgentService.ListChangelogs 的响应消息。

字段
changelogs[]	Changelog 更改日志列表。
next_page_token	string 可作为 ListChangelogsRequest.page_token 发送并用于检索下一页的令牌。如果缺少此字段，则表示没有后续页面。

ListConversationsRequest

AgentService.ListConversations 的请求消息。

字段
parent	string 必需。要列出对话的应用的资源名称。
page_size	int32 可选。请求的页面大小。 服务器返回的项可能要比请求的少。如果未指定，服务器将选择合适的默认值。
page_token	string 可选。从上一次列表 AgentService.ListConversations 调用返回的 next_page_token 值。
filter	string 可选。列出对话时要应用的过滤条件。如需了解详情，请参阅 https://google.aip.dev/160。
source	Conversation.Source 可选。指明对话的来源。如果未设置，系统将默认应用 Source.Live。将被弃用，取而代之的是 sources 字段。
sources[]	Conversation.Source 可选。指明对话的来源。如果未设置，则默认应用所有可用来源。

ListConversationsResponse

AgentService.ListConversations 的响应消息。

字段
conversations[]	Conversation 对话列表。
next_page_token	string 可作为 ListConversationsRequest.page_token 发送并用于检索下一页的令牌。如果缺少此字段，则表示没有后续页面。

ListDeploymentsRequest

AgentService.ListDeployments 的请求消息。

字段
parent	string 必需。父应用。格式：projects/{project}/locations/{location}/apps/{app}
page_size	int32 可选。要返回的部署数量上限。服务返回的值可能小于此值。如果未指定，则最多返回 50 个部署。最大值为 1,000；大于 1,000 的值将被强制转换为 1,000。
page_token	string 可选。从之前的 ListDeployments 调用接收的页面令牌。利用其进行后续页面检索。 进行分页时，提供给 ListDeployments 的所有其他参数必须与提供页面令牌的调用匹配。
order_by	string 可选。要排序的字段。仅支持“name”和“create_time”。如需了解详情，请参阅 https://google.aip.dev/132#ordering。

ListDeploymentsResponse

AgentService.ListDeployments 的响应消息。

字段
deployments[]	Deployment 部署列表。
next_page_token	string 可作为 page_token 发送并用于检索下一页的令牌。如果省略此字段，则不存在后续页面。

ListExamplesRequest

AgentService.ListExamples 的请求消息。

字段
parent	string 必需。要列出示例的应用的资源名称。
page_size	int32 可选。请求的页面大小。 服务器返回的项可能要比请求的少。如果未指定，服务器将选择合适的默认值。
page_token	string 可选。从上一次列表 AgentService.ListExamples 调用返回的 next_page_token 值。
filter	string 可选。列出示例时要应用的过滤条件。如需了解详情，请参阅 https://google.aip.dev/160。
order_by	string 可选。要排序的字段。仅支持“name”和“create_time”。如需了解详情，请参阅 https://google.aip.dev/132#ordering。

ListExamplesResponse

AgentService.ListExamples 的响应消息。

字段
examples[]	Example 示例列表。
next_page_token	string 可作为 ListExamplesRequest.page_token 发送并用于检索下一页的令牌。如果缺少此字段，则表示没有后续页面。

ListGuardrailsRequest

AgentService.ListGuardrails 的请求消息。

字段
parent	string 必需。要列出安全屏障的应用的资源名称。
page_size	int32 可选。请求的页面大小。 服务器返回的项可能要比请求的少。如果未指定，服务器将选择合适的默认值。
page_token	string 可选。从上一次列表 AgentService.ListGuardrails 调用返回的 next_page_token 值。
filter	string 可选。列出保护措施时要应用的过滤条件。如需了解详情，请参阅 https://google.aip.dev/160。
order_by	string 可选。要排序的字段。仅支持“name”和“create_time”。如需了解详情，请参阅 https://google.aip.dev/132#ordering。

ListGuardrailsResponse

AgentService.ListGuardrails 的响应消息。

字段
guardrails[]	Guardrail 防护措施列表。
next_page_token	string 可作为 ListGuardrailsRequest.page_token 发送并用于检索下一页的令牌。如果缺少此字段，则表示没有后续页面。

ListToolsRequest

AgentService.ListTools 的请求消息。

字段
parent	string 必需。要列出工具的应用的资源名称。
page_size	int32 可选。请求的页面大小。 服务器返回的项可能要比请求的少。如果未指定，服务器将选择合适的默认值。
page_token	string 可选。从上一次列表 AgentService.ListTools 调用返回的 next_page_token 值。
filter	string 可选。列出工具时要应用的过滤条件。使用“include_system_tools=true”可在回答中包含系统工具。如需了解详情，请参阅 https://google.aip.dev/160。
order_by	string 可选。要排序的字段。仅支持“name”和“create_time”。如需了解详情，请参阅 https://google.aip.dev/132#ordering。

ListToolsResponse

AgentService.ListTools 的响应消息。

字段
tools[]	Tool 工具列表。
next_page_token	string 可作为 ListToolsRequest.page_token 发送并用于检索下一页的令牌。如果缺少此字段，则表示没有后续页面。

ListToolsetsRequest

AgentService.ListToolsets 的请求消息。

字段
parent	string 必需。要列出工具集的应用的资源名称。
page_size	int32 可选。请求的页面大小。 服务器返回的项可能要比请求的少。如果未指定，服务器将选择合适的默认值。
page_token	string 可选。从上一次列表 AgentService.ListToolsets 调用返回的 next_page_token 值。
filter	string 可选。列出工具集时要应用的过滤条件。如需了解详情，请参阅 https://google.aip.dev/160。
order_by	string 可选。要排序的字段。仅支持“name”和“create_time”。如需了解详情，请参阅 https://google.aip.dev/132#ordering。

ListToolsetsResponse

AgentService.ListToolsets 的响应消息。

字段
toolsets[]	Toolset 工具集列表。
next_page_token	string 可作为 ListToolsetsRequest.page_token 发送并用于检索下一页的令牌。如果缺少此字段，则表示没有后续页面。

LoggingSettings

用于描述应用日志记录行为的设置。

字段
redaction_config	RedactionConfig 可选。有关如何对敏感数据进行遮盖的配置。
audio_recording_config	AudioRecordingConfig 可选。用于配置应如何记录音频互动。
bigquery_export_settings	BigQueryExportSettings 可选。用于描述应用的 BigQuery 导出行为的设置。如果已启用，对话数据将导出到 BigQuery 表。
cloud_logging_settings	CloudLoggingSettings 可选。用于描述应用的 Cloud Logging 行为的设置。
conversation_logging_settings	ConversationLoggingSettings 可选。用于描述应用的对话记录行为的设置。
evaluation_audio_recording_config	AudioRecordingConfig 可选。用于评估的音频互动应如何记录的配置。默认情况下，评估会话不会启用音频录制功能。
metric_analysis_settings	MetricAnalysisSettings 可选。用于描述应用的 LLM 分析流水线的对话数据收集行为的设置。

McpTool

一种 MCP 工具。如需了解详情，请参阅 https://modelcontextprotocol.io/specification/2025-06-18/server/tools。

字段
name	string 必需。MCP 工具的名称。
description	string 可选。MCP 工具的说明。
input_schema	Schema 可选。MCP 工具的输入实参的架构。
output_schema	Schema 可选。MCP 工具的输出实参的架构。
server_address	string 必需。MCP 服务器的服务器地址，例如 “https://example.com/mcp/”。如果服务器是使用 MCP SDK 构建的，则网址应以“/mcp/”为后缀。仅支持基于可流式传输的 HTTP 传输的服务器。这与 McpToolset 中的 server_address 相同。如需了解详情，请参阅 https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http。
api_authentication	ApiAuthentication 可选。针对 MCP 服务器执行该工具所需的身份验证信息。对于不记名令牌身份验证，令牌仅适用于工具执行，而不适用于列出工具。这要求无需身份验证即可列出工具。
tls_config	TlsConfig 可选。TLS 配置。包含客户端应信任的自定义服务器证书。
service_directory_config	ServiceDirectoryConfig 可选。VPC-SC 的 Service Directory 配置，用于解析边界内的服务名称。

McpToolset

一种工具集，其中包含 MCP 服务器提供的一系列工具。

字段
server_address	string 必需。MCP 服务器的地址，例如“https://example.com/mcp/”。如果服务器是使用 MCP SDK 构建的，则网址应以“/mcp/”为后缀。仅支持基于可流式传输的 HTTP 传输的服务器。如需了解详情，请参阅 https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http。
api_authentication	ApiAuthentication 可选。访问工具并针对 MCP 服务器执行工具所需的身份验证信息。对于不记名令牌身份验证，令牌仅适用于工具执行，而不适用于列出工具。这要求无需身份验证即可列出工具。
service_directory_config	ServiceDirectoryConfig 可选。VPC-SC 的 Service Directory 配置，用于解析边界内的服务名称。
tls_config	TlsConfig 可选。TLS 配置。包含客户端应信任的自定义服务器证书。

消息

对话中的消息。

字段
role	string 可选。对话中的角色，例如用户、代理。
chunks[]	Chunk 可选。消息的内容，以一系列块的形式呈现。
event_time	Timestamp 可选。消息的发送或接收时间。如果消息是 example 的一部分，则不应使用此属性。

MetricAnalysisSettings

用于描述 LLM 分析指标流水线的对话数据收集行为的设置。

字段
llm_metrics_opted_out	bool 可选。是否收集对话数据以用于 LLM 分析指标。如果为 true，则不会收集对话数据以用于 LLM 分析指标；否则，将收集对话数据。

ModelSettings

模型设置包含 LLM 模型的各种配置。

字段
model	string 可选。智能体应使用的 LLM 模型。如果未设置，代理将沿用其父代理的模型。
temperature	double 可选。如果设置，系统将使用此温度值来运行 LLM 模型。温度可控制模型回答的随机性。温度越低，生成的回答就越可预测。温度越高，生成的回答就越有创意。

OAuthConfig

使用 OAuth 进行身份验证的配置。

字段
oauth_grant_type	OAuthConfig.OauthGrantType 必需。OAuth 授权类型。
client_id	string 必需。OAuth 提供方的客户端 ID。
client_secret_version	string 必需。存储客户端密钥的 SecretManager 密钥版本资源的名称。格式：projects/{project}/secrets/{secret}/versions/{version} 注意：您应向 CES 服务代理 service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com 授予 roles/secretmanager.secretAccessor 角色。
token_endpoint	string 必需。OAuth 提供方中用于换取访问令牌的令牌端点。
scopes[]	string 可选。要授予的 OAuth 范围。

OauthGrantType

OAuth 授权类型。仅支持客户端凭据授权。

枚举
OAUTH_GRANT_TYPE_UNSPECIFIED	未指定。默认值为 CLIENT_CREDENTIAL。
CLIENT_CREDENTIAL	表示客户端凭据流。

全渠道

表示全渠道资源。

字段
name	string 标识符。全渠道资源的唯一标识符。格式：projects/{project}/locations/{location}/omnichannels/{omnichannel}
display_name	string 必需。全渠道资源的显示名称。
description	string 可选。全渠道资源的人类可读说明。
create_time	Timestamp 仅限输出。全渠道资源的创建时间戳。
update_time	Timestamp 仅限输出。全渠道资源上次更新时的时间戳。
etag	string 仅限输出。用于确保对象在读取-修改-写入操作期间未发生更改的 ETag。
integration_config	OmnichannelIntegrationConfig 可选。全渠道资源的集成配置。

OmnichannelIntegrationConfig

OmnichannelIntegrationConfig 包含所有应用集成配置。

字段
channel_configs	map<string, OmnichannelIntegrationConfig.ChannelConfig> 可选。用于处理应用事件的各种配置。
subscriber_configs	map<string, OmnichannelIntegrationConfig.SubscriberConfig> 可选。各种订阅者配置。
routing_configs	map<string, OmnichannelIntegrationConfig.RoutingConfig> 可选。routing_configs 的键是 app_configs 的键，值是 RoutingConfig，其中包含订阅者的键。

CesAppConfig

CES 应用的配置。

字段
app	string CES 应用的唯一标识符。格式：projects/{project}/locations/{location}/apps/{app}

ChannelConfig

ChannelConfig 包含各种应用集成的配置。

字段
联合字段 channel_config。应用的配置。channel_config 只能是下列其中一项：
whatsapp_config	OmnichannelIntegrationConfig.WhatsappConfig WhatsApp 配置。

RoutingConfig

路由配置用于指定如何/将应用事件路由到订阅者。

字段
subscriber_key	string 订阅者的密钥。

SubscriberConfig

订阅者的配置。

字段
联合字段 subscriber_config。订阅者的配置。subscriber_config 只能是下列其中一项：
ces_app_config	OmnichannelIntegrationConfig.CesAppConfig Ces 应用配置。

WhatsappConfig

全渠道应如何接收/回复来自 WhatsApp 的事件。

字段
phone_number_id	string 与 WhatsApp Business 账号关联的电话号码 ID。
phone_number	string 用于发送/接收消息的手机号码。
whatsapp_business_account_id	string 客户的 WhatsApp Business 账号 (WABA) ID。
webhook_verify_token	string 在 Meta 应用信息中心内为 webhook 验证配置的验证令牌。
whatsapp_business_token	string 用于对 WhatsApp Cloud API 的 API 调用进行身份验证的访问令牌。https://developers.facebook.com/docs/whatsapp/business-management-api/get-started/#business-integration-system-user-access-tokens
meta_business_portfolio_id	string Meta 商家投资组合 (MBP) ID。https://www.facebook.com/business/help/1710077379203657

OmnichannelOperationMetadata

表示长时间运行的操作的元数据。

字段
create_time	Timestamp 仅供输出。操作的创建时间。
end_time	Timestamp 仅供输出。操作完成运行的时间。
status_message	string 仅限输出。人类可读的操作状态（如果有）。
requested_cancellation	bool 仅限输出。标识用户是否已请求取消操作。

OpenApiTool

由 OpenAPI 架构定义的远程 API 工具。

字段
open_api_schema	string 必需。JSON 或 YAML 格式的 OpenAPI 架构。
name	string 可选。工具的名称。如果未提供，工具的名称将从 OpenAPI 架构的 operation.operationId 中派生出来。
description	string 可选。工具的说明。如果未提供，工具的说明将从 OpenAPI 架构（operation.description 或 operation.summary）中派生。
api_authentication	ApiAuthentication 可选。API 所需的身份验证信息。
tls_config	TlsConfig 可选。TLS 配置。包含客户端将信任的自定义服务器证书。
service_directory_config	ServiceDirectoryConfig 可选。Service Directory 配置。
ignore_unknown_fields	bool 可选。如果为 true，代理将忽略 API 响应中的未知字段。
url	string 可选。Open API 架构的服务器网址。仅当架构包含服务器网址时，此字段才会在导出过程中设置到环境依赖项中的工具中。在导入过程中，如果此网址存在于环境依赖项中，并且架构具有 $env_var 占位符，则该网址将替换架构中的占位符。

OpenApiToolset

包含由 OpenAPI 架构定义的一系列工具的工具集。

字段
open_api_schema	string 必需。工具集的 OpenAPI 架构。
api_authentication	ApiAuthentication 可选。API 所需的身份验证信息。
tls_config	TlsConfig 可选。TLS 配置。包含自定义服务器证书
service_directory_config	ServiceDirectoryConfig 可选。Service Directory 配置。
ignore_unknown_fields	bool 可选。如果为 true，则对于 OpenAPI 架构中定义的所有操作，代理将忽略 API 响应中的未知字段。
url	string 可选。Open API 架构的服务器网址。如果架构包含服务器网址，则仅在导出过程中，在环境依赖项的工具集中设置此字段。在导入过程中，如果此网址存在于环境依赖项中，并且架构具有 $env_var 占位符，则该网址将替换架构中的占位符。

OperationMetadata

表示长时间运行的操作的元数据。

字段
create_time	Timestamp 仅供输出。操作的创建时间。
end_time	Timestamp 仅供输出。操作完成运行的时间。
status_message	string 仅限输出。人类可读的操作状态（如果有）。
requested_cancellation	bool 仅限输出。标识用户是否已请求取消操作。已成功取消的操作具有 google.longrunning.Operation.error 值，且 google.rpc.Status.code 为 1（对应于 Code.CANCELLED）。

OutputAudioConfig

OutputAudioConfig 用于配置 CES 代理应如何合成传出的音频响应。

字段
audio_encoding	AudioEncoding 必需。输出音频数据的编码。
sample_rate_hertz	int32 必需。输出音频数据的采样率（以赫兹为单位）。

PythonCodeCondition

用于评估条件的 Python 代码块。

字段
python_code	string 必需。要执行的 Python 代码。

PythonFunction

Python 函数工具。

字段
name	string 可选。要执行的 Python 函数的名称。必须与 Python 代码中定义的 Python 函数名称一致。区分大小写。如果未提供名称，系统将使用 Python 代码中定义的第一个函数。
python_code	string 可选。要为工具执行的 Python 代码。
description	string 仅限输出。从 Python 代码的文档字符串中解析出的 Python 函数说明。

RecognitionResult

音频输入的语音识别结果。

字段
transcript	string 可选。在当前回合中捕获的串联用户语音片段。

RedactionConfig

用于指示应如何处理敏感数据的配置。

字段
enable_redaction	bool 可选。如果为 true，则在各种日志记录场景（包括对话记录、Cloud Logging 和录音）中应用隐去。
inspect_template	string 可选。用于配置敏感数据类型检测的 DLP 检查模板名称。 格式：projects/{project}/locations/{location}/inspectTemplates/{inspect_template}
deidentify_template	string 可选。DLP 去标识化模板名称，用于指示如何对内容进行去标识化处理。 格式：projects/{project}/locations/{location}/deidentifyTemplates/{deidentify_template}

RestoreAppVersionRequest

AgentService.RestoreAppVersion 的请求消息

字段
name	string 必需。要恢复的应用版本的资源名称。

RestoreAppVersionResponse

此类型没有字段。

AgentService.RestoreAppVersion 的响应消息

RetrieveToolSchemaRequest

ToolService.RetrieveToolSchema 的请求消息。

字段
parent	string 必需。工具/工具集所属应用的资源名称。格式：projects/{project}/locations/{location}/apps/{app}
联合字段 tool_identifier。要检索架构的工具的标识符。它可以是持久化工具，也可以是工具集中的工具。tool_identifier 只能是下列其中一项：
tool	string 可选。要检索其架构的工具的名称。格式：projects/{project}/locations/{location}/apps/{app}/tools/{tool}
toolset_tool	ToolsetTool 可选。要检索的工具集工具的架构。工具集中只能有一个工具与谓词匹配。否则，系统将返回错误。

RetrieveToolSchemaResponse

ToolService.RetrieveToolSchema 的响应消息。

字段
input_schema	Schema 工具输入参数的架构。
output_schema	Schema 工具输出参数的架构。
联合字段 tool_identifier。相应架构所针对的工具的标识符。tool_identifier 只能是下列其中一项：
tool	string 相应架构所针对的工具的名称。格式：projects/{project}/locations/{location}/apps/{app}/tools/{tool}
toolset_tool	ToolsetTool 架构所针对的工具集工具。

RetrieveToolsRequest

ToolService.RetrieveTools 的请求消息。

字段
toolset	string 必需。要检索的工具集的名称。格式：projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}
tool_ids[]	string 可选。要从工具集中检索的工具的标识符。如果为空，则返回工具集中的所有工具。

RetrieveToolsResponse

ToolService.RetrieveTools 的响应消息。

字段
tools[]	Tool 指定工具集中包含的工具的列表。

RunSessionRequest

SessionService.RunSession 的请求消息。

字段
config	SessionConfig 必需。会话的配置。
inputs[]	SessionInput 必需。会话的输入。

RunSessionResponse

SessionService.RunSession 的响应消息。

字段
outputs[]	SessionOutput 会话的输出。

架构

表示 OpenAPI 3.0 架构对象的选定子集。

字段
type	Schema.Type 必需。数据类型。
properties	map<string, Schema> 可选。Type.OBJECT 的属性。
required[]	string 可选。Type.OBJECT 的必需属性。
description	string 可选。数据的说明。
items	Schema 可选。Type.ARRAY 的元素的架构。
nullable	bool 可选。指示值是否为 null。
unique_items	bool 可选。表示数组中的项必须是唯一的。仅适用于 TYPE.ARRAY。
prefix_items[]	Schema 可选。Type.ARRAY 的初始元素的架构。
additional_properties	Schema 可选。可以是布尔值或对象，用于控制是否存在其他属性。
any_of[]	Schema 可选。该值应根据列表中的任何（一个或多个）子架构进行验证。
enum[]	string 可选。原始类型的元素可能的具有枚举格式的值。示例：1. 我们可以将方向定义为：{type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. 我们可以将公寓号定义为：{type:INTEGER, format:enum, enum:["101", "201", "301"]}
default	Value 可选。数据的默认值。
ref	string 可选。允许在架构节点之间进行间接引用。该值应该是对根 defs 的子元素的有效引用。 例如，以下架构定义了对名为“Pet”的架构节点的引用： type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string “pet”属性的值是对名为“Pet”的架构节点的引用。如需了解详情，请参阅 https://json-schema.org/understanding-json-schema/structuring。
defs	map<string, Schema> 可选。供 ref 使用的定义映射。仅允许在架构的根级使用。
title	string 可选。架构的标题。
min_items	int64 可选。Type.ARRAY 的元素数量下限。
max_items	int64 可选。Type.ARRAY 的元素数量上限。
minimum	double 可选。Type.INTEGER 和 Type.NUMBER 的最小值。
maximum	double 可选。Type.INTEGER 和 Type.NUMBER 的最大值。

类型

OpenAPI 数据类型。

枚举
TYPE_UNSPECIFIED	未指定类型。
STRING	字符串类型。
INTEGER	整数类型。
NUMBER	数字类型。
BOOLEAN	布尔值类型。
OBJECT	对象类型。
ARRAY	数组类型。

ServiceAccountAuthConfig

使用自定义服务账号进行身份验证的配置。

字段
service_account	string 必需。用于身份验证的服务账号的电子邮件地址。CES 使用此服务账号来交换访问令牌，然后在请求的 Authorization 标头中发送该访问令牌。 服务账号必须拥有授予 CES 服务代理 service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com 的 roles/iam.serviceAccountTokenCreator 角色。
scopes[]	string 可选。要授予的 OAuth 范围。如果未指定，则使用默认范围 https://www.googleapis.com/auth/cloud-platform。

ServiceAgentIdTokenAuthConfig

此类型没有字段。

使用从服务代理生成的 ID 令牌进行身份验证的配置。

ServiceDirectoryConfig

使用 Service Directory 的工具的配置。

字段
service	string 必需。Service Directory 服务的名称。格式：projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}。服务目录的位置必须与应用的位置相同。

SessionConfig

会话的配置。

字段
session	string 必需。会话的唯一标识符。格式：projects/{project}/locations/{location}/apps/{app}/sessions/{session}
input_audio_config	InputAudioConfig 可选。用于处理输入音频的配置。
output_audio_config	OutputAudioConfig 可选。用于生成输出音频的配置。
historical_contexts[]	Message 可选。会话的历史背景信息，包括用户输入、智能体回答和其他消息。通常，CES 代理会自动管理会话，因此客户端无需明确填充此字段。不过，客户端可以选择替换历史上下文，强制会话从特定状态开始。
entry_agent	string 可选。处理会话的初始客服人员。如果未指定，会话将由应用的 root agent 处理。格式：projects/{project}/locations/{location}/apps/{app}/agents/{agent}
deployment	string 可选。会话要使用的应用部署。格式：projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
time_zone	string 可选。用户的时区。如果提供，代理将使用该时区来处理与日期和时间相关的变量。否则，代理将使用 App.time_zone_settings 中指定的时区。 格式为 IANA 时区数据库中的时区，例如“America/Los_Angeles”。
remote_dialogflow_query_parameters	SessionConfig.RemoteDialogflowQueryParameters 可选。当会话控制权转移到远程 Dialogflow 代理时，要发送给远程代理的 QueryParameters。

RemoteDialogflowQueryParameters

当会话控制权转移到远程 Dialogflow 代理时，要发送给远程代理的 QueryParameters。

字段
webhook_headers	map<string, string> 可选。要作为 QueryParameters 中的 webhook_headers 发送的 HTTP 标头。
payload	Struct 可选。要在 QueryParameters 中发送的载荷。
end_user_metadata	Struct 可选。要在 QueryParameters 中发送的最终用户元数据。

SessionInput

会话的输入。

字段
will_continue	bool 可选。一个标志，用于指示当前消息是否是双向流式会话中较大输入的片段。 如果设置为 true，代理会延迟处理，直到收到 will_continue 为 false 的后续消息，或者直到系统检测到音频输入中的端点。 注意：此字段不适用于音频和 DTMF 输入，因为它们始终会根据端点信号自动处理。
联合字段 input_type。输入的类型。input_type 只能是下列其中一项：
text	string 可选。最终用户的文本数据。
dtmf	string 可选。来自最终用户的 DTMF 数字。
audio	bytes 可选。最终用户的音频数据。
tool_responses	ToolResponses 可选。来自客户端的工具调用的执行结果。
image	Image 可选。最终用户的图片数据。
blob	Blob 可选。来自最终用户的 Blob 数据。
variables	Struct 可选。会话的上下文变量，按名称键控。CES 代理只会使用在应用中声明的变量。 无法识别的变量仍会作为额外的会话参数发送到 [Dialogflow 代理][Agent.RemoteDialogflowAgent]。
event	Event 可选。活动输入。

SessionOutput

会话的输出。

字段
turn_index	int32 表示相应输出所属对话轮次的顺序，从 1 开始。
turn_completed	bool 如果为 true，则表示 CES 代理已检测到当前对话轮次的结束，并且不会再为该轮次提供任何输出。
diagnostic_info	SessionOutput.DiagnosticInfo 可选。诊断信息包含输入处理期间的执行详细信息。仅在每个轮次的最后一个 SessionOutput（具有 turn_completed=true）中填充。
联合字段 output_type。输出的类型。output_type 只能是下列其中一项：
text	string 来自 CES 代理的输出文本。
audio	bytes CES 代理的输出音频。
tool_calls	ToolCalls 请求客户端执行工具。
citations	Citations 提供代理生成的文本的来源信息的引用。
google_search_suggestions	GoogleSearchSuggestions 通过调用 GoogleSearchTool 从 Google 搜索返回的建议。
end_session	EndSession 表示会话已结束。
payload	Struct 包含来自 CES 代理的结构化输出的自定义载荷。

DiagnosticInfo

包含处理期间的执行详情。

字段
messages[]	Message 处理期间发生的消息的列表。
root_span	Span 整个请求处理过程的轨迹，以根 span 表示。此 span 可以包含用于特定操作的嵌套子 span。

span

Span 是指请求处理期间的工作单元或单个操作。

字段
name	string 仅限输出。span 的名称。
start_time	Timestamp 仅限输出。时间段的开始时间。
end_time	Timestamp 仅限输出。时间段的结束时间。
duration	Duration 仅限输出。Span 的时长。
attributes	Struct 仅限输出。与 span 关联的键值对属性。
child_spans[]	Span 仅限输出。嵌套在此 span 下的子 span。

SynthesizeSpeechConfig

有关如何合成代理回答的配置。

字段
voice	string 可选。语音的名称。如果未设置，则该服务将根据其他参数（例如 language_code）选择语音。 如需查看可用的语音列表，请参阅 Cloud Text-to-Speech 的支持的语音和语言。
speaking_rate	double 可选。朗读速率/速度，范围为 [0.25, 2.0]。1.0 表示特定语音支持的正常原生速度。2.0 表示快一倍的速度，0.5 则表示原有速度的一半。如果值不在 [0.25, 2.0] 范围内，系统会返回错误。

SystemTool

预定义的系统工具。

字段
name	string 必需。系统工具的名称。
description	string 仅限输出。系统工具的说明。

TimeZoneSettings

应用的 TimeZone 设置。

字段
time_zone	string 可选。根据时区数据库确定的应用时区，例如 America/Los_Angeles、Europe/Paris。

TlsConfig

TLS 配置。

字段
ca_certs[]	TlsConfig.CaCert 必需。指定用于 HTTPS 验证的允许的自定义 CA 证书列表。

CaCert

CA 证书。

字段
display_name	string 必需。允许使用的自定义 CA 证书的名称。这可用于消除自定义 CA 证书的歧义。
cert	bytes 必需。用于 HTTPS 验证的允许的自定义 CA 证书（采用 DER 格式）。此设置会替换默认的 SSL 信任库。如果此字段为空或未指定，CES 将使用 Google 的默认信任库来验证证书。注意：请确保 HTTPS 服务器证书使用“subject alt name”进行签名。例如，可以使用以下命令自签名证书：openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'")

工具

工具表示 CES 代理可以采取的行动，以实现特定目标。

字段
name	string 标识符。工具的唯一标识符。格式：- projects/{project}/locations/{location}/apps/{app}/tools/{tool}（适用于 从工具集中检索到的工具的 projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool}。这些工具是动态的，并且只能输出，无法在需要工具的地方直接引用。
display_name	string 仅限输出。工具的显示名称，根据工具的类型派生。例如，[ClientFunction][Tool.ClientFunction] 的显示名称派生自其 name 属性。
execution_type	ExecutionType 可选。工具的执行类型。
create_time	Timestamp 仅限输出。工具创建时的时间戳。
update_time	Timestamp 仅限输出。上次更新工具时的时间戳。
etag	string 用于确保对象在读取-修改-写入操作期间未发生更改的 ETag。如果 etag 为空，则更新会覆盖任何并发更改。
generated_summary	string 仅限输出。如果该工具是由 LLM 助理生成的，则此字段包含生成内容的描述性摘要。
tool_fake_config	ToolFakeConfig 可选。伪造模式下的工具行为配置。
联合字段 tool_type。工具的类型。tool_type 只能是下列其中一项：
client_function	ClientFunction 可选。客户端函数。
open_api_tool	OpenApiTool 可选。开放式 API 工具。
google_search_tool	GoogleSearchTool 可选。Google 搜索工具。
connector_tool	ConnectorTool 可选。Integration Connector 工具。
data_store_tool	DataStoreTool 可选。数据存储区工具。
python_function	PythonFunction 可选。Python 函数工具。
mcp_tool	McpTool 可选。MCP 工具。MCP 工具无法直接创建或更新，而是由 MCP 工具集管理。
file_search_tool	FileSearchTool 可选。文件搜索工具。
system_tool	SystemTool 可选。系统工具。
widget_tool	WidgetTool 可选。微件工具。

ToolCall

请求客户端或代理执行指定工具。

字段
id	string 可选。工具调用的唯一标识符。如果填充了此字段，客户端应返回执行结果，并在 ToolResponse 中包含匹配 ID。
display_name	string 仅限输出。工具的显示名称。
args	Struct 可选。以 JSON 对象格式表示的工具的输入参数和值。
联合字段 tool_identifier。要执行的工具的标识符。它可以是持久化工具，也可以是工具集中的工具。tool_identifier 只能是下列其中一项：
tool	string 可选。要执行的工具的名称。格式：projects/{project}/locations/{location}/apps/{app}/tools/{tool}
toolset_tool	ToolsetTool 可选。要执行的工具集工具。

ToolCalls

请求客户端执行工具并返回执行结果，然后再继续会话。

字段
tool_calls[]	ToolCall 可选。要执行的工具调用的列表。

ToolFakeConfig

伪造模式下的工具行为配置。

字段
enable_fake_mode	bool 可选。工具是否处于模拟模式。
联合字段 tool_response。响应可以是静态的，也可以由 Python 函数提供。tool_response 只能是下列其中一项：
code_block	CodeBlock 可选。将执行的代码块，而不是实际的工具调用。

ToolResponse

客户端或代理的特定工具的执行结果。

字段
id	string 可选。相应回答所针对的匹配项的 ID。tool call
display_name	string 仅限输出。工具的显示名称。
response	Struct 必需。以 JSON 对象格式表示的工具执行结果。使用“output”键指定工具响应，使用“error”键指定错误详情（如有）。如果未指定“output”和“error”键，则整个“response”都被视为工具执行结果。
联合字段 tool_identifier。已执行的工具的标识符。它可以是持久化工具，也可以是工具集中的工具。tool_identifier 只能是下列其中一项：
tool	string 可选。要执行的工具的名称。格式：projects/{project}/locations/{location}/apps/{app}/tools/{tool}
toolset_tool	ToolsetTool 可选。已执行的工具集工具。

ToolResponses

客户端请求的工具调用的执行结果。

字段
tool_responses[]	ToolResponse 可选。工具执行结果列表。

工具集

工具集表示可供代理使用的动态管理工具组。

字段
name	string 标识符。工具集的唯一标识符。格式：projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}
display_name	string 可选。工具集的显示名称。在同一应用中必须是唯一的。
description	string 可选。工具集的说明。
create_time	Timestamp 仅限输出。工具集创建时的时间戳。
update_time	Timestamp 仅限输出。上次更新工具集时的时间戳。
etag	string 用于确保对象在读取-修改-写入操作期间未发生更改的 ETag。如果 etag 为空，则更新会覆盖任何并发更改。
execution_type	ExecutionType 可选。工具集中工具的执行类型。
tool_fake_config	ToolFakeConfig 可选。伪模式下工具行为的配置。
联合字段 toolset_type。工具集的类型。toolset_type 只能是下列其中一项：
mcp_toolset	McpToolset 可选。一种工具集，其中包含 MCP 服务器提供的一系列工具。
open_api_toolset	OpenApiToolset 可选。包含由 OpenAPI 架构定义的一系列工具的工具集。
connector_toolset	ConnectorToolset 可选。一种可从 Integration Connectors 连接生成工具的工具集。

ToolsetTool

根据工具集创建的工具。

字段
toolset	string 必需。相应工具所源自的 Toolset 的资源名称。格式：projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}
tool_id	string 可选。用于过滤工具的工具 ID，以检索相应工具的架构。

TransferRule

转接给特定客服人员的规则。

字段
child_agent	string 必需。规则所适用的子代理的资源名称。格式：projects/{project}/locations/{location}/apps/{app}/agents/{agent}
direction	TransferRule.Direction 必需。转移方向。
联合字段 rule_type。规则类型。rule_type 只能是下列其中一项：
deterministic_transfer	TransferRule.DeterministicTransfer 可选。当条件满足时立即转接给目标客服人员的规则。
disable_planner_transfer	TransferRule.DisablePlannerTransfer 可选。阻止规划器转移到目标代理的规则。

DeterministicTransfer

确定性转移规则。当条件评估结果为 true 时，系统会执行转移。

字段
联合字段 condition_type。要评估的条件。condition_type 只能是下列其中一项：
expression_condition	ExpressionCondition 可选。评估会话状态条件的规则。如果条件计算结果为 true，则会发生转移。
python_code_condition	PythonCodeCondition 可选。使用 Python 代码块评估条件的规则。如果条件计算结果为 true，则会发生转移。

方向

转移方向。

枚举
DIRECTION_UNSPECIFIED	未指定方向。
PARENT_TO_CHILD	从父代理转移到子代理。
CHILD_TO_PARENT	从子代理转移到父代理。

DisablePlannerTransfer

阻止规划器转移到目标代理的规则。

字段
expression_condition	ExpressionCondition 必需。如果条件评估结果为 true，则规划者将无法转移到目标代理。

TriggerAction

在满足特定前提条件时执行的操作。

字段
联合字段 action。要采取的行动。action 只能是下列其中一项：
respond_immediately	TriggerAction.RespondImmediately 可选。立即使用预配置的回答进行回复。
transfer_agent	TriggerAction.TransferAgent 可选。将对话转接给其他客服人员。
generative_answer	TriggerAction.GenerativeAnswer 可选。使用生成式回答进行回复。

GenerativeAnswer

智能体将立即以生成式答案进行回答。

字段
prompt	string 必需。用于生成式回答的提示。

RespondImmediately

代理会立即返回预配置的回答。

字段
responses[]	TriggerAction.Response 必需。供代理选择的预设回复。系统会随机选择回答。

响应

表示来自代理的响应。

字段
text	string 必需。智能体要回复的文本。
disabled	bool 可选。响应是否已停用。代理不会使用已停用的回答。

TransferAgent

客服人员会将对话转给其他客服人员。

字段
agent	string 必需。要将对话转接到的代理的名称。代理必须与当前代理位于同一应用中。格式：projects/{project}/locations/{location}/apps/{app}/agents/{agent}

UpdateAgentRequest

AgentService.UpdateAgent 的请求消息。

字段
agent	Agent 必需。要更新的代理。
update_mask	FieldMask 可选。字段掩码用于控制要更新的字段。如果未提供掩码，则系统将更新所有字段。

UpdateAppRequest

AgentService.UpdateApp 的请求消息。

字段
app	App 必需。要更新的应用。
update_mask	FieldMask 可选。字段掩码用于控制要更新的字段。如果未提供掩码，则系统将更新所有字段。

UpdateDeploymentRequest

AgentService.UpdateDeployment 的请求消息。

字段
deployment	Deployment 必需。要更新的部署。
update_mask	FieldMask 可选。要更新的字段列表。

UpdateExampleRequest

AgentService.UpdateExample 的请求消息。

字段
example	Example 必需。要更新的示例。
update_mask	FieldMask 可选。字段掩码用于控制要更新的字段。如果未提供掩码，则系统将更新所有字段。

UpdateGuardrailRequest

AgentService.UpdateGuardrail 的请求消息。

字段
guardrail	Guardrail 必需。要更新的护栏。
update_mask	FieldMask 可选。字段掩码用于控制要更新的字段。如果未提供掩码，则系统将更新所有字段。

UpdateToolRequest

AgentService.UpdateTool 的请求消息。

字段
tool	Tool 必需。要更新的工具。
update_mask	FieldMask 可选。字段掩码用于控制要更新的字段。如果未提供掩码，则系统将更新所有字段。

UpdateToolsetRequest

AgentService.UpdateToolset 的请求消息。

字段
toolset	Toolset 必需。要更新的工具集。
update_mask	FieldMask 可选。字段掩码用于控制要更新的字段。如果未提供掩码，则系统将更新所有字段。

WebSearchQuery

表示单个网络搜索查询及其关联的搜索 URI。

字段
query	string 搜索查询文本。
uri	string 相应查询的 Google 搜索结果页面的 URI。

WidgetTool

表示智能体可以调用的 widget 工具。当智能体选择工具后，会将 widget 返回给客户端。客户端负责处理 widget 并生成下一个用户查询，以继续与代理互动。

字段
name	string 必需。widget 工具的显示名称。
description	string 可选。widget 工具的说明。
widget_type	WidgetTool.WidgetType 可选。widget 工具的类型。如果未指定，则默认类型为 CUSTOMIZED。
联合字段 input。widget 工具的输入。input 只能是下列其中一项：
parameters	Schema 可选。widget 工具的输入参数。

WidgetType

所有可用的 widget 类型。将来可能会向此枚举添加新值。

枚举
WIDGET_TYPE_UNSPECIFIED	未指定 widget 类型。
CUSTOM	自定义 widget 类型。
PRODUCT_CAROUSEL	商品轮播微件。
PRODUCT_DETAILS	商品详情 widget。
QUICK_ACTIONS	“快速操作”widget。
PRODUCT_COMPARISON	商品比较微件。
ADVANCED_PRODUCT_DETAILS	高级商品详情 widget。
SHORT_FORM	简短的表单 widget。
OVERALL_SATISFACTION	总体满意度 widget。
ORDER_SUMMARY	订单摘要 widget。
APPOINTMENT_DETAILS	预约详情 widget。
APPOINTMENT_SCHEDULER	预约安排工具微件。
CONTACT_FORM	联系表单微件。