Package google.cloud.ces.v1

Índice

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 por lotes 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 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.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 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.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 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.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 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.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 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.create

Para obtener más información, consulta la documentación de IAM.

CreateGuardrail

rpc CreateGuardrail(CreateGuardrailRequest) returns (Guardrail)

Crea una nueva barandilla 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.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 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.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 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.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 barandilla 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 los 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 los 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 los 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 los detalles de 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 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.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 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.appVersions.list

Para obtener más información, consulta la documentación de IAM.

ListApps

rpc ListApps(ListAppsRequest) returns (ListAppsResponse)

Enumera las apps en la ubicación y el proyecto 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 de 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 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.deployments.list

Para obtener más información, consulta la documentación de IAM.

ListExamples

rpc ListExamples(ListExamplesRequest) returns (ListExamplesResponse)

Enumera los ejemplos de 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 las protecciones de 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.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 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.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 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.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 nueva versión 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.

UpdateAppVersion

rpc UpdateAppVersion(UpdateAppVersionRequest) returns (AppVersion)

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

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

--- Flujo de solicitudes del cliente --- El cliente transmite las solicitudes en el siguiente orden:

  1. Inicialización: El primer mensaje debe contener SessionConfig. En el caso de las sesiones de audio, también se deben incluir InputAudioConfig y OutputAudioConfig para definir los parámetros de procesamiento y síntesis de audio.

  2. Interacción: Flujo de mensajes posteriores SessionInput que contiene datos de entrada del usuario en tiempo real.

  3. Finalización: El cliente debe cerrar parcialmente la transmisión cuando no haya más entradas del usuario. También debería cerrarse a medias cuando reciba EndSession o GoAway del agente.

--- Transmisión de respuesta del servidor --- Para cada turno de interacción, el agente transmite mensajes en la siguiente secuencia:

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

  2. Respuesta (siguientes M mensajes): Contiene SessionOutput que entrega la respuesta del agente en varias modalidades (p.ej., texto, audio).

  3. Turn Completion (mensaje final del turno): Contiene SessionOutput con turn_completed establecido como verdadero. Esto indica el final del turno actual y, además, incluye DiagnosticInfo con detalles de la ejecución.

--- Audio Best Practices --- 1. Transmisión: Transmite audio data DE FORMA CONTINUA, incluso durante los silencios. Tamaño de fragmento recomendado: 40-120 ms (equilibra la latencia y la eficiencia).

  1. Reproducción e interrupción: Reproduce audio responses cuando se reciba. 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.

CancelAssistantTurn

rpc CancelAssistantTurn(CancelAssistantTurnRequest) returns (CancelAssistantTurnResponse)

Cancela el turno en curso de la sesión del asistente, si lo hay: la detención explícita del usuario para un turno que se ejecuta de forma independiente de cualquier transmisión. Una cancelación que llega a una tarea que no aloja el turno lo interrumpe a través de la época del turno de la sesión, lo que lo finaliza dentro de una renovación de la asignació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 name:

  • ces.assistantSessions.get

Para obtener más información, consulta la documentación de IAM.

GenerateOnboardingSuggestions

rpc GenerateOnboardingSuggestions(GenerateOnboardingSuggestionsRequest) returns (GenerateOnboardingSuggestionsResponse)

Genera sugerencias de integración personalizadas para el estado cero de Arc: clasifica al usuario que realiza la solicitud (nuevo, explorando o recurrente) a partir de su historial de sesiones de asistente en la app y devuelve chips de sugerencias (reanudar una sesión, continuar el trabajo o comenzar algo nuevo) para renderizar antes de que se envíe cualquier mensaje.

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

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.

StreamChatAiAssistant

rpc StreamChatAiAssistant(StreamChatAiAssistantRequest) returns (StreamChatAiAssistantResponse)

Ejecuta Arc, el asistente de IA, para la sesión de asistente especificada en un formato de transmisió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 name:

  • ces.assistantSessions.get

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. Usa 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 de 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 como 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 especificada con los argumentos proporcionados.

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

Acción

Es la configuración de una acción que usará la herramienta. 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 especifica ningún campo, se usarán todos los campos de la entidad.

output_fields[]

string

Es opcional. Son los campos de entidad que se devolverán de la operación. Si no se especifica ningún campo, se devolverán todos los campos de la entidad.

Campo de unión action_spec. Especificación de una acción que se debe configurar para que la herramienta la use. 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 entidad que usará la herramienta.

EntityOperation

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. Es la operación que se realizará en la entidad.

OperationType

Es la operación que se realizará en la entidad.

Enums
OPERATION_TYPE_UNSPECIFIED No se especificó el tipo de operación. No es válido, por lo que fallará la creación o actualización de ConnectorTool.
LIST Operación de lista.
GET Obtener operación.
CREATE Crea una operación.
UPDATE Operación de actualización.
DELETE Borra la operación.

Agente

Un agente actúa como el componente básico 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. Es el nombre visible del agente.

description

string

Es opcional. Descripción del agente legible por humanos.

model_settings

ModelSettings

Es opcional. Son los parámetros de configuración del modelo de LLM.

instruction

string

Es opcional. Son las instrucciones para que el modelo de LLM guíe 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, la ejecución se detiene 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, la ejecución se detiene 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, la ejecución se detiene 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, la ejecución se detiene 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, la ejecución se detiene 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 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, la ejecución se detiene 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. Marca de tiempo de la última actualización del agente.

guardrails[]

string

Es opcional. Es la lista de barreras de seguridad para el agente. Formato: projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}

etag

string

Es la etiqueta de entidad que se usa para garantizar que el objeto no haya cambiado durante una operación de lectura, modificación y escritura. Si la etag está vacía, la actualización reemplazará cualquier cambio simultáneo.

toolsets[]

Agent.AgentToolset

Es opcional. Es la lista de conjuntos de herramientas para el agente.

generated_summary

string

Solo salida. Si el asistente de LLM genera el agente, este campo contiene un resumen descriptivo de la generación.

transfer_rules[]

TransferRule

Es opcional. Reglas de transferencia de agentes Si coinciden varias reglas, se usará la primera de la lista.

validation_errors[]

string

Solo salida. Parámetros de configuración incorrectos o errores 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 establece 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.

remote_a2a_agent

Agent.RemoteA2aAgent

Es opcional. El agente A2A remoto que se usará para la ejecución del agente.

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 las instrucciones y las devoluciones de llamada especificadas en él para realizar la tarea con un modelo de lenguaje grande.

RemoteA2aAgent

Es el agente que transferirá la ejecución a un agente A2A remoto.

Campos
a2a_config

RemoteA2aConfig

Obligatorio. Es la configuración de la conexión de A2A.

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 vuelta al agente de CES superior.

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 de 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. 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 sesión de Dialogflow a los nombres de las variables de la app que se enviarán de vuelta 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 establecida 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. Es el 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 definida 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. Una descripción del dominio de acción o espacio de solución del agente.

supported_interfaces[]

AgentInterface

Obligatorio. Es una 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 un agente puede realizar. Esto puede ser un poco abstracto, pero representa un conjunto de acciones más enfocado en el 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 de protocolo admitida en esta URL. Esta es una cadena de formato abierto que se puede extender fácilmente para otras vinculaciones de protocolo. Los principales que se admiten oficialmente son JSONRPC, GRPC y HTTP+JSON.

tenant

string

Es el ID de usuario 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"

AgentRegistryDeployment

Configuración y estado de la implementación de Agent Registry.

Campos
agent_registry_service_name

string

Es opcional. Solo salida. Es el nombre del recurso del servicio de Agent Registry implementado. Formato: projects/{project}/locations/{location}/services/{service}

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 un nombre legible por humanos para la habilidad.

description

string

Obligatorio. Es una descripción detallada de la habilidad.

tags[]

string

Obligatorio. Un conjunto de palabras clave que describen las capacidades de la habilidad.

examples[]

string

Instrucciones o situaciones de ejemplo que esta habilidad puede controlar.

input_modes[]

string

Es el conjunto de tipos de contenido multimedia 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 que el agente llame a otro agente.

Campos
name

string

Obligatorio. Es el nombre de la herramienta del agente.

description

string

Es opcional. 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 un agente diferente.

Campos
target_agent

string

Obligatorio. Es el agente al que se transfiere la conversación. El agente se encargará de la conversación a partir de este punto. Formato: projects/{project}/locations/{location}/apps/{app}/agents/{agent}

display_name

string

Solo salida. Es el nombre visible del agente.

AmbientSoundConfig

Configuración del sonido ambiental 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 [-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. Es el 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

Es opcional. Obsoleto: prebuilt_ambient_noise dejó de estar disponible y se reemplazó por prebuilt_ambient_sound.

gcs_uri

string

Es opcional. Ruido ambiental como un archivo WAV de 16 kHz de 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 el permiso storage.objects.get para el objeto de Cloud Storage.

prebuilt_ambient_sound

string

Es opcional. Es el nombre del sonido ambiental predeterminado. 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" - "air_conditioner"

PrebuiltAmbientNoise

Ruido ambiental precompilado.

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. Configuración para la autenticación con clave de API.

oauth_config

OAuthConfig

Es opcional. Configuración de OAuth.

service_agent_id_token_auth_config

ServiceAgentIdTokenAuthConfig

Es opcional. Es la configuración para la autenticación con tokens de ID generada 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 del portador.

ApiKeyConfig

Parámetros de configuración para la autenticación con la 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 del Secret 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. Es la ubicación de la clave en la solicitud.

RequestLocation

La 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 funciona como un contenedor de nivel superior para un grupo de agentes, incluidos 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 legible por humanos de la app.

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. La configuración de idioma de la app

time_zone_settings

TimeZoneSettings

Es opcional. Es la configuración de la 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 registro de la app.

error_handling_settings

ErrorHandlingSettings

Es opcional. Configuración de manejo de errores de la app.

model_settings

ModelSettings

Es opcional. La configuración predeterminada del modelo de LLM para la app. Los recursos individuales (p.ej., agentes y protecciones) pueden anular estos parámetros de configuración 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 establecerá de forma predeterminada en PARALLEL.

evaluation_metrics_thresholds

EvaluationMetricsThresholds

Es opcional. Son los umbrales de evaluación de la app.

variable_declarations[]

App.VariableDeclaration

Es opcional. Las declaraciones de las variables.

predefined_variable_declarations[]

App.VariableDeclaration

Solo salida. Son las declaraciones de 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 protecciones de la app. Formato: 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 la etiqueta de entidad que se usa para garantizar que el objeto no haya cambiado durante una operación de lectura, modificación y escritura. Si la etag está vacía, la actualización reemplazará cualquier cambio simultáneo.

deployment_count

int32

Solo salida. Es la 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. La configuración de VPC-SC para la app.

locked

bool

Es opcional. Indica si la app está bloqueada para cambios. Si la app está bloqueada, se rechazarán las modificaciones en sus recursos.

validation_errors[]

string

Solo salida. Configuraciones incorrectas o advertencias en la app

dashboard_settings

DashboardSettings

Es opcional. Configuración del panel específica de la app para vincular y configurar los paneles de Estadísticas de Contact Center.

ToolExecutionMode

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

Enums
TOOL_EXECUTION_MODE_UNSPECIFIED Modo de ejecución de la herramienta no especificado. 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

Una instantánea de la app

Campos
app

App

Es opcional. La configuración básica de la app

agents[]

Agent

Es opcional. Es la lista de agentes de la app.

tools[]

Tool

Es opcional. Lista de herramientas de la app.

examples[]

Example

Es opcional. Es la lista de ejemplos en la app.

guardrails[]

Guardrail

Es opcional. Lista de barreras de seguridad en la app.

toolsets[]

Toolset

Es opcional. Es la lista de conjuntos de herramientas de 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. Es el 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.

update_time

Timestamp

Solo salida. Marca de tiempo de la última actualización de la versión de la app.

snapshot

AppSnapshot

Solo salida. La instantánea de la app cuando se crea la versión.

etag

string

Solo salida. Es la etiqueta de entidad que se usa para garantizar que el objeto no haya cambiado durante una operación de lectura, modificación y escritura. Si la etag está vacía, la actualización reemplazará cualquier cambio simultáneo.

ArtifactChunk

Un fragmento transmitido de un artefacto de documento (p.ej., un TDD de Markdown) que genera el asistente. Los cambios de contenido se transmiten mientras se escribe el documento para que los clientes puedan renderizar una vista previa en vivo. El fragmento FINALIZED lleva el URI de Cloud Storage una vez que se conserva el archivo.

Campos
artifact_id

string

Identificador del artefacto, estable en todos los fragmentos de un artefacto dentro de la transmisión.

display_name

string

Es el nombre del archivo que se muestra al usuario, p.ej., "hotel_booking_tdd.md". Se establece en STARTED (y se repite en FINALIZED).

mime_type

string

Es el tipo de medio de IANA del contenido del artefacto, p.ej., "text/markdown".

content_delta

string

Contenido incremental de artefactos. Se establece en fragmentos DELTA.

gcs_uri

string

Es el objeto de Cloud Storage en el que se conservó el artefacto. Se establece en los fragmentos FINALIZADOS.

state

ArtifactChunk.State

Es la posición del ciclo de vida de este fragmento.

target_app

string

Solo salida. La app para la que se produjo este artefacto, cuando se produjo para una. Formato: projects/{project}/locations/{location}/apps/{app}

Estado

Es la posición del ciclo de vida de este fragmento dentro del flujo del artefacto.

Enums
STATE_UNSPECIFIED Valor predeterminado sin usar.
STARTED El asistente comenzó a generar el artefacto.
DELTA Un incremento de contenido; se establece content_delta.
FINALIZED Se conservó el artefacto; se estableció gcs_uri.
FAILED Se produjo un error en la generación o la persistencia, por lo que no se guardó el artefacto.
CLOSED El documento terminó de transmitirse: su contenido se entregó por completo a través de fragmentos de content_delta. Es posible que la persistencia continúe; se envía un fragmento FINALIZED con un gcs_uri si se guarda el artefacto y cuando se guarda.

AssistantConfirmationRequest

Es una pregunta o confirmación de bloqueo que el asistente necesita que se responda antes de que pueda continuar una acción del agente. El agente que realiza la solicitud se pausa y se reanuda solo cuando la respuesta llega en un StreamChatAiAssistantRequest.confirmation_response posterior.

Campos
confirmation_id

string

Es el identificador que correlaciona esta solicitud con su respuesta. Es opaco para los clientes; se debe repetir de forma literal en la solicitud de respuesta.

context

string

Contexto que describe lo que se confirma (p.ej., la acción que el agente quiere realizar o la pregunta que necesita responder). Se renderiza como texto sin formato, no como Markdown.

positive_label

string

Es la etiqueta de la acción de aprobación de una confirmación binaria (p.ej., "Publicar"). No se establece cuando se propaga questions.

negative_label

string

Etiqueta para la acción de rechazo de una confirmación binaria (p.ej., "Todavía no"). No se establece cuando se propaga questions.

questions[]

OptionQuestionsChunk.Question

Formulario de confirmación de opción múltiple. Cuando se propaga, la tarjeta renderiza una lista de opciones seleccionables y el submit_text de la opción elegida (o el texto de formato libre del usuario) se devuelve como AssistantConfirmationResponse.answer_text.

tool

string

Es el nombre de la llamada a la herramienta en la que se detuvo el agente (p.ej., "update_app") para el encabezado de la tarjeta. No se establece para preguntas puras.

agent_name

string

Es la etiqueta de visualización del agente que generó la confirmación (p.ej., "Contract Architect") para el encabezado de la tarjeta.

expire_time

Timestamp

Es el tiempo después del cual ya no se puede responder esta confirmación. Una tarjeta vencida se renderiza como inactiva y el servidor rechaza la confirmación en el siguiente turno para que el agente pausado no espere de forma indefinida.

targets[]

AssistantConfirmationRequest.Target

Todo lo que cambiará la acción confirmada, para que la consola pueda renderizar "Actualizar 2 apps" y una insignia por app. Se deja vacío para las tarjetas heredadas de un solo objetivo.

Objetivo

Un recurso que cambiará la acción confirmada.

Campos
resource

string

Es el recurso que cambiará, como un nombre de recurso completo.

display_name

string

Es el nombre visible del recurso o la app para la tarjeta.

action

string

La acción, p.ej., CREATE, UPDATE, DELETE, COPY, LINK.

target_app

string

Es la app a la que pertenece el recurso o está vacía para una acción con alcance de ubicación, como crear una app. Formato: projects/{project}/locations/{location}/apps/{app}

AssistantConfirmationResponse

Es la respuesta del usuario a un AssistantConfirmationRequest, que se envía en la siguiente llamada a SessionService.StreamChatAiAssistant para reanudar el agente en pausa.

Campos
confirmation_id

string

La AssistantConfirmationRequest.confirmation_id que se está respondiendo.

Campo de unión response. Es la respuesta del usuario. response puede ser solo uno de los parámetros siguientes:
confirmed

bool

Respuesta binaria: true aprueba la acción pausada, false la rechaza.

answer_text

string

El submit_text de la opción elegida o el texto de formato libre del usuario. Se cancela la acción pausada y se entrega el texto al agente para que actúe en consecuencia.

AssistantSuggestion

Un solo chip de sugerencias de incorporación personalizado para el estado cero de Arc.

Campos
suggestion_id

string

Es el identificador estable de esta sugerencia, que los clientes devuelven en el registro de interacciones.

label

string

Es la etiqueta del chip que se muestra al usuario (60 caracteres como máximo).

rationale

string

Explicación breve opcional de por qué se muestra esta sugerencia (cuadro de información o ventana emergente de justificación).

icon

AssistantSuggestion.Icon

Es la sugerencia de ícono para el chip.

source

AssistantSuggestion.Source

Cómo se generó esta sugerencia

candidate_type

string

Es el tipo de candidato de la tabla de reglas en minúsculas con guiones medios (p.ej., "resume-pending-review") para las métricas.

Campo de unión action. Qué sucede cuando se activa el chip action puede ser solo uno de los parámetros siguientes:
seed_prompt

string

Completa previamente el compositor con este texto; el usuario lo revisa y lo envía.

load_session

AssistantSuggestion.LoadSession

Abre una sesión existente de Gemini.

send_message

string

Completa previamente el compositor con este texto y envíalo de inmediato. Solo se usa para chips de respuesta rápida dentro de una conversación de incorporación activa.

Ícono

Es la sugerencia de ícono para el chip.

Enums
ICON_UNSPECIFIED Ícono sin especificar.
RESUME Reanudar una sesión anterior
BUILD Crea algo nuevo.
EVALUATE Sugerencia relacionada con la evaluación.
DEPLOY Sugerencia relacionada con la Deployment.
EXPLORE Sugerencia de exploración o descubrimiento.
FIX Corregir un error o un estado de falla

LoadSession

Son los parámetros de la acción load_session.

Campos
assistant_session_id

string

Es el identificador de la sesión del asistente que se abrirá (el segmento final del nombre del recurso AssistantSession).

Fuente

Cómo se generó esta sugerencia

Enums
SOURCE_UNSPECIFIED Origen sin especificar.
RULE Candidato de tabla de reglas determinista con fraseo de plantilla.
LLM_RANKED Candidato de la tabla de reglas reclasificado y reformulado por el paso de reformulación del LLM.

AudioEncoding

AudioEncoding especifica el formato de codificación de 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 Muestras de 8 bits que comprimen muestras de audio de 14 bits con la ley A/PCMU 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. Configuración de cómo se debe sintetizar la respuesta del agente, asignando el código de idioma a SynthesizeSpeechConfig.

Si no se encuentra la configuración del código de idioma especificado, se usará la configuración del 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 interactuar.

ambient_sound_config

AmbientSoundConfig

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

custom_voice_samples[]

CustomVoiceSample

Es opcional. Configura muestras de voz personalizadas para la clonación de voz.

AudioRecordingConfig

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

Campos
gcs_bucket

string

Es opcional. El bucket de Cloud Storage para almacenar las grabaciones de audio de la sesión. El URI debe empezar con "gs://".

Elige una ubicación de bucket que cumpla con tus requisitos de residencia de datos.

Nota: Si el bucket de Cloud Storage está en un proyecto diferente al de la app, debes otorgar el permiso 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 AAAA-MM-DD - $session: ID de la sesión

Si no se especifica el prefijo de la ruta de acceso, se usará el prefijo predeterminado $project/$location/$app/$date/$session/.

BargeInConfig

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

Campos
disable_barge_in
(deprecated)

bool

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á habilitado, el agente adaptará su próxima respuesta en función de 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 de forma visual.

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 con las conversaciones que no se pudieron borrar.

BearerTokenConfig

Son los parámetros de configuración 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 de la sesión.

BidiSessionServerMessage

Es el mensaje de nivel superior que se devuelve del 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. 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 la sesión finalizó.

go_away

GoAway

Es opcional. Indica que el servidor se desconectará pronto y que el cliente debe cerrar parcialmente y reiniciar la conexión.

BigQueryExportSettings

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

Campos
enabled

bool

Es opcional. Indica si la exportación de BigQuery está habilitada.

project

string

Es opcional. 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 está 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 por humanos 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 se habilita, 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 posterior al modelo. HABILITA CON PRECAUCIÓN. Por lo general, la devolución de llamada After model 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.

CancelAssistantTurnRequest

Solicita cancelar el turno en curso de una sesión de asistente.

Campos
name

string

Obligatorio. Es la sesión del asistente cuyo turno en curso se cancelará.

turn_id

string

Es opcional. Es el turno que se cancelará. Si se deja vacío, se cancelará el turno que se esté ejecutando. Una cancelación que nombra un turno que ya no es el que se está ejecutando no tiene efecto.

CancelAssistantTurnResponse

Respuesta para CancelAssistantTurn.

Campos
cancelled

bool

Indica si se encontró un turno en curso y se solicitó que se detuviera (directamente en esta tarea o a través de una interrupción de época para un turno alojado en otro lugar).

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. Es la 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 modificó.

description

string

Solo salida. Descripción del cambio, que suele capturar los campos modificados en el recurso.

resource

string

Solo salida. Es el recurso que se modificó.

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

create_time

Timestamp

Solo salida. Es la hora en que se realizó el cambio.

sequence_number

int64

Solo salida. Es el número de secuencia que aumenta de forma monótona del registro de cambios.

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 la persona del perfil del canal.

web_widget_config

ChannelProfile.WebWidgetConfig

Es opcional. 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. Configuración específica para las implementaciones de Instagram.

disable_dtmf

bool

Es opcional. Indica si se debe inhabilitar la DTMF (multifrecuencia de dos tonos).

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 habla. - false: El agente conserva el control automático sobre cuándo el usuario puede interrumpir.

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 Canal de IU web.
API Canal de la 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 (chat de CCaaS).
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

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 de Meta de la empresa que se recuperó.

thumbnail_url

string

Solo salida. Es la URL de la miniatura del perfil de Meta de la empresa que se recuperó.

description

string

Solo salida. La descripción de la página o el perfil de Meta de la empresa.

PersonaProperty

Representa la propiedad de perfil de un canal.

Campos
persona

ChannelProfile.PersonaProperty.Persona

Es opcional. La personalidad del canal

Personificación

La personalidad del canal

Enums
UNKNOWN Persona DESCONOCIDA.
CONCISE El agente mantiene las respuestas concisas y directas.
CHATTY El agente proporciona contexto, explicaciones y detalles adicionales.

WebWidgetConfig

Mensaje de configuración para el widget web.

Campos
modality

ChannelProfile.WebWidgetConfig.Modality

Es opcional. 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. La configuración de seguridad del widget web.

Modalidad

Es la modalidad del widget web.

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

SecuritySettings

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 que permitan acceder al agente de CES.

enable_origin_check

bool

Es opcional. Indica si está habilitada la verificación de origen para el widget web. Si es true, el widget web verificará el origen del sitio web que lo carga 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. RFC 6454 define un origen. 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 la verificación de reCAPTCHA para el widget web está habilitada.

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. Es el número de teléfono en formato E.164.

display_name

string

Solo salida. Es el nombre de la página de Meta de la empresa que se recuperó.

thumbnail_url

string

Solo salida. Es la URL de la miniatura del perfil de Meta de la empresa que se recuperó.

description

string

Solo salida. La descripción de la página o el perfil de Meta de la empresa.

Bandinsecto

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. Datos de BLOB.

payload

Struct

Es opcional. Datos de carga útil personalizados.

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. Evento de transferencia de agente.

updated_variables

Struct

Un struct representa las variables que se actualizaron en la conversación, con clave por nombres de variables.

default_variables

Struct

Un struct representa las variables predeterminadas al inicio de la conversación, con clave por nombres de variables.

Citas

Son las citas asociadas con la respuesta del agente.

Campos
cited_chunks[]

Citations.CitedChunk

Es una lista de los fragmentos de información citados.

inline_citations[]

Citations.InlineCitation

Es opcional. Es la lista de citas intercaladas en la respuesta del agente.

CitedChunk

Es un fragmento de información citada.

Campos
uri

string

Es el URI que se usa para la cita.

title

string

Es el título del documento citado.

text

string

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

InlineCitation

Una cita intercalada en el texto de la respuesta.

Campos
start_index

int32

Es el índice de inicio (en bytes) del segmento de texto en la respuesta del agente.

end_index

int32

Es el índice final (en bytes) del segmento de texto en la respuesta del agente.

cited_chunk_indices[]

int32

Son los índices de los fragmentos citados que respaldan este segmento de texto. Los índices hacen referencia a los elementos de cited_chunks.

ClientCertificateSettings

Configuración de los certificados de cliente personalizados.

Campos
tls_certificate

string

Obligatorio. Es el certificado TLS codificado en formato PEM. Esta cadena debe incluir las líneas de encabezado de inicio y de pie de página de finalización.

private_key

string

Obligatorio. Es el nombre del recurso de la versión del Secret de SecretManager 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 del Secret de Secret Manager que almacena la frase de contraseña para desencriptar la clave privada. Debe dejarse 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 los comportamientos de Cloud Logging de la app.

Campos
enable_cloud_logging

bool

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

CodeBlock

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

Campos
python_code

string

Obligatorio. Código de Python que se invocará en el modo de simulación de la herramienta. Firma de función de Python esperada - Para detectar todas las llamadas a la herramienta: def fake_tool_call(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: Para detectar una llamada a la 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 una configuración de autenticación de usuario final diferente. Nota: La conexión debe tener habilitada la anulación de la 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 llamar a esta ConnectorTool.

description

string

Es opcional. Es la descripción de la herramienta que el agente puede usar para decidir si llamar a esta 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 una configuración de autenticación de usuario final diferente. Nota: La conexión debe tener habilitada la anulación de la 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 del conector o de operaciones de entidad 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 del momento en 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

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 maneja la conversación inicialmente. 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

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 no especificado.
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 Es un tipo de entrada sin especificar.
INPUT_TYPE_TEXT Entrada de texto.
INPUT_TYPE_EVENT Entrada del evento.
INPUT_TYPE_AUDIO Entrada de audio.
INPUT_TYPE_IMAGE Entrada de imagen.
INPUT_TYPE_BLOB Entrada de BLOB.
INPUT_TYPE_TOOL_RESPONSE Entrada de respuesta de la herramienta de función del cliente.
INPUT_TYPE_VARIABLES Entrada de variables.

Fuente

Es la fuente de la conversación.

Enums
SOURCE_UNSPECIFIED Origen sin especificar.
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 de agente. La herramienta de agente ejecuta el agente en una sesión independiente, que se conserva para realizar pruebas y depuraciones.

Turno

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

Campos
messages[]

Message

Es opcional. Es la 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. Es el texto de verdad fundamental previsto del emisor simulado (Polysynth). Solo se propaga cuando se habilitan las métricas de tasa de errores 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 establece, 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á una 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. 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 de la app.

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 superior. Formato: 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. 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 barandilla.

guardrail_id

string

Es opcional. Es el ID que se usará para la barandilla, que se convertirá en el componente final del nombre del recurso de la barandilla. Si no se proporciona, se asignará automáticamente un ID único para la protección.

guardrail

Guardrail

Obligatorio. 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. 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á un 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á.

CustomVoiceSample

Es la configuración de una muestra de voz personalizada que se usa para la clonación de voz.

Campos
name

string

Es opcional. Es el nombre definido por el usuario para la muestra de voz personalizada.

voice_sample_gcs_uri

string

Es opcional. 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 24 kHz y un solo canal.

consent_audio_gcs_uri

string

Es opcional. Audio de consentimiento para la clonación de voz.

voice_instruction

string

Es opcional. Son las instrucciones en lenguaje natural para el estilo, el tono, el ritmo o la pronunciación de la voz.

preview_audio_content

bytes

Solo salida. Es el audio de vista previa sintetizado para la voz personalizada, con formato WAV canónico (LINEAR16, 24 kHz, 16 bits, mono).

preview_text

string

Es opcional. Texto para sintetizar el audio de vista previa de la voz personalizada.

warnings[]

CustomVoiceSample.Warning

Solo salida. Son los mensajes de advertencia que se encontraron durante el procesamiento de la clonación de voz (p.ej., nivel de audio bajo).

voice_instruction_mode

CustomVoiceSample.VoiceInstructionMode

Es opcional. Es el modo de instrucción para la muestra de voz. Si no se especifica, se establece de forma predeterminada como NO_INSTRUCTION.

VoiceInstructionMode

Es el modo de instrucción para la muestra de voz.

Enums
VOICE_INSTRUCTION_MODE_UNSPECIFIED Indica que no se especificó el modo de instrucción. La configuración predeterminada es NO_INSTRUCTION.
NO_INSTRUCTION No se usarán instrucciones por voz.
GENERATE_INSTRUCTION La IA generará automáticamente la instrucción de voz a partir de la muestra de audio.
CUSTOM_INSTRUCTION Instrucción de voz personalizada que proporciona el usuario.

Advertencia

Es un mensaje de advertencia que se encuentra durante el procesamiento de la muestra de voz.

Campos
message

string

Solo salida. Es una descripción legible por humanos de la advertencia.

type

CustomVoiceSample.Warning.WarningType

Solo salida. Es el tipo de advertencia.

WarningType

Es el tipo de advertencia que se encontró durante el procesamiento de la muestra de voz.

Enums
WARNING_TYPE_UNSPECIFIED Indica que no se especificó el tipo de advertencia.
LOW_AUDIO_LEVEL El nivel de audio de la muestra de voz es demasiado bajo (p.ej., amplitud RMS baja).

DashboardSettings

Es la configuración de los paneles asociados con la app, que se muestran en la vista de Monitoring.

Campos
default_dashboard

string

Es opcional. Es el nombre del recurso del panel predeterminado de Estadísticas de Contact Center asociado con la app. Este es el panel que se mostrará cuando los usuarios naveguen a la vista de 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 del 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 lo completa el servidor.

document_processing_mode

DataStore.DocumentProcessingMode

Solo salida. Es el modo de procesamiento de documentos para la conexión del almacén de datos. Solo se establece 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. Por 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 Un almacén de datos que contiene contenido web público.
UNSTRUCTURED 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 Un almacén de datos que es un conector a un servicio propio 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

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

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 Indica que no se especificó el tipo de 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 la herramienta para recuperar datos del almacén de datos o del motor de Vertex AI Search para fundamentar las respuestas. 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. Especificación de mejora para mejorar ciertos documentos.

modality_configs[]

DataStoreTool.ModalityConfig

Es opcional. Son los parámetros de configuración de la modalidad para el 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 motor. search_source puede ser solo uno de los parámetros siguientes:
data_store_source

DataStoreTool.DataStoreSource

Es opcional. Busca en un solo DataStore específico.

engine_source

DataStoreTool.EngineSource

Es opcional. Busca dentro de un motor (potencialmente en varios almacenes de datos).

BoostSpec

Especificación de mejora para mejorar ciertos documentos.

Campos
condition_boost_specs[]

DataStoreTool.BoostSpec.ConditionBoostSpec

Obligatorio. Es una lista de especificaciones de boosting.

ConditionBoostSpec

Especificación de mejora para una condición.

Campos
condition

string

Obligatorio. Es una expresión que especifica una condición de aumento. 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 impulsar 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 [-1, 1]. El boosting negativo significa un descenso de nivel. El valor predeterminado es 0.0.

Si se establece en 1.0, las sugerencias se promocionan de forma significativa. Sin embargo, esto no significa necesariamente que el primer resultado será una sugerencia con boosting.

Si se establece en -1.0, las sugerencias se descenderán de nivel de forma significativa. 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 mejora.

boost_control_spec

DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec

Es opcional. Especificación compleja para la clasificación personalizada basada en el valor del atributo definido por el cliente.

BoostControlSpec

Especificación para la clasificación personalizada según el valor del atributo especificado por el cliente. Proporciona más controles para la clasificación personalizada que la combinación simple (condición, aumento) anterior.

Campos
field_name

string

Es opcional. Es el nombre del campo cuyo valor se usará para determinar el importe de la mejora.

attribute_type

DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec.AttributeType

Es opcional. Es el tipo de atributo que se usará para determinar el importe de la mejora. 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 monótona (definida a través del interpolation_type anterior) pasa por los puntos de control que se indican aquí.

AttributeType

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

Enums
ATTRIBUTE_TYPE_UNSPECIFIED AttributeType sin especificar.
NUMERICAL El valor del campo numérico se usará para actualizar de forma dinámica el importe de la mejora. En este caso, el valor del atributo (el valor x) del punto de control será el valor real del campo numérico para el que se especifica boost_amount.
FRESHNESS Para el caso de uso de actualidad, el valor del atributo será la duración entre la hora actual y la fecha en el campo de fecha y hora especificado. El valor debe tener el formato de un valor XSD dayTimeDuration (un subconjunto restringido de un valor de duración ISO 8601). El patrón para esto es el siguiente: [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 monótona (se aceptan valores constantes).

Campos
attribute_value

string

Es opcional. Puede ser una de las siguientes opciones: 1. Es el valor numérico del campo. 2. La especificación de duración para la actualización: El valor debe tener el formato de un valor XSD dayTimeDuration (un subconjunto restringido de un valor de duración ISO 8601). El patrón para esto es el siguiente: [nD][T[nH][nM][nS]].

boost_amount

float

Es opcional. Es el valor entre -1 y 1 por el que se aumentará la puntuación si el atributo attribute_value se evalúa con 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

Especificaciones de mejora para mejorar 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 aumento. Es el nombre completo del recurso del almacén de datos, como projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}.

spec[]

DataStoreTool.BoostSpec

Obligatorio. Es una lista de especificaciones de boosting.

DataStoreSource

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

Campos
filter

string

Es opcional. 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. El almacén de datos.

EngineSource

Es la configuración para buscar dentro de un motor, lo que podría orientarse a almacenes de datos 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 almacenes de datos 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 todo 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 Comportamiento predeterminado del filtro. Incluye el parámetro de filtro 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 Incluye siempre 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

Configuración de la 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 volverán a mostrar solo fragmentos relevantes.

Por ejemplo, un nivel de 3 significa que la puntuación de fundamentación debe ser de 3 o más para que se devuelva la respuesta.

disabled

bool

Es opcional. Indica si la fundamentación está inhabilitada.

ModalityConfig

Si se especifica, se aplicará la configuración dada 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 de resumen.

grounding_config

DataStoreTool.GroundingConfig

Es opcional. Es la configuración de la 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

Configuración del reescritor.

Campos
model_settings

ModelSettings

Obligatorio. Son los parámetros de configuración del modelo de LLM.

prompt

string

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

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 fragmentos que se devolverán por consulta. Si no se establece, devuelve todos los fragmentos del servicio de forma predeterminada.

SummarizationConfig

Es la configuración de resumen.

Campos
model_settings

ModelSettings

Es opcional. Son los parámetros de configuración del modelo de LLM.

prompt

string

Es opcional. 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 otras apps, agentes o ejemplos aún hacen referencia a él.

  • Si es force = false, la eliminación falla si otros agentes o ejemplos hacen referencia a ella.
  • Si es force = true, borra el agente y quítalo de todas las apps, agentes y ejemplos que hagan referencia a él.
etag

string

Es opcional. Es la etag actual del agente. Si no se proporciona una etag, la eliminación reemplazará los cambios simultáneos. Si se proporciona una etag y no coincide con la etag actual del agente, se bloqueará la eliminación 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, la eliminación reemplazará los cambios simultáneos. Si se proporciona una etag y no coincide con la etag actual de la app, se bloqueará la eliminación 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 una etag, la eliminación reemplazará los cambios simultáneos. Si se proporciona una etag y no coincide con la etag actual de la versión de la app, se bloqueará la eliminación 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

Es opcional. Indica la fuente de la conversación. Si no se establece, 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 la etag de la implementación. Si se proporciona una etag y no coincide con la etag actual de la implementación, se bloqueará la eliminación 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. La ETag actual del ejemplo. Si no se proporciona una etag, la eliminación reemplazará los cambios simultáneos. Si se proporciona una etag y no coincide con la etag actual del ejemplo, se bloqueará la eliminación y se devolverá un error ABORTED.

DeleteGuardrailRequest

Mensaje de solicitud para AgentService.DeleteGuardrail.

Campos
name

string

Obligatorio. Es el nombre del recurso de la barandilla de seguridad que se borrará.

force

bool

Es opcional. Indica si se debe borrar la barandilla de seguridad de forma forzosa, 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 barandilla de seguridad.
  • Si es force = true, se quitarán todas las referencias existentes de las apps o los agentes, y se borrará la barandilla de seguridad.
etag

string

Es opcional. La etag actual de la barandilla. Si no se proporciona una etag, la eliminación reemplazará los cambios simultáneos. Si se proporciona una etag y no coincide con la etag actual de la barandilla de seguridad, se bloqueará la eliminación 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 forzosa, incluso si los agentes o 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 se borra force = true, se quitarán todas las referencias existentes de los agentes y se borrará la herramienta.
etag

string

Es opcional. La ETag actual de la herramienta. Si no se proporciona una etag, la eliminación reemplazará los cambios simultáneos. Si se proporciona una etag y no coincide con la etag actual de la herramienta, se bloqueará la eliminación 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 de forma forzada el conjunto de herramientas, incluso si la app 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 se borra force = true, se quitarán todas las referencias existentes de los agentes y se borrará el conjunto de herramientas.
etag

string

Es opcional. La ETag actual del conjunto de herramientas. Si no se proporciona una etag, la eliminación reemplazará los cambios simultáneos. Si se proporciona una etag y no coincide con la etag actual del conjunto de herramientas, se bloqueará la eliminación y se devolverá un error ABORTED.

DeployChannelResponse

Mensaje de respuesta para AgentService.DeployChannel.

Campos
deployment

Deployment

Es el objeto Deployment creado.

Implementación

Una implementación representa una versión inmutable y consultable de la app. 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 de borrador.

channel_profile

ChannelProfile

Obligatorio. Es el perfil de 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 la etiqueta de entidad que se usa para garantizar que el objeto no haya cambiado durante una operación de lectura, modificación y escritura. Si la etag está vacía, 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. Son las credenciales efímeras de WhatsApp que se requieren 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: La anulación de la configuración del modelo a nivel de la Deployment está restringida por una 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á restringida por una lista de entidades permitidas. Comunícate con el equipo de CXAS para habilitar este campo.

agent_registry_deployment

AgentRegistryDeployment

Es opcional. Es la configuración para implementar esta implementación en el Registro de agentes. Si está presente, esta implementación se publicará en Agent Registry.

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 porque se completó correctamente (p.ej., el usuario dice "¡Adiós!") ) o una derivación a un agente.

El agente no procesará más entradas después de que se finalice la sesión, y el cliente deberá cerrar parcialmente 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 indicador de finalización de la sesión, como el motivo por el que finalizó.

EndUserAuthConfig

Es la configuración de autenticación del usuario final que se usa para las llamadas de conexión. 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

Autenticación de otorgamiento de autorización de OAuth 2.0 de perfil de JWT

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

Configuración de la autenticación de la concesión de autorización de OAuth 2.0 del perfil de JWT.

Campos
issuer

string

Obligatorio. Es el nombre del parámetro de la entidad emisora 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 proyecto o ubicación.

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 de la política 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 VPC-SC está activo.
ALWAYS Esta política se aplica SIEMPRE, independientemente del estado de VPC-SC.

ErrorHandlingSettings

Parámetros de 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. 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 de LLM).

EndSessionConfig

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

Campos
escalate_session

bool

Es opcional. Indica si se debe derivar la sesión en EndSession. Si se deriva la sesión, 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 errores.

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

FallbackResponseConfig

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 de LLM), asignados por el código de idioma admitido.

max_fallback_attempts

int32

Es opcional. Es la cantidad máxima de intentos de resguardo que se deben realizar antes de que el agente emita el indicador EndSession.

EvaluationMetricsThresholds

Configuración de umbral para las métricas en una evaluación.

Campos
golden_evaluation_metrics_thresholds

EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds

Es opcional. Los umbrales de las métricas de evaluación de referencia.

hallucination_metric_behavior
(deprecated)

EvaluationMetricsThresholds.HallucinationMetricBehavior

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

Configuración de 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. La configuración de coincidencia de la herramienta. Una llamada a la herramienta adicional es una llamada a la herramienta que está presente en la ejecución, pero que no coincide con ninguna llamada a la herramienta en la expectativa de referencia.

ExpectationLevelMetricsThresholds

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

Campos
tool_invocation_parameter_correctness_threshold

float

Es opcional. Es el umbral de éxito para la corrección de los 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

Umbrales de métricas a nivel de 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 herramientas. 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 Métrica sin especificar. La configuración predeterminada es TEXT.
TEXT Usa la similitud semántica de texto.
AUDIO Usa la similitud semántica de audio.

HallucinationMetricBehavior

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 de evaluación general.

Enums
HALLUCINATION_METRIC_BEHAVIOR_UNSPECIFIED Comportamiento de la métrica de alucinación no especificado.
DISABLED Inhabilitar la métrica de alucinación.
ENABLED Habilita la métrica de alucinación.

ToolMatchingSettings

Configuración para las llamadas a la herramienta que coincidan.

Campos
extra_tool_call_behavior

EvaluationMetricsThresholds.ToolMatchingSettings.ExtraToolCallBehavior

Es opcional. Comportamiento para las llamadas a herramientas adicionales. La configuración predeterminada es FAIL.

ExtraToolCallBehavior

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

Enums
EXTRA_TOOL_CALL_BEHAVIOR_UNSPECIFIED Comportamiento no especificado. La configuración predeterminada es FAIL.
FAIL Falla la evaluación si se encuentra una llamada a la herramienta adicional.
ALLOW Permitir la llamada a la herramienta adicional.

Evento

Entrada del evento.

Campos
event

string

Obligatorio. Es el nombre del evento.

variables

Struct

Es opcional. Son las variables adicionales asociadas con el 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. Descripción legible por humanos del ejemplo.

entry_agent

string

Es opcional. Es el agente que maneja la conversación inicialmente. Si no se especifica, el ejemplo representa una conversación que controla el agente raíz. Formato: projects/{project}/locations/{location}/apps/{app}/agents/{agent}

messages[]

Message

Es opcional. Es la colección de mensajes que conforman la conversación.

create_time

Timestamp

Solo salida. Es la marca de tiempo de cuando se creó el ejemplo.

update_time

Timestamp

Solo salida. 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 de referencia. Los ejemplos no válidos no se usarán como ejemplos de aprendizaje con pocos ejemplos.

etag

string

Es la etiqueta de entidad que se usa para garantizar que el objeto no haya cambiado durante una operación de lectura, modificación y escritura. Si la etag está vacía, 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. Configuración de simulación para la ejecución de la herramienta. Si se establece este campo, las herramientas que llaman a otras herramientas se simularán según 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 puede ser solo uno de los siguientes:
variables

Struct

Es opcional. Son las variables que están disponibles para la ejecución de la herramienta.

context

Struct

Es opcional. El [ToolCallContext](https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/python#environment para obtener más 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 los hay). Si no se especifican las claves "output" y "error", toda la "response" se trata como el 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 citas que proporcionan la información de la fuente para la ejecución de la herramienta.

google_search_suggestions

GoogleSearchSuggestions

Son las sugerencias que se devuelven de 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

Experimenta 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 del lanzamiento 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. Porcentaje de tráfico de la asignación de tráfico. Los valores mínimo y máximo son 0 y 100, respectivamente.

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 exportado se escribirá directamente en el objeto de Cloud Storage 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 No se especifica el formato de exportación.
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. La app exportada. app puede ser solo uno de los siguientes:
app_content

bytes

Es la 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 la 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 al agente buscar en los archivos que subió el desarrollador de la app o del agente. Tiene ajustes 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 Tipo de corpus no especificado.
USER_OWNED El usuario crea el corpus y es su propietario.
FULLY_MANAGED El agente crea el corpus.

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 que genera 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 para que el widget de chat se autentique con las APIs de sesión.

expire_time

Timestamp

Es la hora en la que vence el token de chat.

GenerateOnboardingSuggestionsRequest

Mensaje de solicitud para SessionService.GenerateOnboardingSuggestions.

Campos
name

string

Obligatorio. La app cuyo estado cero se está renderizando. Formato: projects/{project}/locations/{location}/apps/{app}

max_suggestions

int32

Es opcional. Es la cantidad máxima de sugerencias que se devolverán. El valor predeterminado es 4 cuando no se establece.

GenerateOnboardingSuggestionsResponse

Mensaje de respuesta para SessionService.GenerateOnboardingSuggestions.

Campos
user_profile

GenerateOnboardingSuggestionsResponse.UserProfile

Es la clasificación del historial del usuario que realiza la solicitud.

suggestions[]

AssistantSuggestion

Sugerencias personalizadas, clasificadas primero por relevancia.

context_token

string

Es el token opaco que captura la instantánea de incorporación que se usó para generar estas sugerencias. Los clientes lo repiten en el primer StreamChatAiAssistantRequest para que el servidor pueda reutilizar la instantánea.

UserProfile

Clasificación del historial del usuario que realiza la solicitud con el asistente en esta app.

Enums
USER_PROFILE_UNSPECIFIED Perfil sin especificar.
NEW No hay sesiones de asistente que contengan mensajes.
EXPLORING Una o dos sesiones de asistente que contienen mensajes.
RETURNING Más de dos sesiones de asistente que contienen mensajes.

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

Es opcional. Indica la fuente de la conversación. Si no se establece, 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 barandilla de seguridad 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 parcialmente y reiniciar la conexión.

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 del dispositivo, lo que la muestra en modo oscuro o claro según lo indicado por @media(prefers-color-scheme).

web_search_queries[]

WebSearchQuery

Es la lista de consultas que se usaron para realizar la búsqueda de Google junto con los URI de los resultados de la búsqueda que forman las sugerencias de búsqueda.

GoogleSearchTool

Representa una herramienta para realizar búsquedas web en Google con el objetivo de fundamentar la informació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. Descripción del propósito de la herramienta.

context_urls[]

string

Es opcional. El contenido se recuperará directamente de estas URLs para el contexto y la fundamentación. 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 deben restringir 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. Es la 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

Son los parámetros de 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 de protección

La barrera de seguridad contiene una lista de verificaciones y balances para mantener a los agentes seguros.

Campos
name

string

Es el identificador. Es el identificador único de la barandilla de seguridad. Formato: projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}

display_name

string

Obligatorio. Es el nombre visible de la barandilla.

description

string

Es opcional. Descripción de la barrera de seguridad.

enabled

bool

Es opcional. Indica si la barandilla está habilitada.

action

TriggerAction

Es opcional. Es la acción que se debe realizar cuando se activa la barrera de protección.

create_time

Timestamp

Solo salida. Es la marca de tiempo de la creación de la barandilla de seguridad.

update_time

Timestamp

Solo salida. Marca de tiempo de la última actualización de la barandilla.

etag

string

Es la etiqueta de entidad que se usa para garantizar que el objeto no haya cambiado durante una operación de lectura, modificación y escritura. Si la etag está vacía, 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 barrera que prohíbe que se use 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. Es la barrera 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 barrera de protección que puede bloquear la conversación según el resultado de la ejecución de la devolución de llamada.

supervisor

Guardrail.Supervisor

Es opcional. Es la protección que ejecuta la intervención del supervisor.

CodeCallback

Es la barrera 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': 'OK' o 'TRIGGER'. - "reason": 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': 'OK' o 'TRIGGER'. - "reason": 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': 'OK' o 'TRIGGER'. - "reason": 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': 'OK' o 'TRIGGER'. - "reason": Una cadena que explica la decisión. Una decisión de "ACTIVACIÓN" puede detener el procesamiento posterior.

ContentFilter

Es una barrera que prohíbe que se use cierto contenido en la conversación.

Campos
banned_contents[]

string

Es opcional. 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. Lista de frases prohibidas. Solo se aplica a las entradas de los usuarios.

banned_contents_in_agent_response[]

string

Es opcional. Lista de frases prohibidas. Solo se aplica a las respuestas del agente.

match_type

Guardrail.ContentFilter.MatchType

Obligatorio. Es el tipo de concordancia del filtro de contenido.

disregard_diacritics

bool

Es opcional. Si es verdadero, se ignoran los signos diacríticos durante la coincidencia.

sensitive_words_exemptions[]

string

Es opcional. Son las entradas de la lista de palabras sensibles que permite esta barandilla de seguridad. Solo es válido cuando match_type es SENSITIVE_WORDS. Cada valor debe ser igual a una entrada de la lista (no distingue mayúsculas de minúsculas, se ignoran los espacios en blanco circundantes); los demás valores no tienen efecto. Se aplica solo a esta barandilla de seguridad. Un máximo de 1,000 entradas de hasta 256 caracteres cada una.

MatchType

Es el tipo de concordancia del filtro de contenido.

Enums
MATCH_TYPE_UNSPECIFIED No se especificó el tipo de concordancia.
SIMPLE_STRING_MATCH El contenido se compara con las 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 se compara con la sintaxis de expresiones regulares.
SENSITIVE_WORDS El contenido se compara con una lista de palabras y frases sensibles administrada por el sistema. Si adjuntas una barandilla con este tipo de coincidencia a una app o un agente, se reemplazará el filtro predeterminado de palabras sensibles para los agentes afectados. Inhabilita la barandilla para inhabilitar el filtro predeterminado.

LlmPolicy

Es la barrera 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 verifiques esta política, considera los últimos "n" mensajes de la conversación. Si no se establece, se usará un valor predeterminado de 10.

model_settings

ModelSettings

Es opcional. Configuración del modelo

prompt

string

Obligatorio. Mensaje de política. Admite marcadores de posición de variables de sesión ({var}), así como {agent_system_instruction} para insertar las instrucciones del sistema resueltas del agente.

policy_scope

Guardrail.LlmPolicy.PolicyScope

Obligatorio. Define cuándo aplicar la verificación de la 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 la política, se produce un error de apertura y no se activa la barandilla.

allow_short_utterance

bool

Es opcional. De forma predeterminada, la verificación de la política de LLM se omite 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 aplicar la verificación de la política durante la conversación.

Enums
POLICY_SCOPE_UNSPECIFIED No se especificó el permiso 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 permiso 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 permiso de política generará latencia adicional antes de que el agente pueda responder.

LlmPromptSecurity

Es una 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 de LLM. - Si es verdadero, se omite la barrera de protección. - Si es falso (predeterminado), la barandilla 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 opciones de configuración. security_config puede ser solo uno de los parámetros siguientes:
default_settings

Guardrail.LlmPromptSecurity.DefaultSecuritySettings

Es opcional. Usa la configuración de seguridad predeterminada 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 una LlmPolicy definida por el usuario para configurar la barrera de seguridad.

DefaultSecuritySettings

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 tiene fines de visualización para mostrarle al usuario 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, se anula la configuración predeterminada y se activa la barandilla si la respuesta se considera no segura.

Campos
safety_settings[]

Guardrail.ModelSafety.SafetySetting

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

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 el lenguaje obsceno.
HARM_CATEGORY_TOXIC La categoría de daño es tóxica.

SafetySetting

Configuración de seguridad.

Campos
category

Guardrail.ModelSafety.HarmCategory

Obligatorio. La categoría de daño.

threshold

Guardrail.ModelSafety.HarmBlockThreshold

Obligatorio. El umbral de bloqueo de daño.

Supervisor

Es la protección que ejecuta la intervención del supervisor.

Campos
type

Guardrail.Supervisor.Type

Es opcional. Es el tipo de supervisor.

detection_mode

Guardrail.Supervisor.DetectionMode

Es opcional. Es el modo de detección del supervisor.

DetectionMode

Es el modo de detección del supervisor.

Enums
DETECTION_MODE_UNSPECIFIED No se especificó el modo de detección. El valor predeterminado es NON_BLOCKING.
NON_BLOCKING Modo de detección sin bloqueo. La respuesta no se bloquea cuando la detección del supervisor está en curso.
BLOCKING Modo de detección de bloqueo. La respuesta se bloquea cuando la detección del supervisor está en curso.

Tipo

Es el tipo de supervisor.

Enums
TYPE_UNSPECIFIED El tipo no está especificado.
INVALID_TEXT Tipo de problema de texto no válido.
LANGUAGE_SHIFT Es el tipo de problema de cambio de idioma.
SPEAKER_SHIFT Es el tipo de problema de cambio de interlocutor.
AUDIO_MISMATCH Tipo de problema de discrepancia de audio.
MISSING_TOOL_CALL Falta el tipo de problema de llamada a la herramienta.
CUSTOM Tipo de problema personalizado.
CHOPPY_AUDIO Tipo de problema de audio entrecortado.
PROFANITY Es el tipo de problema de lenguaje obsceno del agente.

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 compatibles incluyen los siguientes: * image/png * image/jpeg * image/webp

data

bytes

Obligatorio. Son los bytes sin procesar de la imagen.

alt_text

string

Es opcional. Es el texto alternativo de la imagen.

ImportAppRequest

Mensaje de solicitud para AgentService.ImportApp.

Campos
parent

string

Obligatorio. Es el nombre del recurso superior 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 se vuelve a importar, no se debe establecer este campo. Si proporcionas un nombre visible durante la reimportación, se producirá 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 del nombre de su 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. Parámetro 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.

Campo de unión json_patch. Los parches JSON que se aplicarán a la app importada. json_patch solo puede ser uno de los siguientes:
json_patch_content

string

Es opcional. Es el contenido del parche como una cadena JSON.

json_patch_gcs_uri

string

Es opcional. Un URI de Cloud Storage que apunta a un archivo JSON que contiene los parches.

ImportOptions

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

Campos
conflict_resolution_strategy

ImportAppRequest.ImportOptions.ConflictResolutionStrategy

Es opcional. Es la estrategia que se usará para resolver conflictos durante la importación.

validate_only

bool

Es opcional. Es la marca para ejecutar el proceso de importación de forma de prueba. Si se establece como verdadero, el proceso de importación solo realizará validaciones y no hará cambios 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.) 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 Reemplaza 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, barreras de seguridad 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 los recursos importados con nombres visibles nuevos. - Los recursos existentes que no tengan un nombre visible coincidente en la app importada no se modificarán.
OVERWRITE Reemplaza los datos existentes por 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, barreras de seguridad y conjuntos de herramientas) de 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 mensajes de advertencia que se generan durante el proceso de importación. Si se producen errores en recursos específicos, 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. 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

Credenciales efímeras de Meta para la integración nativa de Instagram

Campos
auth_code

string

Obligatorio. Es el código de autenticación de Meta que proporciona el flujo de registro incorporado.

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 la interrupción del usuario o a la generación de 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

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. Es la 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 true, los agentes de la app usarán instrucciones precompiladas para mejorar el manejo de la entrada multilingüe.

fallback_action
(deprecated)

string

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 debe realizar cuando un agente recibe una entrada en un idioma no admitido.

Puede ser una acción predefinida o una llamada a la herramienta personalizada. Los valores válidos son los siguientes: - El nombre de recurso completo de una herramienta, que activa la ejecución de una herramienta específica. - Una acción predefinida del sistema, 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 de 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. Es 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. Es el 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

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

Es 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 enumeran 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. Es 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 enumeren las apps. Consulta https://google.aip.dev/160 para obtener más detalles.

order_by

string

Es opcional. Es el 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

Es 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. Es 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 enumeren 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:me@example.com * create_time > "2025-01-01T00:00:00Z" * create_time <= "2025-01-01T00:00:00Z" AND resource_type:tool

order_by

string

Es opcional. Es el 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

Es 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 de 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. Es 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 enumeren 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 establece, se aplicará Source.Live de forma predeterminada. Se dará de baja y se reemplazará por el campo sources.

sources[]

Conversation.Source

Es opcional. Indica las fuentes de las conversaciones. Si no se establece, se aplicarán todas las fuentes disponibles de forma predeterminada.

ListConversationsResponse

Mensaje de respuesta para AgentService.ListConversations.

Campos
conversations[]

Conversation

La lista de conversaciones.

next_page_token

string

Es 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 superior. Formato: 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. Es el 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. Es 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. Es el 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

Es 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 de 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. Es 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 enumeren las barreras de seguridad. Consulta https://google.aip.dev/160 para obtener más detalles.

order_by

string

Es opcional. Es el 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 de seguridad.

next_page_token

string

Es 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 de 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. Es 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 enumeren las 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. Es el 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

Es 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 de 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. Es 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 enumeren los conjuntos de herramientas. Consulta https://google.aip.dev/160 para obtener más detalles.

order_by

string

Es opcional. Es el 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

Es 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 que describe 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. Configuración de cómo se deben grabar las interacciones de audio. El audio está sujeto a ocultamiento según lo configurado en RedactionConfig.

unredacted_audio_recording_config

AudioRecordingConfig

Es opcional. Configura una grabación adicional de audio sin ocultar. Esto se puede usar para mantener una copia de audio sin procesar cuando se enabled la ocultación de audio, por lo general, con fines de auditoría o supervisión.

bigquery_export_settings

BigQueryExportSettings

Es opcional. Configura los comportamientos de BigQuery Export para la app. Los datos de la conversación están sujetos a ocultamiento, según se configura en RedactionConfig.

unredacted_bigquery_export_settings

BigQueryExportSettings

Es opcional. Configura los comportamientos de exportación de BigQuery para la app. Los datos de conversación sin ocultar se exportarán a las tablas de BigQuery si están habilitados.

cloud_logging_settings

CloudLoggingSettings

Es opcional. Es la configuración para describir los comportamientos de Cloud Logging de 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 de cómo se deben grabar 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. Son los parámetros de configuración que describen los comportamientos de recopilación de datos de conversaciones para la canalización de análisis de 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 el nombre se anuló con una anulación de Toolset.

description

string

Es opcional. 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. 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 de HTTP transmitible. 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 del portador, el token solo se aplica a la ejecución de herramientas, no a la lista 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. 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ámica de la herramienta en el servidor externo.

Estado

Representa el estado de disponibilidad dinámica 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 el contenedor de los elementos de definición principales de una herramienta que se capturan. Los esquemas de la instantánea se usan tal como están y no se pueden anular.

Campos
description

string

Solo salida. La descripción de la herramienta de MCP. Esto se puede anular con description_override en McpToolOverride.

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

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, la herramienta usa este nombre en el agente en lugar del nombre original. Esto se usa principalmente como un alias si el servidor de MCP ofrece herramientas con nombres poco claros.

description_override

string

Es opcional. Si está presente, la herramienta usa esta descripción en lugar de la original del servidor.

snapshot

McpToolDefinition

Solo salida. Si está presente, esta herramienta se "fija" y usa los valores de la instantánea como resguardos si el servidor deja de estar disponible temporalmente o si no hay ninguna anulación presente.

McpToolset

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

Campos
server_address

string

Obligatorio. 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 de HTTP transmitible. 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 ejecutarlas en el servidor de MCP. En el caso de la autenticación con token del portador, el token solo se aplica a la ejecución de herramientas, no a la lista de herramientas. Esto requiere que las herramientas se puedan enumerar sin autenticación.

service_directory_config

ServiceDirectoryConfig

Es opcional. 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. Anulaciones para herramientas individuales dentro de este conjunto de herramientas. Esto permite anular detalles específicos, como descripciones o 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, 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 conversación para las métricas de análisis de LLM. Si se establece como verdadero, no se recopilarán datos de conversación para las métricas de análisis de LLM; de lo contrario, se recopilarán datos de conversación.

MockConfig

Configuración de llamadas a herramientas simuladas para la sesión.

Campos
mocked_tool_calls[]

MockedToolCall

Es opcional. Todas las llamadas a la herramienta que se simularán durante la sesión.

unmatched_tool_call_behavior

MockConfig.UnmatchedToolCallBehavior

Obligatorio. Comportamiento de las llamadas a la herramienta 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 Arroja un error para cualquier llamada a la herramienta que no coincida con un patrón de entrada esperado simulado.
PASS_THROUGH Para las llamadas a herramientas que no coincidan, pasa la llamada a la herramienta real.

MockedToolCall

Una llamada a la herramienta simulada.

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

Campos
tool
(deprecated)

string

Es opcional. Obsoleto. Usa tool_identifier en su lugar.

expected_args_pattern

Struct

Obligatorio. Es un patrón que se compara con los argumentos o las entradas de todas las llamadas a la herramienta enviadas. Si las entradas de la llamada a la herramienta coinciden con este patrón, se devolverá el resultado simulado.

mock_response

Struct

Es opcional. La respuesta o el resultado simulados que se devolverán 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. Es el 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 para 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 de LLM que debe usar el agente. Si no se establece, el agente heredará el modelo de su agente superior.

thinking_level

ModelSettings.ThinkingLevel

Es opcional. Es el nivel de razonamiento del modelo.

temperature

double

Es opcional. Si se establece, 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.

ThinkingLevel

Es la configuración del nivel de razonamiento del modelo.

Enums
THINKING_LEVEL_UNSPECIFIED No se especificó el nivel de pensamiento.
DEFAULT Nivel de razonamiento predeterminado.
LOW Nivel de razonamiento bajo.
MEDIUM Nivel de razonamiento medio.
HIGH Nivel de razonamiento alto.

OAuthConfig

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. Es el nombre del recurso de la versión del Secret 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 que se intercambiará 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. La configuración predeterminada 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. Es el 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, de 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. 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 OpenAPI. Este campo solo se establece 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

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. 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 OpenAPI. Este campo solo se establece en los conjuntos de herramientas de las dependencias del entorno durante el proceso de exportación si el esquema contiene una URL de 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.

OperationCompletedEvent

Es el evento que envía el cliente o el trabajador en segundo plano para reanudar una sesión de asistente después de que se completa una operación de larga duración (LRO) asíncrona.

Campos
operation_name

string

Es el nombre del recurso de la operación (p.ej., operations/{op}).

target_resource_name

string

Es el recurso principal al que se orienta o que produce la operación (p.ej., ID de ejecución de la evaluación, ID de la app o ID del conjunto de datos).

operation_type

string

Es el tipo de operación o el nombre de la herramienta (p.ej., "run_evaluation", "copy_app", "export_app").

status

string

Es el estado de la ejecución de la operación (p.ej., "SUCCEEDED", "FAILED", "CANCELLED").

deduplication_token

string

Es un token de anulación de duplicación opcional (p.ej., UUID) para evitar la ejecución de turnos duplicados desde pestañas del navegador simultáneas.

error

Status

Estado de error canónico opcional si la operación falló.

metadata

Struct

Metadatos de resultados estructurados opcionales (p.ej., pass_rate, total_examples, export_uri).

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.

OptionQuestionsChunk

Son opciones de aclaración estructuradas que el asistente le pide al usuario que elija, traducidas del lado del servidor fuera del turno del modelo (el bloque de opciones se quita del texto transmitido y persistente). La consola renderiza una lista de opciones navegable con el teclado que se fija sobre el cuadro de redacción.

Campos
questions[]

OptionQuestionsChunk.Question

Las preguntas que se hicieron en este turno. Si hay más de una entrada, se activa el paginador "1 de N" de la consola.

Opción

Una sola opción seleccionable.

Campos
title

string

Título corto de la opción en texto sin formato (sin lenguaje de marcado ni numeración).

details

string

Detalles opcionales de compensación que se muestran como texto secundario.

submit_text

string

Texto del mensaje opcional que se enviará cuando se elija la opción; el valor predeterminado es title cuando está vacío.

Pregunta

Una pregunta con sus opciones.

Campos
question

string

Es el texto del encabezado de la pregunta.

options[]

OptionQuestionsChunk.Option

Son las opciones que se pueden seleccionar, en orden de presentación.

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

Una herramienta de función de Python.

Campos
name

string

Es opcional. Es el nombre de la función de Python que se ejecutará. Debe coincidir con el nombre de una función de Python definida 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 de voz del usuario concatenados que se capturaron 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 true, se aplicará la ocultación 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}

RemoteA2aConfig

Es la configuración compartida para conectarse a un agente A2A remoto.

Campos
api_authentication

ApiAuthentication

Es opcional. Es la configuración de autenticación para llamar al agente remoto. Es opcional si la referencia del registro ya controla la autenticación.

input_variable_mapping

map<string, string>

Es opcional. Asignación de nombres de variables de entrada del agente remoto a nombres de variables de GECX.

output_variable_mapping

map<string, string>

Es opcional. Asignación de nombres de variables de salida del agente remoto a nombres de variables de GECX.

streaming_enabled

bool

Es opcional. Indica si la transmisión está habilitada para el agente remoto.

context_id

string

Es opcional. Si no está vacío, las interacciones con el agente A2A remoto usarán este ID de contexto. Este campo context_id puede hacer referencia a una variable de sesión como $context.variables.order_agent_session_id.

Campo de unión agent_spec. Especificación del agente remoto. agent_spec puede ser solo uno de los parámetros siguientes:
agent_card

AgentCard

Es opcional. La tarjeta de agente completa definida de forma intercalada.

agent_registry

string

Es opcional. Referencia al agente en Agent Registry. Formato: projects/{project}/locations/{location}/agents/{agent}

RemoteAgentTool

Representa una herramienta que permite que el agente llame 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. 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.

stateful_agent

bool

Es opcional. Cuando se habilita, la interacción entre la app de CXAS y el agente remoto compartirá el mismo contexto. Si el agente remoto devuelve un context_id, este se conservará durante toda la sesión de esta herramienta de agente remoto.

input_variable_mapping

map<string, string>

Es opcional. Asignación de nombres de variables de entrada del agente remoto a nombres de variables de GECX.

output_variable_mapping

map<string, string>

Es opcional. Asignación de nombres de variables de salida del agente remoto a nombres de variables de GECX.

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 aplica 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 creó 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 creó el esquema.

RetrieveToolsRequest

Mensaje de solicitud para ToolService.RetrieveTools.

Campos
toolset

string

Obligatorio. Es el nombre del conjunto de herramientas del 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.

bypass_persistence_config

bool

Es opcional. Si es verdadero, las herramientas devueltas contendrán descripciones y esquemas sin procesar directamente del 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. Propiedades de Type.OBJECT.

required[]

string

Es opcional. 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 booleano o un objeto, y controla la presencia de propiedades adicionales.

any_of[]

Schema

Es opcional. El valor se debe validar con cualquiera (uno o más) de los subesquemas 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 nodos de esquema. El valor debe ser una referencia válida a un elemento secundario de la raíz defs.

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 de 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 que usa 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

Tipos de datos de OpenAPI.

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

SecuritySettings

Configuración de seguridad a nivel de proyecto o 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. Configuración relacionada con el control de extremos.

create_time

Timestamp

Solo salida. Es la hora de creación de la configuración de seguridad.

update_time

Timestamp

Solo salida. Es la hora de la última actualización de la configuración de seguridad.

etag

string

Solo salida. Etag de la configuración de seguridad.

ServiceAccountAuthConfig

Son los parámetros de 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 permiso predeterminado https://www.googleapis.com/auth/cloud-platform.

ServiceAgentIdTokenAuthConfig

Este tipo no tiene campos.

Parámetros de configuración para la autenticación con el token de ID generado a partir del agente de servicio.

ServiceDirectoryConfig

Configuración de las herramientas que usan el Directorio de servicios.

Campos
service

string

Obligatorio. Es el nombre del servicio del Directorio de servicios. 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.

SessionCheckpoint

Es el punto de control de la sesión que contiene la intención del usuario inferida para el título y la IU de la sesión.

Campos
user_intent

string

Es el objetivo o tema inferido del usuario para la sesión (p.ej., "Creación de un agente de asistencia para comercio electrónico").

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 propagar 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 que controlará la sesión. Si no se especifica, la sesión se controlará con 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. Es la 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 establece 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 que se enviarán 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 debe transmitir la salida de texto del modelo al cliente de forma incremental a medida que se genera. La configuración predeterminada es false.

  • Cuando se inhabilita, el resultado de texto del modelo se almacena en búfer y cada resultado de texto que se envía al cliente es una oración completa. Los clientes pueden renderizar cada resultado de texto en una línea nueva.
  • Cuando está habilitado, cada salida de texto puede contener solo una parte de una oración. Los clientes deben concatenar los resultados de texto consecutivos para renderizar la respuesta completa.

NOTA: Esto solo se admite para sesiones de texto (sin voz) con StreamRunSession o BidiRunSession.

include_llm_thought_summary

bool

Es opcional. Indica si se deben incluir resúmenes de pensamientos del LLM en los resultados de la sesión.

exclude_diagnostic_info

bool

Es opcional. Indica si se debe excluir la información de diagnóstico del resultado de la sesión.

include_progress_update

bool

Es opcional. Indica si se debe incluir la actualización de procesamiento intermedio para el cliente. Si está habilitada, la actualización se enviará de vuelta en SessionOutput.progress.

RemoteDialogflowQueryParameters

QueryParameters que se enviarán 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.

recording_control

SessionInput.RecordingControl

Es opcional. Si la conversación se puede grabar y registrar a partir de este momento.

Usa esta opción cuando la app, en lugar del agente, decida qué se puede conservar, por ejemplo, cuando el usuario final deba dar su consentimiento para que se lo grabe antes de que se pueda almacenar cualquier información sobre la llamada.

El valor permanece vigente hasta que el cliente envía uno diferente, por lo que solo se debe enviar cuando cambia la respuesta. Lo que esté vigente cuando se complete un turno decide ese turno, tanto si su audio llega al bucket de grabación como si su transcripción llega al historial de conversaciones, BigQuery y Cloud Logging. Abarca tanto el lado del agente como el del usuario final.

Los turnos que se completan antes de que el cliente envíe este campo por primera vez se registran según la configuración de registro de la app, como si el campo no existiera.

Si más de una entrada en la misma solicitud lo establece, gana la última.

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 la herramienta desde el 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 clave por 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. Entrada del evento.

RecordingControl

Es posible que se registre y se guarde lo que la app haya decidido.

Esta enumeración es extensible; es posible que se agreguen valores nuevos en el futuro.

Enums
RECORDING_CONTROL_UNSPECIFIED La app no controla la grabación. La configuración de registro de la app decide, como lo hace para cada sesión que nunca establece este campo.
RECORDING_ENABLED A partir de este momento, es posible que se grabe y registre la conversación.
RECORDING_DISABLED Es posible que la conversación no se grabe ni se registre a partir de este momento.

SessionOutput

Es el resultado de la sesión.

Campos
turn_index

int32

Indica el orden secuencial del turno de conversación al que pertenece este resultado, a partir de 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 ejecución durante el procesamiento de la entrada. Solo se completa en el último SessionOutput (con turn_completed=true) para cada turno.

Campo de unión output_type. Es el tipo de resultado. output_type puede ser solo uno de los parámetros siguientes:
text

string

Es el texto de salida del agente de CES.

audio

bytes

Es el audio de salida del agente de CES.

tool_calls

ToolCalls

Solicita que el cliente ejecute las herramientas.

citations

Citations

Son citas que proporcionan la información de la fuente del texto generado por el agente.

google_search_suggestions

GoogleSearchSuggestions

Son las sugerencias que se devuelven de la Búsqueda de Google como resultado de invocar el GoogleSearchTool.

end_session

EndSession

Indica que la sesión finalizó.

payload

Struct

Carga útil personalizada con resultados estructurados del agente de CES.

image

Image

Imagen de salida del agente de CES.

progress

string

Actualización intermedia del progreso del agente de CES.

DiagnosticInfo

Contiene detalles de ejecución durante el procesamiento.

Campos
messages[]

Message

Es la lista de los mensajes que se produjeron durante el procesamiento.

root_span

Span

Un seguimiento 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 intervalo 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 intervalo.

end_time

Timestamp

Solo salida. Es la hora de finalización del intervalo.

duration

Duration

Solo salida. La duración del intervalo.

attributes

Struct

Solo salida. Son los atributos de par clave-valor asociados con el intervalo.

child_spans[]

Span

Solo salida. Son los intervalos secundarios que están anidados en este intervalo.

StreamChatAiAssistantRequest

Mensaje de solicitud para SessionService.StreamChatAiAssistant.

Campos
name

string

Obligatorio. Es la sesión del asistente que se usará para ejecutarlo. Formato: projects/{project}/locations/{location}/apps/{app}/assistantSessions/{assistant_session}

message

string

Es opcional. Es el mensaje que se enviará al agente de asistencia. Puede estar vacío cuando se establece confirmation_response (responder una confirmación pendiente sin agregar un mensaje nuevo); se debe proporcionar al menos uno de los dos.

attached_gcs_uris[]

string

Es opcional. Son los URIs de Cloud Storage para los archivos que subió el usuario durante este turno. Ejemplo: "gs://cxas-transient-uploads/uuid/prd.pdf"

context_token

string

Es opcional. Es el token de contexto de integración opaco que devuelve SessionService.GenerateOnboardingSuggestions. Cuando se establece y aún está actualizado, el servidor reutiliza la instantánea de incorporación calculada para el estado cero en lugar de volver a calcularla para el primer turno de conversación.

confirmation_response

AssistantConfirmationResponse

Es opcional. Es la respuesta del usuario a un AssistantConfirmationRequest pendiente. Cuando se establece, el servidor reanuda el agente pausado con esta respuesta en lugar de (o además de) iniciar un nuevo turno de instrucción.

client_capabilities[]

StreamChatAiAssistantRequest.ClientCapability

Es opcional. Son las funciones de respuesta que este cliente puede renderizar. El servidor solo emite eventos que necesitan una capacidad (p.ej., confirmation_request) cuando se declara la capacidad, por lo que los clientes más antiguos nunca reciben eventos que descartarían de forma silenciosa.

operation_completed_event

OperationCompletedEvent

Es opcional. Reanuda una sesión de asistente que se detuvo mientras esperaba que se completara una operación de larga duración administrada por el cliente.

resume_from_sequence_number

int64

Es opcional. Cursor opcional para reanudar y volver a reproducir eventos de un turno en curso o completado.

attach_only

bool

Es opcional. Es una marca opcional para adjuntar a un turno en curso existente sin enviar un mensaje nuevo.

ClientCapability

Son las funciones de respuesta que puede declarar un cliente.

Enums
CLIENT_CAPABILITY_UNSPECIFIED Capacidad no especificada; se ignora.
CONFIRMATION_CARDS El cliente renderiza las tarjetas AssistantConfirmationRequest y las responde a través de confirmation_response.
CLIENT_MANAGED_LRO El cliente administra las operaciones de larga duración fuera de banda sondeando la operación y enviando operation_completed_event para reanudar el turno. Si no se declara, el servidor administra el sondeo de LRO y completa el turno de forma intercalada.
PROJECT_SCOPE El cliente renderiza eventos de alcance del proyecto: tarjetas typed_payload, target_app en llamadas a la herramienta y respuestas, targets en solicitudes de confirmación y touched_apps en la finalización del turno.

StreamChatAiAssistantResponse

Mensaje de respuesta para SessionService.StreamChatAiAssistant.

Campos
event_id

string

Identificador único para el evento.

event_time

Timestamp

Es la marca de tiempo de cuando ocurrió el evento.

ui_event

UiEvent

Es opcional. Es la carga útil del evento de IU.

turn_metadata

TurnMetadata

Es opcional. Metadatos a nivel de turno y categorización de intents

sequence_number

int64

Es opcional. Es el número de secuencia que aumenta de forma monótona para este turno de sesión.

turn_in_progress

bool

Es opcional. Indica si el turno aún se está ejecutando de forma activa en segundo plano.

Campo de unión event. Es la carga útil del evento. event puede ser solo uno de los parámetros siguientes:
text_chunk

string

Token de texto (para transmitir las respuestas de Gemini palabra por palabra)

status

Status

Actualización de estado simple.

thought_chunk

string

Es el fragmento de texto de pensamiento (el razonamiento del agente antes de generar la respuesta).

tool_call

ToolCall

Es el evento de ejecución de la llamada a la herramienta.

tool_response

ToolResponse

Es el evento de respuesta de la llamada a la herramienta.

artifact_chunk

ArtifactChunk

Evento de artefacto de documento generado (deltas de vista previa en vivo + puntero final de Cloud Storage).

option_questions_chunk

OptionQuestionsChunk

Son las opciones de aclaración estructuradas que se analizan a partir del turno del modelo. La consola los renderiza como una lista de opciones seleccionables en lugar de texto sin procesar.

confirmation_request

AssistantConfirmationRequest

Es una confirmación de bloqueo en la que se detuvo el agente. El agente se reanuda cuando la respuesta llega en el confirmation_response de una solicitud posterior. Solo se envía a los clientes que declararon la capacidad CONFIRMATION_CARDS en la solicitud.

session_checkpoint

SessionCheckpoint

Es el evento de resumen de compactación o punto de control de la sesión que contiene la intención del usuario y el resumen continuo.

resume_snapshot

TurnResumeSnapshot

Es una repetición compactada de un turno en curso, que se envía como el primer evento de cada conexión o reanudación antes de cualquier evento en vivo. El cliente reemplaza cualquier estado renderizado de forma local para este turno por el contenido de la instantánea.

handoff

TurnHandoffEvent

Le indica al cliente que se vuelva a conectar de forma silenciosa con resume_from_sequence_number: la tarea que entrega esta transmisión desaparecerá y el turno continuará en otro lugar. No es un error; la transmisión se completa con normalidad después de este evento.

turn_completed

TurnCompletedEvent

Finalizó el turno. Se envía como el último evento de cada turno, en la transmisión original y en cada transmisión adjunta o reanudada, para que los clientes puedan finalizar el turno con una señal explícita en lugar de inferirla del cierre de la transmisión.

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 de Cloud Text-to-Speech.

speaking_rate

double

Es opcional. La velocidad de habla en el rango [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] devolverán un error.

model

string

Es opcional. Es el modelo que se usa para sintetizar audio. Valores admitidos actualmente: - "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 la voz cuando se usa un modelo generativo.

SystemTool

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 la zona horaria de la app.

Campos
time_zone

string

Es opcional. Es la 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 AC personalizados permitidos para la verificación de HTTPS.

CaCert

Es el certificado de la AC.

Campos
display_name

string

Obligatorio. Es el nombre de los certificados de la AC personalizados permitidos. Esto se puede usar para eliminar la ambigüedad de los certificados de la AC personalizados.

cert

bytes

Obligatorio. Son los certificados de la 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 lograr 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 las 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 puede hacer referencia a ellas directamente donde se espera una herramienta.

display_name

string

Solo salida. Es el nombre visible de la herramienta, que se deriva según su tipo. Por ejemplo, el nombre visible de una [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. Marca de tiempo de la última actualización de la herramienta.

etag

string

Es la etiqueta de entidad que se usa para garantizar que el objeto no haya cambiado durante una operación de lectura, modificación y escritura. Si la etag está vacía, 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. Configuración del comportamiento de la herramienta en el modo falso.

read_only

bool

Solo salida. Indica si la herramienta es de solo lectura. Si es verdadero, el usuario no puede modificar la herramienta.

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. La función del cliente

open_api_tool

OpenApiTool

Es opcional. La herramienta de API abierta.

google_search_tool

GoogleSearchTool

Es opcional. La herramienta de Búsqueda de Google

connector_tool

ConnectorTool

Es opcional. La herramienta Integration Connector

data_store_tool

DataStoreTool

Es opcional. La herramienta de almacén de datos.

python_function

PythonFunction

Es opcional. La herramienta de función de Python.

mcp_tool

McpTool

Es opcional. La herramienta de MCP. No se puede crear ni actualizar una herramienta de MCP directamente, y se administra con el conjunto de herramientas de MCP.

file_search_tool

FileSearchTool

Es opcional. La herramienta de búsqueda de archivos.

system_tool

SystemTool

Es opcional. La herramienta del sistema.

agent_tool

AgentTool

Es opcional. La herramienta del agente.

widget_tool

WidgetTool

Es opcional. La herramienta de widgets

remote_agent_tool

RemoteAgentTool

Es opcional. La herramienta de 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. Es el 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 agente secundario que trabaja en nombre de una llamada superior. Está vacío para las llamadas de nivel superior. Permite que un cliente agrupe el trabajo de un agente secundario en la llamada que lo inició, en lugar de renderizar cada paso como un elemento hermano.

agent_name

string

Solo salida. Nombre legible por humanos del agente que emitió esta llamada, p.ej., "Arquitecto de contratos". Está vacío cuando lo emite el agente raíz.

target_app

string

Solo salida. La app a la que se dirige esta llamada, derivada por el asistente a partir de los argumentos de recursos de la llamada: un nombre de recurso de app, PROJECT para las herramientas con alcance de ubicación o vacío para las herramientas locales de la sesión. Se establece solo en las sesiones de asistente con alcance de proyecto.

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

Solicita que el cliente ejecute las herramientas y devuelva 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

Configuración del comportamiento de la herramienta en el modo falso.

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. 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 al que corresponde la respuesta.

display_name

string

Solo salida. Es el 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 los hay). Si no se especifican las claves "output" y "error", toda la "response" se trata como el 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 agente secundario que trabaja en nombre de una llamada superior. Está vacío para las llamadas de nivel superior. Permite que un cliente agrupe el trabajo de un agente secundario en la llamada que lo inició, en lugar de renderizar cada paso como un elemento hermano.

agent_name

string

Solo salida. Nombre legible por humanos del agente que emitió esta llamada, p.ej., "Arquitecto de contratos". Está vacío cuando lo emite el agente raíz.

target_app

string

Solo salida. Es la app a la que se orientó la herramienta ejecutada; refleja ToolCall.target_app.

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 la herramienta 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 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. Marca de tiempo de la última actualización del conjunto de herramientas.

etag

string

Es la ETag que se usa para garantizar que el objeto no haya cambiado durante una operación de lectura, modificación y escritura. Si la etag está vacía, la actualización reemplazará cualquier cambio simultáneo.

execution_type

ExecutionType

Es opcional. Es el tipo de ejecución de las herramientas del conjunto de herramientas.

tool_fake_config

ToolFakeConfig

Es opcional. Configuración del comportamiento de las herramientas en el modo falso.

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 herramientas que ofrece el servidor de MCP.

open_api_toolset

OpenApiToolset

Es opcional. 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 de las que se 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. 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 transfiere de inmediato al agente de destino cuando se cumple la condición.

disable_planner_transfer

TransferRule.DisablePlannerTransfer

Es opcional. Es la regla que impide que el planificador transfiera al agente de destino.

DeterministicTransfer

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 produce 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 produce la transferencia.

Dirección

La dirección de la transferencia.

Enums
DIRECTION_UNSPECIFIED Dirección sin especificar.
PARENT_TO_CHILD Transferencia del agente superior al agente secundario.
CHILD_TO_PARENT Transferencia del agente secundario al agente superior

DisablePlannerTransfer

Una regla que impide que el planificador transfiera al agente de destino.

Campos
expression_condition

ExpressionCondition

Obligatorio. Si la condición se evalúa como verdadera, el planificador no podrá transferir 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. Responde 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ándares entre las 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 debe 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}

TurnCompletedEvent

Es el evento de terminal de un turno (consulta StreamChatAiAssistantResponse.turn_completed).

Campos
turn_id

string

Es el identificador del giro que finalizó. Coincide con TurnResumeSnapshot.turn_id y ActiveTurnInfo.turn_id.

reason

TurnCompletedEvent.Reason

Por qué finalizó el turno

final_sequence_number

int64

Es el número de secuencia del último evento que produjo el turno. Un cliente cuyo cursor esté más abajo se perdió contenido y debería volver a cargar la sesión para verlo.

touched_apps[]

string

Las apps que se modificaron o se orientaron en este turno, de modo que la consola pueda actualizar exactamente los almacenes de esas apps. Solo sesiones con permiso de proyecto. Formato: projects/{project}/locations/{location}/apps/{app}

Motivo

Por qué finalizó el turno, de modo que un cliente que se unió tarde pueda expresar el resultado en lugar de adivinarlo a partir de una transmisión vacía.

Enums
REASON_UNSPECIFIED Sin especificar.
COMPLETED El turno se ejecutó hasta completarse; la sesión conserva su resultado confirmado.
ABANDONED Ninguna tarea impulsaba el turno, se selló a un parcial confirmado y no se puede continuar.
RESUME_UNAVAILABLE Este servidor no admite adjuntar ni reanudar la sesión, por lo que no se hizo un seguimiento de nada. En su lugar, el cliente debería volver a cargar la sesión.

TurnHandoffEvent

Se emite antes de que esta tarea deje de entregar la transmisión a mitad del turno (p.ej., un reinicio del servidor). El estado del turno se conserva; una reconexión que lleva resume_from_sequence_number lo continúa en otra tarea.

Campos
turn_id

string

Identifica el turno que se reanudará.

reason

TurnHandoffEvent.Reason

Por qué se transfiere la transmisión

Motivo

Por qué se transfiere la transmisión

Enums
REASON_UNSPECIFIED Sin especificar.
SERVER_RESTART La tarea de entrega se está cerrando (envío de versión o reprogramación).

TurnMetadata

Metadatos a nivel de turno y categorización de intents

Campos
contract_finalized

bool

Se establece en el evento de artefacto final de un turno cuyo borrador de contrato se publicó (se activó una revisión). Terminal para el flujo de aclaración de este borrador: contract_progress es autoritativo y completo.

contract_streaming_phase

TurnMetadata.ContractStreamingPhase

Se establece solo en las estimaciones de progreso en curso emitidas mientras se transmite una barrera de artefactos de contrato y en el evento de inicio de turno de revisión. No se establece en las cargas útiles autorizadas.

contract_draft_complete

bool

Se establece en el evento de terminal de un borrador de contrato en el que se resuelven todos los marcadores de posición (contract_progress es 100%), independientemente de si se publicó el borrador o no. Los clientes completan y descartan la visualización del progreso del contrato en él; la publicación se informa por separado mediante contract_finalized.

ContractStreamingPhase

Es la fase de transmisión de la carga útil del progreso del contrato.

Enums
CONTRACT_STREAMING_PHASE_UNSPECIFIED La carga útil es autoritativa (se calcula a partir de un documento de contrato completo, una instantánea persistente o el estado previo al borrador). Los clientes deben reemplazar cualquier progreso recibido anteriormente por este.
DRAFTING Se está transmitiendo un borrador inicial del contrato. contract_progress es una estimación en curso: no disminuye dentro de un límite de artefacto, tiene un límite inferior al rango de autoridad y pillar_breakdowns tiene total_item_count == 0 para marcar los estados estimados de los pilares.
REVISING Se está transmitiendo una revisión de un contrato existente (por ejemplo, después de un envío de anotaciones). Tiene la misma semántica de estimación que DRAFTING.

TurnResumeSnapshot

Es una repetición compactada de un turno en curso: todo lo necesario para renderizar el resultado visible del turno hasta el momento, además de la posición desde la que continúan los eventos en vivo.

Campos
turn_id

string

Identifica el turno al que se adjunta.

resolved_sequence_number

int64

Es la posición que representa esta instantánea. Los eventos en vivo siguen con un sequence_number estrictamente mayor que este. Cuando es inferior al resume_from_sequence_number que solicitó el cliente, el progreso vaciado se retrasa con respecto a lo que el cliente ya renderizó: el cliente debe descartar el contenido renderizado de este turno más allá de esta posición antes de aplicar la instantánea.

events[]

StreamChatAiAssistantResponse

Son eventos compactados que reconstruyen el resultado visible del turno, en orden de renderización, con las mismas formas de eventos que la transmisión en vivo.

orphan_deadline_time

Timestamp

Cuándo se cerrará el turno si no queda ningún cliente conectado.

UiEvent

Representa una carga útil de evento de IU.

Campos
mime_type

string

Es el tipo de medio (tipo de MIME) que indica el formato de la carga útil del evento de la IU (p.ej., "application/json+a2ui").

json_payload

string

Es la carga útil de JSON que representa la plataforma de A2UI.

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.

UpdateAppVersionRequest

Mensaje de solicitud para AgentService.UpdateAppVersion.

Campos
app_version

AppVersion

Obligatorio. Es la versión de la app que se actualizará.

update_mask

FieldMask

Es opcional. La lista de campos que se deben actualizar. Si está vacío, se actualizarán los campos display_name y description.

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

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

Campos
query

string

Es el texto de la búsqueda.

uri

string

Es el URI de la página de resultados de la Búsqueda de Google para la consulta.

WhatsAppCredentials

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

Campos
auth_code

string

Obligatorio. Es el código de autenticación de Meta que proporciona el flujo de registro incorporado.

pin

string

Obligatorio. Es el PIN de 6 dígitos que crea el usuario para la verificación en dos pasos.

phone_number

string

Obligatorio. Es el número de teléfono 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 elija la herramienta, devolverá el widget al cliente. El cliente es responsable de procesar el widget y generar la siguiente consulta del usuario para continuar la interacción con el agente.

Campos
name

string

Obligatorio. Es el nombre visible de la herramienta de widget.

description

string

Es opcional. Es la descripción de la herramienta de widget.

widget_type

WidgetTool.WidgetType

Es opcional. Es el tipo de herramienta de 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. 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 de las respuestas de texto que siempre se incluyen.

Campo de unión input. 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

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 de origen 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

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 devuelve 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ática que se devuelve cuando el tipo es STATIC.

text_response_instruction

string

Es opcional. Es la 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 genera una respuesta de texto junto con el widget según el contexto de la conversación.
LLM_GENERATED Se requiere de forma explícita que el LLM genere una respuesta de texto.
STATIC Siempre se usa una respuesta de texto estática predefinida.

WidgetType

Todos los tipos de widgets disponibles. Es posible que se agreguen valores nuevos a esta enumeración en el futuro.

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