Package google.cloud.ces.v1

Índice

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

AgentService

Es el servicio que administra los recursos relacionados con los agentes en Gemini Enterprise for Customer Engagement (CES).

BatchDeleteConversations

rpc BatchDeleteConversations(BatchDeleteConversationsRequest) returns (Operation) Borra de forma masiva las conversaciones especificadas. Permisos de autorización Se necesita uno de los siguientes permisos de OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Para obtener más información, consulta Authentication Overview. Permisos de IAM Se requiere el siguiente permiso de IAM en el recurso parent: ces.conversations.delete Para obtener más información, consulta la documentación de IAM.

CreateAgent

rpc CreateAgent(CreateAgentRequest) returns (Agent) Crea un agente nuevo en la app especificada. Permisos de autorización Se necesita uno de los siguientes permisos de OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Para obtener más información, consulta Authentication Overview. Permisos de IAM Se requiere el siguiente permiso de IAM en el recurso parent: ces.agents.create Para obtener más información, consulta la documentación de IAM.

CreateApp

rpc CreateApp(CreateAppRequest) returns (Operation) Crea una app nueva en el proyecto y la ubicación especificados. Permisos de autorización Se necesita uno de los siguientes permisos de OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Para obtener más información, consulta Authentication Overview. Permisos de IAM Se requiere el siguiente permiso de IAM en el recurso parent: ces.apps.create Para obtener más información, consulta la documentación de IAM.

CreateAppVersion

rpc CreateAppVersion(CreateAppVersionRequest) returns (AppVersion) Crea una versión nueva de la app especificada. Permisos de autorización Se necesita uno de los siguientes permisos de OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Para obtener más información, consulta Authentication Overview. Permisos de IAM Se requiere el siguiente permiso de IAM en el recurso parent: ces.appVersions.create Para obtener más información, consulta la documentación de IAM.

CreateDeployment

rpc CreateDeployment(CreateDeploymentRequest) returns (Deployment) Crea una implementación nueva en la app especificada. Permisos de autorización Se necesita uno de los siguientes permisos de OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Para obtener más información, consulta Authentication Overview. Permisos de IAM Se requiere el siguiente permiso de IAM en el recurso parent: ces.deployments.create Para obtener más información, consulta la documentación de IAM.

CreateExample

rpc CreateExample(CreateExampleRequest) returns (Example) Crea un ejemplo nuevo en la app especificada. Permisos de autorización Se necesita uno de los siguientes permisos de OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Para obtener más información, consulta Authentication Overview. Permisos de IAM Se requiere el siguiente permiso de IAM en el recurso parent: ces.examples.create Para obtener más información, consulta la documentación de IAM.

CreateGuardrail

rpc CreateGuardrail(CreateGuardrailRequest) returns (Guardrail) Crea una nueva protección en la app especificada. Permisos de autorización Se necesita uno de los siguientes permisos de OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Para obtener más información, consulta Authentication Overview. Permisos de IAM Se requiere el siguiente permiso de IAM en el recurso parent: ces.guardrails.create Para obtener más información, consulta la documentación de IAM.

CreateTool

rpc CreateTool(CreateToolRequest) returns (Tool) Crea una herramienta nueva en la app especificada. Permisos de autorización Se necesita uno de los siguientes permisos de OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Para obtener más información, consulta Authentication Overview. Permisos de IAM Se requiere el siguiente permiso de IAM en el recurso parent: ces.tools.create Para obtener más información, consulta la documentación de IAM.

CreateToolset

rpc CreateToolset(CreateToolsetRequest) returns (Toolset) Crea un nuevo conjunto de herramientas en la app especificada. Permisos de autorización Se necesita uno de los siguientes permisos de OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Para obtener más información, consulta Authentication Overview. Permisos de IAM Se requiere el siguiente permiso de IAM en el recurso parent: ces.toolsets.create Para obtener más información, consulta la documentación de IAM.

DeleteAgent

rpc DeleteAgent(DeleteAgentRequest) returns (Empty) Borra el agente especificado. Permisos de autorización Se necesita uno de los siguientes permisos de OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Para obtener más información, consulta Authentication Overview. Permisos de IAM Se requiere el siguiente permiso de IAM en el recurso name: ces.agents.delete Para obtener más información, consulta la documentación de IAM.

DeleteApp

rpc DeleteApp(DeleteAppRequest) returns (Operation) Borra la app especificada. Permisos de autorización Se necesita uno de los siguientes permisos de OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Para obtener más información, consulta Authentication Overview. Permisos de IAM Se requiere el siguiente permiso de IAM en el recurso name: ces.apps.delete Para obtener más información, consulta la documentación de IAM.

DeleteAppVersion

rpc DeleteAppVersion(DeleteAppVersionRequest) returns (Empty) Borra la versión de la app especificada. Permisos de autorización Se necesita uno de los siguientes permisos de OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Para obtener más información, consulta Authentication Overview. Permisos de IAM Se requiere el siguiente permiso de IAM en el recurso name: ces.appVersions.delete Para obtener más información, consulta la documentación de IAM.

DeleteConversation

rpc DeleteConversation(DeleteConversationRequest) returns (Empty) Borra la conversación especificada. Permisos de autorización Se necesita uno de los siguientes permisos de OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Para obtener más información, consulta Authentication Overview. Permisos de IAM Se requiere el siguiente permiso de IAM en el recurso name: ces.conversations.delete Para obtener más información, consulta la documentación de IAM.

DeleteDeployment

rpc DeleteDeployment(DeleteDeploymentRequest) returns (Empty) Borra la implementación especificada. Permisos de autorización Se necesita uno de los siguientes permisos de OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Para obtener más información, consulta Authentication Overview. Permisos de IAM Se requiere el siguiente permiso de IAM en el recurso name: ces.deployments.delete Para obtener más información, consulta la documentación de IAM.

DeleteExample

rpc DeleteExample(DeleteExampleRequest) returns (Empty) Borra el ejemplo especificado. Permisos de autorización Se necesita uno de los siguientes permisos de OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Para obtener más información, consulta Authentication Overview. Permisos de IAM Se requiere el siguiente permiso de IAM en el recurso name: ces.examples.delete Para obtener más información, consulta la documentación de IAM.

DeleteGuardrail

rpc DeleteGuardrail(DeleteGuardrailRequest) returns (Empty) Borra la protección especificada. Permisos de autorización Se necesita uno de los siguientes permisos de OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Para obtener más información, consulta Authentication Overview. Permisos de IAM Se requiere el siguiente permiso de IAM en el recurso name: ces.guardrails.delete Para obtener más información, consulta la documentación de IAM.

DeleteTool

rpc DeleteTool(DeleteToolRequest) returns (Empty) Borra la herramienta especificada. Permisos de autorización Se necesita uno de los siguientes permisos de OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Para obtener más información, consulta Authentication Overview. Permisos de IAM Se requiere el siguiente permiso de IAM en el recurso name: ces.tools.delete Para obtener más información, consulta la documentación de IAM.

DeleteToolset

rpc DeleteToolset(DeleteToolsetRequest) returns (Empty) Borra el conjunto de herramientas especificado. Permisos de autorización Se necesita uno de los siguientes permisos de OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Para obtener más información, consulta Authentication Overview. Permisos de IAM Se requiere el siguiente permiso de IAM en el recurso name: ces.toolsets.delete Para obtener más información, consulta la documentación de IAM.

ExportApp

rpc ExportApp(ExportAppRequest) returns (Operation) Exporta la app especificada. Permisos de autorización Se necesita uno de los siguientes permisos de OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Para obtener más información, consulta Authentication Overview. Permisos de IAM Se requiere el siguiente permiso de IAM en el recurso name: ces.apps.export Para obtener más información, consulta la documentación de IAM.

GetAgent

rpc GetAgent(GetAgentRequest) returns (Agent) Obtiene detalles del agente especificado. Permisos de autorización Se necesita uno de los siguientes permisos de OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Para obtener más información, consulta Authentication Overview. Permisos de IAM Se requiere el siguiente permiso de IAM en el recurso name: ces.agents.get Para obtener más información, consulta la documentación de IAM.

GetApp

rpc GetApp(GetAppRequest) returns (App) Obtiene detalles de la app especificada. Permisos de autorización Se necesita uno de los siguientes permisos de OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Para obtener más información, consulta Authentication Overview. Permisos de IAM Se requiere el siguiente permiso de IAM en el recurso name: ces.apps.get Para obtener más información, consulta la documentación de IAM.

GetAppVersion

rpc GetAppVersion(GetAppVersionRequest) returns (AppVersion) Obtiene detalles de la versión de la app especificada. Permisos de autorización Se necesita uno de los siguientes permisos de OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Para obtener más información, consulta Authentication Overview. Permisos de IAM Se requiere el siguiente permiso de IAM en el recurso name: ces.appVersions.get Para obtener más información, consulta la documentación de IAM.

GetChangelog

rpc GetChangelog(GetChangelogRequest) returns (Changelog) Obtiene el registro de cambios especificado. Permisos de autorización Se necesita uno de los siguientes permisos de OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Para obtener más información, consulta Authentication Overview. Permisos de IAM Se requiere el siguiente permiso de IAM en el recurso name: ces.changelogs.get Para obtener más información, consulta la documentación de IAM.

GetConversation

rpc GetConversation(GetConversationRequest) returns (Conversation) Obtiene detalles de la conversación especificada. Permisos de autorización Se necesita uno de los siguientes permisos de OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Para obtener más información, consulta Authentication Overview. Permisos de IAM Se requiere el siguiente permiso de IAM en el recurso name: ces.conversations.get Para obtener más información, consulta la documentación de IAM.

GetDeployment

rpc GetDeployment(GetDeploymentRequest) returns (Deployment) Obtiene detalles de la implementación especificada. Permisos de autorización Se necesita uno de los siguientes permisos de OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Para obtener más información, consulta Authentication Overview. Permisos de IAM Se requiere el siguiente permiso de IAM en el recurso name: ces.deployments.get Para obtener más información, consulta la documentación de IAM.

GetExample

rpc GetExample(GetExampleRequest) returns (Example) Obtiene detalles del ejemplo especificado. Permisos de autorización Se necesita uno de los siguientes permisos de OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Para obtener más información, consulta Authentication Overview. Permisos de IAM Se requiere el siguiente permiso de IAM en el recurso name: ces.examples.get Para obtener más información, consulta la documentación de IAM.

GetGuardrail

rpc GetGuardrail(GetGuardrailRequest) returns (Guardrail) Obtiene detalles sobre la protección especificada. Permisos de autorización Se necesita uno de los siguientes permisos de OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Para obtener más información, consulta Authentication Overview. Permisos de IAM Se requiere el siguiente permiso de IAM en el recurso name: ces.guardrails.get Para obtener más información, consulta la documentación de IAM.

GetTool

rpc GetTool(GetToolRequest) returns (Tool) Obtiene detalles de la herramienta especificada. Permisos de autorización Se necesita uno de los siguientes permisos de OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Para obtener más información, consulta Authentication Overview. Permisos de IAM Se requiere el siguiente permiso de IAM en el recurso name: ces.tools.get Para obtener más información, consulta la documentación de IAM.

GetToolset

rpc GetToolset(GetToolsetRequest) returns (Toolset) Obtiene detalles del conjunto de herramientas especificado. Permisos de autorización Se necesita uno de los siguientes permisos de OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Para obtener más información, consulta Authentication Overview. Permisos de IAM Se requiere el siguiente permiso de IAM en el recurso name: ces.toolsets.get Para obtener más información, consulta la documentación de IAM.

ImportApp

rpc ImportApp(ImportAppRequest) returns (Operation) Importa la app especificada. Permisos de autorización Se necesita uno de los siguientes permisos de OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Para obtener más información, consulta Authentication Overview. Permisos de IAM Se requiere el siguiente permiso de IAM en el recurso parent: ces.apps.import Para obtener más información, consulta la documentación de IAM.

ListAgents

rpc ListAgents(ListAgentsRequest) returns (ListAgentsResponse) Enumera los agentes de la app especificada. Permisos de autorización Se necesita uno de los siguientes permisos de OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Para obtener más información, consulta Authentication Overview. Permisos de IAM Se requiere el siguiente permiso de IAM en el recurso parent: ces.agents.list Para obtener más información, consulta la documentación de IAM.

ListAppVersions

rpc ListAppVersions(ListAppVersionsRequest) returns (ListAppVersionsResponse) Enumera todas las versiones de la app especificada. Permisos de autorización Se necesita uno de los siguientes permisos de OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Para obtener más información, consulta Authentication Overview. Permisos de IAM Se requiere el siguiente permiso de IAM en el recurso parent: ces.appVersions.list Para obtener más información, consulta la documentación de IAM.

ListApps

rpc ListApps(ListAppsRequest) returns (ListAppsResponse) Enumera las apps en el proyecto y la ubicación determinados. Permisos de autorización Se necesita uno de los siguientes permisos de OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Para obtener más información, consulta Authentication Overview. Permisos de IAM Se requiere el siguiente permiso de IAM en el recurso parent: ces.apps.list Para obtener más información, consulta la documentación de IAM.

ListChangelogs

rpc ListChangelogs(ListChangelogsRequest) returns (ListChangelogsResponse) Enumera los registros de cambios de la app especificada. Permisos de autorización Se necesita uno de los siguientes permisos de OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Para obtener más información, consulta Authentication Overview. Permisos de IAM Se requiere el siguiente permiso de IAM en el recurso parent: ces.changelogs.list Para obtener más información, consulta la documentación de IAM.

ListConversations

rpc ListConversations(ListConversationsRequest) returns (ListConversationsResponse) Enumera las conversaciones en la app determinada. Permisos de autorización Se necesita uno de los siguientes permisos de OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Para obtener más información, consulta Authentication Overview. Permisos de IAM Se requiere el siguiente permiso de IAM en el recurso parent: ces.conversations.list Para obtener más información, consulta la documentación de IAM.

ListDeployments

rpc ListDeployments(ListDeploymentsRequest) returns (ListDeploymentsResponse) Enumera las implementaciones en la app especificada. Permisos de autorización Se necesita uno de los siguientes permisos de OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Para obtener más información, consulta Authentication Overview. Permisos de IAM Se requiere el siguiente permiso de IAM en el recurso parent: ces.deployments.list Para obtener más información, consulta la documentación de IAM.

ListExamples

rpc ListExamples(ListExamplesRequest) returns (ListExamplesResponse) Enumera ejemplos en la app determinada. Permisos de autorización Se necesita uno de los siguientes permisos de OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Para obtener más información, consulta Authentication Overview. Permisos de IAM Se requiere el siguiente permiso de IAM en el recurso parent: ces.examples.list Para obtener más información, consulta la documentación de IAM.

ListGuardrails

rpc ListGuardrails(ListGuardrailsRequest) returns (ListGuardrailsResponse) Enumera los parámetros de protección de la app especificada. Permisos de autorización Se necesita uno de los siguientes permisos de OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Para obtener más información, consulta Authentication Overview. Permisos de IAM Se requiere el siguiente permiso de IAM en el recurso parent: ces.guardrails.list Para obtener más información, consulta la documentación de IAM.

ListTools

rpc ListTools(ListToolsRequest) returns (ListToolsResponse) Enumera las herramientas de la app especificada. Permisos de autorización Se necesita uno de los siguientes permisos de OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Para obtener más información, consulta Authentication Overview. Permisos de IAM Se requiere el siguiente permiso de IAM en el recurso parent: ces.tools.list Para obtener más información, consulta la documentación de IAM.

ListToolsets

rpc ListToolsets(ListToolsetsRequest) returns (ListToolsetsResponse) Enumera los conjuntos de herramientas de la app especificada. Permisos de autorización Se necesita uno de los siguientes permisos de OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Para obtener más información, consulta Authentication Overview. Permisos de IAM Se requiere el siguiente permiso de IAM en el recurso parent: ces.toolsets.list Para obtener más información, consulta la documentación de IAM.

RestoreAppVersion

rpc RestoreAppVersion(RestoreAppVersionRequest) returns (Operation) Restablece la versión de la app especificada. Se creará una versión nueva de la app a partir del borrador actual y se reemplazará el borrador actual por la versión de la app especificada. Permisos de autorización Se necesita uno de los siguientes permisos de OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Para obtener más información, consulta Authentication Overview. Permisos de IAM Se requiere el siguiente permiso de IAM en el recurso name: ces.appVersions.restore Para obtener más información, consulta la documentación de IAM.

UpdateAgent

rpc UpdateAgent(UpdateAgentRequest) returns (Agent) Actualiza el agente especificado. Permisos de autorización Se necesita uno de los siguientes permisos de OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Para obtener más información, consulta Authentication Overview. Permisos de IAM Se requiere el siguiente permiso de IAM en el recurso name: ces.agents.update Para obtener más información, consulta la documentación de IAM.

UpdateApp

rpc UpdateApp(UpdateAppRequest) returns (App) Actualiza la app especificada. Permisos de autorización Se necesita uno de los siguientes permisos de OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Para obtener más información, consulta Authentication Overview. Permisos de IAM Se requiere el siguiente permiso de IAM en el recurso name: ces.apps.update Para obtener más información, consulta la documentación de IAM.

UpdateDeployment

rpc UpdateDeployment(UpdateDeploymentRequest) returns (Deployment) Actualiza la implementación especificada. Permisos de autorización Se necesita uno de los siguientes permisos de OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Para obtener más información, consulta Authentication Overview. Permisos de IAM Se requiere el siguiente permiso de IAM en el recurso name: ces.deployments.update Para obtener más información, consulta la documentación de IAM.

UpdateExample

rpc UpdateExample(UpdateExampleRequest) returns (Example) Actualiza el ejemplo especificado. Permisos de autorización Se necesita uno de los siguientes permisos de OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Para obtener más información, consulta Authentication Overview. Permisos de IAM Se requiere el siguiente permiso de IAM en el recurso name: ces.examples.update Para obtener más información, consulta la documentación de IAM.

UpdateGuardrail

rpc UpdateGuardrail(UpdateGuardrailRequest) returns (Guardrail) Actualiza la protección especificada. Permisos de autorización Se necesita uno de los siguientes permisos de OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Para obtener más información, consulta Authentication Overview. Permisos de IAM Se requiere el siguiente permiso de IAM en el recurso name: ces.guardrails.update Para obtener más información, consulta la documentación de IAM.

UpdateTool

rpc UpdateTool(UpdateToolRequest) returns (Tool) Actualiza la herramienta especificada. Permisos de autorización Se necesita uno de los siguientes permisos de OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Para obtener más información, consulta Authentication Overview. Permisos de IAM Se requiere el siguiente permiso de IAM en el recurso name: ces.tools.update Para obtener más información, consulta la documentación de IAM.

UpdateToolset

rpc UpdateToolset(UpdateToolsetRequest) returns (Toolset) Actualiza el conjunto de herramientas especificado. Permisos de autorización Se necesita uno de los siguientes permisos de OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Para obtener más información, consulta Authentication Overview. Permisos de IAM Se requiere el siguiente permiso de IAM en el recurso name: ces.toolsets.update Para obtener más información, consulta la documentación de IAM.

SessionService

El servicio de sesión proporciona APIs para interactuar con los agentes de CES.

BidiRunSession

rpc BidiRunSession(BidiSessionClientMessage) returns (BidiSessionServerMessage) Establece una conexión de transmisión bidireccional con el agente de CES. El agente procesa entradas multimodales continuas (p.ej., texto y audio) y genera transmisiones de salida multimodales en tiempo real. --- Client Request Stream --- El cliente transmite solicitudes en el siguiente orden: Inicialización: El primer mensaje debe contener SessionConfig. En el caso de las sesiones de audio, también debe incluir InputAudioConfig y OutputAudioConfig para definir los parámetros de procesamiento y síntesis de audio. Interacción: Flujo de mensajes posteriores SessionInput que contiene datos de entrada del usuario en tiempo real. Finalización: El cliente debe cerrar la mitad de la transmisión cuando no haya más entrada del usuario. También debe cerrarse a la mitad cuando reciba EndSession o GoAway del agente. --- Flujo de respuesta del servidor --- En cada turno de interacción, el agente transmite mensajes en la siguiente secuencia: Reconocimiento de voz (primeros N mensajes): Contiene RecognitionResult, que representa los segmentos de voz del usuario concatenados que se capturaron hasta el momento. Este campo solo se completa para las sesiones de audio. Respuesta (próximos M mensajes): Contiene SessionOutput que entrega la respuesta del agente en varias modalidades (p.ej., texto, audio). Finalización del turno (mensaje final del turno): Contiene SessionOutput con turn_completed establecido en verdadero. Esto indica el final del turno actual y contiene DiagnosticInfo con detalles de ejecución. --- Prácticas recomendadas de audio --- 1. Transmisión: Transmite audio data DE FORMA CONTINUA, incluso durante los silencios. Tamaño de fragmento recomendado: de 40 a 120 ms (equilibra la latencia y la eficiencia). Reproducción e interrupción: Reproduce audio responses cuando lo recibas. Detén la reproducción de inmediato si se recibe un InterruptionSignal (p.ej., interrupción del usuario o respuesta de un agente nuevo). Permisos de autorización Se necesita uno de los siguientes permisos de OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Para obtener más información, consulta Authentication Overview. Permisos de IAM Se requiere el siguiente permiso de IAM en el recurso session: ces.sessions.bidiRunSession Para obtener más información, consulta la documentación de IAM.

RunSession

rpc RunSession(RunSessionRequest) returns (RunSessionResponse) Inicia una interacción de un solo turno con el agente de CES dentro de una sesión. Permisos de autorización Se necesita uno de los siguientes permisos de OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Para obtener más información, consulta Authentication Overview. Permisos de IAM Se requiere el siguiente permiso de IAM en el recurso session: ces.sessions.runSession Para obtener más información, consulta la documentación de IAM.

StreamRunSession

rpc StreamRunSession(RunSessionRequest) returns (RunSessionResponse) Inicia una interacción de un solo turno con el agente de CES. Utiliza la transmisión del servidor para entregar resultados incrementales y respuestas parciales a medida que se generan. De forma predeterminada, las respuestas completas (p.ej., mensajes de devoluciones de llamada o respuestas completas del LLM) se envían al cliente en cuanto están disponibles. Para habilitar la transmisión de fragmentos de texto individuales directamente desde el modelo, establece enable_text_streaming en verdadero. Permisos de autorización Se necesita uno de los siguientes permisos de OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Para obtener más información, consulta Authentication Overview. Permisos de IAM Se requiere el siguiente permiso de IAM en el recurso session: ces.sessions.runSession Para obtener más información, consulta la documentación de IAM.

ToolService

El servicio de herramientas proporciona APIs para interactuar con las herramientas de CES.

ExecuteTool

rpc ExecuteTool(ExecuteToolRequest) returns (ExecuteToolResponse) Ejecuta la herramienta determinada con los argumentos determinados. Permisos de autorización Se necesita uno de los siguientes permisos de OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Para obtener más información, consulta Authentication Overview. Permisos de IAM Se requiere el siguiente permiso de IAM en el recurso parent: ces.tools.execute Para obtener más información, consulta la documentación de IAM.

RetrieveToolSchema

rpc RetrieveToolSchema(RetrieveToolSchemaRequest) returns (RetrieveToolSchemaResponse) Recupera el esquema de la herramienta determinada. El esquema se calcula sobre la marcha para la instancia determinada de la herramienta. Permisos de autorización Se necesita uno de los siguientes permisos de OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Para obtener más información, consulta Authentication Overview. Permisos de IAM Se requiere el siguiente permiso de IAM en el recurso parent: ces.tools.get Para obtener más información, consulta la documentación de IAM.

RetrieveTools

rpc RetrieveTools(RetrieveToolsRequest) returns (RetrieveToolsResponse) Recupera la lista de herramientas incluidas en el conjunto de herramientas especificado. Permisos de autorización Se necesita uno de los siguientes permisos de OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Para obtener más información, consulta Authentication Overview. Permisos de IAM Se requiere el siguiente permiso de IAM en el recurso toolset: ces.toolsets.get Para obtener más información, consulta la documentación de IAM.

WidgetService

Proporciona APIs para que los widgets interactúen con las APIs de CES.

GenerateChatToken

rpc GenerateChatToken(GenerateChatTokenRequest) returns (GenerateChatTokenResponse) Genera un token con alcance de sesión para que el widget de chat se autentique con las APIs de Session. Permisos de autorización Se necesita uno de los siguientes permisos de OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Para obtener más información, consulta Authentication Overview.

Acción

Es la configuración de una acción que la herramienta puede usar. Nota: Puede ser una acción o una operación. Consulta https://cloud.google.com/integration-connectors/docs/entities-operation-action para obtener más detalles.

Campos
input_fields[]	string Es opcional. Son los campos de entidad que se usarán como entradas para la operación. Si no se especifican campos, se usarán todos los campos de la entidad.
output_fields[]	string Es opcional. Son los campos de la entidad que se devolverán de la operación. Si no se especifican campos, se mostrarán todos los campos de la entidad.
Campo de unión action_spec. Es la especificación de una acción que se configurará para que la use la herramienta. action_spec puede ser solo uno de los parámetros siguientes:
connection_action_id	string Es el ID de una acción de conexión que usará la herramienta.
entity_operation	Action.EntityOperation Es la configuración de la operación de la entidad que usará la herramienta.

EntityOperation

Es la especificación de la operación CRUD de la entidad.

Campos
entity_id	string Obligatorio. Es el ID de la entidad.
operation	Action.EntityOperation.OperationType Obligatorio. Operación que se realizará en la entidad.

OperationType

Operación que se realizará en la entidad.

Enums
OPERATION_TYPE_UNSPECIFIED	No se especificó el tipo de operación. No es válido. Fallará la creación o actualización de ConnectorTool.
LIST	Operación de lista.
GET	Operación de obtención.
CREATE	Operación de creación.
UPDATE	Operación de actualización.
DELETE	Operación de eliminación.

Agente

Un agente actúa como el componente básico fundamental que proporciona instrucciones al modelo de lenguaje grande (LLM) para ejecutar tareas específicas.

Campos
name	string Es el identificador. El identificador único del agente. Formato: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
display_name	string Obligatorio. Nombre visible del agente.
description	string Es opcional. Es una descripción del agente legible por humanos.
model_settings	ModelSettings Es opcional. Es la configuración del modelo de LLM.
instruction	string Es opcional. Son las instrucciones para el modelo de LLM que guían el comportamiento del agente.
tools[]	string Es opcional. Es la lista de herramientas disponibles para el agente. Formato: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
child_agents[]	string Es opcional. Es la lista de agentes secundarios en el árbol de agentes. Formato: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
before_agent_callbacks[]	Callback Es opcional. Son las devoluciones de llamada que se ejecutarán antes de que se llame al agente. Las devoluciones de llamada proporcionadas se ejecutan de forma secuencial en el orden exacto en que se proporcionan en la lista. Si una devolución de llamada muestra una respuesta anulada, se detiene la ejecución y se omiten las devoluciones de llamada restantes.
after_agent_callbacks[]	Callback Es opcional. Son las devoluciones de llamada que se ejecutarán después de que se llame al agente. Las devoluciones de llamada proporcionadas se ejecutan de forma secuencial en el orden exacto en que se proporcionan en la lista. Si una devolución de llamada muestra una respuesta anulada, se detiene la ejecución y se omiten las devoluciones de llamada restantes.
before_model_callbacks[]	Callback Es opcional. Son las devoluciones de llamada que se ejecutarán antes de que se llame al modelo. Si hay varias llamadas al modelo, la devolución de llamada se ejecutará varias veces. Las devoluciones de llamada proporcionadas se ejecutan de forma secuencial en el orden exacto en que se proporcionan en la lista. Si una devolución de llamada muestra una respuesta anulada, se detiene la ejecución y se omiten las devoluciones de llamada restantes.
after_model_callbacks[]	Callback Es opcional. Son las devoluciones de llamada que se ejecutarán después de que se llame al modelo. Si hay varias llamadas al modelo, la devolución de llamada se ejecutará varias veces. Las devoluciones de llamada proporcionadas se ejecutan de forma secuencial en el orden exacto en que se proporcionan en la lista. Si una devolución de llamada muestra una respuesta anulada, se detiene la ejecución y se omiten las devoluciones de llamada restantes.
before_tool_callbacks[]	Callback Es opcional. Son las devoluciones de llamada que se ejecutarán antes de que se invoque la herramienta. Si hay varias invocaciones de herramientas, la devolución de llamada se ejecutará varias veces. Las devoluciones de llamada proporcionadas se ejecutan de forma secuencial en el orden exacto en que se proporcionan en la lista. Si una devolución de llamada muestra una respuesta anulada, se detiene la ejecución y se omiten las devoluciones de llamada restantes.
after_tool_callbacks[]	Callback Es opcional. Son las devoluciones de llamada que se ejecutarán después de invocar la herramienta. Si hay varias invocaciones de herramientas, la devolución de llamada se ejecutará varias veces. Las devoluciones de llamada proporcionadas se ejecutan de forma secuencial en el orden exacto en que se proporcionan en la lista. Si una devolución de llamada muestra una respuesta anulada, se detiene la ejecución y se omiten las devoluciones de llamada restantes.
create_time	Timestamp Solo salida. Es la marca de tiempo de cuando se creó el agente.
update_time	Timestamp Solo salida. Es la marca de tiempo de la última actualización del agente.
guardrails[]	string Es opcional. Es la lista de medidas de protección del agente. Formato: projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}
etag	string Es el ETag que se usa para garantizar que el objeto no haya cambiado durante una operación de lectura, modificación y escritura. Si el ETag está vacío, la actualización reemplazará cualquier cambio simultáneo.
toolsets[]	Agent.AgentToolset Es opcional. Es la lista de conjuntos de herramientas del agente.
generated_summary	string Solo salida. Si el agente lo genera el asistente de LLM, este campo contiene un resumen descriptivo de la generación.
transfer_rules[]	TransferRule Es opcional. Son las reglas de transferencia del agente. Si coinciden varias reglas, se usará la primera de la lista.
validation_errors[]	string Solo salida. Son errores o parámetros de configuración incorrectos en el agente que pueden afectar su calidad.
Campo de unión agent_type. Es el tipo de agente. agent_type puede ser solo uno de los parámetros siguientes:
llm_agent	Agent.LlmAgent Es opcional. Es el tipo de agente predeterminado.
remote_dialogflow_agent	Agent.RemoteDialogflowAgent Es opcional. Es el agente remoto de Dialogflow que se usará para la ejecución del agente. Si se configura este campo, se ignorarán todas las demás propiedades a nivel del agente. Nota: Si el agente de Dialogflow está en un proyecto diferente al de la app, debes otorgar roles/dialogflow.client al agente de servicio de CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.

AgentToolset

Un conjunto de herramientas con una selección de sus herramientas.

Campos
toolset	string Obligatorio. Es el nombre del recurso del conjunto de herramientas. Formato: projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}
tool_ids[]	string Es opcional. Son los IDs de las herramientas para filtrar el conjunto de herramientas.

LlmAgent

Este tipo no tiene campos.

Es el tipo de agente predeterminado. El agente usa instrucciones y devoluciones de llamada especificadas en el agente para realizar la tarea con un modelo de lenguaje grande.

RemoteDialogflowAgent

Es el agente que transferirá la ejecución a un agente remoto de Dialogflow CX. El agente de Dialogflow procesará las consultas posteriores del usuario hasta que finalice la sesión o el flujo, y el control se transferirá de nuevo al agente principal de CES.

Campos
agent	string Obligatorio. Es el nombre del recurso del agente de Dialogflow. Formato: projects/{project}/locations/{location}/agents/{agent}
flow_id	string Es opcional. Es el ID del flujo en el agente de Dialogflow.
environment_id	string Es opcional. Es el ID del entorno del agente de Dialogflow que se usará para la ejecución del agente. Si no se especifica, se usará el entorno de borrador.
input_variable_mapping	map<string, string> Es opcional. Es la asignación de los nombres de las variables de la app a los nombres de los parámetros de sesión de Dialogflow que se enviarán al agente de Dialogflow como entrada.
output_variable_mapping	map<string, string> Es opcional. Es la asignación de los nombres de los parámetros de la sesión de Dialogflow a los nombres de las variables de la app que se enviarán al agente de CES después de que finalice la ejecución del agente de Dialogflow.
respect_response_interruption_settings	bool Es opcional. Indica si se debe respetar la configuración de interrupción a nivel del mensaje configurada en el agente de Dialogflow. Si es falso, todos los mensajes de respuesta del agente de Dialogflow siguen la configuración de interrupción a nivel de la app. Si es verdadero, solo se podrán interrumpir los mensajes de respuesta con allow_playback_interruption establecido como verdadero. Todos los demás mensajes seguirán la configuración de interrupción a nivel de la app.
language_code_variable	string Es opcional. Nombre de la variable que contiene el código de idioma que se usará para la sesión de Dialogflow. Si no se especifica, se usará el código de idioma predeterminado del agente de Dialogflow.

AgentCard

AgentCard transmite información clave sobre un agente remoto. Es una versión reducida de AgentCard, que se define en el protocolo A2A https://a2a-protocol.org/dev/specification/#441-agentcard

Campos
name	string Obligatorio. Nombre del agente legible por humanos.
description	string Obligatorio. Es una descripción del dominio de acción o el espacio de soluciones del agente.
supported_interfaces[]	AgentInterface Obligatorio. Lista ordenada de interfaces compatibles. Se prefiere la primera entrada.
version	string Obligatorio. Es la versión del agente.
skills[]	AgentSkill Obligatorio. Las habilidades representan una unidad de capacidad que puede realizar un agente. Esto puede ser algo abstracto, pero representa un conjunto más enfocado de acciones en las que es muy probable que el agente tenga éxito.

AgentInterface

Declara una combinación de una URL de destino, un transporte y una versión de protocolo para interactuar con el agente. Esto permite que los agentes expongan la misma funcionalidad a través de varios mecanismos de vinculación de protocolos.

Campos
url	string Obligatorio. Es la URL en la que está disponible esta interfaz. Debe ser una URL HTTPS absoluta válida en producción. Ejemplo: "https://api.example.com/a2a/v1", "https://grpc.example.com/a2a"
protocol_binding	string Obligatorio. Es la vinculación del protocolo admitida en esta URL. Es una cadena de formulario abierto que se puede extender fácilmente para otras vinculaciones de protocolos. Los principales que se admiten oficialmente son JSONRPC, GRPC y HTTP+JSON.
tenant	string Es el ID de inquilino que se usará en la solicitud cuando se llame al agente.
protocol_version	string Obligatorio. Es la versión del protocolo A2A que expone esta interfaz. Usa la versión secundaria compatible más reciente por versión principal. Ejemplos: “0.3”, “1.0”

AgentSkill

Representa una capacidad o función distinta que un agente puede realizar.

Campos
id	string Obligatorio. Es un identificador único para la habilidad del agente.
name	string Obligatorio. Es el nombre de la habilidad legible por humanos.
description	string Obligatorio. Es una descripción detallada de la habilidad.
tags[]	string Obligatorio. Es un conjunto de palabras clave que describen las capacidades de la skill.
examples[]	string Ejemplos de instrucciones o situaciones que esta habilidad puede controlar.
input_modes[]	string Es el conjunto de tipos de medios de entrada admitidos para esta habilidad, que anula los valores predeterminados del agente.
output_modes[]	string Es el conjunto de tipos de medios de salida admitidos para esta habilidad, que anula los valores predeterminados del agente.

AgentTool

Representa una herramienta que permite al agente llamar a otro agente.

Campos
name	string Obligatorio. Es el nombre de la herramienta del agente.
description	string Es opcional. Es la descripción del propósito de la herramienta.
agent	string Es opcional. Es el nombre del recurso del agente que es el punto de entrada de la herramienta. Formato: projects/{project}/locations/{location}/agents/{agent}

AgentTransfer

Representa un evento que indica la transferencia de una conversación a otro agente.

Campos
target_agent	string Obligatorio. Es el agente al que se transfiere la conversación. A partir de este punto, el agente se encargará de la conversación. Formato: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
display_name	string Solo salida. Nombre visible del agente.

AmbientSoundConfig

Es la configuración del sonido ambiente que se reproducirá con la respuesta sintetizada del agente para mejorar la naturalidad de la conversación.

Campos
volume_gain_db	double Es opcional. Es la ganancia de volumen (en dB) del volumen nativo normal que admite el ruido ambiental, en el rango de [-96.0, 16.0]. Si no se establece, o se establece en un valor de 0.0 (dB), se reproducirá en la amplitud de la señal nativa normal. Un valor de -6.0 (dB) se reproducirá aproximadamente a la mitad de la amplitud de la señal nativa normal. Un valor de +6.0 (dB) se reproducirá aproximadamente al doble de la amplitud de la señal nativa normal. Recomendamos no superar los +10 (dB) ya que, por lo general, no hay un aumento efectivo en la sonoridad para ningún valor superior.
Campo de unión source. Ruido ambiental que se reproducirá con la respuesta sintetizada del agente para mejorar la naturalidad de la conversación. source puede ser solo uno de los parámetros siguientes:
prebuilt_ambient_noise (deprecated)	AmbientSoundConfig.PrebuiltAmbientNoise Este elemento está obsoleto. Es opcional. Obsoleto: prebuilt_ambient_noise dejó de estar disponible y se reemplazó por prebuilt_ambient_sound.
gcs_uri	string Es opcional. Ruido ambiente como un archivo WAV de 16 kHz y un solo canal almacenado en Cloud Storage. Nota: Asegúrate de que el agente de servicio de CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com tenga permiso storage.objects.get para el objeto de Cloud Storage.
prebuilt_ambient_sound	string Es opcional. Nombre del sonido ambiental prediseñado. Los valores válidos son los siguientes: "coffee_shop", "keyboard", "keypad", "hum", "office_1", "office_2", "office_3", "room_1", "room_2", "room_3", "room_4", "room_5" y "air_conditioner".

PrebuiltAmbientNoise

Ruido ambiental prediseñado.

Enums
PREBUILT_AMBIENT_NOISE_UNSPECIFIED	No especificado.
RETAIL_STORE	Ruido ambiental de una tienda minorista.
CONVENTION_HALL	Ruido ambiental de una sala de convenciones.
OUTDOOR	Ruido ambiental de una calle.

ApiAuthentication

Es la información de autenticación necesaria para las llamadas a la API.

Campos
Campo de unión auth_config. Es la configuración de autenticación. auth_config puede ser solo uno de los parámetros siguientes:
api_key_config	ApiKeyConfig Es opcional. Es la configuración para la autenticación con clave de API.
oauth_config	OAuthConfig Es opcional. Es la configuración de OAuth.
service_agent_id_token_auth_config	ServiceAgentIdTokenAuthConfig Es opcional. Es la configuración para la autenticación con token de ID que se genera a partir del agente de servicio de CES.
service_account_auth_config	ServiceAccountAuthConfig Es opcional. Es la configuración para la autenticación de la cuenta de servicio.
bearer_token_config	BearerTokenConfig Es opcional. Es la configuración para la autenticación de token de portador.

ApiKeyConfig

Son las configuraciones para la autenticación con clave de API.

Campos
key_name	string Obligatorio. Es el nombre del parámetro o del encabezado de la clave de API. P. ej., Si la solicitud a la API es "https://example.com/act?X-Api-Key=", "X-Api-Key" sería el nombre del parámetro.
api_key_secret_version	string Obligatorio. Es el nombre del recurso de la versión secreta de Secret Manager que almacena la clave de API. Formato: projects/{project}/secrets/{secret}/versions/{version} Nota: Debes otorgar el rol roles/secretmanager.secretAccessor al agente de servicio de CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.
request_location	ApiKeyConfig.RequestLocation Obligatorio. Ubicación de la clave en la solicitud.

RequestLocation

Ubicación de la clave de API en la solicitud.

Enums
REQUEST_LOCATION_UNSPECIFIED	Sin especificar. No se debe usar este valor.
HEADER	Representa la clave en el encabezado HTTP.
QUERY_STRING	Representa la clave en la cadena de consulta.

App

Una app sirve como contenedor de nivel superior para un grupo de agentes, incluido el agente raíz y sus agentes secundarios, junto con sus configuraciones asociadas. Estos agentes trabajan juntos para lograr objetivos específicos dentro del contexto de la app.

Campos
name	string Es el identificador. Es el identificador único de la app. Formato: projects/{project}/locations/{location}/apps/{app}
display_name	string Obligatorio. Es el nombre visible de la app.
description	string Es opcional. Es la descripción de la app legible por humanos.
pinned	bool Es opcional. Indica si la app está fijada en la lista de apps.
root_agent	string Es opcional. El agente raíz es el punto de entrada de la app. Formato: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
language_settings	LanguageSettings Es opcional. Es la configuración de idioma de la app.
time_zone_settings	TimeZoneSettings Es opcional. Es la configuración de zona horaria de la app.
audio_processing_config	AudioProcessingConfig Es opcional. Es la configuración del procesamiento de audio de la app.
logging_settings	LoggingSettings Es opcional. Es la configuración de registros de la app.
error_handling_settings	ErrorHandlingSettings Es opcional. Es la configuración de manejo de errores de la app.
model_settings	ModelSettings Es opcional. Es la configuración predeterminada del modelo de LLM para la app. Los recursos individuales (p.ej., agentes y medidas de seguridad) pueden anular estas configuraciones según sea necesario.
tool_execution_mode	App.ToolExecutionMode Es opcional. Es el modo de ejecución de la herramienta para la app. Si no se proporciona, se usará PARALLEL de forma predeterminada.
evaluation_metrics_thresholds	EvaluationMetricsThresholds Es opcional. Son los umbrales de evaluación de la app.
variable_declarations[]	App.VariableDeclaration Es opcional. Son las declaraciones de las variables.
predefined_variable_declarations[]	App.VariableDeclaration Solo salida. Son las declaraciones de las variables predefinidas para la app.
global_instruction	string Es opcional. Son instrucciones para todos los agentes de la app. Puedes usar esta instrucción para configurar una identidad o personalidad estable en todos los agentes.
guardrails[]	string Es opcional. Es la lista de barreras de seguridad de la app. El formato es projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}.
data_store_settings	DataStoreSettings Es opcional. Es la configuración del almacén de datos de la app.
default_channel_profile	ChannelProfile Es opcional. Es el perfil de canal predeterminado que usa la app.
metadata	map<string, string> Es opcional. Son los metadatos sobre la app. Este campo se puede usar para almacenar información adicional relevante para los detalles de la app o los usos previstos.
create_time	Timestamp Solo salida. Es la marca de tiempo de cuando se creó la app.
update_time	Timestamp Solo salida. Marca de tiempo de la última actualización de la app.
etag	string Solo salida. Es el ETag que se usa para garantizar que el objeto no haya cambiado durante una operación de lectura, modificación y escritura. Si el ETag está vacío, la actualización reemplazará cualquier cambio simultáneo.
deployment_count	int32 Solo salida. Cantidad de implementaciones en la app.
client_certificate_settings	ClientCertificateSettings Es opcional. Es la configuración predeterminada del certificado de cliente para la app.
vpc_sc_settings	VpcScSettings Es opcional. Es la configuración de VPC-SC para la app.
locked	bool Es opcional. Indica si la app está bloqueada para realizar cambios. Si la app está bloqueada, se rechazarán las modificaciones en los recursos de la app.
validation_errors[]	string Solo salida. Advertencias o configuraciones incorrectas en la app
dashboard_settings	DashboardSettings Es opcional. Son los parámetros de configuración específicos de la aplicación para vincular y configurar los paneles de Contact Center Insights.

ToolExecutionMode

Define el comportamiento de ejecución de la herramienta si el agente selecciona varias herramientas al mismo tiempo.

Enums
TOOL_EXECUTION_MODE_UNSPECIFIED	Modo de ejecución de la herramienta sin especificar. El valor predeterminado es PARALLEL.
PARALLEL	Si se seleccionan varias herramientas, se ejecutarán en paralelo, con el mismo ToolContext.
SEQUENTIAL	Si se seleccionan varias herramientas, se ejecutarán de forma secuencial. La siguiente herramienta solo se ejecutará después de que se complete la anterior y pueda ver el ToolContext actualizado de la herramienta anterior.

VariableDeclaration

Define la estructura y los metadatos de una variable.

Campos
name	string Obligatorio. Es el nombre de la variable. El nombre debe comenzar con una letra o un guion bajo, y solo puede contener letras, números o guiones bajos.
description	string Obligatorio. Es la descripción de la variable.
schema	Schema Obligatorio. Es el esquema de la variable.

AppSnapshot

Es una instantánea de la app.

Campos
app	App Es opcional. Es la configuración básica de la app.
agents[]	Agent Es opcional. Es la lista de agentes en la app.
tools[]	Tool Es opcional. Es la lista de herramientas de la app.
examples[]	Example Es opcional. Es la lista de ejemplos en la app.
guardrails[]	Guardrail Es opcional. Es la lista de medidas de protección de la app.
toolsets[]	Toolset Es opcional. Es la lista de conjuntos de herramientas en la app.

AppVersion

En Paquete de interacción con los clientes (CES), una versión de la app es una instantánea de la app en un momento específico. Es inmutable y no se puede modificar una vez que se crea.

Campos
name	string Es el identificador. Es el identificador único de la versión de la app. Formato: projects/{project}/locations/{location}/apps/{app}/versions/{version}
display_name	string Es opcional. Es el nombre visible de la versión de la app.
description	string Es opcional. Es la descripción de la versión de la app.
creator	string Solo salida. Correo electrónico del usuario que creó la versión de la app.
create_time	Timestamp Solo salida. Es la marca de tiempo de cuando se creó la versión de la app.
snapshot	AppSnapshot Solo salida. Es la instantánea de la app cuando se crea la versión.
etag	string Solo salida. Es el ETag que se usa para garantizar que el objeto no haya cambiado durante una operación de lectura, modificación y escritura. Si el ETag está vacío, la actualización reemplazará cualquier cambio simultáneo.

AudioEncoding

AudioEncoding especifica el formato de codificación para los datos de audio.

Enums
AUDIO_ENCODING_UNSPECIFIED	Codificación de audio no especificada.
LINEAR16	Codificación de audio PCM lineal de 16 bits.
MULAW	Las muestras de 8 bits que comprimen las muestras de audio de 14 bits mediante la ley PCMU/mu-law de G.711.
ALAW	Las muestras de 8 bits que comprimen las muestras de audio de 14 bits con la ley PCMU/A-law de G.711.

AudioProcessingConfig

Es la configuración de cómo se debe procesar y entregar el audio de entrada y salida.

Campos
synthesize_speech_configs	map<string, SynthesizeSpeechConfig> Es opcional. Es la configuración de cómo se debe sintetizar la respuesta del agente, que asigna el código de idioma a SynthesizeSpeechConfig. Si no se encuentra la configuración para el código de idioma especificado, se usará la configuración para el código de idioma raíz. Por ejemplo, si el mapa contiene "en-us" y "en", y el código de idioma especificado es "en-gb", se usará la configuración "en". Nota: El código de idioma no distingue mayúsculas de minúsculas.
barge_in_config	BargeInConfig Es opcional. Configura el comportamiento del agente para las actividades de interrupción del usuario.
inactivity_timeout	Duration Es opcional. Es la duración de la inactividad del usuario (sin voz ni interacción) antes de que el agente le solicite que vuelva a participar. Si no se establece, el agente no le solicitará al usuario que vuelva a participar.
ambient_sound_config	AmbientSoundConfig Es opcional. Es la configuración del sonido ambiente que se reproducirá con la respuesta sintetizada del agente para mejorar la naturalidad de la conversación.

AudioRecordingConfig

Es la configuración de cómo se deben registrar las interacciones de audio.

Campos
gcs_bucket	string Es opcional. Bucket de Cloud Storage para almacenar las grabaciones de audio de la sesión. El URI debe comenzar con “gs://”. Elige una ubicación del bucket que cumpla con tus requisitos de residencia de datos. Nota: Si el bucket de Cloud Storage está en un proyecto diferente de la app, debes otorgar permiso de storage.objects.create al agente de servicio de CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.
gcs_path_prefix	string Es opcional. Es el prefijo de la ruta de acceso de Cloud Storage para las grabaciones de audio. Este prefijo puede incluir los siguientes marcadores de posición, que se sustituirán de forma dinámica en el momento de la publicación: - $project: ID del proyecto - $location: ubicación de la app - $app: ID de la app - $date: fecha de la sesión en formato YYYY-MM-DD - $session: ID de la sesión Si no se especifica el prefijo de ruta de acceso, se usará el prefijo predeterminado $project/$location/$app/$date/$session/.

BargeInConfig

Es la configuración sobre cómo se deben controlar las actividades de interrupción del usuario.

Campos
disable_barge_in (deprecated)	bool Este elemento está obsoleto. Es opcional. Obsoleto: disable_barge_in dejó de estar disponible y se reemplazó por disable_barge_in_control en ChannelProfile. Inhabilita la interrupción del usuario mientras el agente está hablando. Si es verdadero, se ignorará la entrada del usuario durante la reproducción de la respuesta del agente.
barge_in_awareness	bool Es opcional. Si está habilitada, el agente adaptará su próxima respuesta según la suposición de que el usuario no escuchó el mensaje anterior completo del agente. No se debe usar en situaciones en las que las respuestas del agente se muestran visualmente.

BatchDeleteConversationsRequest

Mensaje de solicitud para AgentService.BatchDeleteConversations.

Campos
parent	string Obligatorio. Es el nombre del recurso de la app de la que se borrarán las conversaciones. Formato: projects/{project}/locations/{location}/apps/{app}
conversations[]	string Obligatorio. Son los nombres de los recursos de las conversaciones que se borrarán.

BatchDeleteConversationsResponse

Mensaje de respuesta para AgentService.BatchDeleteConversations.

Campos
deleted_conversations[]	string Es la lista de conversaciones que se borraron correctamente.
failed_conversations[]	string Es la lista de conversaciones que no se pudieron borrar.
error_messages[]	string Es opcional. Es una lista de mensajes de error asociados a las conversaciones que no se pudieron borrar.

BearerTokenConfig

Son las configuraciones para la autenticación con un token del portador.

Campos
token	string Obligatorio. Es el token del portador. Debe tener el formato $context.variables.<name_of_variable>.

BidiSessionClientMessage

Es el mensaje de nivel superior que envía el cliente para el método SessionService.BidiRunSession.

Campos
Campo de unión message_type. El tipo de mensaje. message_type puede ser solo uno de los parámetros siguientes:
config	SessionConfig Es opcional. Es el mensaje de configuración inicial de la sesión.
realtime_input	SessionInput Es opcional. Es la entrada en tiempo real para la sesión.

BidiSessionServerMessage

Es el mensaje de nivel superior que muestra el método SessionService.BidiRunSession.

Campos
Campo de unión message_type. El tipo de mensaje. message_type puede ser solo uno de los parámetros siguientes:
session_output	SessionOutput Es opcional. Es el resultado del procesamiento del agente de CES.
recognition_result	RecognitionResult Es opcional. Es el resultado del reconocimiento de voz en tiempo real para la entrada de audio.
interruption_signal	InterruptionSignal Es opcional. Indica que se interrumpió la respuesta de audio del agente.
end_session	EndSession Es opcional. Indica que finalizó la sesión.
go_away	GoAway Es opcional. Indica que el servidor se desconectará pronto y que el cliente debe cerrar la conexión a medias y reiniciarla.

BigQueryExportSettings

Es la configuración para describir los comportamientos de la exportación de BigQuery para la app.

Campos
enabled	bool Es opcional. Indica si la exportación a BigQuery está habilitada.
project	string Es opcional. Es el ID del proyecto del conjunto de datos de BigQuery al que se exportarán los datos. Nota: Si el conjunto de datos de BigQuery se encuentra en un proyecto diferente al de la app, debes otorgar el rol roles/bigquery.admin al agente de servicio de CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.
dataset	string Es opcional. Es el ID del conjunto de datos de BigQuery al que se exportarán los datos.

BLOB

Representa una entrada o salida de BLOB en la conversación.

Campos
mime_type	string Obligatorio. Es el tipo de MIME estándar de IANA de los datos de origen.
data	bytes Obligatorio. Son los bytes sin procesar del BLOB.

Devolución de llamada

Una devolución de llamada define la lógica personalizada que se ejecutará en varias etapas de la interacción del agente.

Campos
description	string Es opcional. Es una descripción legible de la devolución de llamada.
disabled	bool Es opcional. Indica si la devolución de llamada está inhabilitada. El agente ignora las devoluciones de llamada inhabilitadas.
proactive_execution_enabled	bool Es opcional. Si está habilitada, la devolución de llamada también se ejecutará en los resultados intermedios del modelo. Este parámetro de configuración solo afecta a la devolución de llamada after model. Habilítalo con precaución. Por lo general, la devolución de llamada posterior al modelo solo debe ejecutarse después de recibir todas las respuestas del modelo. Habilitar la ejecución proactiva puede tener implicaciones negativas en el costo y la latencia de la ejecución, y solo debe habilitarse en situaciones excepcionales.
Campo de unión callback. Es la devolución de llamada que se ejecutará. callback puede ser solo uno de los parámetros siguientes:
python_code	string Obligatorio. Es el código de Python que se ejecutará para la devolución de llamada.

Registro de cambios

Los registros de cambios representan un cambio realizado en la app o en un recurso dentro de ella.

Campos
name	string Es el identificador. Es el identificador único del registro de cambios. Formato: projects/{project}/locations/{location}/apps/{app}/changelogs/{changelog}
author	string Solo salida. Dirección de correo electrónico del autor del cambio.
display_name	string Solo salida. Es el nombre visible del cambio. Por lo general, debe ser el nombre visible del recurso que se cambió.
description	string Solo salida. Es la descripción del cambio, que suele capturar los campos modificados en el recurso.
resource	string Solo salida. Es el recurso que se cambió.
resource_type	string Solo salida. Es el tipo de recurso que se modificó.
action	string Solo salida. Es la acción que se realizó en el recurso.
original_resource	Struct Solo salida. Es el recurso original antes del cambio.
new_resource	Struct Solo salida. Es el recurso nuevo después del cambio.
dependent_resources[]	Struct Solo salida. Son los recursos dependientes que se modificaron.
create_time	Timestamp Solo salida. Fecha y hora en que se realizó el cambio.
sequence_number	int64 Solo salida. Es el número de secuencia del registro de cambios, que aumenta de forma monótona.

ChannelProfile

Un ChannelProfile configura el comportamiento del agente para un canal de comunicación específico, como la IU web o la telefonía.

Campos
profile_id	string Es opcional. Es el identificador único del perfil del canal.
channel_type	ChannelProfile.ChannelType Es opcional. Es el tipo de perfil del canal.
persona_property	ChannelProfile.PersonaProperty Es opcional. Es la propiedad de arquetipo del perfil del canal.
web_widget_config	ChannelProfile.WebWidgetConfig Es opcional. Es la configuración del widget web.
whatsapp_config	ChannelProfile.WhatsAppConfig Es opcional. Es la configuración específica de las implementaciones de WhatsApp.
instagram_config	ChannelProfile.InstagramConfig Es opcional. Es la configuración específica para las implementaciones de Instagram.
disable_dtmf	bool Es opcional. Indica si se debe inhabilitar la señalización multifrecuencia de dos tonos (DTMF).
disable_barge_in_control	bool Es opcional. Indica si se debe inhabilitar el control de interrupción del usuario en la conversación. - true: Las interrupciones del usuario se inhabilitan mientras el agente está hablando. - false: El agente conserva el control automático sobre cuándo puede interrumpir el usuario.
noise_suppression_level	string Es opcional. Es el nivel de reducción de ruido del perfil del canal. Los valores disponibles son "low", "moderate", "high" y "very_high".

ChannelType

Es el tipo de perfil del canal.

Enums
UNKNOWN	Tipo de canal desconocido.
WEB_UI	Es el canal de la IU web.
API	Canal de API
TWILIO	Canal de Twilio.
GOOGLE_TELEPHONY_PLATFORM	Canal de la Plataforma de Telefonía de Google
CONTACT_CENTER_AS_A_SERVICE	Canal de centro de contacto como servicio (CCaaS).
CONTACT_CENTER_AS_A_SERVICE_CHAT	Canal de centro de contacto como servicio (CCaaS Chat).
FIVE9	Canal de Five9
CONTACT_CENTER_INTEGRATION	Canal de integración de centros de contacto de terceros.
WHATSAPP	Canal de WhatsApp
INSTAGRAM	Canal de Instagram

InstagramConfig

Es la configuración específica para las implementaciones de Instagram.

Campos
instagram_account_id	string Obligatorio. Es el ID de la cuenta de Instagram.
display_name	string Solo salida. Es el nombre de la página comercial de Meta recuperada.
thumbnail_url	string Solo salida. Es la URL de la miniatura del perfil de la empresa de Meta recuperada.
description	string Solo salida. Es la descripción del perfil o la página comercial de Meta.

PersonaProperty

Representa la propiedad de arquetipo de un canal.

Campos
persona	ChannelProfile.PersonaProperty.Persona Es opcional. La personalidad del canal

Personificación

La personalidad del canal

Enums
UNKNOWN	Arquetipo DESCONOCIDO.
CONCISE	El agente mantiene las respuestas concisas y específicas.
CHATTY	El agente proporciona contexto, explicaciones y detalles adicionales.

WebWidgetConfig

Es el mensaje de configuración del widget web.

Campos
modality	ChannelProfile.WebWidgetConfig.Modality Es opcional. Es la modalidad del widget web.
theme	ChannelProfile.WebWidgetConfig.Theme Es opcional. Es el tema del widget web.
web_widget_title	string Es opcional. Es el título del widget web.
security_settings	ChannelProfile.WebWidgetConfig.SecuritySettings Es opcional. Es la configuración de seguridad del widget web.

Modalidad

Modalidad del widget web.

Enums
MODALITY_UNSPECIFIED	Modalidad desconocida.
CHAT_AND_VOICE	El widget admite la entrada de voz y chat.
VOICE_ONLY	El widget solo admite entrada de voz.
CHAT_ONLY	El widget solo admite la entrada de chat.
CHAT_VOICE_AND_VIDEO	El widget admite la entrada de chat, voz y video.

SecuritySettings

Es la configuración de seguridad del widget web.

Campos
enable_public_access	bool Es opcional. Indica si está habilitado el acceso público al widget web. Si es true, el widget web será de acceso público. Si es false, el widget web debe integrarse con tu propio sistema de autenticación y autorización para devolver credenciales válidas para acceder al agente de CES.
enable_origin_check	bool Es opcional. Indica si la verificación de origen del widget web está habilitada. Si es true, el widget web verificará el origen del sitio web que carga el widget web y solo permitirá que se cargue en el mismo origen o en cualquiera de los orígenes permitidos.
allowed_origins[]	string Es opcional. Son los orígenes que pueden alojar el widget web. Un origen se define en el RFC 6454. Si está vacío, se permiten todos los orígenes. Se permite un máximo de 100 orígenes. Ejemplo: "https://example.com"
enable_recaptcha	bool Es opcional. Indica si está habilitada la verificación de reCAPTCHA para el widget web.

Tema

Es el tema del widget web.

Enums
THEME_UNSPECIFIED	Tema desconocido.
LIGHT	Tema claro
DARK	Tema oscuro

WhatsAppConfig

Es la configuración específica de las implementaciones de WhatsApp.

Campos
waba_id	string Obligatorio. Es el ID de la cuenta de WhatsApp Business.
phone_number_id	string Obligatorio. Es el ID del número de teléfono de Meta.
phone_number	string Es opcional. Número de teléfono en formato E.164.
display_name	string Solo salida. Es el nombre de la página comercial de Meta recuperada.
thumbnail_url	string Solo salida. Es la URL de la miniatura del perfil de la empresa de Meta recuperada.
description	string Solo salida. Es la descripción del perfil o la página comercial de Meta.

Fragmento

Es un fragmento de contenido dentro de un mensaje.

Campos
Campo de unión data. Datos de fragmentos data puede ser solo uno de los parámetros siguientes:
text	string Es opcional. Datos de texto.
transcript	string Es opcional. Es la transcripción asociada al audio.
blob	Blob Es opcional. Son los datos del BLOB.
payload	Struct Es opcional. Son los datos de la carga útil personalizada.
image	Image Es opcional. Son los datos de la imagen.
tool_call	ToolCall Es opcional. Es la solicitud de ejecución de la herramienta.
tool_response	ToolResponse Es opcional. Es la respuesta de la ejecución de la herramienta.
agent_transfer	AgentTransfer Es opcional. Es el evento de transferencia del agente.
updated_variables	Struct Un struct representa las variables que se actualizaron en la conversación, con claves según los nombres de las variables.
default_variables	Struct Un struct representa variables predeterminadas al inicio de la conversación, con claves según los nombres de las variables.

Citas

Son las citas asociadas con la respuesta del agente.

Campos
cited_chunks[]	Citations.CitedChunk Lista de fragmentos de información citados.

CitedChunk

Es un fragmento de información citado.

Campos
uri	string Es el URI que se usa para la cita.
title	string Es el título del documento citado.
text	string Texto que se usa para la cita.
requires_attribution	bool Indica si esta cita requiere que se muestre la atribución a los usuarios finales.

ClientCertificateSettings

Es la configuración de los certificados de cliente personalizados.

Campos
tls_certificate	string Obligatorio. Certificado TLS codificado en formato PEM. Esta cadena debe incluir las líneas de encabezado de inicio y pie de página de finalización.
private_key	string Obligatorio. Es el nombre del recurso de la versión secreta de Secret Manager que almacena la clave privada codificada en formato PEM. Formato: projects/{project}/secrets/{secret}/versions/{version}
passphrase	string Es opcional. Es el nombre del recurso de la versión secreta de Secret Manager que almacena la frase de contraseña para desencriptar la clave privada. Se debe dejar sin configurar si la clave privada no está encriptada. Formato: projects/{project}/secrets/{secret}/versions/{version}

ClientFunction

Representa una función del cliente que el agente puede invocar. Cuando el agente elige la herramienta, el control se transfiere al cliente. El cliente es responsable de ejecutar la función y devolver el resultado como un ToolResponse para continuar la interacción con el agente.

Campos
name	string Obligatorio. Es el nombre de la función.
description	string Es opcional. Es la descripción de la función.
parameters	Schema Es opcional. Es el esquema de los parámetros de la función.
response	Schema Es opcional. Es el esquema de la respuesta de la función.

CloudLoggingSettings

Es la configuración para describir el comportamiento de Cloud Logging para la app.

Campos
enable_cloud_logging	bool Es opcional. Indica si se debe habilitar Cloud Logging para las sesiones.

CodeBlock

Es un bloque de código que se ejecutará en lugar de una llamada a herramienta real.

Campos

python_code

string Obligatorio. Código de Python que se invocará en el modo simulado de la herramienta. Firma de función de Python esperada: Para detectar todas las llamadas a herramientas: def fake_tool_call(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: Para detectar una llamada a herramienta específica: def fake_{tool_id}(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: Si la función devuelve None, se invocará la herramienta real.

ConnectorTool

Un ConnectorTool permite conexiones a diferentes integraciones. Consulta: https://cloud.google.com/integration-connectors/docs/overview.

Campos
connection	string Obligatorio. Es el nombre completo del recurso de la conexión de Integration Connectors a la que se hace referencia. Formato: projects/{project}/locations/{location}/connections/{connection}
action	Action Obligatorio. Es la acción que debe usar la herramienta.
auth_config	EndUserAuthConfig Es opcional. Configura cómo se controla la autenticación en Integration Connectors. De forma predeterminada, se pasa una autenticación de administrador en las solicitudes a la API de Integration Connectors. Puedes anularla con otra configuración de autenticación del usuario final. Nota: La conexión debe tener habilitada la anulación de autenticación para especificar una configuración de EUC aquí. De lo contrario, fallará la creación de ConnectorTool. Consulta https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override para obtener más detalles.
name	string Es opcional. Es el nombre de la herramienta que puede usar el agente para decidir si llama a este ConnectorTool.
description	string Es opcional. Es la descripción de la herramienta que puede usar el agente para decidir si debe llamar a este ConnectorTool.

ConnectorToolset

Es un conjunto de herramientas que genera herramientas a partir de una conexión de Integration Connectors.

Campos
connection	string Obligatorio. Es el nombre completo del recurso de la conexión de Integration Connectors a la que se hace referencia. Formato: projects/{project}/locations/{location}/connections/{connection}
auth_config	EndUserAuthConfig Es opcional. Configura cómo se controla la autenticación en Integration Connectors. De forma predeterminada, se pasa una autenticación de administrador en las solicitudes a la API de Integration Connectors. Puedes anularla con otra configuración de autenticación del usuario final. Nota: La conexión debe tener habilitada la anulación de autenticación para especificar una configuración de EUC aquí. De lo contrario, fallará la creación del conjunto de herramientas. Consulta: https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override
connector_actions[]	Action Obligatorio. Es la lista de acciones de conectores o de operaciones de entidades para las que se generarán herramientas.

Conversación

Una conversación representa una interacción entre un usuario final y la app de CES.

Campos
name	string Es el identificador. Es el identificador único de la conversación. Formato: projects/{project}/locations/{location}/apps/{app}/conversations/{conversation}
start_time	Timestamp Solo salida. Es la marca de tiempo de cuando se creó la conversación.
end_time	Timestamp Solo salida. Es la marca de tiempo en la que se completó la conversación.
turns[]	Conversation.Turn Obligatorio. Los turnos de la conversación.
turn_count	int32 Solo salida. Es la cantidad de turnos en la conversación.
channel_type (deprecated)	Conversation.ChannelType Este elemento está obsoleto. OBSOLETO. En su lugar, usa input_types.
source	Conversation.Source Solo salida. Indica la fuente de la conversación.
input_types[]	Conversation.InputType Solo salida. Son los tipos de entrada de la conversación.
entry_agent	string Solo salida. Es el agente que inicialmente maneja la conversación. Si no se especifica, el agente raíz controla la conversación. Formato: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
deployment	string Solo salida. Es la implementación de la app que se usa para procesar la conversación. Formato: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
app_version	string Solo salida. Es la versión de la app que se usa para procesar la conversación. Formato: projects/{project}/locations/{location}/apps/{app}/versions/{version}
language_code	string Solo salida. Es el código de idioma de la conversación.
messages[] (deprecated)	Message Este elemento está obsoleto. Obsoleto. En su lugar, usa turnos.

ChannelType

Es el tipo de canal de la conversación.

Enums
CHANNEL_TYPE_UNSPECIFIED	Es un tipo de canal sin especificar.
TEXT	La conversación solo contiene mensajes de texto entre el usuario final y el agente.
AUDIO	La conversación contiene mensajes de audio entre el usuario final y el agente.
MULTIMODAL	Son los mensajes multimodales de la conversación (p.ej., imágenes) entre el usuario final y el agente.

InputType

Es el tipo de mensaje de entrada.

Enums
INPUT_TYPE_UNSPECIFIED	Tipo de entrada sin especificar.
INPUT_TYPE_TEXT	Es la entrada de texto.
INPUT_TYPE_EVENT	Es la entrada del evento.
INPUT_TYPE_AUDIO	Entrada de audio.
INPUT_TYPE_IMAGE	Es la entrada de imagen.
INPUT_TYPE_BLOB	Es la entrada del BLOB.
INPUT_TYPE_TOOL_RESPONSE	Es la entrada de respuesta de la herramienta de función del cliente.
INPUT_TYPE_VARIABLES	Son las variables de entrada.

Fuente

Es la fuente de la conversación.

Enums
SOURCE_UNSPECIFIED	Fuente no especificada.
LIVE	La conversación es del usuario final en vivo.
SIMULATOR	La conversación es del simulador.
EVAL	La conversación es de la evaluación.
AGENT_TOOL	La conversación proviene de una herramienta del agente. La herramienta del agente ejecuta el agente en una sesión separada, que se conserva para fines de prueba y depuración.

Turno

Toda la información sobre un solo turno en la conversación.

Campos
messages[]	Message Es opcional. Lista de mensajes en el turno de conversación, incluidas las entradas del usuario, las respuestas del agente y los eventos intermedios durante el procesamiento.
root_span	Span Es opcional. Es el intervalo raíz del procesamiento de la acción.
user_intended_text	string Es opcional. Texto de verdad fundamental previsto del llamador simulado (Polysynth). Solo se propaga cuando se habilitan las métricas de la tasa de error de palabras.

ConversationLoggingSettings

Es la configuración para describir los comportamientos de registro de conversaciones de la app.

Campos
disable_conversation_logging	bool Es opcional. Indica si se debe inhabilitar el registro de conversaciones para las sesiones.
retention_window	Duration Es opcional. Controla el período de retención de la conversación. Si no se configura, la conversación se conservará durante 365 días.

CreateAgentRequest

Mensaje de solicitud para AgentService.CreateAgent.

Campos
parent	string Obligatorio. Es el nombre del recurso de la app en la que se creará un agente.
agent_id	string Es opcional. Es el ID que se usará para el agente, que se convertirá en el componente final del nombre del recurso del agente. Si no se proporciona, se asignará automáticamente un ID único para el agente.
agent	Agent Obligatorio. El agente que se creará.

CreateAppRequest

Mensaje de solicitud para AgentService.CreateApp.

Campos
parent	string Obligatorio. Es el nombre del recurso de la ubicación en la que se creará la app.
app_id	string Es opcional. Es el ID que se usará para la app, que se convertirá en el componente final del nombre del recurso de la app. Si no se proporciona, se asignará automáticamente un ID único para la app.
app	App Obligatorio. Es la app que se creará.

CreateAppVersionRequest

Mensaje de solicitud para AgentService.CreateAppVersion

Campos
parent	string Obligatorio. Es el nombre del recurso de la app en la que se creará una versión.
app_version_id	string Es opcional. Es el ID que se usará para la versión de la app, que se convertirá en el componente final del nombre del recurso de la versión de la app. Si no se proporciona, se asignará automáticamente un ID único para la versión de la app.
app_version	AppVersion Obligatorio. Es la versión de la app que se creará.

CreateDeploymentRequest

Mensaje de solicitud para AgentService.CreateDeployment.

Campos
parent	string Obligatorio. Es la app principal. El formato es projects/{project}/locations/{location}/apps/{app}.
deployment_id	string Es opcional. Es el ID que se usará para la implementación, que se convertirá en el componente final del nombre del recurso de la implementación. Si no se proporciona, se asignará automáticamente un ID único para la implementación.
deployment	Deployment Obligatorio. Es la implementación que se creará.

CreateExampleRequest

Mensaje de solicitud para AgentService.CreateExample.

Campos
parent	string Obligatorio. Es el nombre del recurso de la app en la que se creará un ejemplo.
example_id	string Es opcional. Es el ID que se usará para el ejemplo, que se convertirá en el componente final del nombre del recurso del ejemplo. Si no se proporciona, se asignará automáticamente un ID único para el ejemplo.
example	Example Obligatorio. Es el ejemplo que se creará.

CreateGuardrailRequest

Mensaje de solicitud para AgentService.CreateGuardrail.

Campos
parent	string Obligatorio. Es el nombre del recurso de la app en la que se creará una protección.
guardrail_id	string Es opcional. Es el ID que se usará para la protección, que se convertirá en el componente final del nombre del recurso de la protección. Si no se proporciona, se asignará automáticamente un ID único para la protección.
guardrail	Guardrail Obligatorio. Es la protección que se creará.

CreateToolRequest

Mensaje de solicitud para AgentService.CreateTool.

Campos
parent	string Obligatorio. Es el nombre del recurso de la app en la que se creará una herramienta.
tool_id	string Es opcional. Es el ID que se usará para la herramienta, que se convertirá en el componente final del nombre del recurso de la herramienta. Si no se proporciona, se asignará automáticamente un ID único para la herramienta.
tool	Tool Obligatorio. Es la herramienta que se creará.

CreateToolsetRequest

Mensaje de solicitud para AgentService.CreateToolset.

Campos
parent	string Obligatorio. Es el nombre del recurso de la app en la que se creará el conjunto de herramientas.
toolset_id	string Es opcional. Es el ID que se usará para el conjunto de herramientas, que se convertirá en el componente final del nombre del recurso del conjunto de herramientas. Si no se proporciona, se asignará automáticamente un ID único para el conjunto de herramientas.
toolset	Toolset Obligatorio. Es el conjunto de herramientas que se creará.

DashboardSettings

Es la configuración de los paneles asociados con la app que aparecen en la vista Supervisión.

Campos
default_dashboard	string Es opcional. Es el nombre del recurso del panel predeterminado de Contact Center Insights asociado a la app. Este es el panel que se mostrará cuando los usuarios naveguen a la vista Supervisión de la app. Formato: projects/{project}/locations/{location}/dashboards/{dashboard}

DataStore

Es un recurso de DataStore en Vertex AI Search.

Campos
name	string Obligatorio. Es el nombre completo del recurso de DataStore. Formato: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}
type	DataStore.DataStoreType Solo salida. Es el tipo de almacén de datos. Este campo es de solo lectura y el servidor lo completa.
document_processing_mode	DataStore.DocumentProcessingMode Solo salida. Modo de procesamiento de documentos para la conexión del almacén de datos. Solo se configura para los almacenes de datos PUBLIC_WEB y UNSTRUCTURED.
display_name	string Solo salida. Es el nombre visible del almacén de datos.
create_time	Timestamp Solo salida. Es la marca de tiempo de cuando se creó el almacén de datos.
connector_config	DataStore.ConnectorConfig Solo salida. Es la configuración del conector para la conexión del almacén de datos.

ConnectorConfig

Es la configuración del conector para la conexión del almacén de datos.

Campos
collection	string Es el nombre del recurso de la colección a la que pertenece el almacén de datos.
collection_display_name	string Es el nombre visible de la colección a la que pertenece el almacén de datos.
data_source	string Es el nombre de la fuente de datos. Ejemplo: salesforce, jira, confluence, bigquery.

DataStoreType

Es el tipo de almacén de datos.

Enums
DATA_STORE_TYPE_UNSPECIFIED	No especificado. Este valor indica que no se especificó el tipo de almacén de datos, por lo que no se usará durante la búsqueda.
PUBLIC_WEB	Es un almacén de datos que contiene contenido web público.
UNSTRUCTURED	Es un almacén de datos que contiene datos privados no estructurados.
FAQ	Es un almacén de datos que contiene datos estructurados que se usan como preguntas frecuentes.
CONNECTOR	Es un almacén de datos que es un conector a un servicio de origen o de terceros.

DocumentProcessingMode

Es el modo de procesamiento de documentos del almacén de datos.

Enums
DOCUMENT_PROCESSING_MODE_UNSPECIFIED	No especificado.
DOCUMENTS	Los documentos se procesan como documentos.
CHUNKS	Los documentos se convierten en fragmentos.

DataStoreSettings

Es la configuración relacionada con el almacén de datos de la app.

Campos
engines[]	DataStoreSettings.Engine Solo salida. Son los motores de la app.

Motor

Es un motor al que se conectan los almacenes de datos. Consulta Vertex AI Search: https://cloud.google.com/generative-ai-app-builder/docs/enterprise-search-introduction.

Campos
name	string Solo salida. Es el nombre del recurso del motor. Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}
type	DataStoreSettings.Engine.Type Solo salida. Es el tipo de motor.

Tipo

Es el tipo de motor. Consulta la documentación disponible en https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1/SolutionType y https://cloud.google.com/generative-ai-app-builder/docs/create-datastore-ingest.

Enums
TYPE_UNSPECIFIED	Tipo de motor sin especificar.
ENGINE_TYPE_SEARCH	Es el motor SOLUTION_TYPE_SEARCH de la app. Todos los almacenes de datos del conector que se agreguen a la app se agregarán a este motor.
ENGINE_TYPE_CHAT	Es el tipo de motor de chat. Es el motor SOLUTION_TYPE_CHAT de la app. Todos los almacenes de datos del conector que se agreguen a la app se agregarán a este motor.

DataStoreTool

Es una herramienta para recuperar datos del almacén de datos o el motor de Vertex AI Search para la fundamentación. Acepta un almacén de datos o un motor, pero no ambos. Consulta Vertex AI Search: https://cloud.google.com/generative-ai-app-builder/docs/enterprise-search-introduction.

Campos
name	string Obligatorio. Es el nombre de la herramienta del almacén de datos.
description	string Es opcional. Es la descripción de la herramienta.
boost_specs[]	DataStoreTool.BoostSpecs Es opcional. Mejora la especificación para destacar ciertos documentos.
modality_configs[]	DataStoreTool.ModalityConfig Es opcional. Es la configuración de modalidad del almacén de datos.
filter_parameter_behavior	DataStoreTool.FilterParameterBehavior Es opcional. Es el comportamiento del parámetro de filtro.
Campo de unión search_source. Define la fuente de búsqueda, ya sea un solo DataStore o un Engine. search_source puede ser solo uno de los parámetros siguientes:
data_store_source	DataStoreTool.DataStoreSource Es opcional. Realiza búsquedas en un solo DataStore específico.
engine_source	DataStoreTool.EngineSource Es opcional. Realiza búsquedas dentro de un motor (potencialmente en varios almacenes de datos).

BoostSpec

Mejora la especificación para destacar ciertos documentos.

Campos
condition_boost_specs[]	DataStoreTool.BoostSpec.ConditionBoostSpec Obligatorio. Es una lista de especificaciones de potenciación.

ConditionBoostSpec

Es la especificación de refuerzo para una condición.

Campos
condition	string Obligatorio. Es una expresión que especifica una condición de refuerzo. La sintaxis es la misma que la de la expresión de filtro. Actualmente, la única condición admitida es una lista de códigos de idioma BCP-47. Ejemplo: Para potenciar las sugerencias en los idiomas en o fr: (lang_code: ANY("en", "fr"))
boost	float Es opcional. Es la intensidad del boosting, que debe estar en el intervalo [-1, 1]. El boosting negativo significa un descenso de nivel. El valor predeterminado es 0.0. Si se establece en 1.0, las sugerencias reciben una gran promoción. Sin embargo, esto no significa necesariamente que el primer resultado será una sugerencia mejorada. Si se establece en -1.0, las sugerencias recibirán un gran descenso. Sin embargo, es posible que se sigan mostrando otras sugerencias pertinentes. Si se establece en 0.0, no se aplica ningún aumento. Se ignora la condición de refuerzo.
boost_control_spec	DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec Es opcional. Es una especificación compleja para la clasificación personalizada basada en el valor del atributo definido por el cliente.

BoostControlSpec

Es la especificación para la clasificación personalizada basada en el valor del atributo especificado por el cliente. Proporciona más controles para la clasificación personalizada que la combinación simple (condición, refuerzo) anterior.

Campos
field_name	string Es opcional. Nombre del campo cuyo valor se usará para determinar el importe del aumento.
attribute_type	DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec.AttributeType Es opcional. Es el tipo de atributo que se usará para determinar el importe del aumento. El valor del atributo se puede derivar del valor del campo field_name especificado. En el caso de los valores numéricos, es sencillo, es decir, attribute_value = numerical_field_value. Sin embargo, en el caso de la actualización, attribute_value = (time.now() - datetime_field_value).
interpolation_type	DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec.InterpolationType Es opcional. Es el tipo de interpolación que se aplicará para conectar los puntos de control que se indican a continuación.
control_points[]	DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPoint Es opcional. Son los puntos de control que se usan para definir la curva. La función monotónica (definida a través de interpolation_type más arriba) pasa por los puntos de control que se indican aquí.

AttributeType

Es el atributo(o la función) para el que se aplicará la clasificación personalizada.

Enums
ATTRIBUTE_TYPE_UNSPECIFIED	AttributeType no especificado.
NUMERICAL	El valor del campo numérico se usará para actualizar de forma dinámica el importe del aumento. En este caso, el attribute_value (el valor de X) del punto de control será el valor real del campo numérico para el que se especifica boost_amount.
FRESHNESS	En el caso de uso de la actualización, el valor del atributo será la duración entre la hora actual y la fecha especificada en el campo de fecha y hora. El valor debe tener el formato de un valor dayTimeDuration de XSD (un subconjunto restringido de un valor de duración ISO 8601). El patrón para esto es: [nD][T[nH][nM][nS]]. p. ej., 5D, 3DT12H30M, T24H

ControlPoint

Son los puntos de control que se usan para definir la curva. La curva definida a través de estos puntos de control solo puede aumentar o disminuir de forma monotónica(se aceptan valores constantes).

Campos
attribute_value	string Es opcional. Puede ser uno de los siguientes: 1. Es el valor del campo numérico. 2. Especificación de duración para la actualización: El valor debe tener el formato de un valor dayTimeDuration de XSD (un subconjunto restringido de un valor de duración ISO 8601). El patrón para esto es: [nD][T[nH][nM][nS]].
boost_amount	float Es opcional. Valor entre -1 y 1 según el cual se aumentará la puntuación si el atributo attribute_value se evalúa como el valor especificado anteriormente.

InterpolationType

Es el tipo de interpolación que se aplicará. El valor predeterminado será lineal (lineal por partes).

Enums
INTERPOLATION_TYPE_UNSPECIFIED	No se especificó el tipo de interpolación. En este caso, se establece de forma predeterminada en lineal.
LINEAR	Se aplicará la interpolación lineal por partes.

BoostSpecs

Mejora las especificaciones para destacar ciertos documentos. Para obtener más información, consulta https://cloud.google.com/generative-ai-app-builder/docs/boosting.

Campos
data_stores[]	string Obligatorio. Es el almacén de datos en el que se aplica la configuración de potenciación. Es el nombre completo del recurso de DataStore, como projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}.
spec[]	DataStoreTool.BoostSpec Obligatorio. Es una lista de especificaciones de potenciación.

DataStoreSource

Es la configuración para buscar dentro de un DataStore específico.

Campos
filter	string Es opcional. Es la especificación del filtro para el DataStore. Consulta: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata
data_store	DataStore Es opcional. Es el almacén de datos.

EngineSource

Es la configuración para buscar dentro de un motor, que potencialmente se orienta a DataStores específicos.

Campos
engine	string Obligatorio. Es el nombre completo del recurso del motor. Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}
data_store_sources[]	DataStoreTool.DataStoreSource Es opcional. Se usa para segmentar DataStores específicos dentro del motor. Si está vacío, la búsqueda se aplica a todos los almacenes de datos asociados con el motor.
filter	string Es opcional. Es un filtro que se aplica a la búsqueda en el motor. No es relevante y no se usa si se proporciona "data_store_sources". Consulta: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata

FilterParameterBehavior

Comportamiento del parámetro de filtro.

Enums
FILTER_PARAMETER_BEHAVIOR_UNSPECIFIED	Es el comportamiento predeterminado del filtro. Se incluye el filtro de inclusión para los almacenes de datos del conector. Para el resto de los tipos de almacenes de datos, se omite el parámetro de entrada del filtro.
ALWAYS_INCLUDE	Siempre incluye el parámetro de filtro para todos los tipos de almacenes de datos.
NEVER_INCLUDE	El parámetro de filtro nunca se incluye en la lista de parámetros de la herramienta, independientemente del tipo de almacén de datos.

GroundingConfig

Es la configuración de fundamentación.

Campos
grounding_level	float Es opcional. Es el umbral de fundamentación de la respuesta según las fuentes recuperadas. El valor tiene un rango configurable de [1, 5]. El nivel se usa para establecer un umbral de fundamentación de la respuesta, lo que significa que todas las respuestas con una puntuación de fundamentación inferior al umbral recurrirán a mostrar solo fragmentos pertinentes. Por ejemplo, un nivel de 3 significa que la puntuación de fundamentación debe ser 3 o más para que se muestre la respuesta.
disabled	bool Es opcional. Indica si la fundamentación está inhabilitada.

ModalityConfig

Si se especifica, se aplicará la configuración determinada para la modalidad especificada.

Campos
modality_type	DataStoreTool.ModalityConfig.ModalityType Obligatorio. Es el tipo de modalidad.
rewriter_config	DataStoreTool.RewriterConfig Es opcional. Es la configuración del reescritor.
summarization_config	DataStoreTool.SummarizationConfig Es opcional. Es la configuración del resumen.
grounding_config	DataStoreTool.GroundingConfig Es opcional. Es la configuración de fundamentación.
snippets_config	DataStoreTool.SnippetsConfig Es opcional. Es la configuración de los fragmentos.

ModalityType

Es el tipo de modalidad.

Enums
MODALITY_TYPE_UNSPECIFIED	Tipo de modalidad sin especificar.
TEXT	Modalidad de texto.
AUDIO	Modalidad de audio.

RewriterConfig

Es la configuración del reescritor.

Campos
model_settings	ModelSettings Obligatorio. Es la configuración del modelo de LLM.
prompt	string Es opcional. Es la definición de la instrucción. Si no se establece, se usará la instrucción predeterminada.
disabled	bool Es opcional. Indica si el reescritor está inhabilitado.

SnippetsConfig

Es la configuración de los fragmentos.

Campos
enable_snippets	bool Es opcional. Indica si los fragmentos están habilitados.
max_snippets	int32 Es opcional. Es la cantidad de resúmenes que se mostrarán por búsqueda. Si no se establece, se muestran todos los resúmenes del servicio de forma predeterminada.

SummarizationConfig

Es la configuración del resumen.

Campos
model_settings	ModelSettings Es opcional. Es la configuración del modelo de LLM.
prompt	string Es opcional. Es la definición de la instrucción. Si no se establece, se usará la instrucción predeterminada.
disabled	bool Es opcional. Indica si el resumen está inhabilitado.

DeleteAgentRequest

Mensaje de solicitud para AgentService.DeleteAgent.

Campos
name	string Obligatorio. Es el nombre del recurso del agente que se borrará.
force	bool Es opcional. Indica si se debe borrar el agente de forma forzosa, incluso si otros ejemplos, agentes o apps aún hacen referencia a él. Si es force = false, la eliminación falla si otros agentes o ejemplos hacen referencia a él. Si es force = true, borra el agente y quítalo de todas las apps, los agentes y los ejemplos que lo referencian.
etag	string Es opcional. Es la ETag actual del agente. Si no se proporciona un ETag, el borrado reemplazará cualquier cambio simultáneo. Si se proporciona una ETag y no coincide con la ETag actual del agente, se bloqueará el borrado y se devolverá un error ABORTED.

DeleteAppRequest

Mensaje de solicitud para AgentService.DeleteApp.

Campos
name	string Obligatorio. Es el nombre del recurso de la app que se borrará.
etag	string Es opcional. Es la ETag actual de la app. Si no se proporciona una ETag, el borrado sobrescribirá cualquier cambio simultáneo. Si se proporciona una ETag y no coincide con la ETag actual de la app, se bloqueará el borrado y se devolverá un error ABORTED.

DeleteAppVersionRequest

Mensaje de solicitud para AgentService.DeleteAppVersion.

Campos
name	string Obligatorio. Es el nombre del recurso de la versión de la app que se borrará.
etag	string Es opcional. Es la ETag actual de la versión de la app. Si no se proporciona un ETag, el borrado reemplazará cualquier cambio simultáneo. Si se proporciona una ETag y no coincide con la ETag actual de la versión de la app, se bloqueará el borrado y se devolverá un error ABORTED.

DeleteConversationRequest

Mensaje de solicitud para AgentService.DeleteConversation.

Campos
name	string Obligatorio. Es el nombre del recurso de la conversación que se borrará.
source (deprecated)	Conversation.Source Este elemento está obsoleto. Es opcional. Indica la fuente de la conversación. Si no se configura, se aplicará Source.Live de forma predeterminada.

DeleteDeploymentRequest

Mensaje de solicitud para AgentService.DeleteDeployment.

Campos
name	string Obligatorio. Es el nombre de la implementación que se borrará. Formato: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
etag	string Es opcional. Es el ETag de la implementación. Si se proporciona una ETag y no coincide con la ETag actual de la implementación, se bloqueará el borrado y se devolverá un error ABORTED.

DeleteExampleRequest

Mensaje de solicitud para AgentService.DeleteExample.

Campos
name	string Obligatorio. Es el nombre del recurso del ejemplo que se borrará.
etag	string Es opcional. Es la ETag actual del ejemplo. Si no se proporciona un ETag, el borrado reemplazará cualquier cambio simultáneo. Si se proporciona una ETag y no coincide con la ETag actual del ejemplo, se bloqueará el borrado y se devolverá un error ABORTED.

DeleteGuardrailRequest

Mensaje de solicitud para AgentService.DeleteGuardrail.

Campos
name	string Obligatorio. Es el nombre del recurso de la protección que se borrará.
force	bool Es opcional. Indica si se debe borrar de forma forzosa la protección, incluso si la app o los agentes aún hacen referencia a ella. Si es force = false, la eliminación falla si alguna app o agente aún hace referencia a la protección. Si es force = true, se quitarán todas las referencias existentes de las apps o los agentes, y se borrará la protección.
etag	string Es opcional. Es la ETag actual de la protección. Si no se proporciona un ETag, el borrado reemplazará cualquier cambio simultáneo. Si se proporciona una ETag y no coincide con la ETag actual de la protección, se bloqueará el borrado y se devolverá un error ABORTED.

DeleteToolRequest

Mensaje de solicitud para AgentService.DeleteTool.

Campos
name	string Obligatorio. Es el nombre del recurso de la herramienta que se borrará.
force	bool Es opcional. Indica si se debe borrar la herramienta de forma forzada, incluso si los agentes o los ejemplos aún hacen referencia a ella. Si es force = false, la eliminación fallará si algún agente aún hace referencia a la herramienta. Si es force = true, se quitarán todas las referencias existentes de los agentes y se borrará la herramienta.
etag	string Es opcional. Es la ETag actual de la herramienta. Si no se proporciona un ETag, el borrado reemplazará cualquier cambio simultáneo. Si se proporciona una ETag y no coincide con la ETag actual de la herramienta, se bloqueará el borrado y se devolverá un error ABORTED.

DeleteToolsetRequest

Mensaje de solicitud para AgentService.DeleteToolset.

Campos
name	string Obligatorio. Es el nombre del recurso del conjunto de herramientas que se borrará.
force	bool Es opcional. Indica si se debe borrar el conjunto de herramientas de forma forzada, incluso si las apps o los agentes aún hacen referencia a él. Si es force = false, la eliminación falla si algún agente aún hace referencia al conjunto de herramientas. Si es force = true, se quitarán todas las referencias existentes de los agentes y se borrará el conjunto de herramientas.
etag	string Es opcional. Es la ETag actual del conjunto de herramientas. Si no se proporciona un ETag, el borrado reemplazará cualquier cambio simultáneo. Si se proporciona una ETag y no coincide con la ETag actual del conjunto de herramientas, se bloqueará el borrado y se devolverá un error ABORTED.

Implementación

Una implementación representa una versión inmutable de la app que se puede consultar. Se usa para implementar una versión de la app con un perfil de canal específico.

Campos
name	string Es el identificador. Es el nombre del recurso de la implementación. Formato: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
display_name	string Obligatorio. Es el nombre visible de la implementación.
app_version	string Es opcional. Es el nombre del recurso de la versión de la app que se implementará. Formato: projects/{project}/locations/{location}/apps/{app}/versions/{version} Usa projects/{project}/locations/{location}/apps/{app}/versions/- para usar la app en borrador.
channel_profile	ChannelProfile Obligatorio. Es el perfil del canal que se usa en la implementación.
create_time	Timestamp Solo salida. Es la marca de tiempo de la creación de esta implementación.
update_time	Timestamp Solo salida. Es la marca de tiempo de la última actualización de esta implementación.
etag	string Solo salida. Es el ETag que se usa para garantizar que el objeto no haya cambiado durante una operación de lectura, modificación y escritura. Si el ETag está vacío, la actualización reemplazará cualquier cambio simultáneo.
experiment_config	ExperimentConfig Es opcional. Es la configuración del experimento para la implementación.
whatsapp_credentials	WhatsAppCredentials Es opcional. Solo entrada. Se requieren credenciales efímeras de WhatsApp cuando se configura un perfil de canal de WhatsApp.
instagram_credentials	InstagramCredentials Es opcional. Solo entrada. Se requieren credenciales efímeras de Instagram cuando se configura un perfil de canal de Instagram.
model_settings	ModelSettings Es opcional. Es la configuración del modelo para la implementación. Anula la configuración del modelo establecida a nivel de la app o del agente. Nota: El reemplazo de la configuración del modelo a nivel de la Deployment está disponible solo para las cuentas incluidas en la lista de entidades permitidas. Comunícate con el equipo de CXAS para habilitar este campo.
modality	Deployment.Modality Es opcional. Es la modalidad de la implementación. Nota: La anulación de la modalidad a nivel de la Deployment está protegida por una lista de entidades permitidas. Comunícate con el equipo de CXAS para habilitar este campo.

Modalidad

Es la modalidad de la implementación.

Enums
MODALITY_UNSPECIFIED	Modalidad desconocida.
MODALITY_TEXT	Modalidad de texto.
MODALITY_VOICE	Modalidad de voz.
MODALITY_VIDEO	Modalidad de video

EndSession

Indica que la sesión finalizó, ya sea por completarse correctamente (p.ej., el usuario dice "¡Adiós!") ) o una derivación del agente.

El agente no procesará más entradas después de que finalice la sesión, y el cliente debe cerrar la mitad de la conexión y desconectarse después de recibir todas las respuestas restantes del agente.

Campos
metadata	Struct Es opcional. Proporciona información adicional sobre el evento de finalización de la sesión, como el motivo por el que se finalizó.

EndUserAuthConfig

Es la configuración de autenticación del usuario final que se usa para las llamadas de Connection. Los valores de los campos deben ser los nombres de las variables de contexto en el formato $context.variables.<name_of_variable>.

Campos
Campo de unión auth_config. Es la configuración de autenticación. auth_config puede ser solo uno de los parámetros siguientes:
oauth2_auth_code_config	EndUserAuthConfig.Oauth2AuthCodeConfig Autenticación con código de autorización de OAuth 2.0
oauth2_jwt_bearer_config	EndUserAuthConfig.Oauth2JwtBearerConfig Perfil de JWT de autenticación de otorgamiento de autorización de OAuth 2.0.

Oauth2AuthCodeConfig

Es la configuración de autenticación del código de autorización de OAuth 2.0.

Campos
oauth_token	string Obligatorio. Es el nombre del parámetro del token de OAuth que se pasará. Debe tener el formato $context.variables.<name_of_variable>.

Oauth2JwtBearerConfig

Es la configuración de autenticación del otorgamiento de autorización de OAuth 2.0 del perfil de JWT.

Campos
issuer	string Obligatorio. Es el nombre del parámetro del emisor que se pasará. Debe tener el formato $context.variables.<name_of_variable>.
subject	string Obligatorio. Es el nombre del parámetro del asunto que se pasará. Debe tener el formato $context.variables.<name_of_variable>.
client_key	string Obligatorio. Es el nombre del parámetro del cliente que se pasará. Debe tener el formato $context.variables.<name_of_variable>.

EndpointControlPolicy

Define la política de control de extremos a nivel de la ubicación o el proyecto.

Campos
enforcement_scope	EndpointControlPolicy.EnforcementScope Es opcional. Es el alcance en el que se aplica la lista allowed_origins de esta política.
allowed_origins[]	string Es opcional. Son los orígenes HTTP(s) permitidos a los que las herramientas de la app pueden llamar directamente. La aplicación depende del valor de enforcement_scope y del estado de VPC-SC del proyecto. Si no se proporciona un número de puerto, se permitirán todos los puertos. De lo contrario, el número de puerto debe coincidir exactamente. Por ejemplo, "https://example.com" coincidirá con "https://example.com:443" y cualquier otro puerto. "https://example.com:443" solo coincidirá con "https://example.com:443".

EnforcementScope

Define el alcance en el que se aplica la lista allowed_origins de esta política.

Enums
ENFORCEMENT_SCOPE_UNSPECIFIED	Sin especificar. Esta política se tratará como VPCSC_ONLY.
VPCSC_ONLY	Esta política solo se aplica cuando el VPC-SC está activo.
ALWAYS	Esta política SIEMPRE se aplica, independientemente del estado del VPC-SC.

ErrorHandlingSettings

Es la configuración para describir cómo se deben controlar los errores en la app.

Campos
error_handling_strategy	ErrorHandlingSettings.ErrorHandlingStrategy Es opcional. Es la estrategia que se usará para el manejo de errores.
fallback_response_config	ErrorHandlingSettings.FallbackResponseConfig Es opcional. Es la configuración para controlar las respuestas de resguardo.
end_session_config	ErrorHandlingSettings.EndSessionConfig Es opcional. Es la configuración para finalizar la sesión en caso de errores del sistema (p.ej., errores del LLM).

EndSessionConfig

Es la configuración para finalizar la sesión en caso de errores del sistema (p.ej., errores del LLM).

Campos
escalate_session	bool Es opcional. Indica si se debe derivar la sesión en EndSession. Si la sesión se deriva, metadata in EndSession contendrá session_escalated = true. Consulta https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/deploy/google-telephony-platform#transfer_a_call_to_a_human_agent para obtener más detalles.

ErrorHandlingStrategy

Define la estrategia para controlar los errores.

Enums
ERROR_HANDLING_STRATEGY_UNSPECIFIED	Estrategia de manejo de errores no especificada.
NONE	No se habilitó ningún control específico.
FALLBACK_RESPONSE	En caso de errores del sistema (p.ej., errores del LLM), se devolverá un mensaje de resguardo al usuario.
END_SESSION	Se emitirá un indicador EndSession en caso de errores del sistema (p.ej., errores del LLM).

FallbackResponseConfig

Es la configuración para controlar las respuestas de resguardo.

Campos
custom_fallback_messages	map<string, string> Es opcional. Son los mensajes de resguardo en caso de errores del sistema (p.ej., errores del LLM), asignados por código de idioma admitido.
max_fallback_attempts	int32 Es opcional. Es la cantidad máxima de intentos de resguardo que se pueden realizar antes de que el agente emita el EndSession Signal.

EvaluationMetricsThresholds

Es la configuración del umbral para las métricas en una evaluación.

Campos
golden_evaluation_metrics_thresholds	EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds Es opcional. Son los umbrales de las métricas de evaluación ideales.
hallucination_metric_behavior (deprecated)	EvaluationMetricsThresholds.HallucinationMetricBehavior Este elemento está obsoleto. Es opcional. Obsoleto: Usa golden_hallucination_metric_behavior en su lugar. Actualmente, el comportamiento de la métrica de alucinación se usa para las evaluaciones de referencia.
golden_hallucination_metric_behavior	EvaluationMetricsThresholds.HallucinationMetricBehavior Es opcional. Es el comportamiento de la métrica de alucinación para las evaluaciones de referencia.
scenario_hallucination_metric_behavior	EvaluationMetricsThresholds.HallucinationMetricBehavior Es opcional. Es el comportamiento de la métrica de alucinación para las evaluaciones de situaciones.

GoldenEvaluationMetricsThresholds

Es la configuración para las evaluaciones de referencia.

Campos
turn_level_metrics_thresholds	EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.TurnLevelMetricsThresholds Es opcional. Son los umbrales de las métricas a nivel del turno.
expectation_level_metrics_thresholds	EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.ExpectationLevelMetricsThresholds Es opcional. Son los umbrales de las métricas de nivel de expectativa.
tool_matching_settings	EvaluationMetricsThresholds.ToolMatchingSettings Es opcional. Es la configuración de la herramienta de correlación. Una llamada a herramienta adicional es una llamada a herramienta que está presente en la ejecución, pero no coincide con ninguna llamada a herramienta en la expectativa ideal.

ExpectationLevelMetricsThresholds

Son los umbrales de las métricas de nivel de expectativa.

Campos
tool_invocation_parameter_correctness_threshold	float Es opcional. Es el umbral de éxito para la corrección de parámetros de invocación de herramientas individuales. Debe ser un número de punto flotante entre 0 y 1. El valor predeterminado es 1.0.

TurnLevelMetricsThresholds

Son los umbrales de las métricas a nivel del turno.

Campos
semantic_similarity_channel	EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.TurnLevelMetricsThresholds.SemanticSimilarityChannel Es opcional. Es el canal de similitud semántica que se usará para la evaluación.
semantic_similarity_success_threshold	int32 Es opcional. Es el umbral de éxito para la similitud semántica. Debe ser un número entero entre 0 y 4. El valor predeterminado es >= 3.
overall_tool_invocation_correctness_threshold	float Es opcional. Es el umbral de éxito para la corrección general de la invocación de la herramienta. Debe ser un número de punto flotante entre 0 y 1. El valor predeterminado es 1.0.

SemanticSimilarityChannel

Es el canal de similitud semántica que se usará.

Enums
SEMANTIC_SIMILARITY_CHANNEL_UNSPECIFIED	No se especificó la métrica. El valor predeterminado es TEXT.
TEXT	Usa la similitud semántica del texto.
AUDIO	Usa la similitud semántica de audio.

HallucinationMetricBehavior

Es el comportamiento de la métrica de alucinación. Independientemente del comportamiento, la métrica siempre se calculará. La diferencia es que, cuando se inhabilita, la métrica no se usa para calcular la puntuación general de la evaluación.

Enums
HALLUCINATION_METRIC_BEHAVIOR_UNSPECIFIED	Comportamiento de la métrica de alucinación sin especificar.
DISABLED	Inhabilita la métrica de alucinación.
ENABLED	Habilita la métrica de alucinación.

ToolMatchingSettings

Es la configuración para la coincidencia de llamadas a herramientas.

Campos
extra_tool_call_behavior	EvaluationMetricsThresholds.ToolMatchingSettings.ExtraToolCallBehavior Es opcional. Comportamiento para las llamadas a herramientas adicionales. El valor predeterminado es FAIL.

ExtraToolCallBehavior

Define el comportamiento cuando se encuentra una llamada a herramienta adicional. Una llamada a herramienta adicional es una llamada a herramienta que está presente en la ejecución, pero no coincide con ninguna llamada a herramienta en la expectativa ideal.

Enums
EXTRA_TOOL_CALL_BEHAVIOR_UNSPECIFIED	Comportamiento no especificado. El valor predeterminado es FAIL.
FAIL	Si se encuentra una llamada a herramienta adicional, se rechaza la evaluación.
ALLOW	Permite la llamada a la herramienta adicional.

Evento

Es la entrada del evento.

Campos
event	string Obligatorio. Es el nombre del evento.

Ejemplo

Un ejemplo representa una conversación de muestra entre el usuario y los agentes.

Campos
name	string Es el identificador. Es el identificador único del ejemplo. Formato: projects/{project}/locations/{location}/apps/{app}/examples/{example}
display_name	string Obligatorio. Es el nombre visible del ejemplo.
description	string Es opcional. Es una descripción legible del ejemplo.
entry_agent	string Es opcional. Es el agente que inicialmente maneja la conversación. Si no se especifica, el ejemplo representa una conversación que maneja el agente raíz. Formato: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
messages[]	Message Es opcional. Es la colección de mensajes que componen la conversación.
create_time	Timestamp Solo salida. Es la marca de tiempo de la creación del ejemplo.
update_time	Timestamp Solo salida. Es la marca de tiempo de la última actualización del ejemplo.
invalid	bool Solo salida. El ejemplo puede dejar de ser válido si se borran los recursos a los que hace referencia. Los ejemplos no válidos no se usarán como ejemplos de aprendizaje con pocos datos.
etag	string Es el ETag que se usa para garantizar que el objeto no haya cambiado durante una operación de lectura, modificación y escritura. Si el ETag está vacío, la actualización reemplazará cualquier cambio simultáneo.

ExecuteToolRequest

Mensaje de solicitud para ToolService.ExecuteTool.

Campos
parent	string Obligatorio. Es el nombre del recurso de la app a la que pertenece la herramienta o el conjunto de herramientas. Formato: projects/{project}/locations/{location}/apps/{app}
args	Struct Es opcional. Son los parámetros y valores de entrada de la herramienta en formato de objeto JSON.
mock_config	MockConfig Es opcional. Es la configuración simulada para la ejecución de la herramienta. Si se configura este campo, las herramientas que llaman a otras herramientas se simularán en función de los patrones y las respuestas proporcionados.
Campo de unión tool_identifier. Es el identificador de la herramienta que se ejecutará. Puede ser una herramienta persistente o una herramienta de un conjunto de herramientas. tool_identifier puede ser solo uno de los parámetros siguientes:
tool	string Es opcional. Es el nombre de la herramienta que se ejecutará. Formato: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
toolset_tool	ToolsetTool Es opcional. Es la herramienta del conjunto de herramientas que se ejecutará. Solo una herramienta debe coincidir con el predicado del conjunto de herramientas. De lo contrario, se mostrará un error.
Campo de unión tool_execution_context. El contexto adicional que se proporcionará para la ejecución de la herramienta tool_execution_context solo puede ser uno de los siguientes:
variables	Struct Es opcional. Son las variables disponibles para la ejecución de la herramienta.
context	Struct Es opcional. Es el [ToolCallContext](https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/python#environment para obtener detalles) que se pasará a la herramienta de Python.

ExecuteToolResponse

Mensaje de respuesta para ToolService.ExecuteTool.

Campos
response	Struct Es el resultado de la ejecución de la herramienta en formato de objeto JSON. Usa la clave "output" para especificar la respuesta de la herramienta y la clave "error" para especificar los detalles del error (si corresponde). Si no se especifican las claves "output" y "error", toda la "response" se trata como resultado de la ejecución de la herramienta.
variables	Struct Son los valores de las variables al final de la ejecución de la herramienta.
citations	Citations Son las citas que proporcionan la información de la fuente para la ejecución de la herramienta.
google_search_suggestions	GoogleSearchSuggestions Son las sugerencias que devuelve la Búsqueda de Google como resultado de invocar la herramienta de Búsqueda de Google durante la ejecución de la herramienta.
Campo de unión tool_identifier. Es el identificador de la herramienta que se ejecutó. tool_identifier puede ser solo uno de los parámetros siguientes:
tool	string Es el nombre de la herramienta que se ejecutó. Formato: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
toolset_tool	ToolsetTool Es la herramienta del conjunto de herramientas que se ejecutó.

ExecutionType

Es el tipo de ejecución de la herramienta o el conjunto de herramientas.

Enums
EXECUTION_TYPE_UNSPECIFIED	No se especificó el tipo de ejecución. Si no se especifica, el número predeterminado es SYNCHRONOUS.
SYNCHRONOUS	La herramienta se ejecuta de forma síncrona. La sesión se bloquea hasta que la herramienta devuelve un resultado.
ASYNCHRONOUS	La herramienta se ejecuta de forma asíncrona. La sesión continuará mientras se ejecuta la herramienta.

ExperimentConfig

Es el experimento para la implementación.

Campos
version_release	ExperimentConfig.VersionRelease Es opcional. Es la versión de lanzamiento del experimento.

Estado

Es el estado del experimento.

Enums
STATE_UNSPECIFIED	Significa que el estado no se especificó.
PENDING	Obsoleto: Este estado ya no se usa.
RUNNING	Estado de ejecución. El experimento se está ejecutando y es válido.
DONE	Obsoleto: Este estado ya no se usa.
EXPIRED	Obsoleto: Este estado ya no se usa.

VersionRelease

Es la versión de lanzamiento del experimento.

Campos
state	ExperimentConfig.State Es opcional. Es el estado de la versión.
traffic_allocations[]	ExperimentConfig.VersionRelease.TrafficAllocation Es opcional. Son las asignaciones de tráfico para el lanzamiento de la versión.

TrafficAllocation

Es la asignación de tráfico para el lanzamiento de la versión.

Campos
id	string Es opcional. Es el ID de la asignación de tráfico. Cadena de formato libre, de hasta 128 caracteres.
traffic_percentage	int32 Es opcional. Es el porcentaje de tráfico de la asignación de tráfico. Debe estar entre 0 y 100.
app_version	string Es opcional. Es la versión de la app de la asignación de tráfico. Formato: projects/{project}/locations/{location}/apps/{app}/versions/{version}

ExportAppRequest

Mensaje de solicitud para AgentService.ExportApp.

Campos
name	string Obligatorio. Es el nombre del recurso de la app que se exportará.
export_format	ExportAppRequest.ExportFormat Obligatorio. Es el formato en el que se exportará la app.
gcs_uri	string Es opcional. Es el URI de Google Cloud Storage al que se exportará la app. El formato de este URI debe ser gs://<bucket-name>/<object-name>. El archivo de la app exportada se escribirá directamente en el objeto de GCS especificado.
app_version	string Es opcional. Es el nombre del recurso de la versión de la app que se exportará. Formato: projects/{project}/locations/{location}/apps/{app}/versions/{version}.

ExportFormat

Es el formato de exportación de la app.

Enums
EXPORT_FORMAT_UNSPECIFIED	El formato de exportación no está especificado.
JSON	El formato de exportación es JSON.
YAML	El formato de exportación es YAML.

ExportAppResponse

Mensaje de respuesta para AgentService.ExportApp.

Campos
Campo de unión app. Es la app exportada. app solo puede ser uno de los siguientes valores:
app_content	bytes Carpeta de la app comprimida como un archivo ZIP.
app_uri	string Es el URI de Google Cloud Storage al que se exportó la app.

ExpressionCondition

Es una condición de expresión basada en el estado de la sesión.

Campos
expression	string Obligatorio. Es la representación de cadena de la condición cloud.api.Expression.

FileSearchTool

La herramienta de búsqueda de archivos permite que el agente busque en los archivos que subió el desarrollador de la app o del agente. Tiene parámetros de configuración predeterminados para ofrecer una búsqueda de calidad relativamente buena en los archivos subidos y un resumen de los resultados recuperados.

Campos
corpus_type	FileSearchTool.CorpusType Es opcional. Es el tipo de corpus. El valor predeterminado es FULLY_MANAGED.
name	string Obligatorio. Es el nombre de la herramienta.
description	string Es opcional. Es la descripción de la herramienta.
file_corpus	string Es opcional. Es el corpus en el que se almacenan los archivos. Formato: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}

CorpusType

Es el tipo de corpus de RAG de Vertex.

Enums
CORPUS_TYPE_UNSPECIFIED	Es un tipo de corpus sin especificar.
USER_OWNED	El corpus es creado por el usuario y es de su propiedad.
FULLY_MANAGED	El corpus lo crea el agente.

GenerateChatTokenRequest

Mensaje de solicitud para WidgetService.GenerateChatToken.

Campos
name	string Obligatorio. Es el nombre de la sesión para la que se generará el token de chat. Formato: projects/{project}/locations/{location}/apps/{app}/sessions/{session}
deployment	string Obligatorio. Es la implementación de la app que se usará para la sesión. Formato: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
recaptcha_token	string Es opcional. Es el token de reCAPTCHA generado por el widget de chat del cliente.
live_handoff_enabled	bool Es opcional. Indica si la transferencia en vivo está habilitada para la sesión.

GenerateChatTokenResponse

Mensaje de respuesta para WidgetService.GenerateChatToken.

Campos
chat_token	string Es el token con alcance de sesión del widget de chat para autenticarse con las APIs de Session.
expire_time	Timestamp Fecha y hora de vencimiento del token de chat.

GetAgentRequest

Mensaje de solicitud para AgentService.GetAgent.

Campos
name	string Obligatorio. Es el nombre del recurso del agente que se recuperará.

GetAppRequest

Mensaje de solicitud para AgentService.GetApp.

Campos
name	string Obligatorio. Es el nombre del recurso de la app que se recuperará.

GetAppVersionRequest

Mensaje de solicitud para AgentService.GetAppVersion.

Campos
name	string Obligatorio. Es el nombre del recurso de la versión de la app que se recuperará.

GetChangelogRequest

Mensaje de solicitud para AgentService.GetChangelog.

Campos
name	string Obligatorio. Es el nombre del recurso del registro de cambios que se recuperará.

GetConversationRequest

Mensaje de solicitud para AgentService.GetConversation.

Campos
name	string Obligatorio. Es el nombre del recurso de la conversación que se recuperará.
source (deprecated)	Conversation.Source Este elemento está obsoleto. Es opcional. Indica la fuente de la conversación. Si no se configura, se buscará en todas las fuentes.

GetDeploymentRequest

Mensaje de solicitud para AgentService.GetDeployment.

Campos
name	string Obligatorio. El nombre de la implementación. Formato: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}

GetExampleRequest

Mensaje de solicitud para AgentService.GetExample.

Campos
name	string Obligatorio. Es el nombre del recurso del ejemplo que se recuperará.

GetGuardrailRequest

Mensaje de solicitud para AgentService.GetGuardrail.

Campos
name	string Obligatorio. Es el nombre del recurso de la protección que se recuperará.

GetToolRequest

Mensaje de solicitud para AgentService.GetTool.

Campos
name	string Obligatorio. Es el nombre del recurso de la herramienta que se recuperará.

GetToolsetRequest

Mensaje de solicitud para AgentService.GetToolset.

Campos
name	string Obligatorio. Es el nombre del recurso del conjunto de herramientas que se recuperará.

GoAway

Este tipo no tiene campos.

Indica que el servidor se desconectará pronto y que el cliente debe cerrar la conexión a medias y reiniciarla.

GoogleSearchSuggestions

Sugerencias de búsqueda de Google Search Tool.

Campos
htmls[]	string Estilo HTML y CSS compatible para las sugerencias de búsqueda. El HTML y CSS proporcionados se adaptan automáticamente a la configuración de tu dispositivo, lo que se muestra en modo oscuro o claro indicado por @media(prefers-color-scheme).
web_search_queries[]	WebSearchQuery Es la lista de las búsquedas que se usaron para realizar la Búsqueda de Google, junto con los URIs de los resultados de búsqueda que forman las sugerencias de búsqueda.

GoogleSearchTool

Representa una herramienta para realizar búsquedas web en Google para la fundamentación. Consulta https://cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool#google-search.

Campos
name	string Obligatorio. Es el nombre de la herramienta.
description	string Es opcional. Es la descripción del propósito de la herramienta.
context_urls[]	string Es opcional. El contenido se recuperará directamente de estas URLs para la fundamentación y el contexto. Ejemplo: "https://example.com/path.html". Se permite un máximo de 20 URLs.
preferred_domains[]	string Es opcional. Especifica los dominios a los que se restringirán los resultados de la búsqueda. Ejemplo: "example.com", "another.site". Se puede especificar un máximo de 20 dominios.
exclude_domains[]	string Es opcional. Lista de dominios que se excluirán de los resultados de la búsqueda. Ejemplo: "example.com". Se puede excluir un máximo de 2,000 dominios.
prompt_config	GoogleSearchTool.PromptConfig Es opcional. Son las instrucciones de la instrucción que se pasan al planificador sobre cómo se deben procesar los resultados de la búsqueda para texto y voz.

PromptConfig

Es la configuración de instrucciones que usa el modelo cuando procesa o resume los resultados de la Búsqueda de Google.

Campos
text_prompt	string Es opcional. Define la instrucción que se usa para las instrucciones del sistema cuando se interactúa con el agente en conversaciones de chat. Si no se establece, se usará la instrucción predeterminada.
voice_prompt	string Es opcional. Define la instrucción que se usa para las instrucciones del sistema cuando se interactúa con el agente en conversaciones de voz. Si no se establece, se usará la instrucción predeterminada.

Barrera

La barrera de seguridad contiene una lista de controles y equilibrios para mantener a los agentes seguros y protegidos.

Campos
name	string Es el identificador. Es el identificador único de la protección. Formato: projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}
display_name	string Obligatorio. Es el nombre visible de la protección.
description	string Es opcional. Es la descripción de la protección.
enabled	bool Es opcional. Indica si la protección está habilitada.
action	TriggerAction Es opcional. Es la acción que se debe tomar cuando se activa la barrera de protección.
create_time	Timestamp Solo salida. Es la marca de tiempo de cuando se creó el parámetro de protección.
update_time	Timestamp Solo salida. Es la marca de tiempo de la última actualización del parámetro de protección.
etag	string Es el ETag que se usa para garantizar que el objeto no haya cambiado durante una operación de lectura, modificación y escritura. Si el ETag está vacío, la actualización reemplazará cualquier cambio simultáneo.
Campo de unión guardrail_type. Es el tipo de barrera de seguridad. guardrail_type puede ser solo uno de los parámetros siguientes:
content_filter	Guardrail.ContentFilter Es opcional. Es una protección que prohíbe el uso de cierto contenido en la conversación.
llm_prompt_security	Guardrail.LlmPromptSecurity Es opcional. Es una protección que bloquea la conversación si la instrucción se considera no segura según la clasificación del LLM.
llm_policy	Guardrail.LlmPolicy Es opcional. Protección que bloquea la conversación si se considera que la respuesta del LLM incumple la política según la clasificación del LLM.
model_safety	Guardrail.ModelSafety Es opcional. Es una protección que bloquea la conversación si la respuesta del LLM se considera no segura según la configuración de seguridad del modelo.
code_callback	Guardrail.CodeCallback Es opcional. Es una protección que puede bloquear la conversación según el resultado de la ejecución de la devolución de llamada.

CodeCallback

Es una protección que bloquea la conversación según las devoluciones de llamada de código proporcionadas.

Campos
before_agent_callback	Callback Es opcional. Es la devolución de llamada que se ejecutará antes de que se llame al agente. Se espera que cada función de devolución de llamada devuelva una estructura (p.ej., un diccionario o un objeto) que contenga, al menos, lo siguiente: - "decision": Puede ser "OK" o "TRIGGER". - "reason": Es una cadena que explica la decisión. Una decisión de "ACTIVACIÓN" puede detener el procesamiento posterior.
after_agent_callback	Callback Es opcional. Es la devolución de llamada que se ejecutará después de que se llame al agente. Se espera que cada función de devolución de llamada devuelva una estructura (p.ej., un diccionario o un objeto) que contenga, al menos, lo siguiente: - "decision": Puede ser "OK" o "TRIGGER". - "reason": Es una cadena que explica la decisión. Una decisión de "ACTIVACIÓN" puede detener el procesamiento posterior.
before_model_callback	Callback Es opcional. Es la devolución de llamada que se ejecutará antes de que se llame al modelo. Si hay varias llamadas al modelo, la devolución de llamada se ejecutará varias veces. Se espera que cada función de devolución de llamada devuelva una estructura (p.ej., un diccionario o un objeto) que contenga, al menos, lo siguiente: - "decision": Puede ser "OK" o "TRIGGER". - "reason": Es una cadena que explica la decisión. Una decisión de "ACTIVACIÓN" puede detener el procesamiento posterior.
after_model_callback	Callback Es opcional. Es la devolución de llamada que se ejecutará después de que se llame al modelo. Si hay varias llamadas al modelo, la devolución de llamada se ejecutará varias veces. Se espera que cada función de devolución de llamada devuelva una estructura (p.ej., un diccionario o un objeto) que contenga, al menos, lo siguiente: - "decision": Puede ser "OK" o "TRIGGER". - "reason": Es una cadena que explica la decisión. Una decisión de "ACTIVACIÓN" puede detener el procesamiento posterior.

ContentFilter

Es una protección que prohíbe el uso de cierto contenido en la conversación.

Campos
banned_contents[]	string Es opcional. Es la lista de frases prohibidas. Se aplica tanto a las entradas del usuario como a las respuestas del agente.
banned_contents_in_user_input[]	string Es opcional. Es la lista de frases prohibidas. Solo se aplica a las entradas del usuario.
banned_contents_in_agent_response[]	string Es opcional. Es la lista de frases prohibidas. Solo se aplica a las respuestas del agente.
match_type	Guardrail.ContentFilter.MatchType Obligatorio. Es el tipo de concordancia para el filtro de contenido.
disregard_diacritics	bool Es opcional. Si es verdadero, los signos diacríticos se ignoran durante la coincidencia.

MatchType

Es el tipo de concordancia para el filtro de contenido.

Enums
MATCH_TYPE_UNSPECIFIED	No se especificó el tipo de concordancia.
SIMPLE_STRING_MATCH	El contenido se compara con subcadenas carácter por carácter.
WORD_BOUNDARY_STRING_MATCH	El contenido solo coincide si el patrón que se encuentra en el texto está rodeado de delimitadores de palabras. Las frases prohibidas también pueden contener delimitadores de palabras.
REGEXP_MATCH	El contenido coincide con la sintaxis de expresiones regulares.

LlmPolicy

Protección que bloquea la conversación si se considera que la respuesta del LLM incumple la política según la clasificación del LLM.

Campos
max_conversation_messages	int32 Es opcional. Cuando revises esta política, ten en cuenta los últimos "n" mensajes de la conversación. Cuando no se establece, se usa un valor predeterminado de 10.
model_settings	ModelSettings Es opcional. Es la configuración del modelo.
prompt	string Obligatorio. Instrucción de política.
policy_scope	Guardrail.LlmPolicy.PolicyScope Obligatorio. Define cuándo se debe aplicar la verificación de política durante la conversación. Si se establece en POLICY_SCOPE_UNSPECIFIED, la política se aplicará a la entrada del usuario. Cuando se aplique la política a la respuesta del agente, se introducirá una latencia adicional antes de que el agente pueda responder.
fail_open	bool Es opcional. Si se produce un error durante la verificación de políticas, se debe permitir el acceso y no activar la protección.
allow_short_utterance	bool Es opcional. De forma predeterminada, se omite la verificación de políticas del LLM para las expresiones cortas. Si habilitas este parámetro de configuración, se aplicará la verificación de políticas a todas las expresiones, incluidas las que normalmente se omitirían.

PolicyScope

Define cuándo se debe aplicar la verificación de política durante la conversación.

Enums
POLICY_SCOPE_UNSPECIFIED	No se especificó el alcance de la política.
USER_QUERY	La verificación de políticas se activa con la entrada del usuario.
AGENT_RESPONSE	La verificación de políticas se activa en la respuesta del agente. Aplicar este alcance de política generará latencia adicional antes de que el agente pueda responder.
USER_QUERY_AND_AGENT_RESPONSE	La verificación de políticas se activa tanto en la entrada del usuario como en la respuesta del agente. Aplicar este alcance de política generará latencia adicional antes de que el agente pueda responder.

LlmPromptSecurity

Protección que bloquea la conversación si la entrada se considera insegura según la clasificación del LLM.

Campos
fail_open	bool Es opcional. Determina el comportamiento cuando la barrera de seguridad encuentra un error del LLM. - Si es verdadero, se omite la barrera de protección. - Si es falso (valor predeterminado), la protección se activa o bloquea. Nota: Si se proporciona una política personalizada, este campo se ignora en favor de la configuración "fail_open" de la política.
Campo de unión security_config. Define el modo de configuración de seguridad. El usuario debe elegir una de las siguientes configuraciones. security_config puede ser solo uno de los parámetros siguientes:
default_settings	Guardrail.LlmPromptSecurity.DefaultSecuritySettings Es opcional. Usar la configuración de seguridad predeterminada predefinida del sistema Para seleccionar este modo, incluye un mensaje "default_settings" vacío en la solicitud. El servidor completará el campo "default_prompt_template" en la respuesta.
custom_policy	Guardrail.LlmPolicy Es opcional. Usa un LlmPolicy definido por el usuario para configurar la barrera de seguridad.

DefaultSecuritySettings

Es la configuración de los parámetros de seguridad predeterminados del sistema.

Campos
default_prompt_template	string Solo salida. Es la plantilla de instrucciones predeterminada que usa el sistema. Este campo se muestra para que el usuario vea qué instrucción usa el sistema de forma predeterminada. Es OUTPUT_ONLY.

ModelSafety

Anulaciones de la configuración de seguridad del modelo. Cuando se establece este parámetro, se anula la configuración predeterminada y se activa la protección si la respuesta se considera insegura.

Campos
safety_settings[]	Guardrail.ModelSafety.SafetySetting Obligatorio. Es la lista de parámetros de configuración de seguridad.

HarmBlockThreshold

Niveles de umbral basados en la probabilidad para el bloqueo.

Enums
HARM_BLOCK_THRESHOLD_UNSPECIFIED	Umbral de bloqueo de daño no especificado.
BLOCK_LOW_AND_ABOVE	Bloquea el umbral bajo y superior (es decir, bloquea más).
BLOCK_MEDIUM_AND_ABOVE	Bloquea el umbral medio y superior.
BLOCK_ONLY_HIGH	Bloquea solo el umbral alto (es decir, bloquea menos).
BLOCK_NONE	No bloquear.
OFF	Desactiva el filtro de seguridad.

HarmCategory

Es la categoría de daño.

Enums
HARM_CATEGORY_UNSPECIFIED	No se especifica la categoría de daño.
HARM_CATEGORY_HATE_SPEECH	La categoría de daño es la incitación al odio o a la violencia.
HARM_CATEGORY_DANGEROUS_CONTENT	La categoría de daño es el contenido peligroso.
HARM_CATEGORY_HARASSMENT	La categoría de daño es el hostigamiento.
HARM_CATEGORY_SEXUALLY_EXPLICIT	La categoría de daño es el contenido sexual explícito.
HARM_CATEGORY_PROFANITY	La categoría de daño es la obscenidad.
HARM_CATEGORY_TOXIC	La categoría de daño es tóxico.

SafetySetting

Es un parámetro de configuración de seguridad.

Campos
category	Guardrail.ModelSafety.HarmCategory Obligatorio. Es la categoría de daño.
threshold	Guardrail.ModelSafety.HarmBlockThreshold Obligatorio. El umbral de bloqueo de daño.

Imagen

Representa una entrada o salida de imagen en la conversación.

Campos
mime_type	string Obligatorio. Es el tipo de MIME estándar de IANA de los datos de origen. Los tipos de imágenes admitidos incluyen los siguientes: * image/png * image/jpeg * image/webp
data	bytes Obligatorio. Son los bytes sin procesar de la imagen.

ImportAppRequest

Mensaje de solicitud para AgentService.ImportApp.

Campos
parent	string Obligatorio. Es el nombre del recurso principal con la ubicación de la app que se importará.
display_name	string Es opcional. Es el nombre visible de la app que se importará. * Si la app se crea durante la importación y se especifica el nombre visible, la app importada usará este nombre visible. Si se detecta un conflicto con una app existente, se agregará una marca de tiempo al nombre visible para que sea único. * Si la app es una reimportación, no se debe establecer este campo. Si proporcionas un nombre visible durante la reimportación, se generará un error INVALID_ARGUMENT.
app_id	string Es opcional. Es el ID que se usará para la app importada. * Si no se especifica, se asignará automáticamente un ID único para la app. * De lo contrario, la app importada usará este ID como el componente final de su nombre de recurso. Si ya existe una app con el mismo ID en la ubicación especificada del proyecto, se reemplazará el contenido de la app existente.
import_options	ImportAppRequest.ImportOptions Es opcional. Son las opciones que rigen el proceso de importación de la app.
ignore_app_lock	bool Es opcional. Es una marca para anular el bloqueo de apps durante la importación. Si se establece como verdadero, el proceso de importación ignorará el bloqueo de apps.
Campo de unión app. Es la app que se importará. app puede ser solo uno de los parámetros siguientes:
gcs_uri	string Es el URI de Google Cloud Storage desde el que se importará la app. El formato de este URI debe ser gs://<bucket-name>/<object-name>.
app_content	bytes Son los bytes sin procesar que representan el archivo zip comprimido con la estructura de carpetas de la app.

ImportOptions

Son las opciones de configuración para el proceso de importación de la app. Estas opciones controlan el comportamiento de la importación, en especial cuando surgen conflictos con los datos de app existentes.

Campos
conflict_resolution_strategy	ImportAppRequest.ImportOptions.ConflictResolutionStrategy Es opcional. Es la estrategia que se usará cuando se resuelvan conflictos durante la importación.
validate_only	bool Es opcional. Es una marca para ejecutar el proceso de importación en modo de prueba. Si se establece como verdadero, el proceso de importación solo realizará validaciones y no realizará ningún cambio en la app existente ni creará una nueva.

ConflictResolutionStrategy

Define la estrategia para controlar los conflictos cuando ya existe una app con el mismo ID o cuando los recursos importados (como agentes, herramientas, etcétera) tienen los mismos nombres visibles que los recursos existentes dentro de esa app.

Enums
CONFLICT_RESOLUTION_STRATEGY_UNSPECIFIED	No se especificó la estrategia de resolución de conflictos.
REPLACE	Reemplazar los datos existentes por los datos importados Si ya existe una app con el mismo app_id, su contenido se actualizará según la app importada. Los recursos (app, agentes, herramientas, ejemplos, medidas de protección y conjuntos de herramientas) de la app importada que tengan el mismo nombre visible que los recursos existentes reemplazarán a los existentes. - Se crearán recursos importados con nombres visibles nuevos. - Los recursos existentes que no tengan un nombre visible coincidente en la app importada permanecerán sin cambios.
OVERWRITE	Sobrescribe los datos existentes con los datos importados. Si ya existe una app con el mismo app_id, su contenido se reemplazará por el de la app importada. Se borrarán los recursos existentes (agentes, herramientas, ejemplos, medidas de protección, conjuntos de herramientas) en la app. - Los recursos importados se crearán como recursos nuevos.

ImportAppResponse

Mensaje de respuesta para AgentService.ImportApp.

Campos
name	string Es el nombre del recurso de la app que se importó.
warnings[]	string Son los mensajes de advertencia que se generan durante el proceso de importación. Si se producen errores en recursos específicos, estos no se incluirán en la app importada y el error se mencionará aquí.

InputAudioConfig

InputAudioConfig configura cómo el agente de CES debe interpretar los datos de audio entrantes.

Campos
audio_encoding	AudioEncoding Obligatorio. Es la codificación de los datos de audio de entrada.
sample_rate_hertz	int32 Obligatorio. Es la tasa de muestreo (en hercios) de los datos de audio de entrada.
noise_suppression_level	string Es opcional. Indica si se debe habilitar la reducción de ruido en el audio de entrada. Los valores disponibles son "low", "moderate", "high" y "very_high".

InstagramCredentials

Son credenciales de Meta efímeras para la integración nativa de Instagram.

Campos
auth_code	string Obligatorio. Es el código de autorización de Meta que proporciona el flujo de registro integrado.
conversation_profile_id	string Es opcional. Es el ID del perfil de conversación que se usará para la implementación.

InterruptionSignal

Indica que se interrumpió la respuesta de audio del agente. El cliente debe detener de inmediato cualquier reproducción de audio actual (p.ej., debido a una interrupción del usuario o a que se está generando una nueva respuesta del agente).

Campos
barge_in	bool Indica si la interrupción se debe a un evento de interrupción del usuario.

LanguageSettings

Es la configuración de idioma de la app.

Campos
default_language_code	string Es opcional. Es el código de idioma predeterminado de la app.
supported_language_codes[]	string Es opcional. Lista de códigos de idioma que admite la app, además de default_language_code.
enable_multilingual_support	bool Es opcional. Habilita la compatibilidad multilingüe. Si es verdadero, los agentes de la app usarán instrucciones prediseñadas para mejorar el procesamiento de la entrada multilingüe.
fallback_action (deprecated)	string Este elemento está obsoleto. Es opcional. Obsoleto: Esta función ya no es compatible. En su lugar, usa enable_multilingual_support para mejorar el manejo de la entrada multilingüe. Es la acción que se realizará cuando un agente reciba entrada en un idioma no admitido. Puede ser una acción predefinida o una llamada a herramienta personalizada. Los valores válidos son los siguientes: - El nombre completo del recurso de una herramienta, que activa una ejecución específica de la herramienta. - Una acción del sistema predefinida, como "derivar" o "salir", que activa un indicador EndSession con el metadata correspondiente para finalizar la conversación.

ListAgentsRequest

Mensaje de solicitud para AgentService.ListAgents.

Campos
parent	string Obligatorio. Es el nombre del recurso de la app desde la que se enumerarán los agentes.
page_size	int32 Es opcional. Indica el tamaño de la página solicitada. Es posible que el servidor devuelva menos elementos de los que se solicitaron. Si no se especifica, el servidor elegirá un valor predeterminado adecuado.
page_token	string Es opcional. El valor de next_page_token que se muestra de una llamada AgentService.ListAgents de lista anterior.
filter	string Es opcional. Es el filtro que se aplicará cuando se enumeren los agentes. Consulta https://google.aip.dev/160 para obtener más detalles.
order_by	string Es opcional. Campo por el que se ordenará. Solo se admiten "name" y "create_time". Consulta https://google.aip.dev/132#ordering para obtener más detalles.

ListAgentsResponse

Mensaje de respuesta para AgentService.ListAgents.

Campos
agents[]	Agent La lista de agentes.
next_page_token	string Un token que se puede enviar como ListAgentsRequest.page_token para recuperar la página siguiente. La ausencia de este campo indica que no hay páginas posteriores.

ListAppVersionsRequest

Mensaje de solicitud para AgentService.ListAppVersions.

Campos
parent	string Obligatorio. Es el nombre del recurso de la app de la que se enumerarán las versiones.
page_size	int32 Es opcional. Indica el tamaño de la página solicitada. Es posible que el servidor devuelva menos elementos de los que se solicitaron. Si no se especifica, el servidor elegirá un valor predeterminado adecuado.
page_token	string Es opcional. El valor de next_page_token que se muestra de una llamada AgentService.ListAppVersions de lista anterior.
filter	string Es opcional. Es el filtro que se aplicará cuando se enumeren las versiones de la app. Consulta https://google.aip.dev/160 para obtener más detalles.
order_by	string Es opcional. Campo por el que se ordenará. Solo se admiten "name" y "create_time". Consulta https://google.aip.dev/132#ordering para obtener más detalles.

ListAppVersionsResponse

Mensaje de respuesta para AgentService.ListAppVersions.

Campos
app_versions[]	AppVersion Es la lista de versiones de la app.
next_page_token	string Un token que se puede enviar como ListAppVersionsRequest.page_token para recuperar la página siguiente. La ausencia de este campo indica que no hay páginas posteriores.

ListAppsRequest

Mensaje de solicitud para AgentService.ListApps.

Campos
parent	string Obligatorio. Es el nombre del recurso de la ubicación desde la que se enumerarán las apps.
page_size	int32 Es opcional. Indica el tamaño de la página solicitada. Es posible que el servidor devuelva menos elementos de los que se solicitaron. Si no se especifica, el servidor elegirá un valor predeterminado adecuado.
page_token	string Es opcional. El valor de next_page_token que se muestra de una llamada AgentService.ListApps de lista anterior.
filter	string Es opcional. Es el filtro que se aplicará cuando se muestren las apps. Consulta https://google.aip.dev/160 para obtener más detalles.
order_by	string Es opcional. Campo por el que se ordenará. Solo se admiten "name" y "create_time". Consulta https://google.aip.dev/132#ordering para obtener más detalles.

ListAppsResponse

Mensaje de respuesta para AgentService.ListApps.

Campos
apps[]	App Es la lista de apps.
next_page_token	string Un token que se puede enviar como ListAppsRequest.page_token para recuperar la página siguiente. La ausencia de este campo indica que no hay páginas posteriores.
unreachable[]	string Lista sin ordenar. Ubicaciones a las que no se pudo llegar.

ListChangelogsRequest

Mensaje de solicitud para AgentService.ListChangelogs.

Campos
parent	string Obligatorio. Es el nombre del recurso de la app de la que se enumerarán los registros de cambios.
page_size	int32 Es opcional. Indica el tamaño de la página solicitada. Es posible que el servidor devuelva menos elementos de los que se solicitaron. Si no se especifica, el servidor elegirá un valor predeterminado adecuado.
page_token	string Es opcional. El valor de next_page_token que se muestra de una llamada AgentService.ListChangelogs de lista anterior.
filter	string Es opcional. Es el filtro que se aplicará cuando se muestren los registros de cambios. Consulta https://google.aip.dev/160 para obtener más detalles. La cadena de filtro se puede usar para filtrar por action, resource_type, resource_name, author y create_time. El comparador : se puede usar para la coincidencia parcial que no distingue mayúsculas de minúsculas en los campos de cadena, mientras que = realiza una coincidencia exacta que distingue mayúsculas de minúsculas. Ejemplos: * action:update (coincidencia parcial que no distingue mayúsculas de minúsculas) * action="Create" (coincidencia exacta que distingue mayúsculas de minúsculas) * 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 Es opcional. Campo por el que se ordenará. Solo se admiten "name" y "create_time". Consulta https://google.aip.dev/132#ordering para obtener más detalles.

ListChangelogsResponse

Mensaje de respuesta para AgentService.ListChangelogs.

Campos
changelogs[]	Changelog Es la lista de registros de cambios.
next_page_token	string Un token que se puede enviar como ListChangelogsRequest.page_token para recuperar la página siguiente. La ausencia de este campo indica que no hay páginas posteriores.

ListConversationsRequest

Mensaje de solicitud para AgentService.ListConversations.

Campos
parent	string Obligatorio. Es el nombre del recurso de la app desde la que se enumerarán las conversaciones.
page_size	int32 Es opcional. Indica el tamaño de la página solicitada. Es posible que el servidor devuelva menos elementos de los que se solicitaron. Si no se especifica, el servidor elegirá un valor predeterminado adecuado.
page_token	string Es opcional. El valor de next_page_token que se muestra de una llamada AgentService.ListConversations de lista anterior.
filter	string Es opcional. Es el filtro que se aplicará cuando se listen las conversaciones. Consulta https://google.aip.dev/160 para obtener más detalles.
source	Conversation.Source Es opcional. Indica la fuente de la conversación. Si no se configura, se aplicará Source.Live de forma predeterminada. Dejará de estar disponible y se reemplazará por el campo sources.
sources[]	Conversation.Source Es opcional. Indica las fuentes de las conversaciones. Si no se configura, se aplicarán todas las fuentes disponibles de forma predeterminada.

ListConversationsResponse

Mensaje de respuesta para AgentService.ListConversations.

Campos
conversations[]	Conversation Es la lista de conversaciones.
next_page_token	string Un token que se puede enviar como ListConversationsRequest.page_token para recuperar la página siguiente. La ausencia de este campo indica que no hay páginas posteriores.

ListDeploymentsRequest

Mensaje de solicitud para AgentService.ListDeployments.

Campos
parent	string Obligatorio. Es la app principal. El formato es projects/{project}/locations/{location}/apps/{app}.
page_size	int32 Es opcional. Es la cantidad máxima de implementaciones que se devolverán. El servicio puede mostrar menos que este valor. Si no se especifica, se devolverán, como máximo, 50 implementaciones. El valor máximo es 1,000; valores superiores a 1,000 se convertirán en 1,000.
page_token	string Es opcional. Un token de página, recibido desde una llamada ListDeployments anterior. Proporciona esto para recuperar la página siguiente. Cuando se pagina, todos los demás parámetros proporcionados a ListDeployments deben coincidir con la llamada que proporcionó el token de la página.
order_by	string Es opcional. Campo por el que se ordenará. Solo se admiten "name" y "create_time". Consulta https://google.aip.dev/132#ordering para obtener más detalles.

ListDeploymentsResponse

Mensaje de respuesta para AgentService.ListDeployments.

Campos
deployments[]	Deployment Es la lista de implementaciones.
next_page_token	string Un token, que se puede enviar como page_token para recuperar la página siguiente. Si se omite este campo, no habrá páginas siguientes.

ListExamplesRequest

Mensaje de solicitud para AgentService.ListExamples.

Campos
parent	string Obligatorio. Es el nombre del recurso de la app de la que se enumerarán los ejemplos.
page_size	int32 Es opcional. Indica el tamaño de la página solicitada. Es posible que el servidor devuelva menos elementos de los que se solicitaron. Si no se especifica, el servidor elegirá un valor predeterminado adecuado.
page_token	string Es opcional. El valor de next_page_token que se muestra de una llamada AgentService.ListExamples de lista anterior.
filter	string Es opcional. Es el filtro que se aplicará cuando se enumeren los ejemplos. Consulta https://google.aip.dev/160 para obtener más detalles.
order_by	string Es opcional. Campo por el que se ordenará. Solo se admiten "name" y "create_time". Consulta https://google.aip.dev/132#ordering para obtener más detalles.

ListExamplesResponse

Mensaje de respuesta para AgentService.ListExamples.

Campos
examples[]	Example Es la lista de ejemplos.
next_page_token	string Un token que se puede enviar como ListExamplesRequest.page_token para recuperar la página siguiente. La ausencia de este campo indica que no hay páginas posteriores.

ListGuardrailsRequest

Mensaje de solicitud para AgentService.ListGuardrails.

Campos
parent	string Obligatorio. Es el nombre del recurso de la app desde la que se enumerarán las protecciones.
page_size	int32 Es opcional. Indica el tamaño de la página solicitada. Es posible que el servidor devuelva menos elementos de los que se solicitaron. Si no se especifica, el servidor elegirá un valor predeterminado adecuado.
page_token	string Es opcional. El valor de next_page_token que se muestra de una llamada AgentService.ListGuardrails de lista anterior.
filter	string Es opcional. Es el filtro que se aplicará cuando se muestren las barreras de seguridad. Consulta https://google.aip.dev/160 para obtener más detalles.
order_by	string Es opcional. Campo por el que se ordenará. Solo se admiten "name" y "create_time". Consulta https://google.aip.dev/132#ordering para obtener más detalles.

ListGuardrailsResponse

Mensaje de respuesta para AgentService.ListGuardrails.

Campos
guardrails[]	Guardrail Es la lista de barreras.
next_page_token	string Un token que se puede enviar como ListGuardrailsRequest.page_token para recuperar la página siguiente. La ausencia de este campo indica que no hay páginas posteriores.

ListToolsRequest

Mensaje de solicitud para AgentService.ListTools.

Campos
parent	string Obligatorio. Es el nombre del recurso de la app desde la que se enumerarán las herramientas.
page_size	int32 Es opcional. Indica el tamaño de la página solicitada. Es posible que el servidor devuelva menos elementos de los que se solicitaron. Si no se especifica, el servidor elegirá un valor predeterminado adecuado.
page_token	string Es opcional. El valor de next_page_token que se muestra de una llamada AgentService.ListTools de lista anterior.
filter	string Es opcional. Es el filtro que se aplicará cuando se muestre la lista de herramientas. Usa "include_system_tools=true" para incluir herramientas del sistema en la respuesta. Consulta https://google.aip.dev/160 para obtener más detalles.
order_by	string Es opcional. Campo por el que se ordenará. Solo se admiten "name" y "create_time". Consulta https://google.aip.dev/132#ordering para obtener más detalles.

ListToolsResponse

Mensaje de respuesta para AgentService.ListTools.

Campos
tools[]	Tool Es la lista de herramientas.
next_page_token	string Un token que se puede enviar como ListToolsRequest.page_token para recuperar la página siguiente. La ausencia de este campo indica que no hay páginas posteriores.

ListToolsetsRequest

Mensaje de solicitud para AgentService.ListToolsets.

Campos
parent	string Obligatorio. Es el nombre del recurso de la app desde la que se enumerarán los conjuntos de herramientas.
page_size	int32 Es opcional. Indica el tamaño de la página solicitada. Es posible que el servidor devuelva menos elementos de los que se solicitaron. Si no se especifica, el servidor elegirá un valor predeterminado adecuado.
page_token	string Es opcional. El valor de next_page_token que se muestra de una llamada AgentService.ListToolsets de lista anterior.
filter	string Es opcional. Es el filtro que se aplicará cuando se muestren los conjuntos de herramientas. Consulta https://google.aip.dev/160 para obtener más detalles.
order_by	string Es opcional. Campo por el que se ordenará. Solo se admiten "name" y "create_time". Consulta https://google.aip.dev/132#ordering para obtener más detalles.

ListToolsetsResponse

Mensaje de respuesta para AgentService.ListToolsets.

Campos
toolsets[]	Toolset Es la lista de conjuntos de herramientas.
next_page_token	string Un token que se puede enviar como ListToolsetsRequest.page_token para recuperar la página siguiente. La ausencia de este campo indica que no hay páginas posteriores.

LoggingSettings

Es la configuración para describir los comportamientos de registro de la app.

Campos
redaction_config	RedactionConfig Es opcional. Es la configuración de cómo se deben ocultar los datos sensibles.
audio_recording_config	AudioRecordingConfig Es opcional. Es la configuración de cómo se deben registrar las interacciones de audio. El audio está sujeto a ocultamiento según la configuración de RedactionConfig.
unredacted_audio_recording_config	AudioRecordingConfig Es opcional. Configura una grabación adicional de audio sin editar. Se puede usar para mantener una copia de audio sin procesar cuando la redacción de audio es enabled, por lo general, para fines de auditoría o supervisión.
bigquery_export_settings	BigQueryExportSettings Es opcional. Configura los comportamientos de la exportación de BigQuery para la app. Los datos de conversación están sujetos a la ocultación según se configuró en RedactionConfig.
unredacted_bigquery_export_settings	BigQueryExportSettings Es opcional. Configura los comportamientos de la exportación de BigQuery para la app. Los datos de conversación sin editar se exportarán a las tablas de BigQuery si está habilitada la exportación.
cloud_logging_settings	CloudLoggingSettings Es opcional. Es la configuración para describir el comportamiento de Cloud Logging para la app.
conversation_logging_settings	ConversationLoggingSettings Es opcional. Es la configuración para describir los comportamientos de registro de conversaciones de la app.
evaluation_audio_recording_config	AudioRecordingConfig Es opcional. Es la configuración sobre cómo se deben registrar las interacciones de audio para la evaluación. De forma predeterminada, la grabación de audio no está habilitada para las sesiones de evaluación.
metric_analysis_settings	MetricAnalysisSettings Es opcional. Es la configuración para describir los comportamientos de recopilación de datos de conversación para la canalización de análisis del LLM de la app.

McpTool

Es una herramienta de MCP. Consulta https://modelcontextprotocol.io/specification/2025-06-18/server/tools para obtener más detalles.

Campos
name	string Obligatorio. Es el nombre de la herramienta de MCP.
name_override	string Es opcional. Es la anulación del nombre de la herramienta de MCP. Este campo se completa si un reemplazo de Toolset anuló el nombre.
description	string Es opcional. Es la descripción de la herramienta de MCP.
input_schema	Schema Es opcional. Es el esquema de los argumentos de entrada de la herramienta de MCP.
output_schema	Schema Es opcional. Es el esquema de los argumentos de salida de la herramienta de MCP.
server_address	string Obligatorio. Es la dirección del servidor de MCP, p.ej., "https://example.com/mcp/". Si el servidor se compila con el SDK de MCP, la URL debe tener el sufijo "/mcp/". Solo se admiten servidores basados en el transporte HTTP que se puede transmitir. Es igual a server_address en McpToolset. Consulta https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http para obtener más detalles.
api_authentication	ApiAuthentication Es opcional. Es la información de autenticación necesaria para ejecutar la herramienta en el servidor de MCP. En el caso de la autenticación con token de portador, el token solo se aplica a la ejecución de la herramienta, no a la enumeración de herramientas. Esto requiere que las herramientas se puedan enumerar sin autenticación.
tls_config	TlsConfig Es opcional. Es la configuración de TLS. Incluye los certificados de servidor personalizados en los que el cliente debe confiar.
service_directory_config	ServiceDirectoryConfig Es opcional. Es la configuración del Directorio de servicios para VPC-SC, que se usa para resolver nombres de servicios dentro de un perímetro.
custom_headers	map<string, string> Es opcional. Son los encabezados personalizados que se enviarán en la solicitud al servidor de MCP. Los valores deben tener el formato $context.variables.<name_of_variable> y se pueden establecer en las variables de sesión. Consulta https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection para obtener más detalles.
state	McpTool.State Solo salida. Es el estado de disponibilidad dinámico de la herramienta en el servidor externo.

Estado

Representa el estado de disponibilidad dinámico de la herramienta.

Enums
STATE_UNSPECIFIED	Es el estado predeterminado.
ACTIVE	La herramienta está disponible y el servidor la ofrece de forma activa.
INACTIVE	La herramienta está configurada o fijada, pero el servidor no la ofrece actualmente.
STALE	La herramienta existe en el servidor, pero no coincide con la versión del servidor.

McpToolDefinition

Es un contenedor para los elementos de definición principales de una herramienta que se capturan. Los esquemas de la instantánea se usan tal cual y no se pueden anular.

Campos
description	string Solo salida. Es la descripción de la herramienta de MCP. description_override en McpToolOverride puede anular este valor.
input_schema	Schema Solo salida. Es el esquema de los argumentos de entrada de la herramienta de MCP.
output_schema	Schema Solo salida. Es el esquema de los argumentos de salida de la herramienta de MCP.

McpToolOverride

Son las anulaciones asociadas con una herramienta determinada en un conjunto de herramientas. Esto permite "fijar" o "anular" las definiciones de herramientas del servidor dinámico externo.

Campos
tool	string Obligatorio. Es el nombre original de la herramienta tal como lo emite el servidor de MCP.
name_override	string Es opcional. Si está presente, esta herramienta usa este nombre en el agente en lugar del nombre original. Se usa principalmente como alias si el servidor de MCP ofrece herramientas con nombres poco claros.
description_override	string Es opcional. Si está presente, esta herramienta usa esta descripción en lugar de la descripción original del servidor.
snapshot	McpToolDefinition Solo salida. Si está presente, esta herramienta está "fijada" y usa los valores de la instantánea como resguardo si el servidor no está disponible temporalmente o si no hay ninguna anulación.

McpToolset

Es un conjunto de herramientas que contiene una lista de las herramientas que ofrece el servidor de MCP.

Campos
server_address	string Obligatorio. Es la dirección del servidor de MCP, por ejemplo, "https://example.com/mcp/". Si el servidor se compila con el SDK de MCP, la URL debe tener el sufijo "/mcp/". Solo se admiten servidores basados en el transporte HTTP que se puede transmitir. Consulta https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http para obtener más detalles.
api_authentication	ApiAuthentication Es opcional. Es la información de autenticación necesaria para acceder a las herramientas y ejecutar una herramienta en el servidor de MCP. En el caso de la autenticación con token de portador, el token solo se aplica a la ejecución de la herramienta, no a la enumeración de herramientas. Esto requiere que las herramientas se puedan enumerar sin autenticación.
service_directory_config	ServiceDirectoryConfig Es opcional. Es la configuración del Directorio de servicios para VPC-SC, que se usa para resolver nombres de servicios dentro de un perímetro.
tls_config	TlsConfig Es opcional. Es la configuración de TLS. Incluye los certificados de servidor personalizados en los que el cliente debe confiar.
custom_headers	map<string, string> Es opcional. Son los encabezados personalizados que se enviarán en la solicitud al servidor de MCP. Los valores deben tener el formato $context.variables.<name_of_variable> y se pueden establecer en las variables de sesión. Consulta https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection para obtener más detalles.
tool_overrides[]	McpToolOverride Es opcional. Son las anulaciones para herramientas individuales dentro de este conjunto de herramientas. Esto permite anular detalles específicos, como descripciones, nombres o fijar los estados de las herramientas para que no sean completamente dinámicos.

Mensaje

Es un mensaje dentro de una conversación.

Campos
role	string Es opcional. Es el rol dentro de la conversación, p.ej., usuario o agente.
chunks[]	Chunk Es opcional. Es el contenido del mensaje como una serie de fragmentos.
event_time	Timestamp Es opcional. Es la marca de tiempo del momento en que se envió o recibió el mensaje. No se debe usar si el mensaje forma parte de un example.

MetricAnalysisSettings

Es la configuración para describir los comportamientos de recopilación de datos de conversaciones para la canalización de métricas de análisis de LLM.

Campos
llm_metrics_opted_out	bool Es opcional. Indica si se deben recopilar datos de conversaciones para las métricas de análisis de LLM. Si es verdadero, no se recopilarán datos de la conversación para las métricas de análisis de LLM; de lo contrario, se recopilarán datos de la conversación.

MockConfig

Es la configuración de las llamadas a herramientas simuladas para la sesión.

Campos
mocked_tool_calls[]	MockedToolCall Es opcional. Son todas las llamadas a herramientas que se simularán durante la sesión.
unmatched_tool_call_behavior	MockConfig.UnmatchedToolCallBehavior Obligatorio. Comportamiento para las llamadas a herramientas que no coinciden con ningún patrón de argumentos en mocked_tool_calls.

UnmatchedToolCallBehavior

Qué hacer cuando una llamada a la herramienta no coincide con ninguna llamada a la herramienta simulada.

Enums
UNMATCHED_TOOL_CALL_BEHAVIOR_UNSPECIFIED	Valor predeterminado. Este valor no se usa.
FAIL	Genera un error para cualquier llamada a la herramienta que no coincida con un patrón de entrada esperado simulado.
PASS_THROUGH	En el caso de las llamadas a herramientas no coincidentes, pasa la llamada a la herramienta real.

MockedToolCall

Es una llamada a la herramienta simulada.

Expresa la herramienta de destino y un patrón para que coincida con los argumentos o las entradas de esa herramienta. Si el patrón coincide, se devolverá la respuesta simulada.

Campos
tool (deprecated)	string Este elemento está obsoleto. Es opcional. Obsoleto. En su lugar, usa tool_identifier.
expected_args_pattern	Struct Obligatorio. Es un patrón que se compara con los argumentos o las entradas de todas las llamadas a herramientas enviadas. Si las entradas de la llamada a la herramienta coinciden con este patrón, se devolverá una salida simulada.
mock_response	Struct Es opcional. Es la respuesta o el resultado simulado que se devolverá si los argumentos o las entradas de la llamada a la herramienta coinciden con el patrón.
Campo de unión tool_identifier. Es el identificador de la herramienta que se simulará. tool_identifier puede ser solo uno de los parámetros siguientes:
tool_id	string Es opcional. Nombre de la herramienta que se simulará. Formato: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
toolset	ToolsetTool Es opcional. Es el conjunto de herramientas que se simulará.

ModelSettings

La configuración del modelo contiene varios parámetros de configuración para el modelo de LLM.

Campos
model	string Es opcional. Es el modelo LLM que debe usar el agente. Si no se configura, el agente heredará el modelo de su agente superior.
temperature	double Es opcional. Si se configura, se usará esta temperatura para el modelo de LLM. La temperatura controla la aleatoriedad de las respuestas del modelo. Las temperaturas más bajas producen respuestas más predecibles. Las temperaturas más altas producen respuestas más creativas.

OAuthConfig

Son los parámetros de configuración para la autenticación con OAuth.

Campos
oauth_grant_type	OAuthConfig.OauthGrantType Obligatorio. Tipos de permisos de OAuth
client_id	string Obligatorio. Es el ID de cliente del proveedor de OAuth.
client_secret_version	string Obligatorio. Nombre del recurso de la versión secreta de Secret Manager que almacena el secreto del cliente. Formato: projects/{project}/secrets/{secret}/versions/{version} Nota: Debes otorgar el rol roles/secretmanager.secretAccessor al agente de servicio de CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.
token_endpoint	string Obligatorio. Es el extremo del token en el proveedor de OAuth para intercambiarlo por un token de acceso.
scopes[]	string Es opcional. Son los permisos de OAuth que se otorgarán.

OauthGrantType

Tipos de permisos de OAuth Solo se admite el otorgamiento de credenciales de cliente.

Enums
OAUTH_GRANT_TYPE_UNSPECIFIED	Sin especificar. El valor predeterminado es CLIENT_CREDENTIAL.
CLIENT_CREDENTIAL	Representa el flujo de credenciales de cliente.

OpenApiTool

Es una herramienta de API remota definida por un esquema de OpenAPI.

Campos
open_api_schema	string Obligatorio. Esquema de OpenAPI en formato JSON o YAML
name	string Es opcional. Es el nombre de la herramienta. Si no se proporciona, el nombre de la herramienta se derivará del esquema de OpenAPI, desde operation.operationId.
description	string Es opcional. Es la descripción de la herramienta. Si no se proporciona, la descripción de la herramienta se derivará del esquema de OpenAPI, de operation.description o operation.summary.
api_authentication	ApiAuthentication Es opcional. Es la información de autenticación que requiere la API.
tls_config	TlsConfig Es opcional. Es la configuración de TLS. Incluye los certificados de servidor personalizados en los que confiará el cliente.
service_directory_config	ServiceDirectoryConfig Es opcional. Es la configuración del Directorio de servicios.
ignore_unknown_fields	bool Es opcional. Si es verdadero, el agente ignorará los campos desconocidos en la respuesta de la API.
url	string Es opcional. Es la URL del servidor del esquema de la API abierta. Este campo solo se configura en las herramientas de las dependencias del entorno durante el proceso de exportación si el esquema contiene una URL del servidor. Durante el proceso de importación, si esta URL está presente en las dependencias del entorno y el esquema tiene el marcador de posición $env_var, se reemplazará el marcador de posición en el esquema.

OpenApiToolset

Es un conjunto de herramientas que contiene una lista de herramientas definidas por un esquema de OpenAPI.

Campos
open_api_schema	string Obligatorio. Es el esquema de OpenAPI del conjunto de herramientas.
api_authentication	ApiAuthentication Es opcional. Es la información de autenticación que requiere la API.
tls_config	TlsConfig Es opcional. Es la configuración de TLS. Incluye los certificados de servidor personalizados
service_directory_config	ServiceDirectoryConfig Es opcional. Es la configuración del Directorio de servicios.
ignore_unknown_fields	bool Es opcional. Si es verdadero, el agente ignorará los campos desconocidos en la respuesta de la API para todas las operaciones definidas en el esquema de OpenAPI.
url	string Es opcional. Es la URL del servidor del esquema de la API abierta. Este campo solo se configura en los conjuntos de herramientas de las dependencias del entorno durante el proceso de exportación si el esquema contiene una URL del servidor. Durante el proceso de importación, si esta URL está presente en las dependencias del entorno y el esquema tiene el marcador de posición $env_var, se reemplazará el marcador de posición en el esquema.

OperationMetadata

Representa los metadatos de la operación de larga duración.

Campos
create_time	Timestamp Es solo de salida. Indica la hora a la que se creó la operación.
end_time	Timestamp Es solo de salida. Indica la hora a la que finalizó la operación.
status_message	string Es solo de salida. Indica el estado legible por humanos de la operación, si corresponde.
requested_cancellation	bool Es solo de salida. Identifica si el usuario solicitó la cancelación de la operación. Las operaciones que se cancelaron con éxito tienen el valor google.longrunning.Operation.error con un google.rpc.Status.code de 1, que corresponde a Code.CANCELLED.

OutputAudioConfig

OutputAudioConfig configura cómo el agente de CES debe sintetizar las respuestas de audio salientes.

Campos
audio_encoding	AudioEncoding Obligatorio. Es la codificación de los datos de audio de salida.
sample_rate_hertz	int32 Obligatorio. Es la tasa de muestreo (en hercios) de los datos de audio de salida.

PythonCodeCondition

Bloque de código de Python para evaluar la condición.

Campos
python_code	string Obligatorio. Es el código de Python que se ejecutará.

PythonFunction

Es una herramienta de función de Python.

Campos
name	string Es opcional. Nombre de la función de Python que se ejecutará. Debe coincidir con un nombre de función de Python definido en el código de Python. Distingue mayúsculas de minúsculas. Si no se proporciona el nombre, se usará la primera función definida en el código de Python.
python_code	string Es opcional. Es el código de Python que se ejecutará para la herramienta.
description	string Solo salida. Es la descripción de la función de Python, analizada a partir de la cadena de documentación del código de Python.
service_directory_config	ServiceDirectoryConfig Es opcional. Es la configuración del Directorio de servicios para la herramienta.

RecognitionResult

Es el resultado del reconocimiento de voz para la entrada de audio.

Campos
transcript	string Es opcional. Son los segmentos concatenados del discurso del usuario capturados durante el turno actual.

RedactionConfig

Es la configuración para indicar cómo se deben controlar los datos sensibles.

Campos
enable_redaction	bool Es opcional. Si es verdadero, se aplicará el ocultamiento en varias situaciones de registro, como el historial de conversaciones, Cloud Logging y la grabación de audio.
inspect_template	string Es opcional. Nombre de la plantilla de inspección de DLP para configurar la detección de tipos de datos sensibles. Formato: projects/{project}/locations/{location}/inspectTemplates/{inspect_template}
deidentify_template	string Es opcional. Nombre de la plantilla de desidentificación de DLP para indicar cómo desidentificar el contenido. Formato: projects/{project}/locations/{location}/deidentifyTemplates/{deidentify_template}

RemoteAgentTool

Representa una herramienta que permite al agente llamar a otro agente remoto.

Campos
name	string Obligatorio. Es el nombre de la herramienta.
description	string Obligatorio. Es la descripción de la herramienta.
agent_card	AgentCard Obligatorio. Es la tarjeta del agente remoto que invoca esta herramienta.
api_authentication	ApiAuthentication Es opcional. Es la configuración de autenticación para llamar al agente remoto.

RestoreAppVersionRequest

Mensaje de solicitud para AgentService.RestoreAppVersion

Campos
name	string Obligatorio. Es el nombre del recurso de la versión de la app que se restablecerá.

RestoreAppVersionResponse

Este tipo no tiene campos.

Mensaje de respuesta para AgentService.RestoreAppVersion

RetrieveToolSchemaRequest

Mensaje de solicitud para ToolService.RetrieveToolSchema.

Campos
parent	string Obligatorio. Es el nombre del recurso de la app a la que pertenece la herramienta o el conjunto de herramientas. Formato: projects/{project}/locations/{location}/apps/{app}
Campo de unión tool_identifier. Es el identificador de la herramienta para la que se recuperará el esquema. Puede ser una herramienta persistente o una herramienta de un conjunto de herramientas. tool_identifier puede ser solo uno de los parámetros siguientes:
tool	string Es opcional. Es el nombre de la herramienta para la que se recuperará el esquema. Formato: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
toolset_tool	ToolsetTool Es opcional. Es la herramienta del conjunto de herramientas para la que se recuperará el esquema. Solo una herramienta debe coincidir con el predicado del conjunto de herramientas. De lo contrario, se mostrará un error.

RetrieveToolSchemaResponse

Mensaje de respuesta para ToolService.RetrieveToolSchema.

Campos
input_schema	Schema Es el esquema de los parámetros de entrada de la herramienta.
output_schema	Schema Es el esquema de los parámetros de salida de la herramienta.
Campo de unión tool_identifier. Es el identificador de la herramienta para la que se usa el esquema. tool_identifier puede ser solo uno de los parámetros siguientes:
tool	string Es el nombre de la herramienta para la que se usa el esquema. Formato: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
toolset_tool	ToolsetTool Es la herramienta del conjunto de herramientas para la que se aplica el esquema.

RetrieveToolsRequest

Mensaje de solicitud para ToolService.RetrieveTools.

Campos
toolset	string Obligatorio. Nombre del conjunto de herramientas para el que se recuperarán las herramientas. Formato: projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}
tool_ids[]	string Es opcional. Son los identificadores de las herramientas que se recuperarán del conjunto de herramientas. Si está vacío, se devolverán todas las herramientas del conjunto de herramientas.
bypass_persistence_config	bool Es opcional. Si es verdadero, las herramientas devueltas contendrán descripciones y esquemas sin procesar directamente desde el servidor, lo que omitirá cualquier configuración de persistencia almacenada (anulaciones o instantáneas).

RetrieveToolsResponse

Mensaje de respuesta para ToolService.RetrieveTools.

Campos
tools[]	Tool Es la lista de herramientas que se incluyen en el conjunto de herramientas especificado.

RunSessionRequest

Mensaje de solicitud para SessionService.RunSession.

Campos
config	SessionConfig Obligatorio. Es la configuración de la sesión.
inputs[]	SessionInput Obligatorio. Son las entradas de la sesión.

RunSessionResponse

Mensaje de respuesta para SessionService.RunSession.

Campos
outputs[]	SessionOutput Son los resultados de la sesión.

Esquema

Representa un subconjunto selecto de un objeto de esquema de OpenAPI 3.0.

Campos
type	Schema.Type Obligatorio. Es el tipo de datos.
properties	map<string, Schema> Es opcional. Son las propiedades de Type.OBJECT.
required[]	string Es opcional. Son las propiedades obligatorias de Type.OBJECT.
description	string Es opcional. La descripción de los datos.
items	Schema Es opcional. Esquema de los elementos de Type.ARRAY.
nullable	bool Es opcional. Indica si el valor puede ser nulo.
unique_items	bool Es opcional. Indica que los elementos del array deben ser únicos. Solo se aplica a TYPE.ARRAY.
prefix_items[]	Schema Es opcional. Esquemas de los elementos iniciales de Type.ARRAY.
additional_properties	Schema Es opcional. Puede ser un valor booleano o un objeto, y controla la presencia de propiedades adicionales.
any_of[]	Schema Es opcional. El valor se debe validar en relación con cualquiera de los subesquemas (uno o más) de la lista.
enum[]	string Es opcional. Valores posibles del elemento de tipo primitivo con formato de enumeración. Ejemplos: 1. Podemos definir la dirección de la siguiente manera : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. Podemos definir el número de departamento de la siguiente manera : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
default	Value Es opcional. Es el valor predeterminado de los datos.
ref	string Es opcional. Permite referencias indirectas entre los nodos del esquema. El valor debe ser una referencia válida a un elemento secundario del defs raíz. Por ejemplo, el siguiente esquema define una referencia a un nodo de esquema llamado "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string El valor de la propiedad "pet" es una referencia al nodo del esquema llamado "Pet". Consulta los detalles en https://json-schema.org/understanding-json-schema/structuring.
defs	map<string, Schema> Es opcional. Es un mapa de definiciones para que lo use ref. Solo se permite en la raíz del esquema.
title	string Es opcional. Es el título del esquema.
min_items	int64 Es opcional. Es la cantidad mínima de elementos para Type.ARRAY.
max_items	int64 Es opcional. Es la cantidad máxima de elementos para Type.ARRAY.
minimum	double Es opcional. Es el valor mínimo para Type.INTEGER y Type.NUMBER.
maximum	double Es opcional. Es el valor máximo para Type.INTEGER y Type.NUMBER.

Tipo

Son los tipos de datos de OpenAPI.

Enums
TYPE_UNSPECIFIED	Indica un tipo no especificado.
STRING	Tipo de cadena.
INTEGER	Es de tipo entero.
NUMBER	Es el tipo de número.
BOOLEAN	Tipo booleano.
OBJECT	Tipo de objeto.
ARRAY	Es el tipo de array.

SecuritySettings

Parámetros de configuración de seguridad a nivel del proyecto o la ubicación para CES.

Campos
name	string Es el identificador. Es el identificador único de la configuración de seguridad. Formato: projects/{project}/locations/{location}/securitySettings
endpoint_control_policy	EndpointControlPolicy Es opcional. Es la configuración relacionada con el control de extremos.
create_time	Timestamp Solo salida. Fecha y hora de creación de la configuración de seguridad.
update_time	Timestamp Solo salida. Es la fecha y hora de la última actualización de la configuración de seguridad.
etag	string Solo salida. Es el ETag de la configuración de seguridad.

ServiceAccountAuthConfig

Es la configuración para la autenticación con una cuenta de servicio personalizada.

Campos
service_account	string Obligatorio. Es la dirección de correo electrónico de la cuenta de servicio que se usa para la autenticación. CES usa esta cuenta de servicio para intercambiar un token de acceso, que luego se envía en el encabezado Authorization de la solicitud. La cuenta de servicio debe tener el rol roles/iam.serviceAccountTokenCreator otorgado al agente de servicio de CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.
scopes[]	string Es opcional. Son los permisos de OAuth que se otorgarán. Si no se especifica, se usa el alcance predeterminado https://www.googleapis.com/auth/cloud-platform.

ServiceAgentIdTokenAuthConfig

Este tipo no tiene campos.

Son las configuraciones para la autenticación con el token de ID generado desde el agente de servicio.

ServiceDirectoryConfig

Es la configuración para las herramientas que usan el Directorio de servicios.

Campos
service	string Obligatorio. Nombre del servicio de Service Directory. Formato: projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}. La ubicación del directorio de servicios debe ser la misma que la de la app.

SessionConfig

Es la configuración de la sesión.

Campos
session	string Obligatorio. Es el identificador único de la sesión. Formato: projects/{project}/locations/{location}/apps/{app}/sessions/{session}
input_audio_config	InputAudioConfig Es opcional. Es la configuración para procesar el audio de entrada.
output_audio_config	OutputAudioConfig Es opcional. Es la configuración para generar el audio de salida.
historical_contexts[]	Message Es opcional. Es el contexto histórico de la sesión, incluidas las entradas del usuario, las respuestas del agente y otros mensajes. Por lo general, el agente de CES administra la sesión automáticamente, por lo que el cliente no necesita completar este campo de forma explícita. Sin embargo, el cliente puede anular de forma opcional los contextos históricos para forzar el inicio de la sesión desde un estado determinado.
entry_agent	string Es opcional. Es el agente de entrada para controlar la sesión. Si no se especifica, la sesión la controlará el root agent de la app. Formato: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
deployment	string Es opcional. Es la implementación de la app que se usará para la sesión. Formato: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
time_zone	string Es opcional. Zona horaria del usuario. Si se proporciona, el agente usará la zona horaria para las variables relacionadas con la fecha y la hora. De lo contrario, el agente usará la zona horaria especificada en App.time_zone_settings. El formato es la zona horaria de la base de datos de zonas horarias de IANA, p.ej., "America/Los_Angeles".
use_tool_fakes	bool Es opcional. Indica si se deben usar simulaciones de herramientas para la sesión. Si se configura este campo, el agente intentará usar simulaciones de herramientas en lugar de llamar a las herramientas reales.
remote_dialogflow_query_parameters	SessionConfig.RemoteDialogflowQueryParameters Es opcional. QueryParameters para enviar al agente remoto de Dialogflow cuando se transfiera el control de la sesión al agente remoto.
enable_text_streaming	bool Es opcional. Indica si se deben habilitar las salidas de texto de transmisión del modelo. De forma predeterminada, las salidas de texto del modelo se recopilan antes de enviarse al cliente. NOTA: Esto solo se admite para sesiones de texto (no de voz) a través de StreamRunSession o BidiRunSession.
exclude_diagnostic_info	bool Es opcional. Indica si se debe excluir la información de diagnóstico del resultado de la sesión.

RemoteDialogflowQueryParameters

QueryParameters para enviar al agente remoto de Dialogflow cuando se transfiera el control de la sesión al agente remoto.

Campos
webhook_headers	map<string, string> Es opcional. Son los encabezados HTTP que se enviarán como webhook_headers en QueryParameters.
payload	Struct Es opcional. Es la carga útil que se enviará en QueryParameters.
end_user_metadata	Struct Es opcional. Son los metadatos del usuario final que se enviarán en QueryParameters.

SessionInput

Es la entrada de la sesión.

Campos
will_continue	bool Es opcional. Es una marca para indicar si el mensaje actual es un fragmento de una entrada más grande en la sesión de transmisión bidireccional. Cuando se establece en true, el agente aplaza el procesamiento hasta que recibe un mensaje posterior en el que will_continue es false o hasta que el sistema detecta un extremo en la entrada de audio. NOTA: Este campo no se aplica a las entradas de audio y DTMF, ya que siempre se procesan automáticamente según la señal de finalización.
Campo de unión input_type. Es el tipo de entrada. input_type puede ser solo uno de los parámetros siguientes:
text	string Es opcional. Son los datos de texto del usuario final.
dtmf	string Es opcional. Dígitos de DTMF del usuario final.
audio	bytes Es opcional. Son los datos de audio del usuario final.
tool_responses	ToolResponses Es opcional. Son los resultados de la ejecución de las llamadas a herramientas del cliente.
image	Image Es opcional. Son los datos de imagen del usuario final.
blob	Blob Es opcional. Son los datos de BLOB del usuario final.
variables	Struct Es opcional. Son las variables contextuales de la sesión, con la clave establecida por el nombre. El agente de CES solo usará las variables declaradas en la app. Las variables no reconocidas se seguirán enviando al [agente de Dialogflow][Agent.RemoteDialogflowAgent] como parámetros de sesión adicionales.
event	Event Es opcional. Es la entrada del evento.

SessionOutput

Es el resultado de la sesión.

Campos
turn_index	int32 Indica el orden secuencial del turno de conversación al que pertenece esta respuesta, comenzando por 1.
turn_completed	bool Si es verdadero, el agente de CES detectó el final del turno de conversación actual y no proporcionará más resultados para este turno.
diagnostic_info	SessionOutput.DiagnosticInfo Es opcional. La información de diagnóstico contiene detalles de la ejecución durante el procesamiento de la entrada. Solo se completa en el último SessionOutput (con turn_completed=true) de cada turno.
context[]	Any Son mensajes de contexto para las protecciones externas de supervisión.
Campo de unión output_type. Es el tipo de salida. output_type puede ser solo uno de los parámetros siguientes:
text	string Es el texto de salida del agente de CES.
audio	bytes Audio de salida del agente de CES.
tool_calls	ToolCalls Solicitud para que el cliente ejecute las herramientas.
citations	Citations Son las citas que proporcionan la información de la fuente del texto generado por el agente.
google_search_suggestions	GoogleSearchSuggestions Son las sugerencias que devuelve la Búsqueda de Google como resultado de invocar GoogleSearchTool.
end_session	EndSession Indica que finalizó la sesión.
payload	Struct Es una carga útil personalizada con resultados estructurados del agente de CES.
image	Image Es la imagen de salida del agente de CES.

DiagnosticInfo

Contiene detalles de la ejecución durante el procesamiento.

Campos
messages[]	Message Es la lista de los mensajes que se produjeron durante el procesamiento.
root_span	Span Es un registro de todo el procesamiento de la solicitud, representado como un intervalo raíz. Este intervalo puede contener intervalos secundarios anidados para operaciones específicas.

Intervalo

Un tramo es una unidad de trabajo o una sola operación durante el procesamiento de la solicitud.

Campos
name	string Solo salida. Es el nombre del intervalo.
start_time	Timestamp Solo salida. Es la hora de inicio del período.
end_time	Timestamp Solo salida. Es la hora de finalización del período.
duration	Duration Solo salida. Es la duración del intervalo.
attributes	Struct Solo salida. Son los atributos clave-valor asociados con el intervalo.
child_spans[]	Span Solo salida. Son los intervalos secundarios anidados en este intervalo.

SynthesizeSpeechConfig

Es la configuración de cómo se debe sintetizar la respuesta del agente.

Campos
voice	string Opcional. El nombre de la voz. Si no se configura, el servicio elegirá una voz según los otros parámetros, como language_code. Para obtener la lista de voces disponibles, consulta Voces y lenguajes compatibles en Cloud Text-to-Speech.
voice_sample_gcs_uri (deprecated)	string Este elemento está obsoleto. Es opcional. Obsoleto: Usa custom_voice_samples en AudioProcessingConfig en su lugar. Es el URI de Cloud Storage de la muestra de audio para la clonación de voz. La muestra de audio debe ser un archivo WAV de un solo canal y 24 kHz. Nota: Asegúrate de que el agente de servicio de CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com tenga permiso storage.objects.get para el objeto de Cloud Storage.
speaking_rate	double Es opcional. Es la velocidad de habla en el intervalo [0.25, 2.0]. 1.0 es la velocidad nativa normal que admite la voz específica. 2.0 es el doble de rápido y 0.5 es la mitad. Los valores fuera del rango [0.25, 2.0] mostrarán un error.
model	string Es opcional. Es el modelo que se usa para sintetizar audio. Actualmente, se admiten los siguientes valores: "gemini-3.1-flash-tts-preview". Si está vacío, se usa Chirp3-HD.
instruction	string Es opcional. Es la instrucción que se usa para sintetizar el habla cuando se usa un modelo generativo.
consent_audio_gcs_uri (deprecated)	string Este elemento está obsoleto. Es opcional. Obsoleto: Usa custom_voice_samples en AudioProcessingConfig en su lugar. Es el URI de Cloud Storage del audio de consentimiento para la clonación de voz.

SystemTool

Es una herramienta del sistema predefinida.

Campos
name	string Obligatorio. Es el nombre de la herramienta del sistema.
description	string Solo salida. Es la descripción de la herramienta del sistema.

TimeZoneSettings

Es la configuración de zona horaria de la app.

Campos
time_zone	string Es opcional. Zona horaria de la app de la base de datos de zonas horarias, p.ej., America/Los_Angeles, Europe/Paris.

TlsConfig

Es la configuración de TLS.

Campos
ca_certs[]	TlsConfig.CaCert Obligatorio. Especifica una lista de certificados de CA personalizados permitidos para la verificación de HTTPS.

CaCert

Es el certificado de la AC.

Campos
display_name	string Obligatorio. Nombre de los certificados de CA personalizados permitidos. Se puede usar para desambiguar los certificados de CA personalizados.
cert	bytes Obligatorio. Son los certificados de AC personalizados permitidos (en formato DER) para la verificación de HTTPS. Esto anula el almacén de confianza de SSL predeterminado. Si este campo está vacío o no se especifica, CES usará el almacén de confianza predeterminado de Google para verificar los certificados. Nota: Asegúrate de que los certificados del servidor HTTPS estén firmados con "subject alt name". Por ejemplo, un certificado se puede autofirmar con el siguiente comando: openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'")

Herramienta

Una herramienta representa una acción que el agente de CES puede realizar para alcanzar ciertos objetivos.

Campos
name	string Es el identificador. Es el nombre del recurso de la herramienta. Formato: projects/{project}/locations/{location}/apps/{app}/tools/{tool} para herramientas independientes projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool} para las herramientas recuperadas de un conjunto de herramientas Estas herramientas son dinámicas y solo de salida; no se pueden hacer referencia directamente a ellas donde se espera una herramienta.
display_name	string Solo salida. Es el nombre visible de la herramienta, que se deriva según el tipo de herramienta. Por ejemplo, el nombre visible de un [ClientFunction][Tool.ClientFunction] se deriva de su propiedad name.
execution_type	ExecutionType Es opcional. Es el tipo de ejecución de la herramienta.
timeout	Duration Es opcional. Es el tiempo de espera para la ejecución de la herramienta. Si no se establece, el tiempo de espera predeterminado es de 30 segundos para las herramientas de SYNCHRONOUS y de 60 segundos para las herramientas de ASYNCHRONOUS.
create_time	Timestamp Solo salida. Es la marca de tiempo de cuando se creó la herramienta.
update_time	Timestamp Solo salida. Es la marca de tiempo de la última actualización de la herramienta.
etag	string Es el ETag que se usa para garantizar que el objeto no haya cambiado durante una operación de lectura, modificación y escritura. Si el ETag está vacío, la actualización reemplazará cualquier cambio simultáneo.
generated_summary	string Solo salida. Si el asistente de LLM genera la herramienta, este campo contiene un resumen descriptivo de la generación.
tool_fake_config	ToolFakeConfig Es opcional. Es la configuración del comportamiento de la herramienta en el modo simulado.
Campo de unión tool_type. Es el tipo de herramienta. tool_type puede ser solo uno de los parámetros siguientes:
client_function	ClientFunction Es opcional. Es la función del cliente.
open_api_tool	OpenApiTool Es opcional. Es la herramienta de API abierta.
google_search_tool	GoogleSearchTool Es opcional. Es la herramienta de Búsqueda de Google.
connector_tool	ConnectorTool Es opcional. La herramienta Integration Connector
data_store_tool	DataStoreTool Es opcional. Es la herramienta de almacén de datos.
python_function	PythonFunction Es opcional. Es la herramienta de función de Python.
mcp_tool	McpTool Es opcional. Es la herramienta de MCP. Una herramienta de MCP no se puede crear ni actualizar directamente, y la administra el conjunto de herramientas de MCP.
file_search_tool	FileSearchTool Es opcional. Es la herramienta de búsqueda de archivos.
system_tool	SystemTool Es opcional. Es la herramienta del sistema.
agent_tool	AgentTool Es opcional. Es la herramienta del agente.
widget_tool	WidgetTool Es opcional. La herramienta de widget.
remote_agent_tool	RemoteAgentTool Es opcional. Es la herramienta del agente remoto.

ToolCall

Solicitud para que el cliente o el agente ejecuten la herramienta especificada.

Campos
id	string Es opcional. Es el identificador único de la llamada a la herramienta. Si se completa, el cliente debe devolver el resultado de la ejecución con el ID para coincidencias en ToolResponse.
display_name	string Solo salida. Nombre visible de la herramienta.
args	Struct Es opcional. Son los parámetros y valores de entrada de la herramienta en formato de objeto JSON.
parent_tool_call_id	string Solo salida. Es el ID de la llamada a la herramienta que causó esta, cuando la emitió un subagente que trabaja en nombre de una llamada principal. Está vacío para las llamadas de nivel superior. Permite que un cliente agrupe el trabajo de un subagente en la llamada que lo inició en lugar de renderizar cada paso como un elemento secundario.
agent_name	string Solo salida. Nombre legible por humanos del agente que emitió esta llamada, p.ej., "Arquitecto de contratos". Está vacío cuando el agente raíz lo emitió.
Campo de unión tool_identifier. Es el identificador de la herramienta que se ejecutará. Puede ser una herramienta persistente o una herramienta de un conjunto de herramientas. tool_identifier puede ser solo uno de los parámetros siguientes:
tool	string Es opcional. Es el nombre de la herramienta que se ejecutará. Formato: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
toolset_tool	ToolsetTool Es opcional. Es la herramienta del conjunto de herramientas que se ejecutará.

ToolCalls

Solicitud para que el cliente ejecute las herramientas y muestre los resultados de la ejecución antes de continuar con la sesión.

Campos
tool_calls[]	ToolCall Es opcional. Es la lista de llamadas a herramientas que se ejecutarán.

ToolFakeConfig

Es la configuración del comportamiento de la herramienta en el modo simulado.

Campos
enable_fake_mode	bool Es opcional. Indica si la herramienta usa el modo falso.
Campo de unión tool_response. La respuesta es estática o la proporciona una función de Python. tool_response puede ser solo uno de los parámetros siguientes:
code_block	CodeBlock Es opcional. Es el bloque de código que se ejecutará en lugar de una llamada a la herramienta real.

ToolResponse

Es el resultado de la ejecución de una herramienta específica del cliente o del agente.

Campos
id	string Es opcional. Es el ID para coincidencias del tool call para el que es la respuesta.
display_name	string Solo salida. Nombre visible de la herramienta.
response	Struct Obligatorio. Es el resultado de la ejecución de la herramienta en formato de objeto JSON. Usa la clave "output" para especificar la respuesta de la herramienta y la clave "error" para especificar los detalles del error (si corresponde). Si no se especifican las claves "output" y "error", toda la "response" se trata como resultado de la ejecución de la herramienta.
parent_tool_call_id	string Solo salida. Es el ID de la llamada a la herramienta que causó esta, cuando la emitió un subagente que trabaja en nombre de una llamada principal. Está vacío para las llamadas de nivel superior. Permite que un cliente agrupe el trabajo de un subagente en la llamada que lo inició en lugar de renderizar cada paso como un elemento secundario.
agent_name	string Solo salida. Nombre legible por humanos del agente que emitió esta llamada, p.ej., "Arquitecto de contratos". Está vacío cuando el agente raíz lo emitió.
Campo de unión tool_identifier. Es el identificador de la herramienta que se ejecutó. Puede ser una herramienta persistente o una herramienta de un conjunto de herramientas. tool_identifier puede ser solo uno de los parámetros siguientes:
tool	string Es opcional. Es el nombre de la herramienta que se ejecutará. Formato: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
toolset_tool	ToolsetTool Es opcional. Es la herramienta del conjunto de herramientas que se ejecutó.

ToolResponses

Son los resultados de la ejecución de las llamadas a herramientas solicitadas por el cliente.

Campos
tool_responses[]	ToolResponse Es opcional. Es la lista de resultados de la ejecución de la herramienta.

Conjunto de herramientas

Un conjunto de herramientas representa un grupo de herramientas administradas de forma dinámica que el agente puede usar.

Campos
name	string Es el identificador. Es el identificador único del conjunto de herramientas. Formato: projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}
display_name	string Es opcional. Es el nombre visible del conjunto de herramientas. Debe ser único dentro de la misma app.
description	string Es opcional. Es la descripción del conjunto de herramientas.
timeout	Duration Es opcional. Es el tiempo de espera para la ejecución del conjunto de herramientas. Si no se establece, el tiempo de espera predeterminado es de 30 segundos para los conjuntos de herramientas de SYNCHRONOUS y de 60 segundos para los conjuntos de herramientas de ASYNCHRONOUS.
create_time	Timestamp Solo salida. Es la marca de tiempo de cuando se creó el conjunto de herramientas.
update_time	Timestamp Solo salida. Es la marca de tiempo de la última actualización del conjunto de herramientas.
etag	string ETag que se usa para garantizar que el objeto no haya cambiado durante una operación de lectura, modificación y escritura. Si el ETag está vacío, la actualización reemplazará cualquier cambio simultáneo.
execution_type	ExecutionType Es opcional. Es el tipo de ejecución de las herramientas en el conjunto de herramientas.
tool_fake_config	ToolFakeConfig Es opcional. Es la configuración del comportamiento de las herramientas en el modo simulado.
Campo de unión toolset_type. Es el tipo de conjunto de herramientas. toolset_type puede ser solo uno de los parámetros siguientes:
mcp_toolset	McpToolset Es opcional. Es un conjunto de herramientas que contiene una lista de las herramientas que ofrece el servidor de MCP.
open_api_toolset	OpenApiToolset Es opcional. Es un conjunto de herramientas que contiene una lista de herramientas definidas por un esquema de OpenAPI.
connector_toolset	ConnectorToolset Es opcional. Es un conjunto de herramientas que genera herramientas a partir de una conexión de Integration Connectors.

ToolsetTool

Es una herramienta que se crea a partir de un conjunto de herramientas.

Campos
toolset	string Obligatorio. Es el nombre del recurso del conjunto de herramientas del que se deriva esta herramienta. Formato: projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}
tool_id	string Es opcional. Es el ID de la herramienta para filtrar las herramientas y recuperar el esquema.

TransferRule

Es la regla para transferir a un agente específico.

Campos
child_agent	string Obligatorio. Es el nombre del recurso del agente secundario al que se aplica la regla. Formato: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
direction	TransferRule.Direction Obligatorio. Es la dirección de la transferencia.
Campo de unión rule_type. Es el tipo de regla. rule_type puede ser solo uno de los parámetros siguientes:
deterministic_transfer	TransferRule.DeterministicTransfer Es opcional. Es una regla que se transfiere de inmediato al agente objetivo cuando se cumple la condición.
disable_planner_transfer	TransferRule.DisablePlannerTransfer Es opcional. Es una regla que impide que el planificador transfiera al agente objetivo.

DeterministicTransfer

Es una regla de transferencia determinística. Cuando la condición se evalúa como verdadera, se produce la transferencia.

Campos
Campo de unión condition_type. Es la condición que se evaluará. condition_type puede ser solo uno de los parámetros siguientes:
expression_condition	ExpressionCondition Es opcional. Es una regla que evalúa una condición de estado de la sesión. Si la condición se evalúa como verdadera, se realiza la transferencia.
python_code_condition	PythonCodeCondition Es opcional. Es una regla que usa un bloque de código de Python para evaluar las condiciones. Si la condición se evalúa como verdadera, se realiza la transferencia.

Dirección

Es la dirección de la transferencia.

Enums
DIRECTION_UNSPECIFIED	Dirección no especificada.
PARENT_TO_CHILD	Transferencia del agente principal al agente secundario.
CHILD_TO_PARENT	Transferencia del agente secundario al agente principal.

DisablePlannerTransfer

Es una regla que impide que el planificador se transfiera al agente objetivo.

Campos
expression_condition	ExpressionCondition Obligatorio. Si la condición se evalúa como verdadera, no se permitirá que el planificador transfiera la llamada al agente de destino.

TriggerAction

Es la acción que se realiza cuando se cumple una condición previa determinada.

Campos
Campo de unión action. La acción por realizar. action puede ser solo uno de los parámetros siguientes:
respond_immediately	TriggerAction.RespondImmediately Es opcional. Responder de inmediato con una respuesta preconfigurada
transfer_agent	TriggerAction.TransferAgent Es opcional. Transferir la conversación a otro agente
generative_answer	TriggerAction.GenerativeAnswer Es opcional. Responder con una respuesta generativa

GenerativeAnswer

El agente responderá de inmediato con una respuesta generativa.

Campos
prompt	string Obligatorio. Es la instrucción que se usará para la respuesta generativa.

RespondImmediately

El agente responderá de inmediato con una respuesta preconfigurada.

Campos
responses[]	TriggerAction.Response Obligatorio. Son las respuestas estándar que puede elegir el agente. La respuesta se elige de forma aleatoria.

Respuesta

Representa una respuesta del agente.

Campos
text	string Obligatorio. Es el texto con el que responderá el agente.
disabled	bool Es opcional. Indica si la respuesta está inhabilitada. El agente no usa las respuestas inhabilitadas.

TransferAgent

El agente transferirá la conversación a otro agente.

Campos
agent	string Obligatorio. Es el nombre del agente al que se transferirá la conversación. El agente debe estar en la misma app que el agente actual. Formato: projects/{project}/locations/{location}/apps/{app}/agents/{agent}

UpdateAgentRequest

Mensaje de solicitud para AgentService.UpdateAgent.

Campos
agent	Agent Obligatorio. El agente que se actualizará.
update_mask	FieldMask Es opcional. La máscara de campo se usa para controlar qué campos se actualizan. Si la máscara no está presente, se actualizarán todos los campos.

UpdateAppRequest

Mensaje de solicitud para AgentService.UpdateApp.

Campos
app	App Obligatorio. Es la app que se actualizará.
update_mask	FieldMask Es opcional. La máscara de campo se usa para controlar qué campos se actualizan. Si la máscara no está presente, se actualizarán todos los campos.

UpdateDeploymentRequest

Mensaje de solicitud para AgentService.UpdateDeployment.

Campos
deployment	Deployment Obligatorio. Es la implementación que se actualizará.
update_mask	FieldMask Es opcional. La lista de campos que se deben actualizar.

UpdateExampleRequest

Mensaje de solicitud para AgentService.UpdateExample.

Campos
example	Example Obligatorio. Es el ejemplo que se actualizará.
update_mask	FieldMask Es opcional. La máscara de campo se usa para controlar qué campos se actualizan. Si la máscara no está presente, se actualizarán todos los campos.

UpdateGuardrailRequest

Mensaje de solicitud para AgentService.UpdateGuardrail.

Campos
guardrail	Guardrail Obligatorio. Es la protección que se actualizará.
update_mask	FieldMask Es opcional. La máscara de campo se usa para controlar qué campos se actualizan. Si la máscara no está presente, se actualizarán todos los campos.

UpdateToolRequest

Mensaje de solicitud para AgentService.UpdateTool.

Campos
tool	Tool Obligatorio. Es la herramienta que se actualizará.
update_mask	FieldMask Es opcional. La máscara de campo se usa para controlar qué campos se actualizan. Si la máscara no está presente, se actualizarán todos los campos.

UpdateToolsetRequest

Mensaje de solicitud para AgentService.UpdateToolset.

Campos
toolset	Toolset Obligatorio. Es el conjunto de herramientas que se actualizará.
update_mask	FieldMask Es opcional. La máscara de campo se usa para controlar qué campos se actualizan. Si la máscara no está presente, se actualizarán todos los campos.

VpcScSettings

Es la configuración de VPC-SC para la app.

Campos

allowed_origins[]

string Es opcional. Son los orígenes HTTP(S) permitidos a los que las herramientas de OpenAPI en la app pueden llamar directamente cuando los Controles del servicio de VPC están habilitados. Estas cadenas deben coincidir exactamente con el origen, incluido el puerto si se especifica. Por ejemplo, "https://example.com" o "https://example.com:443". Esta lista aún no se aplica a las herramientas de Python que pueden realizar llamadas HTTP directas.

WebSearchQuery

Representa una sola búsqueda web y su URI de búsqueda asociado.

Campos
query	string Es el texto de la búsqueda.
uri	string Es el URI de la página de resultados de búsqueda de Google para la búsqueda.

WhatsAppCredentials

Son credenciales de Meta efímeras para la integración nativa de WhatsApp.

Campos
auth_code	string Obligatorio. Es el código de autorización de Meta que proporciona el flujo de registro integrado.
pin	string Obligatorio. Es el PIN de 6 dígitos que creó el usuario para la verificación en dos pasos.
phone_number	string Obligatorio. Número de teléfono con el que se registrará en WhatsApp.
business_account_id	string Obligatorio. Es el ID de la cuenta comercial que se usará para el número de teléfono.
waba_id	string Obligatorio. Es el ID de la cuenta de WhatsApp Business.
conversation_profile_id	string Es opcional. Es el ID del perfil de conversación que se usará para la implementación.

WidgetTool

Representa una herramienta de widget que el agente puede invocar. Cuando el agente elige la herramienta, devuelve el widget al cliente. El cliente es responsable de procesar el widget y generar la siguiente búsqueda del usuario para continuar la interacción con el agente.

Campos
name	string Obligatorio. Es el nombre visible de la herramienta del widget.
description	string Es opcional. Es la descripción de la herramienta del widget.
widget_type	WidgetTool.WidgetType Es opcional. Es el tipo de herramienta del widget. Si no se especifica, el tipo predeterminado será CUSTOMIZED.
ui_config	Struct Es opcional. Es la configuración para renderizar el widget.
data_mapping	WidgetTool.DataMapping Es opcional. Es la asignación que define cómo se asignan los datos de una herramienta de origen a los parámetros de entrada del widget.
text_response_config	WidgetTool.TextResponseConfig Es opcional. Es la configuración para las respuestas de texto que siempre se incluyen.
Campo de unión input. Es la entrada de la herramienta de widget. input puede ser solo uno de los parámetros siguientes:
parameters	Schema Es opcional. Son los parámetros de entrada de la herramienta de widget.

DataMapping

Es la configuración para asignar datos de una herramienta de origen a los parámetros de entrada del widget.

Campos
source_tool_name	string Es opcional. Es el nombre del recurso de la herramienta que proporciona los datos para el widget (p.ej., una herramienta de búsqueda o una función personalizada). Formato: projects/{project}/locations/{location}/agents/{agent}/tools/{tool}
field_mappings	map<string, string> Es opcional. Es un mapa de los campos de parámetros de entrada del widget a los campos de salida correspondientes de la herramienta de origen.
python_function	PythonFunction Es opcional. Es la configuración de una función de Python que se usa para transformar el resultado de la herramienta fuente en el formato de entrada del widget.
mode	WidgetTool.DataMapping.Mode Es opcional. Es el modo de la asignación de datos.
python_script (deprecated)	string Este elemento está obsoleto. Obsoleto: Usa python_function en su lugar.

Modo

Es la estrategia que se usa para asignar datos de la herramienta de origen al widget.

Enums
MODE_UNSPECIFIED	Modo sin especificar.
FIELD_MAPPING	Usa el mapa field_mappings para la transformación de datos.
PYTHON_SCRIPT	Usa python_script para la transformación de datos.

TextResponseConfig

Es la configuración de la respuesta de texto que se muestra con el widget.

Campos
type	WidgetTool.TextResponseConfig.Type Es opcional. Es la estrategia para proporcionar la respuesta de texto.
static_text	string Es opcional. Es la respuesta de texto estático que se devolverá cuando el tipo sea STATIC.
text_response_instruction	string Es opcional. Instrucción para el LLM sobre cómo generar la respuesta de texto. Se usa como la descripción del parámetro de respuesta de texto si el tipo es LLM_GENERATED.

Tipo

Define cómo se produce la respuesta de texto.

Enums
TYPE_UNSPECIFIED	Indica un tipo no especificado.
NONE	El LLM decide de forma dinámica si generará una respuesta de texto junto con el widget según el contexto de la conversación.
LLM_GENERATED	Se requiere explícitamente que el LLM genere una respuesta de texto.
STATIC	Siempre se usa una respuesta de texto estático predefinida.

WidgetType

Son todos los tipos de widgets disponibles. Es posible que se agreguen valores nuevos a este enum en el futuro.

Enums
WIDGET_TYPE_UNSPECIFIED	Tipo de widget sin especificar.
CUSTOM	Es el tipo de widget personalizado.
PRODUCT_CAROUSEL	Es un widget de carrusel de productos.
PRODUCT_DETAILS	Es un widget de detalles del producto.
QUICK_ACTIONS	Widget de acciones rápidas.
PRODUCT_COMPARISON	Es un widget de comparación de productos.
ADVANCED_PRODUCT_DETAILS	Es un widget de detalles del producto avanzados.
SHORT_FORM	Es un widget de formato corto.
OVERALL_SATISFACTION	Es un widget de satisfacción general.
ORDER_SUMMARY	Es un widget de resumen del pedido.
APPOINTMENT_DETAILS	Widget de detalles de la cita.
APPOINTMENT_SCHEDULER	Widget del programador de citas
CONTACT_FORM	Es un widget de formulario de contacto.