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 de forma masiva las conversaciones especificadas.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso parent:

  • ces.conversations.delete

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

rpc CreateAgent(CreateAgentRequest) returns (Agent)

Crea un agente nuevo en la app especificada.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso parent:

  • ces.agents.create

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

rpc CreateApp(CreateAppRequest) returns (Operation)

Crea una app nueva en el proyecto y la ubicación especificados.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso parent:

  • ces.apps.create

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

rpc CreateAppVersion(CreateAppVersionRequest) returns (AppVersion)

Crea una versión nueva de la app en la app especificada.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso parent:

  • ces.appVersions.create

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

rpc CreateDeployment(CreateDeploymentRequest) returns (Deployment)

Crea una implementación nueva en la app especificada.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso parent:

  • ces.deployments.create

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

rpc CreateExample(CreateExampleRequest) returns (Example)

Crea un ejemplo nuevo en la app especificada.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso parent:

  • ces.examples.create

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

rpc CreateGuardrail(CreateGuardrailRequest) returns (Guardrail)

Crea una nueva protección en la app especificada.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso parent:

  • ces.guardrails.create

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

rpc CreateTool(CreateToolRequest) returns (Tool)

Crea una herramienta nueva en la app especificada.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso parent:

  • ces.tools.create

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

rpc CreateToolset(CreateToolsetRequest) returns (Toolset)

Crea un nuevo conjunto de herramientas en la app especificada.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso parent:

  • ces.toolsets.create

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

rpc DeleteAgent(DeleteAgentRequest) returns (Empty)

Borra el agente especificado.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso name:

  • ces.agents.delete

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

rpc DeleteApp(DeleteAppRequest) returns (Operation)

Borra la app especificada.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso name:

  • ces.apps.delete

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

rpc DeleteAppVersion(DeleteAppVersionRequest) returns (Empty)

Borra la versión de la app especificada.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso name:

  • ces.appVersions.delete

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

rpc DeleteConversation(DeleteConversationRequest) returns (Empty)

Borra la conversación especificada.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso name:

  • ces.conversations.delete

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

rpc DeleteDeployment(DeleteDeploymentRequest) returns (Empty)

Borra la implementación especificada.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso name:

  • ces.deployments.delete

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

rpc DeleteExample(DeleteExampleRequest) returns (Empty)

Borra el ejemplo especificado.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso name:

  • ces.examples.delete

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

rpc DeleteGuardrail(DeleteGuardrailRequest) returns (Empty)

Borra la protección especificada.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso name:

  • ces.guardrails.delete

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

rpc DeleteTool(DeleteToolRequest) returns (Empty)

Borra la herramienta especificada.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso name:

  • ces.tools.delete

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

rpc DeleteToolset(DeleteToolsetRequest) returns (Empty)

Borra el conjunto de herramientas especificado.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso name:

  • ces.toolsets.delete

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

rpc ExportApp(ExportAppRequest) returns (Operation)

Exporta la app especificada.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso name:

  • ces.apps.export

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

rpc GetAgent(GetAgentRequest) returns (Agent)

Obtiene detalles del agente especificado.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso name:

  • ces.agents.get

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

rpc GetApp(GetAppRequest) returns (App)

Obtiene detalles de la app especificada.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso name:

  • ces.apps.get

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

rpc GetAppVersion(GetAppVersionRequest) returns (AppVersion)

Obtiene detalles de la versión de la app especificada.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso name:

  • ces.appVersions.get

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

rpc GetChangelog(GetChangelogRequest) returns (Changelog)

Obtiene el registro de cambios especificado.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso name:

  • ces.changelogs.get

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

rpc GetConversation(GetConversationRequest) returns (Conversation)

Obtiene detalles de la conversación especificada.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso name:

  • ces.conversations.get

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

rpc GetDeployment(GetDeploymentRequest) returns (Deployment)

Obtiene detalles de la implementación especificada.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso name:

  • ces.deployments.get

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

rpc GetExample(GetExampleRequest) returns (Example)

Obtiene detalles del ejemplo especificado.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso name:

  • ces.examples.get

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

rpc GetGuardrail(GetGuardrailRequest) returns (Guardrail)

Obtiene detalles sobre la protección especificada.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso name:

  • ces.guardrails.get

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

rpc GetTool(GetToolRequest) returns (Tool)

Obtiene detalles de la herramienta especificada.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso name:

  • ces.tools.get

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

rpc GetToolset(GetToolsetRequest) returns (Toolset)

Obtiene detalles del conjunto de herramientas especificado.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso name:

  • ces.toolsets.get

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

rpc ImportApp(ImportAppRequest) returns (Operation)

Importa la app especificada.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso parent:

  • ces.apps.import

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

rpc ListAgents(ListAgentsRequest) returns (ListAgentsResponse)

Enumera los agentes de la app especificada.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso parent:

  • ces.agents.list

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

rpc ListAppVersions(ListAppVersionsRequest) returns (ListAppVersionsResponse)

Enumera todas las versiones de la app especificada.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso parent:

  • ces.appVersions.list

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

rpc ListApps(ListAppsRequest) returns (ListAppsResponse)

Enumera las apps en el proyecto y la ubicación determinados.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso parent:

  • ces.apps.list

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

rpc ListChangelogs(ListChangelogsRequest) returns (ListChangelogsResponse)

Enumera los registros de cambios de la app especificada.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso parent:

  • ces.changelogs.list

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

rpc ListConversations(ListConversationsRequest) returns (ListConversationsResponse)

Enumera las conversaciones en la app determinada.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso parent:

  • ces.conversations.list

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

rpc ListDeployments(ListDeploymentsRequest) returns (ListDeploymentsResponse)

Enumera las implementaciones en la app especificada.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso parent:

  • ces.deployments.list

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

rpc ListExamples(ListExamplesRequest) returns (ListExamplesResponse)

Enumera ejemplos en la app determinada.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso parent:

  • ces.examples.list

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

rpc ListGuardrails(ListGuardrailsRequest) returns (ListGuardrailsResponse)

Enumera los parámetros de protección de la app especificada.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso parent:

  • ces.guardrails.list

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

rpc ListTools(ListToolsRequest) returns (ListToolsResponse)

Enumera las herramientas de la app especificada.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso parent:

  • ces.tools.list

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

rpc ListToolsets(ListToolsetsRequest) returns (ListToolsetsResponse)

Enumera los conjuntos de herramientas de la app especificada.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso parent:

  • ces.toolsets.list

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

rpc RestoreAppVersion(RestoreAppVersionRequest) returns (Operation)

Restablece la versión de la app especificada. Se creará una versión nueva de la app a partir de la app en borrador actual y se sobrescribirá el borrador actual con la versión de la app especificada.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso name:

  • ces.appVersions.restore

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

rpc UpdateAgent(UpdateAgentRequest) returns (Agent)

Actualiza el agente especificado.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso name:

  • ces.agents.update

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

rpc UpdateApp(UpdateAppRequest) returns (App)

Actualiza la app especificada.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso name:

  • ces.apps.update

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

rpc UpdateDeployment(UpdateDeploymentRequest) returns (Deployment)

Actualiza la implementación especificada.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso name:

  • ces.deployments.update

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

rpc UpdateExample(UpdateExampleRequest) returns (Example)

Actualiza el ejemplo especificado.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso name:

  • ces.examples.update

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

rpc UpdateGuardrail(UpdateGuardrailRequest) returns (Guardrail)

Actualiza la protección especificada.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso name:

  • ces.guardrails.update

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

rpc UpdateTool(UpdateToolRequest) returns (Tool)

Actualiza la herramienta especificada.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso name:

  • ces.tools.update

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

rpc UpdateToolset(UpdateToolsetRequest) returns (Toolset)

Actualiza el conjunto de herramientas especificado.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso name:

  • ces.toolsets.update

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

SessionService

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

BidiRunSession

rpc BidiRunSession(BidiSessionClientMessage) returns (BidiSessionServerMessage)

Establece una conexión de transmisión bidireccional con el agente de CES. El agente procesa entradas multimodales continuas (p.ej., texto y audio) y genera flujos de salida multimodales en tiempo real.

--- Client Request Stream --- El cliente transmite solicitudes en el siguiente orden:

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

  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 la mitad de la transmisión cuando no haya más entrada del usuario. También debe cerrarse a la mitad cuando recibe 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 concatenados del discurso del usuario capturados hasta el momento. Este campo solo se completa para las sesiones de audio.

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

  3. Finalización del turno (mensaje final del turno): Contiene SessionOutput con turn_completed establecido en verdadero. Esto indica el final del turno actual y contiene DiagnosticInfo con detalles de ejecución.

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

  1. Reproducción e interrupción: Reproduce audio responses cuando lo recibas. Detén la reproducción de inmediato si se recibe un InterruptionSignal (p.ej., interrupción del usuario o respuesta nueva del agente).
Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso session:

  • ces.sessions.bidiRunSession

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

rpc RunSession(RunSessionRequest) returns (RunSessionResponse)

Inicia una interacción de un solo turno con el agente de CES dentro de una sesión.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso session:

  • ces.sessions.runSession

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

ToolService

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

ExecuteTool

rpc ExecuteTool(ExecuteToolRequest) returns (ExecuteToolResponse)

Ejecuta la herramienta determinada con los argumentos determinados.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso parent:

  • ces.tools.execute

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

rpc RetrieveToolSchema(RetrieveToolSchemaRequest) returns (RetrieveToolSchemaResponse)

Recupera el esquema de la herramienta determinada. El esquema se calcula sobre la marcha para la instancia determinada de la herramienta.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso parent:

  • ces.tools.get

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

rpc RetrieveTools(RetrieveToolsRequest) returns (RetrieveToolsResponse)

Recupera la lista de herramientas incluidas en el conjunto de herramientas especificado.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso toolset:

  • ces.toolsets.get

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

WidgetService

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

GenerateChatToken

rpc GenerateChatToken(GenerateChatTokenRequest) returns (GenerateChatTokenResponse)

Genera un token con alcance de sesión para que el widget de chat se autentique con las APIs de Session.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Para obtener más información, consulta Authentication Overview.

Acción

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

Campos
input_fields[]

string

Es opcional. Son los campos de la entidad que se usarán como entradas para la operación. Si no se especifican campos, se usarán todos los campos de la entidad.
output_fields[]

string

Es opcional. Son los campos de la entidad que se devolverán de la operación. Si no se especifican campos, se mostrarán todos los campos de la entidad.
Campo de unión action_spec. Es la especificación de una acción que se configurará para que la use la herramienta. action_spec puede ser solo uno de los parámetros siguientes:
connection_action_id

string

Es el ID de una acción de conexión que usará la herramienta.
entity_operation

Action.EntityOperation

Es la configuración de la operación de la entidad que usará la herramienta.

EntityOperation

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

Campos
entity_id

string

Obligatorio. Es el ID de la entidad.
operation

Action.EntityOperation.OperationType

Obligatorio. Operación que se realizará en la entidad.

OperationType

Operación que se realizará en la entidad.

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

Agente

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

Campos
name

string

Es el identificador. El identificador único del agente. Formato: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
display_name

string

Obligatorio. Es el nombre visible del agente.
description

string

Es opcional. Es una descripción del agente legible por humanos.
model_settings

ModelSettings

Es opcional. Es la configuración del modelo de LLM.
instruction

string

Es opcional. Son las instrucciones para el modelo de LLM que guían el comportamiento del agente.
tools[]

string

Es opcional. Es la lista de herramientas disponibles para el agente. Formato: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
child_agents[]

string

Es opcional. Es la lista de agentes secundarios en el árbol de agentes. Formato: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
before_agent_callbacks[]

Callback

Es opcional. Son las devoluciones de llamada que se ejecutarán antes de que se llame al agente. Las devoluciones de llamada proporcionadas se ejecutan de forma secuencial en el orden exacto en que se proporcionan en la lista. Si una devolución de llamada muestra una respuesta anulada, se detiene la ejecución y se omiten las devoluciones de llamada restantes.
after_agent_callbacks[]

Callback

Es opcional. Son las devoluciones de llamada que se ejecutarán después de que se llame al agente. Las devoluciones de llamada proporcionadas se ejecutan de forma secuencial en el orden exacto en que se proporcionan en la lista. Si una devolución de llamada muestra una respuesta anulada, se detiene la ejecución y se omiten las devoluciones de llamada restantes.
before_model_callbacks[]

Callback

Es opcional. Son las devoluciones de llamada que se ejecutarán antes de que se llame al modelo. Si hay varias llamadas al modelo, la devolución de llamada se ejecutará varias veces. Las devoluciones de llamada proporcionadas se ejecutan de forma secuencial en el orden exacto en que se proporcionan en la lista. Si una devolución de llamada muestra una respuesta anulada, se detiene la ejecución y se omiten las devoluciones de llamada restantes.
after_model_callbacks[]

Callback

Es opcional. Son las devoluciones de llamada que se ejecutarán después de que se llame al modelo. Si hay varias llamadas al modelo, la devolución de llamada se ejecutará varias veces. Las devoluciones de llamada proporcionadas se ejecutan de forma secuencial en el orden exacto en que se proporcionan en la lista. Si una devolución de llamada muestra una respuesta anulada, se detiene la ejecución y se omiten las devoluciones de llamada restantes.
before_tool_callbacks[]

Callback

Es opcional. Son las devoluciones de llamada que se ejecutarán antes de invocar la herramienta. Si hay varias invocaciones de herramientas, la devolución de llamada se ejecutará varias veces. Las devoluciones de llamada proporcionadas se ejecutan de forma secuencial en el orden exacto en que se proporcionan en la lista. Si una devolución de llamada muestra una respuesta anulada, se detiene la ejecución y se omiten las devoluciones de llamada restantes.
after_tool_callbacks[]

Callback

Es opcional. Son las devoluciones de llamada que se ejecutarán después de invocar la herramienta. Si hay varias invocaciones de herramientas, la devolución de llamada se ejecutará varias veces. Las devoluciones de llamada proporcionadas se ejecutan de forma secuencial en el orden exacto en que se proporcionan en la lista. Si una devolución de llamada muestra una respuesta anulada, se detiene la ejecución y se omiten las devoluciones de llamada restantes.
create_time

Timestamp

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

Timestamp

Solo salida. Es la marca de tiempo de la última actualización del agente.
guardrails[]

string

Es opcional. Es la lista de medidas de protección del agente. Formato: projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}
etag

string

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

Agent.AgentToolset

Es opcional. Es la lista de conjuntos de herramientas del agente.
generated_summary

string

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

TransferRule

Es opcional. Son las reglas de transferencia de agentes. Si coinciden varias reglas, se usará la primera de la lista.
Campo de unión agent_type. Es el tipo de agente. agent_type puede ser solo uno de los parámetros siguientes:
llm_agent

Agent.LlmAgent

Es opcional. Es el tipo de agente predeterminado.
remote_dialogflow_agent

Agent.RemoteDialogflowAgent

Es opcional. Es el agente remoto de Dialogflow que se usará para la ejecución del agente. Si se configura este campo, se ignorarán todas las demás propiedades a nivel del agente.

Nota: Si el agente de Dialogflow está en un proyecto diferente al de la app, debes otorgar roles/dialogflow.client al agente de servicio de CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.

AgentToolset

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

Campos
toolset

string

Obligatorio. Es el nombre del recurso del conjunto de herramientas. Formato: projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}
tool_ids[]

string

Es opcional. Son los IDs de las herramientas para filtrar el conjunto de herramientas.

LlmAgent

Este tipo no tiene campos.

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

RemoteDialogflowAgent

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

Campos
agent

string

Obligatorio. Es el nombre del recurso del agente de Dialogflow. Formato: projects/{project}/locations/{location}/agents/{agent}
flow_id

string

Es opcional. Es el ID del flujo en el agente de Dialogflow.
environment_id

string

Es opcional. Es el ID del entorno del agente de Dialogflow que se usará para la ejecución del agente. Si no se especifica, se usará el entorno de borrador.
input_variable_mapping

map<string, string>

Es opcional. Es la asignación de los nombres de las variables de la app a los nombres de los parámetros de sesión de Dialogflow que se enviarán al agente de Dialogflow como entrada.
output_variable_mapping

map<string, string>

Es opcional. Es la asignación de los nombres de los parámetros de la sesión de Dialogflow a los nombres de las variables de la app que se enviarán al agente de CES después de que finalice la ejecución del agente de Dialogflow.
respect_response_interruption_settings

bool

Es opcional. Indica si se debe respetar la configuración de interrupción a nivel del mensaje configurada en el agente de Dialogflow.

  • Si es falso, todos los mensajes de respuesta del agente de Dialogflow siguen la configuración de interrupción a nivel de la app.
  • Si es verdadero, solo se podrán interrumpir los mensajes de respuesta con allow_playback_interruption establecido como verdadero. Todos los demás mensajes seguirán la configuración de interrupción a nivel de la app.

AgentTransfer

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

Campos
target_agent

string

Obligatorio. Es el agente al que se transfiere la conversación. 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

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

Campos
volume_gain_db

double

Es opcional. Aumento de volumen (en dB) del volumen nativo normal admitido por el ruido ambiental, dentro del intervalo [-96.0, 16.0]. Si no se establece, o se establece en un valor de 0.0 (dB), se reproducirá en la amplitud de la señal nativa normal. Un valor de -6.0 (dB) se reproducirá aproximadamente a la mitad de la amplitud de la señal nativa normal. Un valor de +6.0 (dB) se reproducirá aproximadamente al doble de la amplitud de la señal nativa normal. Recomendamos no superar los +10 (dB) ya que, por lo general, no hay un aumento efectivo en la sonoridad para ningún valor superior.
Campo de unión source. Ruido ambiental que se reproducirá con la respuesta sintetizada del agente para mejorar la naturalidad de la conversación. source puede ser solo uno de los parámetros siguientes:
prebuilt_ambient_noise
(deprecated)

AmbientSoundConfig.PrebuiltAmbientNoise

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 y un solo canal almacenado en Cloud Storage.

Nota: Asegúrate de que el agente de servicio de CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com tenga permiso storage.objects.get para el objeto de Cloud Storage.
prebuilt_ambient_sound

string

Es opcional. Nombre del sonido ambiental prediseñado. Los valores válidos son los siguientes: "coffee_shop", "keyboard", "keypad", "hum", "office_1", "office_2", "office_3", "room_1", "room_2", "room_3", "room_4", "room_5" y "air_conditioner".

PrebuiltAmbientNoise

Ruido ambiental prediseñado.

Enums
PREBUILT_AMBIENT_NOISE_UNSPECIFIED No especificado.
RETAIL_STORE Ruido ambiental de una tienda minorista.
CONVENTION_HALL Ruido ambiental de un salón de convenciones.
OUTDOOR Ruido ambiental de una calle.

ApiAuthentication

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

Campos
Campo de unión auth_config. Es la configuración de autenticación. auth_config puede ser solo uno de los parámetros siguientes:
api_key_config

ApiKeyConfig

Es opcional. Es la configuración para la autenticación con clave de API.
oauth_config

OAuthConfig

Es opcional. Es la configuración de OAuth.
service_agent_id_token_auth_config

ServiceAgentIdTokenAuthConfig

Es opcional. Es la configuración para la autenticación con token de ID que se genera a partir del agente de servicio de CES.
service_account_auth_config

ServiceAccountAuthConfig

Es opcional. Es la configuración para la autenticación de la cuenta de servicio.
bearer_token_config

BearerTokenConfig

Es opcional. Es la configuración para la autenticación de token de portador.

ApiKeyConfig

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

Campos
key_name

string

Obligatorio. Es el nombre del parámetro o del encabezado de la clave de API. P. ej., Si la solicitud a la API es "https://example.com/act?X-Api-Key=", "X-Api-Key" sería el nombre del parámetro.
api_key_secret_version

string

Obligatorio. Es el nombre del recurso de la versión secreta de Secret Manager que almacena la clave de API. Formato: projects/{project}/secrets/{secret}/versions/{version}

Nota: Debes otorgar el rol roles/secretmanager.secretAccessor al agente de servicio de CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.
request_location

ApiKeyConfig.RequestLocation

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

RequestLocation

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

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

App

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

Campos
name

string

Es el identificador. Es el identificador único de la app. Formato: projects/{project}/locations/{location}/apps/{app}
display_name

string

Obligatorio. Es el nombre visible de la app.
description

string

Es opcional. Es la descripción de la app legible por humanos.
pinned

bool

Es opcional. Indica si la app está fijada en la lista de apps.
root_agent

string

Es opcional. El agente raíz es el punto de entrada de la app. Formato: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
language_settings

LanguageSettings

Es opcional. Es la configuración de idioma de la app.
time_zone_settings

TimeZoneSettings

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

AudioProcessingConfig

Es opcional. Es la configuración del procesamiento de audio de la app.
logging_settings

LoggingSettings

Es opcional. Es la configuración de registro de la app.
error_handling_settings

ErrorHandlingSettings

Es opcional. Es la configuración de manejo de errores de la app.
model_settings

ModelSettings

Es opcional. Es la configuración predeterminada del modelo de LLM para la app. Los recursos individuales (p.ej., agentes y medidas de seguridad) pueden anular estas configuraciones según sea necesario.
tool_execution_mode

App.ToolExecutionMode

Es opcional. Es el modo de ejecución de la herramienta para la app. Si no se proporciona, se establecerá PARALLEL de forma predeterminada.
evaluation_metrics_thresholds

EvaluationMetricsThresholds

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

App.VariableDeclaration

Es opcional. Son las declaraciones de las variables.
predefined_variable_declarations[]

App.VariableDeclaration

Solo salida. Son las declaraciones de las variables predefinidas para la app.
global_instruction

string

Es opcional. Son instrucciones para todos los agentes de la app. Puedes usar esta instrucción para configurar una identidad o personalidad estable en todos los agentes.
guardrails[]

string

Es opcional. Lista de medidas de protección 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 el ETag que se usa para garantizar que el objeto no haya cambiado durante una operación de lectura, modificación y escritura. Si el ETag está vacío, la actualización reemplazará cualquier cambio simultáneo.
deployment_count

int32

Solo salida. 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.
locked

bool

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

ToolExecutionMode

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

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

Es una instantánea de la app.

Campos
app

App

Es opcional. Es la configuración básica de la app.
agents[]

Agent

Es opcional. Es la lista de agentes en la app.
tools[]

Tool

Es opcional. Es la lista de herramientas de la app.
examples[]

Example

Es opcional. Es la lista de ejemplos en la app.
guardrails[]

Guardrail

Es opcional. Es la lista de restricciones de la app.
toolsets[]

Toolset

Es opcional. Es la lista de conjuntos de herramientas en la app.

AppVersion

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

Campos
name

string

Es el identificador. Es el identificador único de la versión de la app. Formato: projects/{project}/locations/{location}/apps/{app}/versions/{version}
display_name

string

Es opcional. Es el nombre visible de la versión de la app.
description

string

Es opcional. Es la descripción de la versión de la app.
creator

string

Solo salida. Correo electrónico del usuario que creó la versión de la app.
create_time

Timestamp

Solo salida. Es la marca de tiempo de la creación de la versión de la app.
snapshot

AppSnapshot

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

string

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

AudioEncoding

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

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

AudioProcessingConfig

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

Campos
synthesize_speech_configs

map<string, SynthesizeSpeechConfig>

Es opcional. Es la configuración de cómo se debe sintetizar la respuesta del agente, que asigna el código de idioma a SynthesizeSpeechConfig.

Si no se encuentra la configuración para el código de idioma especificado, se usará la configuración para el código de idioma raíz. Por ejemplo, si el mapa contiene "en-us" y "en", y el código de idioma especificado es "en-gb", se usará la configuración "en".

Nota: El código de idioma no distingue entre mayúsculas y minúsculas.
barge_in_config

BargeInConfig

Es opcional. Configura el comportamiento del agente para las actividades de interrupción del usuario.
inactivity_timeout

Duration

Es opcional. Es la duración de la inactividad del usuario (sin voz ni interacción) antes de que el agente le solicite que vuelva a participar. Si no se establece, el agente no le solicitará al usuario que vuelva a participar.
ambient_sound_config

AmbientSoundConfig

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

AudioRecordingConfig

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

Campos
gcs_bucket

string

Es opcional. Bucket de Cloud Storage para almacenar las grabaciones de audio de la sesión. El URI debe comenzar con “gs://”.

Elige una ubicación 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 permiso de storage.objects.create al agente de servicio de CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.
gcs_path_prefix

string

Es opcional. Es el prefijo de la ruta de acceso de Cloud Storage para las grabaciones de audio.

Este prefijo puede incluir los siguientes marcadores de posición, que se sustituirán de forma dinámica en el momento de la publicación: - $project: ID del proyecto - $location: ubicación de la app - $app: ID de la app - $date: fecha de la sesión en formato YYYY-MM-DD - $session: ID de la sesión

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

BargeInConfig

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

Campos
disable_barge_in
(deprecated)

bool

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

Obsoleto: disable_barge_in dejó de estar disponible y se reemplazó por disable_barge_in_control en ChannelProfile.
barge_in_awareness

bool

Es opcional. Si está habilitada, el agente adaptará su próxima respuesta según la suposición de que el usuario no escuchó el mensaje completo anterior 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. Nombres de los recursos de las conversaciones que se borrarán.

BatchDeleteConversationsResponse

Mensaje de respuesta para AgentService.BatchDeleteConversations.

Campos
deleted_conversations[]

string

Es la lista de conversaciones que se borraron correctamente.
failed_conversations[]

string

Es la lista de conversaciones que no se pudieron borrar.
error_messages[]

string

Es opcional. Es una lista de mensajes de error asociados a las conversaciones que no se pudieron borrar.

BearerTokenConfig

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

Campos
token

string

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

BidiSessionClientMessage

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

Campos
Campo de unión message_type. El tipo de mensaje. message_type puede ser solo uno de los parámetros siguientes:
config

SessionConfig

Es opcional. Es el mensaje de configuración inicial de la sesión.
realtime_input

SessionInput

Es opcional. Es la entrada en tiempo real para la sesión.

BidiSessionServerMessage

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

Campos
Campo de unión message_type. El tipo de mensaje. message_type puede ser solo uno de los parámetros siguientes:
session_output

SessionOutput

Es opcional. Es el resultado del procesamiento del agente de CES.
recognition_result

RecognitionResult

Es opcional. Es el resultado del reconocimiento de voz en tiempo real para la entrada de audio.
interruption_signal

InterruptionSignal

Es opcional. Indica que se interrumpió la respuesta de audio del agente.
end_session

EndSession

Es opcional. Indica que finalizó la sesión.
go_away

GoAway

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

BigQueryExportSettings

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

Campos
enabled

bool

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

string

Es opcional. Es el ID del proyecto del conjunto de datos de BigQuery al que se exportarán los datos.

Nota: Si el conjunto de datos de BigQuery se encuentra en un proyecto diferente al de la app, debes otorgar el rol de roles/bigquery.admin al agente de servicio de CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.
dataset

string

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

bool

Es opcional. Indica si la devolución de llamada está inhabilitada. El agente ignora las devoluciones de llamada inhabilitadas.
proactive_execution_enabled

bool

Es opcional. Si está habilitada, la devolución de llamada también se ejecutará en los resultados intermedios del modelo. Este parámetro de configuración solo afecta a la devolución de llamada posterior al modelo. Habilítala con precaución. Por lo general, la devolución de llamada posterior al modelo solo debe ejecutarse después de recibir todas las respuestas del modelo. Habilitar la ejecución proactiva puede tener implicaciones negativas en el costo y la latencia de la ejecución, y solo debe habilitarse en situaciones excepcionales.
Campo de unión callback. Es la devolución de llamada que se ejecutará. callback puede ser solo uno de los parámetros siguientes:
python_code

string

Obligatorio. Es el código de Python que se ejecutará para la devolución de llamada.

Registro de cambios

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

Campos
name

string

Es el identificador. Es el identificador único del registro de cambios. Formato: projects/{project}/locations/{location}/apps/{app}/changelogs/{changelog}
author

string

Solo salida. 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 cambió.
description

string

Solo salida. Es la descripción del cambio, que suele capturar los campos modificados en el recurso.
resource

string

Solo salida. Es el recurso que se cambió.
resource_type

string

Solo salida. Es el tipo de recurso que se modificó.
action

string

Solo salida. Es la acción que se realizó en el recurso.
original_resource

Struct

Solo salida. Es el recurso original antes del cambio.
new_resource

Struct

Solo salida. Es el recurso nuevo después del cambio.
dependent_resources[]

Struct

Solo salida. Son los recursos dependientes que se modificaron.
create_time

Timestamp

Solo salida. Fecha y hora en que se realizó el cambio.
sequence_number

int64

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

ChannelProfile

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

Campos
profile_id

string

Es opcional. Es el identificador único del perfil del canal.
channel_type

ChannelProfile.ChannelType

Es opcional. Es el tipo de perfil del canal.
persona_property

ChannelProfile.PersonaProperty

Es opcional. Es la propiedad de arquetipo del perfil del canal.
disable_dtmf

bool

Es opcional. Indica si se debe inhabilitar la señalización multifrecuencia de dos tonos (DTMF).
disable_barge_in_control

bool

Es opcional. Indica si se debe inhabilitar el control de interrupción del usuario en la conversación. - true: Las interrupciones del usuario se inhabilitan mientras el agente habla. - false: El agente conserva el control automático sobre cuándo puede interrumpir el usuario.
web_widget_config

ChannelProfile.WebWidgetConfig

Es opcional. Es la configuración del widget web.
noise_suppression_level

string

Es opcional. Es el nivel de reducción de ruido del perfil del canal. Los valores disponibles son "low", "moderate", "high" y "very_high".

ChannelType

Es el tipo de perfil del canal.

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

PersonaProperty

Representa la propiedad de arquetipo de un canal.

Campos
persona

ChannelProfile.PersonaProperty.Persona

Es opcional. Es la personalidad del canal.

Personificación

Es la personalidad del canal.

Enums
UNKNOWN Es un arquetipo de persona DESCONOCIDO.
CONCISE El agente mantiene las respuestas concisas y específicas.
CHATTY El agente proporciona contexto, explicaciones y detalles adicionales.

WebWidgetConfig

Es el mensaje de configuración del widget web.

Campos
modality

ChannelProfile.WebWidgetConfig.Modality

Es opcional. Es la modalidad del widget web.
theme

ChannelProfile.WebWidgetConfig.Theme

Es opcional. Es el tema del widget web.
web_widget_title

string

Es opcional. Es el título del widget web.
security_settings

ChannelProfile.WebWidgetConfig.SecuritySettings

Es opcional. Es la configuración de seguridad del widget web.

Modalidad

Modalidad del widget web.

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

SecuritySettings

Es la configuración de seguridad del widget web.

Campos
enable_public_access

bool

Es opcional. Indica si está habilitado el acceso público al widget web. Si es true, se podrá acceder al widget web de forma pública. Si es false, el widget web debe integrarse con tu propio sistema de autenticación y autorización para devolver credenciales válidas para acceder al agente de CES.
enable_origin_check

bool

Es opcional. Indica si está habilitada la verificación de origen para el widget web. Si es true, el widget web verificará el origen del sitio web que carga el widget web y solo permitirá que se cargue en el mismo origen o en cualquiera de los orígenes permitidos.
allowed_origins[]

string

Es opcional. Son los orígenes que pueden alojar el widget web. Un origen se define según el RFC 6454. Si está vacío, se permiten todos los orígenes. Se permite un máximo de 100 orígenes. Ejemplo: "https://example.com"
enable_recaptcha

bool

Es opcional. Indica si está habilitada la verificación de reCAPTCHA para el widget web.

Tema

Es el tema del widget web.

Enums
THEME_UNSPECIFIED Tema desconocido.
LIGHT Tema claro
DARK Tema oscuro

Fragmento

Es un fragmento de contenido dentro de un mensaje.

Campos
Campo de unión data. Datos de fragmentos data puede ser solo uno de los parámetros siguientes:
text

string

Es opcional. Datos de texto.
transcript

string

Es opcional. Es la transcripción asociada al audio.
blob

Blob

Es opcional. Son los datos del BLOB.
payload

Struct

Es opcional. Son los datos de 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. Es el evento de transferencia del agente.
updated_variables

Struct

Un struct representa las variables que se actualizaron en la conversación, con claves según los nombres de las variables.
default_variables

Struct

Un struct representa las variables predeterminadas al comienzo de la conversación, con claves según los nombres de las variables.

Citas

Son las citas asociadas con la respuesta del agente.

Campos
cited_chunks[]

Citations.CitedChunk

Lista de fragmentos de información citados.

CitedChunk

Es un fragmento de información citado.

Campos
uri

string

Es el URI que se usa para la cita.
title

string

Es el título del documento citado.
text

string

Es el texto que se usa para la cita.

ClientCertificateSettings

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

Campos
tls_certificate

string

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

string

Obligatorio. Nombre del recurso de la versión secreta de Secret Manager que almacena la clave privada codificada en formato PEM. Formato: projects/{project}/secrets/{secret}/versions/{version}
passphrase

string

Es opcional. Es el nombre del recurso de la versión secreta de Secret Manager que almacena la frase de contraseña para desencriptar la clave privada. Se debe dejar sin configurar si la clave privada no está encriptada. Formato: projects/{project}/secrets/{secret}/versions/{version}

ClientFunction

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

Campos
name

string

Obligatorio. Es el nombre de la función.
description

string

Es opcional. Es la descripción de la función.
parameters

Schema

Es opcional. Es el esquema de los parámetros de la función.
response

Schema

Es opcional. Es el esquema de la respuesta de la función.

CloudLoggingSettings

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

Campos
enable_cloud_logging

bool

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

CodeBlock

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

Campos
python_code

string

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

ConnectorTool

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

Campos
connection

string

Obligatorio. Es el nombre completo del recurso de la conexión de Integration Connectors a la que se hace referencia. Formato: projects/{project}/locations/{location}/connections/{connection}
action

Action

Obligatorio. Es la acción que debe usar la herramienta.
auth_config

EndUserAuthConfig

Es opcional. Configura cómo se controla la autenticación en Integration Connectors. De forma predeterminada, se pasa una autenticación de administrador en las solicitudes de la API de Integration Connectors. Puedes anularla con otra configuración de autenticación del usuario final. Nota: La conexión debe tener habilitada la anulación de autenticación para especificar una configuración de EUC aquí. De lo contrario, fallará la creación de ConnectorTool. Consulta https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override para obtener más detalles.
name

string

Es opcional. Es el nombre de la herramienta que puede usar el agente para decidir si llama a este ConnectorTool.
description

string

Es opcional. Es la descripción de la herramienta que puede usar el agente para decidir si debe llamar a este ConnectorTool.

ConnectorToolset

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

Campos
connection

string

Obligatorio. Es el nombre completo del recurso de la conexión de Integration Connectors a la que se hace referencia. Formato: projects/{project}/locations/{location}/connections/{connection}
auth_config

EndUserAuthConfig

Es opcional. Configura cómo se controla la autenticación en Integration Connectors. De forma predeterminada, se pasa una autenticación de administrador en las solicitudes de la API de Integration Connectors. Puedes anularla con otra configuración de autenticación del usuario final. Nota: La conexión debe tener habilitada la anulación de autenticación para especificar una configuración de EUC aquí. De lo contrario, fallará la creación del conjunto de herramientas. Consulta: https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override
connector_actions[]

Action

Obligatorio. Es la lista de acciones del conector o de operaciones de entidades para las que se generarán herramientas.

Conversación

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

Campos
name

string

Es el identificador. Es el identificador único de la conversación. Formato: projects/{project}/locations/{location}/apps/{app}/conversations/{conversation}
start_time

Timestamp

Solo salida. Es la marca de tiempo de cuando se creó la conversación.
end_time

Timestamp

Solo salida. Es la marca de tiempo en la que se completó la conversación.
turns[]

Conversation.Turn

Obligatorio. Son 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 inicialmente maneja la conversación. Si no se especifica, el agente raíz controla la conversación. Formato: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
deployment

string

Solo salida. Es la implementación de la app que se usa para procesar la conversación. Formato: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
app_version

string

Solo salida. Es la versión de la app que se usó 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 giros.

ChannelType

Es el tipo de canal de la conversación.

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

InputType

Es el tipo del mensaje de entrada.

Enums
INPUT_TYPE_UNSPECIFIED Tipo de entrada sin especificar.
INPUT_TYPE_TEXT El mensaje de entrada es texto.
INPUT_TYPE_AUDIO El mensaje de entrada es de audio.
INPUT_TYPE_IMAGE El mensaje de entrada es una imagen.
INPUT_TYPE_BLOB El mensaje de entrada es un archivo blob.
INPUT_TYPE_TOOL_RESPONSE El mensaje de entrada es la respuesta de la herramienta de función del cliente.
INPUT_TYPE_VARIABLES Los mensajes de entrada son variables.

Fuente

Es la fuente de la conversación.

Enums
SOURCE_UNSPECIFIED Fuente 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.

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.

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.

CreateAgentRequest

Mensaje de solicitud para AgentService.CreateAgent.

Campos
parent

string

Obligatorio. Es el nombre del recurso de la app en la que se creará un agente.
agent_id

string

Es opcional. Es el ID que se usará para el agente, que se convertirá en el componente final del nombre del recurso del agente. Si no se proporciona, se asignará automáticamente un ID único para el agente.
agent

Agent

Obligatorio. El agente que se creará.

CreateAppRequest

Mensaje de solicitud para AgentService.CreateApp.

Campos
parent

string

Obligatorio. Es el nombre del recurso de la ubicación en la que se creará la app.
app_id

string

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

App

Obligatorio. Es la app que se creará.

CreateAppVersionRequest

Mensaje de solicitud para AgentService.CreateAppVersion

Campos
parent

string

Obligatorio. Es el nombre del recurso de la app en la que se creará una versión.
app_version_id

string

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

AppVersion

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

CreateDeploymentRequest

Mensaje de solicitud para AgentService.CreateDeployment.

Campos
parent

string

Obligatorio. Es la app principal. El formato es projects/{project}/locations/{location}/apps/{app}.
deployment_id

string

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

Deployment

Obligatorio. Es la implementación que se creará.

CreateExampleRequest

Mensaje de solicitud para AgentService.CreateExample.

Campos
parent

string

Obligatorio. Es el nombre del recurso de la app en la que se creará un ejemplo.
example_id

string

Es opcional. Es el ID que se usará para el ejemplo, que se convertirá en el componente final del nombre del recurso del ejemplo. Si no se proporciona, se asignará automáticamente un ID único para el ejemplo.
example

Example

Obligatorio. Es el ejemplo que se creará.

CreateGuardrailRequest

Mensaje de solicitud para AgentService.CreateGuardrail.

Campos
parent

string

Obligatorio. Es el nombre del recurso de la app en la que se creará una protección.
guardrail_id

string

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

Guardrail

Obligatorio. Es la protección que se creará.

CreateToolRequest

Mensaje de solicitud para AgentService.CreateTool.

Campos
parent

string

Obligatorio. Es el nombre del recurso de la app en la que se creará una herramienta.
tool_id

string

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

Tool

Obligatorio. Es la herramienta que se creará.

CreateToolsetRequest

Mensaje de solicitud para AgentService.CreateToolset.

Campos
parent

string

Obligatorio. Es el nombre del recurso de la app en la que se creará el conjunto de herramientas.
toolset_id

string

Es opcional. Es el ID que se usará para el conjunto de herramientas, que se convertirá en el componente final del nombre del recurso del conjunto de herramientas. Si no se proporciona, se asignará automáticamente un ID único para el conjunto de herramientas.
toolset

Toolset

Obligatorio. Es el conjunto de herramientas que se creará.

DataStore

Es un recurso de DataStore en Vertex AI Search.

Campos
name

string

Obligatorio. Es el nombre completo del recurso de DataStore. Formato: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}
type

DataStore.DataStoreType

Solo salida. Es el tipo de almacén de datos. Este campo es de solo lectura y el servidor lo completa.
document_processing_mode

DataStore.DocumentProcessingMode

Solo salida. Es el modo de procesamiento de documentos para la conexión del almacén de datos. Solo se configura para los almacenes de datos PUBLIC_WEB y UNSTRUCTURED.
display_name

string

Solo salida. Es el nombre visible del almacén de datos.
create_time

Timestamp

Solo salida. Es la marca de tiempo de cuando se creó el almacén de datos.
connector_config

DataStore.ConnectorConfig

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

ConnectorConfig

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

Campos
collection

string

Es el nombre del recurso de la colección a la que pertenece el almacén de datos.
collection_display_name

string

Es el nombre visible de la colección a la que pertenece el almacén de datos.
data_source

string

Es el nombre de la fuente de datos. Ejemplo: salesforce, jira, confluence, bigquery.

DataStoreType

Es el tipo de almacén de datos.

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

DocumentProcessingMode

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

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

DataStoreSettings

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

Campos
engines[]

DataStoreSettings.Engine

Solo salida. Son los motores de la app.

Motor

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

Campos
name

string

Solo salida. Es el nombre del recurso del motor. Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}
type

DataStoreSettings.Engine.Type

Solo salida. Es el tipo de motor.

Tipo

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

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

DataStoreTool

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

Campos
name

string

Obligatorio. Es el nombre de la herramienta del almacén de datos.
description

string

Es opcional. Es la descripción de la herramienta.
boost_specs[]

DataStoreTool.BoostSpecs

Es opcional. Es la especificación de refuerzo para reforzar ciertos documentos.
modality_configs[]

DataStoreTool.ModalityConfig

Es opcional. Es la configuración de modalidad del almacén de datos.
filter_parameter_behavior

DataStoreTool.FilterParameterBehavior

Es opcional. Es el comportamiento del parámetro de filtro.
Campo de unión search_source. Define la fuente de búsqueda, ya sea un solo DataStore o un Engine. search_source puede ser solo uno de los parámetros siguientes:
data_store_source

DataStoreTool.DataStoreSource

Es opcional. Realiza búsquedas en un solo DataStore específico.
engine_source

DataStoreTool.EngineSource

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

BoostSpec

Es la especificación de refuerzo para reforzar ciertos documentos.

Campos
condition_boost_specs[]

DataStoreTool.BoostSpec.ConditionBoostSpec

Obligatorio. Es una lista de especificaciones de potenciación.

ConditionBoostSpec

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

Campos
condition

string

Obligatorio. Es una expresión que especifica una condición de refuerzo. La sintaxis es la misma que la de la expresión de filtro. Actualmente, la única condición admitida es una lista de códigos de idioma BCP-47. Ejemplo: Para potenciar las sugerencias en los idiomas en o fr: (lang_code: ANY("en", "fr"))
boost

float

Es opcional. Es la intensidad del boosting, que debe estar en el rango [-1, 1]. El boosting negativo significa un descenso de nivel. El valor predeterminado es 0.0.

Si se establece en 1.0, las sugerencias reciben una gran promoción. Sin embargo, esto no significa necesariamente que el primer resultado será una sugerencia mejorada.

Si se establece en -1.0, las sugerencias recibirán un gran descenso. Sin embargo, es posible que se sigan mostrando otras sugerencias pertinentes.

Si se establece en 0.0, no se aplica ningún refuerzo. Se ignora la condición de refuerzo.
boost_control_spec

DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec

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

BoostControlSpec

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

Campos
field_name

string

Es opcional. Nombre del campo cuyo valor se usará para determinar el importe del aumento.
attribute_type

DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec.AttributeType

Es opcional. Es el tipo de atributo que se usará para determinar el importe del aumento. El valor del atributo se puede derivar del valor del campo del campo field_name especificado. En el caso de los valores numéricos, es sencillo, es decir, attribute_value = numerical_field_value. Sin embargo, en el caso de la actualización, attribute_value = (time.now() - datetime_field_value).
interpolation_type

DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec.InterpolationType

Es opcional. Es el tipo de interpolación que se aplicará para conectar los puntos de control que se indican a continuación.
control_points[]

DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPoint

Es opcional. Son los puntos de control que se usan para definir la curva. La función monotónica (definida a través de interpolation_type más arriba) pasa por los puntos de control que se indican aquí.

AttributeType

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

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

ControlPoint

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

Campos
attribute_value

string

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

float

Es opcional. Valor entre -1 y 1 según el cual se aumentará la puntuación si el atributo attribute_value se evalúa como el valor especificado anteriormente.

InterpolationType

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

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

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

Campos
data_stores[]

string

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

DataStoreTool.BoostSpec

Obligatorio. Es una lista de especificaciones de potenciación.

DataStoreSource

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

Campos
filter

string

Es opcional. Es la especificación del filtro para el DataStore. Consulta el siguiente vínculo: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata
data_store

DataStore

Es opcional. Es el almacén de datos.

EngineSource

Es la configuración para buscar dentro de un motor, que puede segmentarse para DataStores específicos.

Campos
engine

string

Obligatorio. Es el nombre completo del recurso del motor. Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}
data_store_sources[]

DataStoreTool.DataStoreSource

Es opcional. Se usa para segmentar DataStores específicos dentro del motor. Si está vacío, la búsqueda se aplica a todos los almacenes de datos asociados con el motor.
filter

string

Es opcional. Es un filtro que se aplica a la búsqueda en todo el motor. No es relevante y no se usa si se proporciona "data_store_sources". Consulta el siguiente vínculo: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata

FilterParameterBehavior

Comportamiento del parámetro de filtro.

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

GroundingConfig

Es la configuración de fundamentación.

Campos
grounding_level

float

Es opcional. Es el umbral de fundamentación de la respuesta según las fuentes recuperadas. El valor tiene un rango configurable de [1, 5]. El nivel se usa para establecer un umbral de fundamentación de la respuesta, lo que significa que todas las respuestas con una puntuación de fundamentación inferior al umbral recurrirán a devolver solo fragmentos relevantes.

Por ejemplo, un nivel de 3 significa que la puntuación de fundamentación debe ser 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 determinada para la modalidad especificada.

Campos
modality_type

DataStoreTool.ModalityConfig.ModalityType

Obligatorio. Es el tipo de modalidad.
rewriter_config

DataStoreTool.RewriterConfig

Es opcional. Es la configuración del reescritor.
summarization_config

DataStoreTool.SummarizationConfig

Es opcional. Es la configuración del resumen.
grounding_config

DataStoreTool.GroundingConfig

Es opcional. Es la configuración de fundamentación.

ModalityType

Es el tipo de modalidad.

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

RewriterConfig

Es la configuración del reescritor.

Campos
model_settings

ModelSettings

Obligatorio. Es la configuración del modelo de LLM.
prompt

string

Es opcional. Es la definición de la instrucción. Si no se establece, se usará la instrucción predeterminada.
disabled

bool

Es opcional. Indica si el reescritor está inhabilitado.

SummarizationConfig

Es la configuración del resumen.

Campos
model_settings

ModelSettings

Es opcional. Es la configuración del modelo de LLM.
prompt

string

Es opcional. Es la definición de la instrucción. Si no se establece, se usará la instrucción predeterminada.
disabled

bool

Es opcional. Indica si la generación de resúmenes está inhabilitada.

DeleteAgentRequest

Mensaje de solicitud para AgentService.DeleteAgent.

Campos
name

string

Obligatorio. Es el nombre del recurso del agente que se borrará.
force

bool

Es opcional. Indica si se debe borrar el agente de forma forzosa, incluso si otros ejemplos, agentes o apps aún hacen referencia a él.

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

string

Es opcional. Es la ETag actual del agente. Si no se proporciona un ETag, el borrado reemplazará cualquier cambio simultáneo. Si se proporciona una ETag y no coincide con la ETag actual del agente, se bloqueará el borrado y se devolverá un error ABORTED.

DeleteAppRequest

Mensaje de solicitud para AgentService.DeleteApp.

Campos
name

string

Obligatorio. Es el nombre del recurso de la app que se borrará.
etag

string

Es opcional. Es la ETag actual de la app. Si no se proporciona una ETag, la eliminación sobrescribirá cualquier cambio simultáneo. Si se proporciona una ETag y no coincide con la ETag actual de la app, se bloqueará el borrado y se devolverá un error ABORTED.

DeleteAppVersionRequest

Mensaje de solicitud para AgentService.DeleteAppVersion.

Campos
name

string

Obligatorio. Es el nombre del recurso de la versión de la app que se borrará.
etag

string

Es opcional. Es la ETag actual de la versión de la app. Si no se proporciona un ETag, el borrado reemplazará cualquier cambio simultáneo. Si se proporciona una ETag y no coincide con la ETag actual de la versión de la app, se bloqueará el borrado y se devolverá un error ABORTED.

DeleteConversationRequest

Mensaje de solicitud para AgentService.DeleteConversation.

Campos
name

string

Obligatorio. Es el nombre del recurso de la conversación que se borrará.
source
(deprecated)

Conversation.Source

Es opcional. Indica la fuente de la conversación. Si no se configura, se aplicará Source.Live de forma predeterminada.

DeleteDeploymentRequest

Mensaje de solicitud para AgentService.DeleteDeployment.

Campos
name

string

Obligatorio. Es el nombre de la implementación que se borrará. Formato: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
etag

string

Es opcional. Es el ETag de la implementación. Si se proporciona una ETag y no coincide con la ETag actual de la implementación, se bloqueará el borrado y se devolverá un error ABORTED.

DeleteExampleRequest

Mensaje de solicitud para AgentService.DeleteExample.

Campos
name

string

Obligatorio. Es el nombre del recurso del ejemplo que se borrará.
etag

string

Es opcional. Es la ETag actual del ejemplo. Si no se proporciona un ETag, el borrado reemplazará cualquier cambio simultáneo. Si se proporciona una ETag y no coincide con la ETag actual del ejemplo, se bloqueará el borrado y se devolverá un error ABORTED.

DeleteGuardrailRequest

Mensaje de solicitud para AgentService.DeleteGuardrail.

Campos
name

string

Obligatorio. Es el nombre del recurso de la protección que se borrará.
force

bool

Es opcional. Indica si se debe borrar de forma forzosa la protección, incluso si la app o los agentes aún hacen referencia a ella.

  • Si es force = false, la eliminación falla si alguna app o agente aún hace referencia a la protección.
  • Si es force = true, se quitarán todas las referencias existentes de las apps o los agentes, y se borrará la protección.
etag

string

Es opcional. Es la ETag actual de la protección. Si no se proporciona un ETag, el borrado reemplazará cualquier cambio simultáneo. Si se proporciona una ETag y no coincide con la ETag actual de la protección, se bloqueará el borrado y se devolverá un error ABORTED.

DeleteToolRequest

Mensaje de solicitud para AgentService.DeleteTool.

Campos
name

string

Obligatorio. Es el nombre del recurso de la herramienta que se borrará.
force

bool

Es opcional. Indica si se debe borrar la herramienta de forma forzada, incluso si los agentes o los ejemplos aún hacen referencia a ella.

  • Si es force = false, la eliminación fallará si algún agente aún hace referencia a la herramienta.
  • Si es force = true, se quitarán todas las referencias existentes de los agentes y se borrará la herramienta.
etag

string

Es opcional. Es la ETag actual de la herramienta. Si no se proporciona un ETag, el borrado reemplazará cualquier cambio simultáneo. Si se proporciona una ETag y no coincide con la ETag actual de la herramienta, se bloqueará el borrado y se devolverá un error ABORTED.

DeleteToolsetRequest

Mensaje de solicitud para AgentService.DeleteToolset.

Campos
name

string

Obligatorio. Es el nombre del recurso del conjunto de herramientas que se borrará.
force

bool

Es opcional. Indica si se debe borrar el conjunto de herramientas de forma forzada, incluso si las apps o los agentes aún hacen referencia a él.

  • Si es force = false, la eliminación falla si algún agente aún hace referencia al conjunto de herramientas.
  • Si es force = true, se quitarán todas las referencias existentes de los agentes y se borrará el conjunto de herramientas.
etag

string

Es opcional. Es la ETag actual del conjunto de herramientas. Si no se proporciona un ETag, el borrado reemplazará cualquier cambio simultáneo. Si se proporciona una ETag y no coincide con la ETag actual del conjunto de herramientas, se bloqueará el borrado y se devolverá un error ABORTED.

Implementación

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

Campos
name

string

Es el identificador. Es el nombre del recurso de la implementación. Formato: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
display_name

string

Obligatorio. Es el nombre visible de la implementación.
app_version

string

Es opcional. Es el nombre del recurso de la versión de la app que se implementará. Formato: projects/{project}/locations/{location}/apps/{app}/versions/{version} Usa projects/{project}/locations/{location}/apps/{app}/versions/- para usar la app en borrador.
channel_profile

ChannelProfile

Obligatorio. Es el perfil del canal que se usa en la implementación.
create_time

Timestamp

Solo salida. Es la marca de tiempo de la creación de esta implementación.
update_time

Timestamp

Solo salida. Es la marca de tiempo de la última actualización de esta implementación.
etag

string

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

EndSession

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

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

Campos
metadata

Struct

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

EndUserAuthConfig

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

Perfil de JWT de autenticación de otorgamiento de autorización de OAuth 2.0.

Oauth2AuthCodeConfig

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

Campos
oauth_token

string

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

Oauth2JwtBearerConfig

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

Campos
issuer

string

Obligatorio. Es el nombre del parámetro del emisor que se pasará. Debe tener el formato $context.variables.<name_of_variable>.
subject

string

Obligatorio. Es el nombre del parámetro del asunto que se pasará. Debe tener el formato $context.variables.<name_of_variable>.
client_key

string

Obligatorio. Es el nombre del parámetro del cliente que se pasará. Debe tener el formato $context.variables.<name_of_variable>.

ErrorHandlingSettings

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

Campos
error_handling_strategy

ErrorHandlingSettings.ErrorHandlingStrategy

Es opcional. Estrategia que se usará para el manejo de errores.

ErrorHandlingStrategy

Define la estrategia para controlar los errores.

Enums
ERROR_HANDLING_STRATEGY_UNSPECIFIED Estrategia de manejo de errores no especificada. La configuración predeterminada es FALLBACK_RESPONSE.
NONE No se habilitó ningún control específico.
FALLBACK_RESPONSE En caso de errores del LLM, se mostrará un mensaje de resguardo al usuario.

EvaluationMetricsThresholds

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

Campos
golden_evaluation_metrics_thresholds

EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds

Es opcional. Son los umbrales de las métricas de evaluación 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

Es la configuración para las evaluaciones de referencia.

Campos
turn_level_metrics_thresholds

EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.TurnLevelMetricsThresholds

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

EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.ExpectationLevelMetricsThresholds

Es opcional. Son los umbrales de las métricas del nivel de expectativa.
tool_matching_settings

EvaluationMetricsThresholds.ToolMatchingSettings

Es opcional. Es la configuración de la herramienta de correlación. Una llamada a herramienta adicional es una llamada a herramienta que está presente en la ejecución, pero no coincide con ninguna llamada a herramienta en la expectativa ideal.

ExpectationLevelMetricsThresholds

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

Campos
tool_invocation_parameter_correctness_threshold

float

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

TurnLevelMetricsThresholds

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

Campos
semantic_similarity_channel

EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.TurnLevelMetricsThresholds.SemanticSimilarityChannel

Es opcional. Es el canal de similitud semántica que se usará para la evaluación.
semantic_similarity_success_threshold

int32

Es opcional. Es el umbral de éxito para la similitud semántica. Debe ser un número entero entre 0 y 4. El valor predeterminado es >= 3.
overall_tool_invocation_correctness_threshold

float

Es opcional. Es el umbral de éxito para la corrección general de la invocación de la herramienta. Debe ser un número de punto flotante entre 0 y 1. El valor predeterminado es 1.0.

SemanticSimilarityChannel

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

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

HallucinationMetricBehavior

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

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

ToolMatchingSettings

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

Campos
extra_tool_call_behavior

EvaluationMetricsThresholds.ToolMatchingSettings.ExtraToolCallBehavior

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

ExtraToolCallBehavior

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

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

Evento

Es la entrada del evento.

Campos
event

string

Obligatorio. Es el nombre del evento.

Ejemplo

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

Campos
name

string

Es el identificador. Es el identificador único del ejemplo. Formato: projects/{project}/locations/{location}/apps/{app}/examples/{example}
display_name

string

Obligatorio. Es el nombre visible del ejemplo.
description

string

Es opcional. Es una descripción del ejemplo legible por humanos.
entry_agent

string

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

Message

Es opcional. Es la colección de mensajes que componen la conversación.
create_time

Timestamp

Solo salida. Es la marca de tiempo de la creación del ejemplo.
update_time

Timestamp

Solo salida. Es la marca de tiempo de la última actualización del ejemplo.
invalid

bool

Solo salida. El ejemplo puede dejar de ser válido si se borran los recursos a los que hace referencia. Los ejemplos no válidos no se usarán como ejemplos de aprendizaje con pocos datos.
etag

string

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

ExecuteToolRequest

Mensaje de solicitud para ToolService.ExecuteTool.

Campos
parent

string

Obligatorio. Es el nombre del recurso de la app a la que pertenece la herramienta o el conjunto de herramientas. Formato: projects/{project}/locations/{location}/apps/{app}
args

Struct

Es opcional. Son los parámetros y valores de entrada de la herramienta en formato de objeto JSON.
variables

Struct

Es opcional. Son las variables disponibles para la ejecución de la herramienta.
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.

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 hay alguno). Si no se especifican las claves "output" y "error", toda la "response" se trata como resultado de la ejecución de la herramienta.
variables

Struct

Son los valores de las variables al final de la ejecución de la herramienta.
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.

ExportAppRequest

Mensaje de solicitud para AgentService.ExportApp.

Campos
name

string

Obligatorio. Es el nombre del recurso de la app que se exportará.
export_format

ExportAppRequest.ExportFormat

Obligatorio. Es el formato en el que se exportará la app.
gcs_uri

string

Es opcional. Es el URI de Google Cloud Storage al que se exportará la app. El formato de este URI debe ser gs://<bucket-name>/<object-name>. El archivo de la app exportada se escribirá directamente en el objeto de GCS especificado.

ExportFormat

Es el formato de exportación de la app.

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

ExportAppResponse

Mensaje de respuesta para AgentService.ExportApp.

Campos
Campo de unión app. Es la app exportada. app solo puede ser una de las siguientes opciones:
app_content

bytes

Carpeta de la app comprimida como un archivo ZIP
app_uri

string

Es el URI de Google Cloud Storage al que se exportó la app.

ExpressionCondition

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

Campos
expression

string

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

FileSearchTool

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

Campos
corpus_type

FileSearchTool.CorpusType

Es opcional. Es el tipo de corpus. El valor predeterminado es FULLY_MANAGED.
name

string

Obligatorio. Es el nombre de la herramienta.
description

string

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

string

Es opcional. Es el corpus en el que se almacenan los archivos. Formato: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}

CorpusType

Es el tipo de corpus de RAG de Vertex.

Enums
CORPUS_TYPE_UNSPECIFIED Es un tipo de corpus sin especificar.
USER_OWNED El corpus es creado y propiedad del usuario.
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 generado por el widget de chat del cliente.

GenerateChatTokenResponse

Mensaje de respuesta para WidgetService.GenerateChatToken.

Campos
chat_token

string

Es el token con alcance de sesión del widget de chat para autenticarse con las APIs de Session.
expire_time

Timestamp

Fecha y hora de vencimiento del token de chat.

GetAgentRequest

Mensaje de solicitud para AgentService.GetAgent.

Campos
name

string

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

GetAppRequest

Mensaje de solicitud para AgentService.GetApp.

Campos
name

string

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

GetAppVersionRequest

Mensaje de solicitud para AgentService.GetAppVersion.

Campos
name

string

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

GetChangelogRequest

Mensaje de solicitud para AgentService.GetChangelog.

Campos
name

string

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

GetConversationRequest

Mensaje de solicitud para AgentService.GetConversation.

Campos
name

string

Obligatorio. Es el nombre del recurso de la conversación que se recuperará.
source
(deprecated)

Conversation.Source

Es opcional. Indica la fuente de la conversación. Si no se configura, se buscará en todas las fuentes.

GetDeploymentRequest

Mensaje de solicitud para AgentService.GetDeployment.

Campos
name

string

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

GetExampleRequest

Mensaje de solicitud para AgentService.GetExample.

Campos
name

string

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

GetGuardrailRequest

Mensaje de solicitud para AgentService.GetGuardrail.

Campos
name

string

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

GetToolRequest

Mensaje de solicitud para AgentService.GetTool.

Campos
name

string

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

GetToolsetRequest

Mensaje de solicitud para AgentService.GetToolset.

Campos
name

string

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

GoAway

Este tipo no tiene campos.

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

GoogleSearchSuggestions

Sugerencias de búsqueda de Google Search Tool.

Campos
htmls[]

string

Estilo HTML y CSS compatible para las sugerencias de búsqueda. El HTML y CSS proporcionados se adaptan automáticamente a la configuración de tu dispositivo, lo que se muestra en modo oscuro o claro indicado por @media(prefers-color-scheme).
web_search_queries[]

WebSearchQuery

Es la lista de las búsquedas que se usaron para realizar la Búsqueda de Google, junto con los URIs de los resultados de la búsqueda que forman las sugerencias de búsqueda.

GoogleSearchTool

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

Campos
name

string

Obligatorio. Es el nombre de la herramienta.
description

string

Es opcional. 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 restringirán los resultados de la búsqueda. Ejemplo: "example.com", "another.site". Se puede especificar un máximo de 20 dominios.
exclude_domains[]

string

Es opcional. 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 que se pasan al planificador sobre cómo se deben procesar los resultados de la búsqueda para texto y voz.

PromptConfig

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

Campos
text_prompt

string

Es opcional. Define la instrucción utilizada 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.

Baranda

La protección contiene una lista de verificaciones y controles para mantener a los agentes seguros.

Campos
name

string

Es el identificador. Es el identificador único de la protección. Formato: projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}
display_name

string

Obligatorio. Es el nombre visible de la protección.
description

string

Es opcional. Es la descripción de la barrera de protección.
enabled

bool

Es opcional. Indica si la protección está habilitada.
action

TriggerAction

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

Timestamp

Solo salida. Es la marca de tiempo de cuando se creó la protección.
update_time

Timestamp

Solo salida. Es la marca de tiempo de la última actualización del parámetro de protección.
etag

string

Es el ETag que se usa para garantizar que el objeto no haya cambiado durante una operación de lectura, modificación y escritura. Si el ETag está vacío, la actualización reemplazará cualquier cambio simultáneo.
Campo de unión guardrail_type. Es el tipo de riel de protección. guardrail_type puede ser solo uno de los parámetros siguientes:
content_filter

Guardrail.ContentFilter

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

Guardrail.LlmPromptSecurity

Es opcional. Es una protección que bloquea la conversación si la instrucción se considera no segura según la clasificación del LLM.
llm_policy

Guardrail.LlmPolicy

Es opcional. Es una protección que bloquea la conversación si se considera que la respuesta del LLM incumple la política según la clasificación del LLM.
model_safety

Guardrail.ModelSafety

Es opcional. Es una protección que bloquea la conversación si la respuesta del LLM se considera no segura según la configuración de seguridad del modelo.
code_callback

Guardrail.CodeCallback

Es opcional. Es una protección que podría bloquear la conversación según el resultado de la ejecución de la devolución de llamada.

CodeCallback

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

Campos
before_agent_callback

Callback

Es opcional. Es la devolución de llamada que se ejecutará antes de que se llame al agente. Se espera que cada función de devolución de llamada muestre una estructura (p.ej., un diccionario o un objeto) que contenga, al menos, lo siguiente: - "decision": Puede ser "OK" o "TRIGGER". - "reason": Es una cadena que explica la decisión. Una decisión de "ACTIVACIÓN" puede detener el procesamiento posterior.
after_agent_callback

Callback

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

Callback

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

Callback

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

ContentFilter

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

Campos
banned_contents[]

string

Es opcional. Es la lista de frases prohibidas. Se aplica tanto a las entradas del usuario como a las respuestas del agente.
banned_contents_in_user_input[]

string

Es opcional. Es la lista de frases prohibidas. Solo se aplica a las entradas del usuario.
banned_contents_in_agent_response[]

string

Es opcional. Es la lista de frases prohibidas. Solo se aplica a las respuestas del agente.
match_type

Guardrail.ContentFilter.MatchType

Obligatorio. Es el tipo de concordancia para el filtro de contenido.
disregard_diacritics

bool

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

MatchType

Es el tipo de concordancia para el filtro de contenido.

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

LlmPolicy

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

Campos
max_conversation_messages

int32

Es opcional. Cuando verifiques esta política, ten en cuenta los últimos "n" mensajes de la conversación. Si no se establece, se usará un valor predeterminado de 10.
model_settings

ModelSettings

Es opcional. Es la configuración del modelo.
prompt

string

Obligatorio. Es una instrucción de política.
policy_scope

Guardrail.LlmPolicy.PolicyScope

Obligatorio. Define cuándo se debe aplicar la verificación de política durante la conversación. Si se establece en POLICY_SCOPE_UNSPECIFIED, la política se aplicará a la entrada del usuario. Cuando se aplique la política a la respuesta del agente, se introducirá una latencia adicional antes de que el agente pueda responder.
fail_open

bool

Es opcional. Si se produce un error durante la verificación de políticas, se debe permitir el acceso y no activar la protección.
allow_short_utterance

bool

Es opcional. De forma predeterminada, se omite la verificación de políticas del LLM para las expresiones cortas. Si habilitas este parámetro de configuración, se aplicará la verificación de políticas a todas las expresiones, incluidas las que normalmente se omitirían.

PolicyScope

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

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

LlmPromptSecurity

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

Campos
fail_open

bool

Es opcional. Determina el comportamiento cuando la protección encuentra un error del LLM. - Si es verdadero, se omite la protección. - Si es falso (valor predeterminado), se activan o bloquean las protecciones.

Nota: Si se proporciona una política personalizada, este campo se ignora en favor de la configuración "fail_open" de la política.
Campo de unión security_config. Define el modo de configuración de seguridad. El usuario debe elegir una de las siguientes configuraciones. security_config puede ser solo uno de los parámetros siguientes:
default_settings

Guardrail.LlmPromptSecurity.DefaultSecuritySettings

Es opcional. Usar la configuración de seguridad predeterminada predefinida del sistema Para seleccionar este modo, incluye un mensaje "default_settings" vacío en la solicitud. El servidor completará el campo "default_prompt_template" en la respuesta.
custom_policy

Guardrail.LlmPolicy

Es opcional. Usa un LlmPolicy definido por el usuario para configurar la barrera de seguridad.

DefaultSecuritySettings

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

Campos
default_prompt_template

string

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

ModelSafety

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

Campos
safety_settings[]

Guardrail.ModelSafety.SafetySetting

Obligatorio. Es la lista de parámetros de configuración de seguridad.

HarmBlockThreshold

Son los niveles de umbral basados en la probabilidad para el bloqueo.

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

HarmCategory

Es la categoría de daño.

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

SafetySetting

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

Campos
category

Guardrail.ModelSafety.HarmCategory

Obligatorio. Es la categoría de daño.
threshold

Guardrail.ModelSafety.HarmBlockThreshold

Obligatorio. El umbral de bloqueo de daño.

Imagen

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

Campos
mime_type

string

Obligatorio. Es el tipo de MIME estándar de IANA de los datos de origen. Los tipos de imágenes admitidos incluyen los siguientes: * image/png * image/jpeg * image/webp
data

bytes

Obligatorio. Son los bytes sin procesar de la imagen.

ImportAppRequest

Mensaje de solicitud para AgentService.ImportApp.

Campos
parent

string

Obligatorio. Es el nombre del recurso principal con la ubicación de la app que se importará.
display_name

string

Es opcional. Es el nombre visible de la app que se importará. * Si la app se crea durante la importación y se especifica el nombre visible, la app importada usará este nombre visible. Si se detecta un conflicto con una app existente, se agregará una marca de tiempo al nombre visible para que sea único. * Si la app es una reimportación, no se debe establecer este campo. Si proporcionas un nombre visible durante la reimportación, se generará un error INVALID_ARGUMENT.
app_id

string

Es opcional. Es el ID que se usará para la app importada. * Si no se especifica, se asignará automáticamente un ID único para la app. * De lo contrario, la app importada usará este ID como el componente final de su nombre de recurso. Si ya existe una app con el mismo ID en la ubicación especificada del proyecto, se reemplazará el contenido de la app existente.
import_options

ImportAppRequest.ImportOptions

Es opcional. Son las opciones que rigen el proceso de importación de la app.
ignore_app_lock

bool

Es opcional. Es una marca para anular el bloqueo de la app durante la importación. Si se establece como verdadero, el proceso de importación ignorará el bloqueo de la app.
Campo de unión app. Es la app que se importará. app puede ser solo uno de los parámetros siguientes:
gcs_uri

string

Es el URI de Google Cloud Storage desde el que se importará la app. El formato de este URI debe ser gs://<bucket-name>/<object-name>.
app_content

bytes

Son los bytes sin procesar que representan el archivo zip comprimido con la estructura de carpetas de la app.

ImportOptions

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

Campos
conflict_resolution_strategy

ImportAppRequest.ImportOptions.ConflictResolutionStrategy

Es opcional. Estrategia que se usará cuando se resuelvan conflictos durante la importación.

ConflictResolutionStrategy

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

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

ImportAppResponse

Mensaje de respuesta para AgentService.ImportApp.

Campos
name

string

Es el nombre del recurso de la app que se importó.
warnings[]

string

Son mensajes de advertencia que se generan durante el proceso de importación. Si se producen errores en recursos específicos, estos no se incluirán en la app importada y el error se mencionará aquí.

InputAudioConfig

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

Campos
audio_encoding

AudioEncoding

Obligatorio. Es la codificación de los datos de audio de entrada.
sample_rate_hertz

int32

Obligatorio. Es la tasa de muestreo (en hercios) de los datos de audio de entrada.
noise_suppression_level

string

Es opcional. Indica si se debe habilitar la supresión de ruido en el audio de entrada. Los valores disponibles son "low", "moderate", "high" y "very_high".

InterruptionSignal

Indica que se interrumpió la respuesta de audio del agente. El cliente debe detener de inmediato cualquier reproducción de audio actual (p.ej., debido a una interrupción del usuario o a 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

Es la configuración de idioma de la app.

Campos
default_language_code

string

Es opcional. Es el código de idioma predeterminado de la app.
supported_language_codes[]

string

Es opcional. Lista de códigos de idioma que admite la app, además de default_language_code.
enable_multilingual_support

bool

Es opcional. Habilita la compatibilidad multilingüe. Si es verdadero, los agentes de la app usarán instrucciones prediseñadas para mejorar el procesamiento de la entrada multilingüe.
fallback_action

string

Es opcional. Es la acción que se realizará cuando un agente reciba entrada en un idioma no admitido.

Puede ser una acción predefinida o una llamada a herramienta personalizada. Los valores válidos son los siguientes: - El nombre completo del recurso de una herramienta, que activa una ejecución específica de la herramienta. - Una acción del sistema predefinida, como "derivar" o "salir", que activa un indicador EndSession con el metadata correspondiente para finalizar la conversación.

ListAgentsRequest

Mensaje de solicitud para AgentService.ListAgents.

Campos
parent

string

Obligatorio. Es el nombre del recurso de la app desde la que se enumerarán los agentes.
page_size

int32

Es opcional. Indica el tamaño de la página solicitada. Es posible que el servidor devuelva menos elementos de los que se solicitaron. Si no se especifica, el servidor elegirá un valor predeterminado adecuado.
page_token

string

Es opcional. El valor de next_page_token que se muestra de una llamada AgentService.ListAgents de lista anterior.
filter

string

Es opcional. Es el filtro que se aplicará cuando se enumeren los agentes. Para obtener más información, consulta https://google.aip.dev/160.
order_by

string

Es opcional. Campo por el que se ordenará. Solo se admiten "name" y "create_time". Consulta https://google.aip.dev/132#ordering para obtener más detalles.

ListAgentsResponse

Mensaje de respuesta para AgentService.ListAgents.

Campos
agents[]

Agent

La lista de agentes.
next_page_token

string

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 desde la que se enumerarán las versiones.
page_size

int32

Es opcional. Indica el tamaño de la página solicitada. Es posible que el servidor devuelva menos elementos de los que se solicitaron. Si no se especifica, el servidor elegirá un valor predeterminado adecuado.
page_token

string

Es opcional. El valor de next_page_token que se muestra de una llamada AgentService.ListAppVersions de lista anterior.
filter

string

Es opcional. Es el filtro que se aplicará cuando se enumeren las versiones de la app. Para obtener más información, consulta https://google.aip.dev/160.
order_by

string

Es opcional. Campo por el que se ordenará. Solo se admiten "name" y "create_time". Consulta https://google.aip.dev/132#ordering para obtener más detalles.

ListAppVersionsResponse

Mensaje de respuesta para AgentService.ListAppVersions.

Campos
app_versions[]

AppVersion

Es la lista de versiones de la app.
next_page_token

string

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 enumerarán las apps.
page_size

int32

Es opcional. Indica el tamaño de la página solicitada. Es posible que el servidor devuelva menos elementos de los que se solicitaron. Si no se especifica, el servidor elegirá un valor predeterminado adecuado.
page_token

string

Es opcional. El valor de next_page_token que se muestra de una llamada AgentService.ListApps de lista anterior.
filter

string

Es opcional. Es el filtro que se aplicará cuando se muestren las apps. Para obtener más información, consulta https://google.aip.dev/160.
order_by

string

Es opcional. Campo por el que se ordenará. Solo se admiten "name" y "create_time". Consulta https://google.aip.dev/132#ordering para obtener más detalles.

ListAppsResponse

Mensaje de respuesta para AgentService.ListApps.

Campos
apps[]

App

Es la lista de apps.
next_page_token

string

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. 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 listen los registros de cambios. Para obtener más información, consulta https://google.aip.dev/160.

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 concordancia parcial que no distingue mayúsculas de minúsculas en los campos de cadena, mientras que = realiza una concordancia 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. 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 desde la que se enumerarán las conversaciones.
page_size

int32

Es opcional. Indica el tamaño de la página solicitada. Es posible que el servidor devuelva menos elementos de los que se solicitaron. Si no se especifica, el servidor elegirá un valor predeterminado adecuado.
page_token

string

Es opcional. El valor de next_page_token que se muestra de una llamada AgentService.ListConversations de lista anterior.
filter

string

Es opcional. Es el filtro que se aplicará cuando se listen las conversaciones. Para obtener más información, consulta https://google.aip.dev/160.
source

Conversation.Source

Es opcional. Indica la fuente de la conversación. Si no se configura, se aplicará Source.Live de forma predeterminada. Dejará de estar disponible y se reemplazará por el campo sources.
sources[]

Conversation.Source

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

ListConversationsResponse

Mensaje de respuesta para AgentService.ListConversations.

Campos
conversations[]

Conversation

Es la lista de conversaciones.
next_page_token

string

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 principal. El formato es projects/{project}/locations/{location}/apps/{app}.
page_size

int32

Es opcional. Es la cantidad máxima de implementaciones que se devolverán. El servicio puede mostrar menos que este valor. Si no se especifica, se devolverán, como máximo, 50 implementaciones. El valor máximo es 1,000; valores superiores a 1,000 se convertirán en 1,000.
page_token

string

Es opcional. Un token de página, recibido desde una llamada ListDeployments anterior. Proporciona esto para recuperar la página siguiente.

Cuando se pagina, todos los demás parámetros proporcionados a ListDeployments deben coincidir con la llamada que proporcionó el token de la página.
order_by

string

Es opcional. Campo por el que se ordenará. Solo se admiten "name" y "create_time". Consulta https://google.aip.dev/132#ordering para obtener más detalles.

ListDeploymentsResponse

Mensaje de respuesta para AgentService.ListDeployments.

Campos
deployments[]

Deployment

Es la lista de implementaciones.
next_page_token

string

Un token, que se puede enviar como page_token para recuperar la página siguiente. Si se omite este campo, no habrá páginas siguientes.

ListExamplesRequest

Mensaje de solicitud para AgentService.ListExamples.

Campos
parent

string

Obligatorio. Es el nombre del recurso de la app de la que se enumerarán los ejemplos.
page_size

int32

Es opcional. Indica el tamaño de la página solicitada. Es posible que el servidor devuelva menos elementos de los que se solicitaron. Si no se especifica, el servidor elegirá un valor predeterminado adecuado.
page_token

string

Es opcional. El valor de next_page_token que se muestra de una llamada AgentService.ListExamples de lista anterior.
filter

string

Es opcional. Es el filtro que se aplicará cuando se enumeren los ejemplos. Para obtener más información, consulta https://google.aip.dev/160.
order_by

string

Es opcional. Campo por el que se ordenará. Solo se admiten "name" y "create_time". Consulta https://google.aip.dev/132#ordering para obtener más detalles.

ListExamplesResponse

Mensaje de respuesta para AgentService.ListExamples.

Campos
examples[]

Example

Es la lista de ejemplos.
next_page_token

string

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 desde la que se enumerarán los parámetros de protección.
page_size

int32

Es opcional. Indica el tamaño de la página solicitada. Es posible que el servidor devuelva menos elementos de los que se solicitaron. Si no se especifica, el servidor elegirá un valor predeterminado adecuado.
page_token

string

Es opcional. El valor de next_page_token que se muestra de una llamada AgentService.ListGuardrails de lista anterior.
filter

string

Es opcional. Es el filtro que se aplicará cuando se listen las barreras de seguridad. Para obtener más información, consulta https://google.aip.dev/160.
order_by

string

Es opcional. Campo por el que se ordenará. Solo se admiten "name" y "create_time". Consulta https://google.aip.dev/132#ordering para obtener más detalles.

ListGuardrailsResponse

Mensaje de respuesta para AgentService.ListGuardrails.

Campos
guardrails[]

Guardrail

Es la lista de barreras.
next_page_token

string

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 desde la que se enumerarán las herramientas.
page_size

int32

Es opcional. Indica el tamaño de la página solicitada. Es posible que el servidor devuelva menos elementos de los que se solicitaron. Si no se especifica, el servidor elegirá un valor predeterminado adecuado.
page_token

string

Es opcional. El valor de next_page_token que se muestra de una llamada AgentService.ListTools de lista anterior.
filter

string

Es opcional. Es el filtro que se aplicará cuando se muestre la lista de herramientas. Usa "include_system_tools=true" para incluir herramientas del sistema en la respuesta. Para obtener más información, consulta https://google.aip.dev/160.
order_by

string

Es opcional. Campo por el que se ordenará. Solo se admiten "name" y "create_time". Consulta https://google.aip.dev/132#ordering para obtener más detalles.

ListToolsResponse

Mensaje de respuesta para AgentService.ListTools.

Campos
tools[]

Tool

Es la lista de herramientas.
next_page_token

string

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 desde la que se enumerarán los conjuntos de herramientas.
page_size

int32

Es opcional. Indica el tamaño de la página solicitada. Es posible que el servidor devuelva menos elementos de los que se solicitaron. Si no se especifica, el servidor elegirá un valor predeterminado adecuado.
page_token

string

Es opcional. El valor de next_page_token que se muestra de una llamada AgentService.ListToolsets de lista anterior.
filter

string

Es opcional. Es el filtro que se aplicará cuando se muestren los conjuntos de herramientas. Para obtener más información, consulta https://google.aip.dev/160.
order_by

string

Es opcional. Campo por el que se ordenará. Solo se admiten "name" y "create_time". Consulta https://google.aip.dev/132#ordering para obtener más detalles.

ListToolsetsResponse

Mensaje de respuesta para AgentService.ListToolsets.

Campos
toolsets[]

Toolset

Es la lista de conjuntos de herramientas.
next_page_token

string

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 para describir los comportamientos de registro de la app.

Campos
redaction_config

RedactionConfig

Es opcional. Es la configuración de cómo se deben ocultar los datos sensibles.
audio_recording_config

AudioRecordingConfig

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

BigQueryExportSettings

Es opcional. Es la configuración para describir los comportamientos de la exportación de BigQuery para la app. Los datos de conversación se exportarán a las tablas de BigQuery si está habilitada la exportación.
cloud_logging_settings

CloudLoggingSettings

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

ConversationLoggingSettings

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

AudioRecordingConfig

Es opcional. Es la configuración sobre cómo se deben registrar las interacciones de audio para la evaluación. De forma predeterminada, la grabación de audio no está habilitada para las sesiones de evaluación.
metric_analysis_settings

MetricAnalysisSettings

Es opcional. Es la configuración para describir los comportamientos de recopilación de datos de conversación para la canalización de análisis del LLM de la app.

McpTool

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

Campos
name

string

Obligatorio. Es el nombre de la herramienta de MCP.
description

string

Es opcional. Es la descripción de la herramienta de MCP.
input_schema

Schema

Es opcional. Es el esquema de los argumentos de entrada de la herramienta de MCP.
output_schema

Schema

Es opcional. Es el esquema de los argumentos de salida de la herramienta de MCP.
server_address

string

Obligatorio. Dirección del servidor de MCP, p.ej., "https://example.com/mcp/". Si el servidor se compila con el SDK de MCP, la URL debe tener el sufijo "/mcp/". Solo se admiten servidores basados en el transporte HTTP que se puede transmitir. Es igual a server_address en McpToolset. Consulta https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http para obtener más detalles.
api_authentication

ApiAuthentication

Es opcional. Es la información de autenticación necesaria para ejecutar la herramienta en el servidor de MCP. En el caso de la autenticación con token de portador, el token solo se aplica a la ejecución de la herramienta, no a las herramientas de creación de fichas. Esto requiere que las herramientas se puedan enumerar sin autenticación.
tls_config

TlsConfig

Es opcional. Es la configuración de TLS. Incluye los certificados de servidor personalizados en los que el cliente debe confiar.
service_directory_config

ServiceDirectoryConfig

Es opcional. Es la configuración de Directorio de servicios para VPC-SC, que se usa para resolver nombres de servicios dentro de un perímetro.

McpToolset

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

Campos
server_address

string

Obligatorio. Es la dirección del servidor de MCP, por ejemplo, "https://example.com/mcp/". Si el servidor se compila con el SDK de MCP, la URL debe tener el sufijo "/mcp/". Solo se admiten servidores basados en el transporte HTTP que se puede transmitir. Consulta https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http para obtener más detalles.
api_authentication

ApiAuthentication

Es opcional. Es la información de autenticación necesaria para acceder a las herramientas y ejecutar una herramienta en el servidor de MCP. En el caso de la autenticación con token de portador, el token solo se aplica a la ejecución de la herramienta, no a las herramientas de creación de fichas. Esto requiere que las herramientas se puedan enumerar sin autenticación.
service_directory_config

ServiceDirectoryConfig

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

Mensaje

Es un mensaje dentro de una conversación.

Campos
role

string

Es opcional. Es el rol dentro de la conversación, p.ej., usuario o agente.
chunks[]

Chunk

Es opcional. Es el contenido del mensaje como una serie de fragmentos.
event_time

Timestamp

Es opcional. Es la marca de tiempo del momento en que se envió o recibió el mensaje. No se debe usar si el mensaje forma parte de un example.

MetricAnalysisSettings

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

Campos
llm_metrics_opted_out

bool

Es opcional. Indica si se deben recopilar datos de conversaciones para las métricas de análisis de LLM. Si es verdadero, no se recopilarán datos de conversaciones para las métricas de análisis de LLM. De lo contrario, se recopilarán datos de conversaciones.

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 configura, el agente heredará el modelo de su agente principal.
temperature

double

Es opcional. Si se configura, se usará esta temperatura para el modelo LLM. La temperatura controla la aleatoriedad de las respuestas del modelo. Las temperaturas más bajas producen respuestas más predecibles. Las temperaturas más altas producen respuestas más creativas.

OAuthConfig

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

Campos
oauth_grant_type

OAuthConfig.OauthGrantType

Obligatorio. Son los tipos de otorgamiento de OAuth.
client_id

string

Obligatorio. Es el ID de cliente del proveedor de OAuth.
client_secret_version

string

Obligatorio. Nombre del recurso de la versión secreta de Secret Manager que almacena el secreto del cliente. Formato: projects/{project}/secrets/{secret}/versions/{version}

Nota: Debes otorgar el rol roles/secretmanager.secretAccessor al agente de servicio de CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.
token_endpoint

string

Obligatorio. Es el extremo del token en el proveedor de OAuth que se intercambiará por un token de acceso.
scopes[]

string

Es opcional. Son los permisos de OAuth que se otorgarán.

OauthGrantType

Son los tipos de otorgamiento de OAuth. Solo se admite el otorgamiento de credenciales de cliente.

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

Varios canales

Representa un recurso de Omnichannel.

Campos
name

string

Es el identificador. Es el identificador único del recurso omnicanal. Formato: projects/{project}/locations/{location}/omnichannels/{omnichannel}
display_name

string

Obligatorio. Es el nombre visible del recurso omnicanal.
description

string

Es opcional. Es una descripción legible del recurso omnicanal.
create_time

Timestamp

Solo salida. Es la marca de tiempo de la creación del recurso omnicanal.
update_time

Timestamp

Solo salida. Es la marca de tiempo de la última actualización del recurso omnicanal.
etag

string

Solo salida. Es el ETag que se usa para garantizar que el objeto no haya cambiado durante una operación de lectura, modificación y escritura.
integration_config

OmnichannelIntegrationConfig

Es opcional. Es la configuración de la integración para el recurso omnicanal.

OmnichannelIntegrationConfig

OmnichannelIntegrationConfig contiene todos los parámetros de configuración de la integración de la app.

Campos
channel_configs

map<string, OmnichannelIntegrationConfig.ChannelConfig>

Es opcional. Varias opciones de configuración para controlar eventos de aplicación.
subscriber_configs

map<string, OmnichannelIntegrationConfig.SubscriberConfig>

Es opcional. Varias configuraciones de suscriptores.
routing_configs

map<string, OmnichannelIntegrationConfig.RoutingConfig>

Es opcional. La clave de routing_configs es una clave de app_configs, y el valor es un RoutingConfig, que contiene la clave del suscriptor.

CesAppConfig

Son los parámetros de configuración de la app de CES.

Campos
app

string

Es el identificador único de la app de CES. Formato: projects/{project}/locations/{location}/apps/{app}

ChannelConfig

ChannelConfig contiene la configuración para varias integraciones de la app.

Campos
Campo de unión channel_config. Es la configuración de la app. channel_config solo puede ser uno de los siguientes valores:
whatsapp_config

OmnichannelIntegrationConfig.WhatsappConfig

Configuración de WhatsApp

RoutingConfig

La configuración de enrutamiento especifica cómo y a quién se deben enrutar los eventos de la app a un suscriptor.

Campos
subscriber_key

string

Es la clave del suscriptor.

SubscriberConfig

Es la configuración de los suscriptores.

Campos
Campo de unión subscriber_config. Es la configuración del suscriptor. subscriber_config puede ser solo uno de los parámetros siguientes:
ces_app_config

OmnichannelIntegrationConfig.CesAppConfig

Ces app config.

WhatsappConfig

Indica cómo el sistema omnicanal debe recibir o responder eventos de WhatsApp.

Campos
phone_number_id

string

Es el ID del número de teléfono asociado a la cuenta de WhatsApp Business.
phone_number

string

Es el número de teléfono que se usa para enviar y recibir mensajes.
whatsapp_business_account_id

string

Es el ID de la cuenta de WhatsApp Business (WABA) del cliente.
webhook_verify_token

string

Es el token de verificación configurado en el panel de la app de Meta para la verificación de webhook.
whatsapp_business_token

string

Es el token de acceso para autenticar las llamadas a la API de WhatsApp Cloud. https://developers.facebook.com/docs/whatsapp/business-management-api/get-started/#business-integration-system-user-access-tokens
meta_business_portfolio_id

string

Es el ID de la cartera de negocios de Meta (MBP). https://www.facebook.com/business/help/1710077379203657

OmnichannelOperationMetadata

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.

OpenApiTool

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

Campos
open_api_schema

string

Obligatorio. Esquema de OpenAPI en formato JSON o YAML
name

string

Es opcional. Es el nombre de la herramienta. Si no se proporciona, el nombre de la herramienta se derivará del esquema de OpenAPI, desde operation.operationId.
description

string

Es opcional. Es la descripción de la herramienta. Si no se proporciona, la descripción de la herramienta se derivará del esquema de OpenAPI, de operation.description o operation.summary.
api_authentication

ApiAuthentication

Es opcional. Es la información de autenticación que requiere la API.
tls_config

TlsConfig

Es opcional. Es la configuración de TLS. Incluye los certificados de servidor personalizados en los que confiará el cliente.
service_directory_config

ServiceDirectoryConfig

Es opcional. Es la configuración del Directorio de servicios.
ignore_unknown_fields

bool

Es opcional. Si es verdadero, el agente ignorará los campos desconocidos en la respuesta de la API.
url

string

Es opcional. Es la URL del servidor del esquema de la API abierta. Este campo solo se configura en las herramientas de las dependencias del entorno durante el proceso de exportación si el esquema contiene una URL del servidor. Durante el proceso de importación, si esta URL está presente en las dependencias del entorno y el esquema tiene el marcador de posición $env_var, se reemplazará el marcador de posición en el esquema.

OpenApiToolset

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

Campos
open_api_schema

string

Obligatorio. Es el esquema de OpenAPI del conjunto de herramientas.
api_authentication

ApiAuthentication

Es opcional. Es la información de autenticación que requiere la API.
tls_config

TlsConfig

Es opcional. Es la configuración de TLS. Incluye los certificados de servidor personalizados
service_directory_config

ServiceDirectoryConfig

Es opcional. Es la configuración del Directorio de servicios.
ignore_unknown_fields

bool

Es opcional. Si es verdadero, el agente ignorará los campos desconocidos en la respuesta de la API para todas las operaciones definidas en el esquema de OpenAPI.
url

string

Es opcional. Es la URL del servidor del esquema de la API abierta. Este campo solo se establece en los conjuntos de herramientas de las dependencias del entorno durante el proceso de exportación si el esquema contiene una URL del servidor. Durante el proceso de importación, si esta URL está presente en las dependencias del entorno y el esquema tiene el marcador de posición $env_var, se reemplazará el marcador de posición en el esquema.

OperationMetadata

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

Campos
create_time

Timestamp

Es solo de salida. Indica la hora a la que se creó la operación.
end_time

Timestamp

Es solo de salida. Indica la hora a la que finalizó la operación.
status_message

string

Es solo de salida. Indica el estado legible por humanos de la operación, si corresponde.
requested_cancellation

bool

Es solo de salida. Identifica si el usuario solicitó la cancelación de la operación. Las operaciones que se cancelaron con éxito tienen el valor google.longrunning.Operation.error con un google.rpc.Status.code de 1, que corresponde a Code.CANCELLED.

OutputAudioConfig

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

Campos
audio_encoding

AudioEncoding

Obligatorio. Es la codificación de los datos de audio de salida.
sample_rate_hertz

int32

Obligatorio. Es la tasa de muestreo (en hercios) de los datos de audio de salida.

PythonCodeCondition

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

Campos
python_code

string

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

PythonFunction

Es una herramienta de función de Python.

Campos
name

string

Es opcional. Nombre de la función de Python que se ejecutará. Debe coincidir con un nombre de función de Python definido en el código de Python. Distingue mayúsculas de minúsculas. Si no se proporciona el nombre, se usará la primera función definida en el código de Python.
python_code

string

Es opcional. Es el código de Python que se ejecutará para la herramienta.
description

string

Solo salida. Es la descripción de la función de Python, analizada a partir de la cadena de documentación del código de Python.

RecognitionResult

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

Campos
transcript

string

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

RedactionConfig

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

Campos
enable_redaction

bool

Es opcional. Si es verdadero, se aplicará el ocultamiento en varias situaciones de registro, como el historial de conversaciones, Cloud Logging y la grabación de audio.
inspect_template

string

Es opcional. Nombre de la plantilla de inspección de DLP para configurar la detección de tipos de datos sensibles.

Formato: projects/{project}/locations/{location}/inspectTemplates/{inspect_template}
deidentify_template

string

Es opcional. Nombre de la plantilla de desidentificación de DLP para indicar cómo desidentificar el contenido.

Formato: projects/{project}/locations/{location}/deidentifyTemplates/{deidentify_template}

RestoreAppVersionRequest

Mensaje de solicitud para AgentService.RestoreAppVersion

Campos
name

string

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

RestoreAppVersionResponse

Este tipo no tiene campos.

Mensaje de respuesta para AgentService.RestoreAppVersion

RetrieveToolSchemaRequest

Mensaje de solicitud para ToolService.RetrieveToolSchema.

Campos
parent

string

Obligatorio. Es el nombre del recurso de la app a la que pertenece la herramienta o el conjunto de herramientas. Formato: projects/{project}/locations/{location}/apps/{app}
Campo de unión tool_identifier. Es el identificador de la herramienta para la que se recuperará el esquema. Puede ser una herramienta persistente o una herramienta de un conjunto de herramientas. tool_identifier puede ser solo uno de los parámetros siguientes:
tool

string

Es opcional. Es el nombre de la herramienta para la que se recuperará el esquema. Formato: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
toolset_tool

ToolsetTool

Es opcional. Es la herramienta del conjunto de herramientas para la que se recuperará el esquema. Solo una herramienta debe coincidir con el predicado del conjunto de herramientas. De lo contrario, se mostrará un error.

RetrieveToolSchemaResponse

Mensaje de respuesta para ToolService.RetrieveToolSchema.

Campos
input_schema

Schema

Es el esquema de los parámetros de entrada de la herramienta.
output_schema

Schema

Es el esquema de los parámetros de salida de la herramienta.
Campo de unión tool_identifier. Es el identificador de la herramienta para la que se usa el esquema. tool_identifier puede ser solo uno de los parámetros siguientes:
tool

string

Es el nombre de la herramienta para la que se usa el esquema. Formato: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
toolset_tool

ToolsetTool

Es la herramienta del conjunto de herramientas para la que se aplica el esquema.

RetrieveToolsRequest

Mensaje de solicitud para ToolService.RetrieveTools.

Campos
toolset

string

Obligatorio. Nombre del conjunto de herramientas para el que se recuperarán las herramientas. Formato: projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}
tool_ids[]

string

Es opcional. Son los identificadores de las herramientas que se recuperarán del conjunto de herramientas. Si está vacío, se devolverán todas las herramientas del conjunto de herramientas.

RetrieveToolsResponse

Mensaje de respuesta para ToolService.RetrieveTools.

Campos
tools[]

Tool

Es la lista de herramientas que se incluyen en el conjunto de herramientas especificado.

RunSessionRequest

Mensaje de solicitud para SessionService.RunSession.

Campos
config

SessionConfig

Obligatorio. Es la configuración de la sesión.
inputs[]

SessionInput

Obligatorio. Son las entradas de la sesión.

RunSessionResponse

Mensaje de respuesta para SessionService.RunSession.

Campos
outputs[]

SessionOutput

Son los resultados de la sesión.

Esquema

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

Campos
type

Schema.Type

Obligatorio. Es el tipo de datos.
properties

map<string, Schema>

Es opcional. Son las propiedades de Type.OBJECT.
required[]

string

Es opcional. Son las propiedades obligatorias de Type.OBJECT.
description

string

Es opcional. La descripción de los datos.
items

Schema

Es opcional. Esquema de los elementos de Type.ARRAY.
nullable

bool

Es opcional. Indica si el valor puede ser nulo.
unique_items

bool

Es opcional. Indica que los elementos del array deben ser únicos. Solo se aplica a TYPE.ARRAY.
prefix_items[]

Schema

Es opcional. Esquemas de los elementos iniciales de Type.ARRAY.
additional_properties

Schema

Es opcional. Puede ser un valor booleano o un objeto, y controla la presencia de propiedades adicionales.
any_of[]

Schema

Es opcional. El valor se debe validar con cualquiera de los subesquemas (uno o más) de la lista.
enum[]

string

Es opcional. Valores posibles del elemento de tipo primitivo con formato de enumeración. Ejemplos: 1. Podemos definir la dirección de la siguiente manera : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. Podemos definir el número de apartamento de la siguiente manera : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
default

Value

Es opcional. Es el valor predeterminado de los datos.
ref

string

Es opcional. Permite referencias indirectas entre los nodos del esquema. El valor debe ser una referencia válida a un elemento secundario del defs raíz.

Por ejemplo, el siguiente esquema define una referencia a un nodo de esquema llamado "Pet":

type: object
properties:
  pet:
    ref: #/defs/Pet
defs:
  Pet:
    type: object
    properties:
      name:
        type: string

El valor de la propiedad "pet" es una referencia al nodo del esquema llamado "Pet". Consulta los detalles en https://json-schema.org/understanding-json-schema/structuring.
defs

map<string, Schema>

Es opcional. Es un mapa de definiciones para que lo use ref. Solo se permite en la raíz del esquema.
title

string

Es opcional. Es el título del esquema.
min_items

int64

Es opcional. Es la cantidad mínima de elementos para Type.ARRAY.
max_items

int64

Es opcional. Es la cantidad máxima de elementos para Type.ARRAY.
minimum

double

Es opcional. Es el valor mínimo para Type.INTEGER y Type.NUMBER.
maximum

double

Es opcional. Es el valor máximo para Type.INTEGER y Type.NUMBER.

Tipo

Son los tipos de datos de OpenAPI.

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

ServiceAccountAuthConfig

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

Campos
service_account

string

Obligatorio. Es la dirección de correo electrónico de la cuenta de servicio que se usa para la autenticación. CES usa esta cuenta de servicio para intercambiar un token de acceso, que luego se envía en el encabezado Authorization de la solicitud.

La cuenta de servicio debe tener el rol roles/iam.serviceAccountTokenCreator otorgado al agente de servicio de CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.
scopes[]

string

Es opcional. Son los permisos de OAuth que se otorgarán. Si no se especifica, se usa el alcance predeterminado https://www.googleapis.com/auth/cloud-platform.

ServiceAgentIdTokenAuthConfig

Este tipo no tiene campos.

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

ServiceDirectoryConfig

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

Campos
service

string

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

SessionConfig

Es la configuración de la sesión.

Campos
session

string

Obligatorio. Es el identificador único de la sesión. Formato: projects/{project}/locations/{location}/apps/{app}/sessions/{session}
input_audio_config

InputAudioConfig

Es opcional. Es la configuración para procesar el audio de entrada.
output_audio_config

OutputAudioConfig

Es opcional. Es la configuración para generar el audio de salida.
historical_contexts[]

Message

Es opcional. El contexto histórico de la sesión, incluidas las entradas del usuario, las respuestas del agente y otros mensajes. Por lo general, el agente de CES administra la sesión automáticamente, por lo que el cliente no necesita completar este campo de forma explícita. Sin embargo, el cliente puede anular de forma opcional los contextos históricos para forzar el inicio de la sesión desde un estado determinado.
entry_agent

string

Es opcional. Es el agente de entrada para controlar la sesión. Si no se especifica, la sesión la controlará el root agent de la app. Formato: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
deployment

string

Es opcional. Es la implementación de la app que se usará para la sesión. Formato: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
time_zone

string

Es opcional. Zona horaria del usuario. Si se proporciona, el agente usará la zona horaria para las variables relacionadas con la fecha y la hora. De lo contrario, el agente usará la zona horaria especificada en App.time_zone_settings.

El formato es la zona horaria de la base de datos de zonas horarias de IANA, p.ej., "America/Los_Angeles".
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.

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 que indica si el mensaje actual es un fragmento de una entrada más grande en la sesión de transmisión bidireccional.

Cuando se establece en true, el agente aplaza el procesamiento hasta que recibe un mensaje posterior en el que will_continue es false o hasta que el sistema detecta un extremo en la entrada de audio.

NOTA: Este campo no se aplica a las entradas de audio y DTMF, ya que siempre se procesan automáticamente según la señal de finalización.
Campo de unión input_type. Es el tipo de entrada. input_type puede ser solo uno de los parámetros siguientes:
text

string

Es opcional. Son los datos de texto del usuario final.
dtmf

string

Es opcional. Dígitos de DTMF del usuario final.
audio

bytes

Es opcional. Son los datos de audio del usuario final.
tool_responses

ToolResponses

Es opcional. Son los resultados de la ejecución de las llamadas a herramientas del cliente.
image

Image

Es opcional. Son los datos de imagen del usuario final.
blob

Blob

Es opcional. Son los datos de BLOB del usuario final.
variables

Struct

Es opcional. Son las variables contextuales de la sesión, con la clave establecida por el nombre. El agente de CES solo usará las variables declaradas en la app.

Las variables no reconocidas se seguirán enviando al [agente de Dialogflow][Agent.RemoteDialogflowAgent] como parámetros de sesión adicionales.
event

Event

Es opcional. Es la entrada del evento.

SessionOutput

Es el resultado de la sesión.

Campos
turn_index

int32

Indica el orden secuencial del turno de conversación al que pertenece esta respuesta, comenzando desde 1.
turn_completed

bool

Si es verdadero, el agente de CES detectó el final del turno de conversación actual y no proporcionará más resultados para este turno.
diagnostic_info

SessionOutput.DiagnosticInfo

Es opcional. La información de diagnóstico contiene detalles de la ejecución durante el procesamiento de la entrada. Solo se completa en el último SessionOutput (con turn_completed=true) de cada turno.
Campo de unión output_type. Es el tipo de salida. output_type puede ser solo uno de los parámetros siguientes:
text

string

Es el texto de salida del agente de CES.
audio

bytes

Audio de salida del agente de CES.
tool_calls

ToolCalls

Solicitud para que el cliente ejecute las herramientas.
citations

Citations

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

GoogleSearchSuggestions

Son las sugerencias que devuelve la Búsqueda de Google como resultado de invocar GoogleSearchTool.
end_session

EndSession

Indica que finalizó la sesión.
payload

Struct

Es una carga útil personalizada con resultados estructurados del agente de CES.

DiagnosticInfo

Contiene detalles de la ejecución durante el procesamiento.

Campos
messages[]

Message

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

Span

Es un registro de todo el procesamiento de la solicitud, representado como un intervalo raíz. Este intervalo puede contener intervalos secundarios anidados para operaciones específicas.

Intervalo

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

Campos
name

string

Solo salida. Es el nombre del intervalo.
start_time

Timestamp

Solo salida. Es la hora de inicio del período.
end_time

Timestamp

Solo salida. Es la hora de finalización del período.
duration

Duration

Solo salida. Es la duración del intervalo.
attributes

Struct

Solo salida. Son los atributos clave-valor asociados con el intervalo.
child_spans[]

Span

Solo salida. Son los intervalos secundarios anidados en este intervalo.

SynthesizeSpeechConfig

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

Campos
voice

string

Opcional. El nombre de la voz. Si no se configura, el servicio elegirá una voz según los otros parámetros, como language_code.

Para obtener la lista de voces disponibles, consulta Voces y lenguajes compatibles en Cloud Text-to-Speech.
speaking_rate

double

Es opcional. Es la velocidad de habla en el intervalo [0.25, 2.0]. 1.0 es la velocidad nativa normal que admite la voz específica. 2.0 es el doble de rápido y 0.5 es la mitad. Los valores fuera del rango [0.25, 2.0] mostrarán un error.

SystemTool

Es una herramienta del sistema predefinida.

Campos
name

string

Obligatorio. Es el nombre de la herramienta del sistema.
description

string

Solo salida. Es la descripción de la herramienta del sistema.

TimeZoneSettings

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

Campos
time_zone

string

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

CaCert

Es el certificado de CA.

Campos
display_name

string

Obligatorio. Nombre de los certificados de CA personalizados permitidos. Se puede usar para desambiguar los certificados de CA personalizados.
cert

bytes

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

Herramienta

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

Campos
name

string

Es el identificador. Es el identificador único de la herramienta. Formato: - projects/{project}/locations/{location}/apps/{app}/tools/{tool} para

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, por lo que no se pueden consultar directamente cuando se espera una herramienta.
display_name

string

Solo salida. Es el nombre visible de la herramienta, que se deriva según el tipo de herramienta. Por ejemplo, el nombre visible de un [ClientFunction][Tool.ClientFunction] se deriva de su propiedad name.
execution_type

ExecutionType

Es opcional. Es el tipo de ejecución de la herramienta.
create_time

Timestamp

Solo salida. Es la marca de tiempo de la creación de la herramienta.
update_time

Timestamp

Solo salida. Es la marca de tiempo de la última actualización de la herramienta.
etag

string

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

string

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

ToolFakeConfig

Es opcional. Es la configuración del comportamiento de la herramienta en el modo simulado.
Campo de unión tool_type. Es el tipo de herramienta. tool_type puede ser solo uno de los parámetros siguientes:
client_function

ClientFunction

Es opcional. Es la función del cliente.
open_api_tool

OpenApiTool

Es opcional. Es la herramienta de API abierta.
google_search_tool

GoogleSearchTool

Es opcional. Es la herramienta de Búsqueda de Google.
connector_tool

ConnectorTool

Es opcional. La herramienta Integration Connector
data_store_tool

DataStoreTool

Es opcional. Es la herramienta de almacén de datos.
python_function

PythonFunction

Es opcional. Es la herramienta de función de Python.
mcp_tool

McpTool

Es opcional. Es la herramienta de MCP. Una herramienta de MCP no se puede crear ni actualizar directamente, sino que se administra a través del conjunto de herramientas de MCP.
file_search_tool

FileSearchTool

Es opcional. Es la herramienta de búsqueda de archivos.
system_tool

SystemTool

Es opcional. Es la herramienta del sistema.
widget_tool

WidgetTool

Es opcional. La herramienta de widget.

ToolCall

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

Campos
id

string

Es opcional. Es el identificador único de la llamada a la herramienta. Si se completa, el cliente debe devolver el resultado de la ejecución con el ID para coincidencias en ToolResponse.
display_name

string

Solo salida. Nombre visible de la herramienta.
args

Struct

Es opcional. Son los parámetros y valores de entrada de la herramienta en formato de objeto JSON.
Campo de unión tool_identifier. Es el identificador de la herramienta que se ejecutará. Puede ser una herramienta persistente o una herramienta de un conjunto de herramientas. tool_identifier puede ser solo uno de los parámetros siguientes:
tool

string

Es opcional. Es el nombre de la herramienta que se ejecutará. Formato: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
toolset_tool

ToolsetTool

Es opcional. Es la herramienta del conjunto de herramientas que se ejecutará.

ToolCalls

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

Campos
tool_calls[]

ToolCall

Es opcional. Es la lista de llamadas a herramientas que se ejecutarán.

ToolFakeConfig

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

Campos
enable_fake_mode

bool

Es opcional. Indica si la herramienta usa el modo falso.
Campo de unión tool_response. La respuesta es estática o la proporciona una función de Python. tool_response puede ser solo uno de los parámetros siguientes:
code_block

CodeBlock

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

ToolResponse

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

Campos
id

string

Es opcional. Es el ID para coincidencias del tool call para el que es la respuesta.
display_name

string

Solo salida. Nombre visible de la herramienta.
response

Struct

Obligatorio. Es el resultado de la ejecución de la herramienta en formato de objeto JSON. Usa la clave "output" para especificar la respuesta de la herramienta y la clave "error" para especificar los detalles del error (si hay alguno). Si no se especifican las claves "output" y "error", toda la "response" se trata como resultado de la ejecución de la herramienta.
Campo de unión tool_identifier. Es el identificador de la herramienta que se ejecutó. Puede ser una herramienta persistente o una herramienta de un conjunto de herramientas. tool_identifier puede ser solo uno de los parámetros siguientes:
tool

string

Es opcional. Es el nombre de la herramienta que se ejecutará. Formato: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
toolset_tool

ToolsetTool

Es opcional. Es la herramienta del conjunto de herramientas que se ejecutó.

ToolResponses

Son los resultados de la ejecución de las llamadas a herramientas solicitadas desde 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.
create_time

Timestamp

Solo salida. Es la marca de tiempo de cuando se creó el conjunto de herramientas.
update_time

Timestamp

Solo salida. Es la marca de tiempo de la última actualización del conjunto de herramientas.
etag

string

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

ExecutionType

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

ToolFakeConfig

Es opcional. Es la configuración del comportamiento de las herramientas en el modo simulado.
Campo de unión toolset_type. Es el tipo de conjunto de herramientas. toolset_type puede ser solo uno de los parámetros siguientes:
mcp_toolset

McpToolset

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

OpenApiToolset

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

ConnectorToolset

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

ToolsetTool

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

Campos
toolset

string

Obligatorio. Es el nombre del recurso del conjunto de herramientas del que se deriva esta herramienta. Formato: projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}
tool_id

string

Es opcional. Es el ID de la herramienta para filtrar las herramientas y recuperar el esquema.

TransferRule

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

Campos
child_agent

string

Obligatorio. Es el nombre del recurso del agente secundario al que se aplica la regla. Formato: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
direction

TransferRule.Direction

Obligatorio. Es la dirección de la transferencia.
Campo de unión rule_type. Es el tipo de regla. rule_type puede ser solo uno de los parámetros siguientes:
deterministic_transfer

TransferRule.DeterministicTransfer

Es opcional. Es una regla que se transfiere de inmediato al agente objetivo cuando se cumple la condición.
disable_planner_transfer

TransferRule.DisablePlannerTransfer

Es opcional. Es una regla que impide que el planificador transfiera la llamada al agente objetivo.

DeterministicTransfer

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

Campos
Campo de unión condition_type. Es la condición que se evaluará. condition_type puede ser solo uno de los parámetros siguientes:
expression_condition

ExpressionCondition

Es opcional. Es una regla que evalúa una condición de estado de la sesión. Si la condición se evalúa como verdadera, se realiza la transferencia.
python_code_condition

PythonCodeCondition

Es opcional. Una regla que usa un bloque de código de Python para evaluar las condiciones. Si la condición se evalúa como verdadera, se realiza la transferencia.

Dirección

Es la dirección de la transferencia.

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

DisablePlannerTransfer

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

Campos
expression_condition

ExpressionCondition

Obligatorio. Si la condición se evalúa como verdadera, no se permitirá que el planificador realice la transferencia al agente objetivo.

TriggerAction

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

Campos
Campo de unión action. La acción por realizar. action puede ser solo uno de los parámetros siguientes:
respond_immediately

TriggerAction.RespondImmediately

Es opcional. Responder de inmediato con una respuesta preconfigurada
transfer_agent

TriggerAction.TransferAgent

Es opcional. Transferir la conversación a otro agente
generative_answer

TriggerAction.GenerativeAnswer

Es opcional. Responder con una respuesta generativa

GenerativeAnswer

El agente responderá de inmediato con una respuesta generativa.

Campos
prompt

string

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

RespondImmediately

El agente responderá de inmediato con una respuesta preconfigurada.

Campos
responses[]

TriggerAction.Response

Obligatorio. Son las respuestas estándar que puede elegir el agente. La respuesta se elige de forma aleatoria.

Respuesta

Representa una respuesta del agente.

Campos
text

string

Obligatorio. Es el texto con el que responderá el agente.
disabled

bool

Es opcional. Indica si la respuesta está inhabilitada. El agente no usa las respuestas inhabilitadas.

TransferAgent

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

Campos
agent

string

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

UpdateAgentRequest

Mensaje de solicitud para AgentService.UpdateAgent.

Campos
agent

Agent

Obligatorio. El agente que se actualizará.
update_mask

FieldMask

Es opcional. La máscara de campo se usa para controlar qué campos se actualizan. Si la máscara no está presente, se actualizarán todos los campos.

UpdateAppRequest

Mensaje de solicitud para AgentService.UpdateApp.

Campos
app

App

Obligatorio. Es la app que se actualizará.
update_mask

FieldMask

Es opcional. La máscara de campo se usa para controlar qué campos se actualizan. Si la máscara no está presente, se actualizarán todos los campos.

UpdateDeploymentRequest

Mensaje de solicitud para AgentService.UpdateDeployment.

Campos
deployment

Deployment

Obligatorio. Es la implementación que se actualizará.
update_mask

FieldMask

Es opcional. La lista de campos que se deben actualizar.

UpdateExampleRequest

Mensaje de solicitud para AgentService.UpdateExample.

Campos
example

Example

Obligatorio. Es el ejemplo que se actualizará.
update_mask

FieldMask

Es opcional. La máscara de campo se usa para controlar qué campos se actualizan. Si la máscara no está presente, se actualizarán todos los campos.

UpdateGuardrailRequest

Mensaje de solicitud para AgentService.UpdateGuardrail.

Campos
guardrail

Guardrail

Obligatorio. Es la protección que se actualizará.
update_mask

FieldMask

Es opcional. La máscara de campo se usa para controlar qué campos se actualizan. Si la máscara no está presente, se actualizarán todos los campos.

UpdateToolRequest

Mensaje de solicitud para AgentService.UpdateTool.

Campos
tool

Tool

Obligatorio. Es la herramienta que se actualizará.
update_mask

FieldMask

Es opcional. La máscara de campo se usa para controlar qué campos se actualizan. Si la máscara no está presente, se actualizarán todos los campos.

UpdateToolsetRequest

Mensaje de solicitud para AgentService.UpdateToolset.

Campos
toolset

Toolset

Obligatorio. Es el conjunto de herramientas que se actualizará.
update_mask

FieldMask

Es opcional. La máscara de campo se usa para controlar qué campos se actualizan. Si la máscara no está presente, se actualizarán todos los campos.

WebSearchQuery

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

Campos
query

string

Es el texto de la búsqueda.
uri

string

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

WidgetTool

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

Campos
name

string

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

string

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

WidgetTool.WidgetType

Es opcional. Es el tipo de herramienta del widget. Si no se especifica, el tipo predeterminado será CUSTOMIZED.
Campo de unión input. Es la entrada de la herramienta de widget. input puede ser solo uno de los parámetros siguientes:
parameters

Schema

Es opcional. Son los parámetros de entrada de la herramienta de widget.

WidgetType

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

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