Package google.cloud.ces.v1

Índice

AgentService

O serviço que gerencia recursos relacionados a agentes no Gemini Enterprise for Customer Engagement (CES).

BatchDeleteConversations

rpc BatchDeleteConversations(BatchDeleteConversationsRequest) returns (Operation)

Exclui em lote as conversas especificadas.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso parent:

  • ces.conversations.delete

Para mais informações, consulte a documentação do IAM.
CreateAgent

rpc CreateAgent(CreateAgentRequest) returns (Agent)

Cria um novo agente no app especificado.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso parent:

  • ces.agents.create

Para mais informações, consulte a documentação do IAM.
CreateApp

rpc CreateApp(CreateAppRequest) returns (Operation)

Cria um novo app no projeto e local especificados.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso parent:

  • ces.apps.create

Para mais informações, consulte a documentação do IAM.
CreateAppVersion

rpc CreateAppVersion(CreateAppVersionRequest) returns (AppVersion)

Cria uma nova versão do app no app especificado.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso parent:

  • ces.appVersions.create

Para mais informações, consulte a documentação do IAM.
CreateDeployment

rpc CreateDeployment(CreateDeploymentRequest) returns (Deployment)

Cria uma nova implantação no app especificado.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso parent:

  • ces.deployments.create

Para mais informações, consulte a documentação do IAM.
CreateExample

rpc CreateExample(CreateExampleRequest) returns (Example)

Cria um novo exemplo no app especificado.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso parent:

  • ces.examples.create

Para mais informações, consulte a documentação do IAM.
CreateGuardrail

rpc CreateGuardrail(CreateGuardrailRequest) returns (Guardrail)

Cria uma nova proteção no app especificado.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso parent:

  • ces.guardrails.create

Para mais informações, consulte a documentação do IAM.
CreateTool

rpc CreateTool(CreateToolRequest) returns (Tool)

Cria uma nova ferramenta no app especificado.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso parent:

  • ces.tools.create

Para mais informações, consulte a documentação do IAM.
CreateToolset

rpc CreateToolset(CreateToolsetRequest) returns (Toolset)

Cria um novo conjunto de ferramentas no app especificado.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso parent:

  • ces.toolsets.create

Para mais informações, consulte a documentação do IAM.
DeleteAgent

rpc DeleteAgent(DeleteAgentRequest) returns (Empty)

Exclui o agente especificado.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso name:

  • ces.agents.delete

Para mais informações, consulte a documentação do IAM.
DeleteApp

rpc DeleteApp(DeleteAppRequest) returns (Operation)

Exclui o app especificado.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso name:

  • ces.apps.delete

Para mais informações, consulte a documentação do IAM.
DeleteAppVersion

rpc DeleteAppVersion(DeleteAppVersionRequest) returns (Empty)

Exclui a versão especificada do app.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso name:

  • ces.appVersions.delete

Para mais informações, consulte a documentação do IAM.
DeleteConversation

rpc DeleteConversation(DeleteConversationRequest) returns (Empty)

Exclui a conversa especificada.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso name:

  • ces.conversations.delete

Para mais informações, consulte a documentação do IAM.
DeleteDeployment

rpc DeleteDeployment(DeleteDeploymentRequest) returns (Empty)

Exclui a implantação especificada.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso name:

  • ces.deployments.delete

Para mais informações, consulte a documentação do IAM.
DeleteExample

rpc DeleteExample(DeleteExampleRequest) returns (Empty)

Exclui o exemplo especificado.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso name:

  • ces.examples.delete

Para mais informações, consulte a documentação do IAM.
DeleteGuardrail

rpc DeleteGuardrail(DeleteGuardrailRequest) returns (Empty)

Exclui a proteção especificada.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso name:

  • ces.guardrails.delete

Para mais informações, consulte a documentação do IAM.
DeleteTool

rpc DeleteTool(DeleteToolRequest) returns (Empty)

Exclui a ferramenta especificada.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso name:

  • ces.tools.delete

Para mais informações, consulte a documentação do IAM.
DeleteToolset

rpc DeleteToolset(DeleteToolsetRequest) returns (Empty)

Exclui o conjunto de ferramentas especificado.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso name:

  • ces.toolsets.delete

Para mais informações, consulte a documentação do IAM.
ExportApp

rpc ExportApp(ExportAppRequest) returns (Operation)

Exporta o app especificado.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso name:

  • ces.apps.export

Para mais informações, consulte a documentação do IAM.
GetAgent

rpc GetAgent(GetAgentRequest) returns (Agent)

Recebe detalhes do agente especificado.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso name:

  • ces.agents.get

Para mais informações, consulte a documentação do IAM.
GetApp

rpc GetApp(GetAppRequest) returns (App)

Recebe detalhes do app especificado.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso name:

  • ces.apps.get

Para mais informações, consulte a documentação do IAM.
GetAppVersion

rpc GetAppVersion(GetAppVersionRequest) returns (AppVersion)

Recebe detalhes da versão do app especificada.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso name:

  • ces.appVersions.get

Para mais informações, consulte a documentação do IAM.
GetChangelog

rpc GetChangelog(GetChangelogRequest) returns (Changelog)

Recebe o changelog especificado.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso name:

  • ces.changelogs.get

Para mais informações, consulte a documentação do IAM.
GetConversation

rpc GetConversation(GetConversationRequest) returns (Conversation)

Recebe detalhes da conversa especificada.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso name:

  • ces.conversations.get

Para mais informações, consulte a documentação do IAM.
GetDeployment

rpc GetDeployment(GetDeploymentRequest) returns (Deployment)

Recebe detalhes da implantação especificada.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso name:

  • ces.deployments.get

Para mais informações, consulte a documentação do IAM.
GetExample

rpc GetExample(GetExampleRequest) returns (Example)

Recebe detalhes do exemplo especificado.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso name:

  • ces.examples.get

Para mais informações, consulte a documentação do IAM.
GetGuardrail

rpc GetGuardrail(GetGuardrailRequest) returns (Guardrail)

Recebe detalhes da proteção especificada.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso name:

  • ces.guardrails.get

Para mais informações, consulte a documentação do IAM.
GetTool

rpc GetTool(GetToolRequest) returns (Tool)

Recebe detalhes da ferramenta especificada.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso name:

  • ces.tools.get

Para mais informações, consulte a documentação do IAM.
GetToolset

rpc GetToolset(GetToolsetRequest) returns (Toolset)

Recebe detalhes do conjunto de ferramentas especificado.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso name:

  • ces.toolsets.get

Para mais informações, consulte a documentação do IAM.
ImportApp

rpc ImportApp(ImportAppRequest) returns (Operation)

Importa o app especificado.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso parent:

  • ces.apps.import

Para mais informações, consulte a documentação do IAM.
ListAgents

rpc ListAgents(ListAgentsRequest) returns (ListAgentsResponse)

Lista os agentes no app especificado.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso parent:

  • ces.agents.list

Para mais informações, consulte a documentação do IAM.
ListAppVersions

rpc ListAppVersions(ListAppVersionsRequest) returns (ListAppVersionsResponse)

Lista todas as versões do app especificado.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso parent:

  • ces.appVersions.list

Para mais informações, consulte a documentação do IAM.
ListApps

rpc ListApps(ListAppsRequest) returns (ListAppsResponse)

Lista os apps no projeto e local especificados.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso parent:

  • ces.apps.list

Para mais informações, consulte a documentação do IAM.
ListChangelogs

rpc ListChangelogs(ListChangelogsRequest) returns (ListChangelogsResponse)

Lista os registros de mudanças do app especificado.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso parent:

  • ces.changelogs.list

Para mais informações, consulte a documentação do IAM.
ListConversations

rpc ListConversations(ListConversationsRequest) returns (ListConversationsResponse)

Lista as conversas no app especificado.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso parent:

  • ces.conversations.list

Para mais informações, consulte a documentação do IAM.
ListDeployments

rpc ListDeployments(ListDeploymentsRequest) returns (ListDeploymentsResponse)

Lista as implantações no app especificado.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso parent:

  • ces.deployments.list

Para mais informações, consulte a documentação do IAM.
ListExamples

rpc ListExamples(ListExamplesRequest) returns (ListExamplesResponse)

Lista exemplos no app especificado.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso parent:

  • ces.examples.list

Para mais informações, consulte a documentação do IAM.
ListGuardrails

rpc ListGuardrails(ListGuardrailsRequest) returns (ListGuardrailsResponse)

Lista os mecanismos de proteção no app especificado.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso parent:

  • ces.guardrails.list

Para mais informações, consulte a documentação do IAM.
ListTools

rpc ListTools(ListToolsRequest) returns (ListToolsResponse)

Lista as ferramentas no app especificado.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso parent:

  • ces.tools.list

Para mais informações, consulte a documentação do IAM.
ListToolsets

rpc ListToolsets(ListToolsetsRequest) returns (ListToolsetsResponse)

Lista os conjuntos de ferramentas no app especificado.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso parent:

  • ces.toolsets.list

Para mais informações, consulte a documentação do IAM.
RestoreAppVersion

rpc RestoreAppVersion(RestoreAppVersionRequest) returns (Operation)

Restaura a versão especificada do app. Isso vai criar uma nova versão do app com base no rascunho atual e substituir o rascunho pela versão especificada.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso name:

  • ces.appVersions.restore

Para mais informações, consulte a documentação do IAM.
UpdateAgent

rpc UpdateAgent(UpdateAgentRequest) returns (Agent)

Atualiza o agente especificado.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso name:

  • ces.agents.update

Para mais informações, consulte a documentação do IAM.
UpdateApp

rpc UpdateApp(UpdateAppRequest) returns (App)

Atualiza o app especificado.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso name:

  • ces.apps.update

Para mais informações, consulte a documentação do IAM.
UpdateDeployment

rpc UpdateDeployment(UpdateDeploymentRequest) returns (Deployment)

Atualiza a implantação especificada.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso name:

  • ces.deployments.update

Para mais informações, consulte a documentação do IAM.
UpdateExample

rpc UpdateExample(UpdateExampleRequest) returns (Example)

Atualiza o exemplo especificado.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso name:

  • ces.examples.update

Para mais informações, consulte a documentação do IAM.
UpdateGuardrail

rpc UpdateGuardrail(UpdateGuardrailRequest) returns (Guardrail)

Atualiza a proteção especificada.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso name:

  • ces.guardrails.update

Para mais informações, consulte a documentação do IAM.
UpdateTool

rpc UpdateTool(UpdateToolRequest) returns (Tool)

Atualiza a ferramenta especificada.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso name:

  • ces.tools.update

Para mais informações, consulte a documentação do IAM.
UpdateToolset

rpc UpdateToolset(UpdateToolsetRequest) returns (Toolset)

Atualiza o conjunto de ferramentas especificado.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso name:

  • ces.toolsets.update

Para mais informações, consulte a documentação do IAM.

SessionService

O serviço de sessão fornece APIs para interagir com agentes do CES.

BidiRunSession

rpc BidiRunSession(BidiSessionClientMessage) returns (BidiSessionServerMessage)

Estabelece uma conexão de streaming bidirecional com o agente do CES. O agente processa entradas multimodais contínuas (por exemplo, texto, áudio) e gera fluxos de saída multimodais em tempo real.

--- Stream de solicitação do cliente --- O cliente transmite solicitações na seguinte ordem:

  1. Inicialização: a primeira mensagem precisa conter SessionConfig. Para sessões de áudio, isso também precisa incluir InputAudioConfig e OutputAudioConfig para definir parâmetros de processamento e síntese de áudio.

  2. Interação: as mensagens subsequentes transmitem SessionInput com dados de entrada do usuário em tempo real.

  3. Encerramento: o cliente deve fechar parcialmente o stream quando não houver mais entrada do usuário. Ele também deve ser fechado pela metade ao receber EndSession ou GoAway do agente.

--- Fluxo de resposta do servidor --- Para cada turno de interação, o agente transmite mensagens na seguinte sequência:

  1. Reconhecimento de fala (primeiras N mensagens): contém RecognitionResult, que representa os segmentos de fala do usuário concatenados capturados até o momento. Esse campo só é preenchido para sessões de áudio.

  2. Resposta (próximas M mensagens): contém SessionOutput que entrega a resposta do agente em várias modalidades (por exemplo, texto, áudio).

  3. Conclusão do turno (última mensagem do turno): contém SessionOutput com turn_completed definido como "true". Isso indica o fim da vez atual e inclui DiagnosticInfo com detalhes da execução.

--- Práticas recomendadas de áudio --- 1. Streaming: transmita audio data CONTINUAMENTE, mesmo durante o silêncio. Tamanho de bloco recomendado: 40 a 120 ms (equilibra latência e eficiência).

  1. Reprodução e interrupção: reproduza audio responses ao receber. Pare a reprodução imediatamente se um InterruptionSignal for recebido (por exemplo, interrupção do usuário ou nova resposta do agente).
Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso session:

  • ces.sessions.bidiRunSession

Para mais informações, consulte a documentação do IAM.
RunSession

rpc RunSession(RunSessionRequest) returns (RunSessionResponse)

Inicia uma interação de turno único com o agente do CES em uma sessão.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso session:

  • ces.sessions.runSession

Para mais informações, consulte a documentação do IAM.

ToolService

O serviço de ferramentas fornece APIs para interagir com as ferramentas do CES.

ExecuteTool

rpc ExecuteTool(ExecuteToolRequest) returns (ExecuteToolResponse)

Executa a ferramenta especificada com os argumentos fornecidos.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso parent:

  • ces.tools.execute

Para mais informações, consulte a documentação do IAM.
RetrieveToolSchema

rpc RetrieveToolSchema(RetrieveToolSchemaRequest) returns (RetrieveToolSchemaResponse)

Recupera o esquema da ferramenta especificada. O esquema é calculado imediatamente para a instância especificada da ferramenta.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso parent:

  • ces.tools.get

Para mais informações, consulte a documentação do IAM.
RetrieveTools

rpc RetrieveTools(RetrieveToolsRequest) returns (RetrieveToolsResponse)

Recupera a lista de ferramentas incluídas no conjunto especificado.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso toolset:

  • ces.toolsets.get

Para mais informações, consulte a documentação do IAM.

WidgetService

Fornece APIs para widgets interagirem com as APIs do CES.

GenerateChatToken

rpc GenerateChatToken(GenerateChatTokenRequest) returns (GenerateChatTokenResponse)

Gera um token no escopo da sessão para o widget de chat autenticar com as APIs Session.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

Ação

Configuração de uma ação para a ferramenta usar. Observação: pode ser uma ação ou uma operação. Consulte https://cloud.google.com/integration-connectors/docs/entities-operation-action para mais detalhes.

Campos
input_fields[]

string

Opcional. Campos de entidade a serem usados como entradas para a operação. Se nenhum campo for especificado, todos os campos da entidade serão usados.
output_fields[]

string

Opcional. Campos de entidade a serem retornados da operação. Se nenhum campo for especificado, todos os campos da entidade serão retornados.
Campo de união action_spec. Especificação de uma ação a ser configurada para uso da ferramenta. action_spec pode ser apenas de um dos tipos a seguir:
connection_action_id

string

ID de uma ação de conexão para a ferramenta usar.
entity_operation

Action.EntityOperation

Configuração de operação de entidade para a ferramenta usar.

EntityOperation

Especificação da operação CRUD da entidade.

Campos
entity_id

string

Obrigatório. ID da entidade.
operation

Action.EntityOperation.OperationType

Obrigatório. Operação a ser realizada na entidade.

OperationType

A operação a ser realizada na entidade.

Tipos enumerados
OPERATION_TYPE_UNSPECIFIED Tipo de operação não especificado. Inválido. A criação/atualização de ConnectorTool vai falhar.
LIST Operação de listagem.
GET Receber operação.
CREATE Criar operação.
UPDATE Operação de atualização.
DELETE Excluir operação.

Agente

Um agente atua como o elemento fundamental que fornece instruções ao modelo de linguagem grande (LLM) para executar tarefas específicas.

Campos
name

string

Identificador. O identificador exclusivo do agente. Formato: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
display_name

string

Obrigatório. Nome de exibição do agente.
description

string

Opcional. Descrição do agente legível por humanos.
model_settings

ModelSettings

Opcional. Configurações do modelo de LLM.
instruction

string

Opcional. Instruções para o modelo de LLM orientar o comportamento do agente.
tools[]

string

Opcional. Lista de ferramentas disponíveis para o agente. Formato: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
child_agents[]

string

Opcional. Lista de agentes filhos na árvore de agentes. Formato: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
before_agent_callbacks[]

Callback

Opcional. Os callbacks a serem executados antes da chamada do agente. Os callbacks fornecidos são executados sequencialmente na ordem exata em que aparecem na lista. Se um callback retornar uma resposta substituída, a execução será interrompida e os callbacks restantes serão ignorados.
after_agent_callbacks[]

Callback

Opcional. Os retornos de chamada a serem executados depois que o agente for chamado. Os callbacks fornecidos são executados sequencialmente na ordem exata em que aparecem na lista. Se um callback retornar uma resposta substituída, a execução será interrompida e os callbacks restantes serão ignorados.
before_model_callbacks[]

Callback

Opcional. Os callbacks a serem executados antes de chamar o modelo. Se houver várias chamadas para o modelo, o callback será executado várias vezes. Os callbacks fornecidos são executados sequencialmente na ordem exata em que aparecem na lista. Se um callback retornar uma resposta substituída, a execução será interrompida e os callbacks restantes serão ignorados.
after_model_callbacks[]

Callback

Opcional. Os callbacks a serem executados depois que o modelo é chamado. Se houver várias chamadas para o modelo, o callback será executado várias vezes. Os callbacks fornecidos são executados sequencialmente na ordem exata em que aparecem na lista. Se um callback retornar uma resposta substituída, a execução será interrompida e os callbacks restantes serão ignorados.
before_tool_callbacks[]

Callback

Opcional. Os callbacks a serem executados antes da invocação da ferramenta. Se houver várias invocações de ferramentas, o callback será executado várias vezes. Os callbacks fornecidos são executados sequencialmente na ordem exata em que aparecem na lista. Se um callback retornar uma resposta substituída, a execução será interrompida e os callbacks restantes serão ignorados.
after_tool_callbacks[]

Callback

Opcional. Os callbacks a serem executados depois que a ferramenta for invocada. Se houver várias invocações de ferramentas, o callback será executado várias vezes. Os callbacks fornecidos são executados sequencialmente na ordem exata em que aparecem na lista. Se um callback retornar uma resposta substituída, a execução será interrompida e os callbacks restantes serão ignorados.
create_time

Timestamp

Apenas saída. Carimbo de data/hora em que o agente foi criado.
update_time

Timestamp

Apenas saída. Carimbo de data/hora da última atualização do agente.
guardrails[]

string

Opcional. Lista de proteções do agente. Formato: projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}
etag

string

Etag usada para garantir que o objeto não mudou durante uma operação de leitura-modificação-gravação. Se a ETag estiver vazia, a atualização vai substituir todas as mudanças simultâneas.
toolsets[]

Agent.AgentToolset

Opcional. Lista de conjuntos de ferramentas para o agente.
generated_summary

string

Apenas saída. Se o agente for gerado pelo assistente de LLM, esse campo vai conter um resumo descritivo da geração.
transfer_rules[]

TransferRule

Opcional. Regras de transferência de agente. Se várias regras forem correspondentes, a primeira da lista será usada.
Campo de união agent_type. O tipo de agente. agent_type pode ser apenas de um dos tipos a seguir:
llm_agent

Agent.LlmAgent

Opcional. O tipo de agente padrão.
remote_dialogflow_agent

Agent.RemoteDialogflowAgent

Opcional. O agente Dialogflow remoto a ser usado para a execução do agente. Se esse campo for definido, todas as outras propriedades no nível do agente serão ignoradas.

Observação: se o agente do Dialogflow estiver em um projeto diferente do app, conceda roles/dialogflow.client ao agente de serviço do CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.

AgentToolset

Um conjunto de ferramentas com uma seleção delas.

Campos
toolset

string

Obrigatório. O nome do recurso do conjunto de ferramentas. Formato: projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}
tool_ids[]

string

Opcional. Os IDs das ferramentas para filtrar o conjunto de ferramentas.

LlmAgent

Esse tipo não tem campos.

Tipo de agente padrão. O agente usa instruções e callbacks especificados nele para realizar a tarefa usando um modelo de linguagem grande.

RemoteDialogflowAgent

O agente que vai transferir a execução para um agente remoto do Dialogflow CX. O agente do Dialogflow vai processar as consultas subsequentes do usuário até que a sessão ou o fluxo termine, e o controle seja transferido de volta para o agente principal do CES.

Campos
agent

string

Obrigatório. O nome do recurso do agente do Dialogflow. Formato: projects/{project}/locations/{location}/agents/{agent}
flow_id

string

Opcional. O ID do fluxo no agente do Dialogflow.
environment_id

string

Opcional. O ID do ambiente do agente do Dialogflow que será usado para a execução do agente. Se não for especificado, o ambiente de rascunho será usado.
input_variable_mapping

map<string, string>

Opcional. O mapeamento dos nomes das variáveis do app para os nomes dos parâmetros da sessão do Dialogflow que serão enviados ao agente do Dialogflow como entrada.
output_variable_mapping

map<string, string>

Opcional. O mapeamento dos nomes dos parâmetros da sessão do Dialogflow para os nomes das variáveis do app que serão enviadas de volta ao agente do CES após o término da execução do agente do Dialogflow.
respect_response_interruption_settings

bool

Opcional. Indica se as configurações de interrupção no nível da mensagem configuradas no agente do Dialogflow devem ser respeitadas.

  • Se for "false", todas as mensagens de resposta do agente do Dialogflow vão seguir as configurações de interrupção no nível do app.
  • Se for verdadeiro: apenas as mensagens de resposta com allow_playback_interruption definido como "true" poderão ser interrompidas. Todas as outras mensagens seguem as configurações de interrupção no nível do app.

AgentTransfer

Representa um evento que indica a transferência de uma conversa para outro agente.

Campos
target_agent

string

Obrigatório. O agente para quem a conversa está sendo transferida. O agente vai cuidar da conversa a partir desse ponto. Formato: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
display_name

string

Apenas saída. Nome de exibição do agente.

AmbientSoundConfig

Configuração para o som ambiente a ser reproduzido com a resposta sintetizada do agente, para aumentar a naturalidade da conversa.

Campos
volume_gain_db

double

Opcional. Ganho (em dB) do volume nativo normal suportado pelo ruído ambiente, no intervalo [-96.0, 16.0]. Se não for definido, ou ajustado para um valor de 0,0 (dB), será reproduzido na amplitude de sinal nativo normal. Um valor de -6,0 (dB) será reproduzido em aproximadamente metade da amplitude do sinal nativo normal. Um valor de +6,0 (dB) será reproduzido em aproximadamente o dobro da amplitude do sinal nativo normal. É altamente recomendável não exceder +10 (dB). Geralmente, não há aumento efetivo de volume para qualquer valor maior que isso.
Campo de união source. Ruído ambiente a ser reproduzido com a resposta sintetizada do agente para aumentar a naturalidade da conversa. source pode ser apenas de um dos tipos a seguir:
prebuilt_ambient_noise
(deprecated)

AmbientSoundConfig.PrebuiltAmbientNoise

Opcional. Descontinuado: prebuilt_ambient_noise foi descontinuado em favor de prebuilt_ambient_sound.
gcs_uri

string

Opcional. Ruído ambiente como um arquivo WAV de 16 kHz de canal único armazenado no Cloud Storage.

Observação: verifique se o agente de serviço do CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com tem permissão storage.objects.get para o objeto do Cloud Storage.
prebuilt_ambient_sound

string

Opcional. Nome do som ambiente predefinido. Os valores válidos são: "coffee_shop", "keyboard", "keypad", "hum", "office_1", "office_2", "office_3", "room_1", "room_2", "room_3", "room_4", "room_5", "air_conditioner".

PrebuiltAmbientNoise

Ruído ambiente pré-criado.

Tipos enumerados
PREBUILT_AMBIENT_NOISE_UNSPECIFIED Não especificado.
RETAIL_STORE Ruído ambiente de uma loja de varejo.
CONVENTION_HALL Ruído ambiente de um centro de convenções.
OUTDOOR Ruído ambiente de uma rua.

ApiAuthentication

Informações de autenticação necessárias para chamadas de API.

Campos
Campo de união auth_config. A configuração de autenticação. auth_config pode ser apenas de um dos tipos a seguir:
api_key_config

ApiKeyConfig

Opcional. Configuração para autenticação de chave de API.
oauth_config

OAuthConfig

Opcional. Configuração para OAuth.
service_agent_id_token_auth_config

ServiceAgentIdTokenAuthConfig

Opcional. Configuração para autenticação de token de ID gerada pelo agente de serviço do CES.
service_account_auth_config

ServiceAccountAuthConfig

Opcional. Configuração para autenticação de conta de serviço.
bearer_token_config

BearerTokenConfig

Opcional. Configuração para autenticação de token do portador.

ApiKeyConfig

Configurações para autenticação com chave de API.

Campos
key_name

string

Obrigatório. O nome do parâmetro ou do cabeçalho da chave de API. Ex.: Se a solicitação de API for "https://example.com/act?X-Api-Key=", "X-Api-Key" será o nome do parâmetro.
api_key_secret_version

string

Obrigatório. O nome do recurso da versão do secret do Secret Manager que armazena a chave de API. Formato: projects/{project}/secrets/{secret}/versions/{version}

Observação: conceda o papel roles/secretmanager.secretAccessor ao agente de serviço do CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.
request_location

ApiKeyConfig.RequestLocation

Obrigatório. Localização da chave na solicitação.

RequestLocation

O local da chave de API na solicitação.

Tipos enumerados
REQUEST_LOCATION_UNSPECIFIED Não especificado. Esse valor não deve ser usado.
HEADER Representa a chave no cabeçalho HTTP.
QUERY_STRING Representa a chave na string de consulta.

App

Um app serve como um contêiner de nível superior para um grupo de agentes, incluindo o agente raiz e os subagentes, além das configurações associadas. Esses agentes trabalham juntos para alcançar metas específicas no contexto do app.

Campos
name

string

Identificador. O identificador exclusivo do app. Formato: projects/{project}/locations/{location}/apps/{app}
display_name

string

Obrigatório. Nome de exibição do app.
description

string

Opcional. Descrição legível do app.
pinned

bool

Opcional. Se o app está fixado na lista de apps.
root_agent

string

Opcional. O agente raiz é o ponto de entrada do app. Formato: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
language_settings

LanguageSettings

Opcional. Configurações de idioma do app.
time_zone_settings

TimeZoneSettings

Opcional. Configurações de fuso horário do app.
audio_processing_config

AudioProcessingConfig

Opcional. Configuração de processamento de áudio do app.
logging_settings

LoggingSettings

Opcional. Configurações de registro do app.
error_handling_settings

ErrorHandlingSettings

Opcional. Configurações de tratamento de erros do app.
model_settings

ModelSettings

Opcional. As configurações padrão do modelo de LLM para o app. Recursos individuais (por exemplo, agentes, mecanismos de proteção) podem substituir essas configurações conforme necessário.
tool_execution_mode

App.ToolExecutionMode

Opcional. O modo de execução da ferramenta para o app. Se não for fornecido, o padrão será PARALLEL.
evaluation_metrics_thresholds

EvaluationMetricsThresholds

Opcional. Os limites de avaliação do app.
variable_declarations[]

App.VariableDeclaration

Opcional. As declarações das variáveis.
predefined_variable_declarations[]

App.VariableDeclaration

Apenas saída. As declarações de variáveis predefinidas para o app.
global_instruction

string

Opcional. Instruções para todos os agentes no app. Use essa instrução para definir uma identidade ou personalidade estável em todos os agentes.
guardrails[]

string

Opcional. Lista de proteções para o app. Formato: projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}
data_store_settings

DataStoreSettings

Opcional. As configurações do repositório de dados para o app.
default_channel_profile

ChannelProfile

Opcional. O perfil de canal padrão usado pelo app.
metadata

map<string, string>

Opcional. Metadados sobre o app. Esse campo pode ser usado para armazenar informações adicionais relevantes para os detalhes ou usos pretendidos do app.
create_time

Timestamp

Apenas saída. Carimbo de data/hora da criação do app.
update_time

Timestamp

Apenas saída. Carimbo de data/hora em que o app foi atualizado pela última vez.
etag

string

Apenas saída. Etag usada para garantir que o objeto não mudou durante uma operação de leitura-modificação-gravação. Se a ETag estiver vazia, a atualização vai substituir todas as mudanças simultâneas.
deployment_count

int32

Apenas saída. Número de implantações no app.
client_certificate_settings

ClientCertificateSettings

Opcional. As configurações padrão de certificado do cliente para o app.
locked

bool

Opcional. Indica se o app está bloqueado para mudanças. Se o app estiver bloqueado, as modificações nos recursos dele serão rejeitadas.

ToolExecutionMode

Define o comportamento de execução da ferramenta se houver várias ferramentas sendo selecionadas pelo agente ao mesmo tempo.

Tipos enumerados
TOOL_EXECUTION_MODE_UNSPECIFIED Modo de execução de ferramenta não especificado. O padrão é PARALLEL.
PARALLEL Se várias ferramentas forem selecionadas, elas serão executadas em paralelo, com o mesmo ToolContext.
SEQUENTIAL Se várias ferramentas forem selecionadas, elas serão executadas em sequência. A próxima ferramenta só será executada depois que a anterior for concluída e poderá ver o ToolContext atualizado da ferramenta anterior.

VariableDeclaration

Define a estrutura e os metadados de uma variável.

Campos
name

string

Obrigatório. O nome da variável. O nome precisa começar com uma letra ou um sublinhado e conter apenas letras, números ou sublinhados.
description

string

Obrigatório. A descrição da variável.
schema

Schema

Obrigatório. O esquema da variável.

AppSnapshot

Um snapshot do app.

Campos
app

App

Opcional. As configurações básicas do app.
agents[]

Agent

Opcional. Lista de agentes no app.
tools[]

Tool

Opcional. Lista de ferramentas no app.
examples[]

Example

Opcional. Lista de exemplos no app.
guardrails[]

Guardrail

Opcional. Lista de proteções no app.
toolsets[]

Toolset

Opcional. Lista de conjuntos de ferramentas no app.

AppVersion

Na Customer Engagement Suite (CES), uma versão do app é um snapshot do app em um momento específico. Ele é imutável e não pode ser modificado depois de criado.

Campos
name

string

Identificador. O identificador exclusivo da versão do app. Formato: projects/{project}/locations/{location}/apps/{app}/versions/{version}
display_name

string

Opcional. O nome de exibição da versão do app.
description

string

Opcional. A descrição da versão do app.
creator

string

Apenas saída. E-mail do usuário que criou a versão do app.
create_time

Timestamp

Apenas saída. Carimbo de data/hora em que a versão do app foi criada.
snapshot

AppSnapshot

Apenas saída. O snapshot do app quando a versão é criada.
etag

string

Apenas saída. Etag usada para garantir que o objeto não mudou durante uma operação de leitura-modificação-gravação. Se a ETag estiver vazia, a atualização vai substituir todas as mudanças simultâneas.

AudioEncoding

AudioEncoding especifica o formato de codificação para dados de áudio.

Tipos enumerados
AUDIO_ENCODING_UNSPECIFIED Codificação de áudio não especificada.
LINEAR16 Codificação de áudio PCM linear de 16 bits.
MULAW Amostras de 8 bits resultantes do compand de amostras de áudio de 14 bits em que foi usado G.711 PCMU/mu-law.
ALAW Amostras de 8 bits resultantes do compand de amostras de áudio de 14 bits em que foi usado G.711 PCMU/A-law.

AudioProcessingConfig

Configuração de como o áudio de entrada e saída deve ser processado e entregue.

Campos
synthesize_speech_configs

map<string, SynthesizeSpeechConfig>

Opcional. Configuração de como a resposta do agente deve ser sintetizada, mapeando do código de idioma para SynthesizeSpeechConfig.

Se a configuração do código de idioma especificado não for encontrada, a configuração do código de idioma raiz será usada. Por exemplo, se o mapa contiver "en-us" e "en", e o código de idioma especificado for "en-gb", a configuração "en" será usada.

Observação: o código do idioma não diferencia maiúsculas de minúsculas.
barge_in_config

BargeInConfig

Opcional. Configura o comportamento do agente para as atividades de interrupção do usuário.
inactivity_timeout

Duration

Opcional. A duração da inatividade do usuário (sem fala ou interação) antes que o agente peça para ele interagir novamente. Se não for definido, o agente não vai pedir que o usuário se envolva novamente.
ambient_sound_config

AmbientSoundConfig

Opcional. Configuração para o som ambiente a ser reproduzido com a resposta sintetizada do agente, para aumentar a naturalidade da conversa.

AudioRecordingConfig

Configuração de como as interações de áudio devem ser gravadas.

Campos
gcs_bucket

string

Opcional. O bucket do Cloud Storage para armazenar as gravações de áudio da sessão. O URI precisa começar com "gs://".

Escolha um local de bucket que atenda aos seus requisitos de residência de dados.

Observação: se o bucket do Cloud Storage estiver em um projeto diferente do app, conceda a permissão storage.objects.create ao agente de serviço do CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.
gcs_path_prefix

string

Opcional. O prefixo do caminho do Cloud Storage para gravações de áudio.

Esse prefixo pode incluir os seguintes marcadores de posição, que serão substituídos dinamicamente no momento da veiculação: - $project: ID do projeto - $location: local do app - $app: ID do app - $date: data da sessão no formato AAAA-MM-DD - $session: ID da sessão

Se o prefixo de caminho não for especificado, o prefixo padrão $project/$location/$app/$date/$session/ será usado.

BargeInConfig

Configuração de como as atividades de interrupção do usuário devem ser processadas.

Campos
disable_barge_in
(deprecated)

bool

Opcional. Desativa a interrupção do usuário enquanto o agente está falando. Se for verdadeiro, a entrada do usuário durante a reprodução da resposta do agente será ignorada.

Descontinuado: disable_barge_in foi descontinuado em favor de disable_barge_in_control em ChannelProfile.
barge_in_awareness

bool

Opcional. Se ativado, o agente vai adaptar a próxima resposta com base na suposição de que o usuário não ouviu a mensagem completa anterior do agente. Isso não deve ser usado em cenários em que as respostas do agente são mostradas visualmente.

BatchDeleteConversationsRequest

Mensagem de solicitação para AgentService.BatchDeleteConversations.

Campos
parent

string

Obrigatório. O nome do recurso do app de que as conversas serão excluídas. Formato: projects/{project}/locations/{location}/apps/{app}
conversations[]

string

Obrigatório. Os nomes de recursos das conversas a serem excluídas.

BatchDeleteConversationsResponse

Mensagem de resposta para AgentService.BatchDeleteConversations.

Campos
deleted_conversations[]

string

A lista de conversas excluídas.
failed_conversations[]

string

A lista de conversas que não foram excluídas.
error_messages[]

string

Opcional. Uma lista de mensagens de erro associadas a conversas que não foram excluídas.

BearerTokenConfig

Configurações para autenticação com um token do portador.

Campos
token

string

Obrigatório. O token do portador. Precisa estar no formato $context.variables.<name_of_variable>.

BidiSessionClientMessage

A mensagem de nível superior enviada pelo cliente para o método SessionService.BidiRunSession.

Campos
Campo de união message_type. É o tipo de mensagem. message_type pode ser apenas de um dos tipos a seguir:
config

SessionConfig

Opcional. A mensagem de configuração inicial da sessão.
realtime_input

SessionInput

Opcional. Entrada em tempo real para a sessão.

BidiSessionServerMessage

A mensagem de nível superior retornada do método SessionService.BidiRunSession.

Campos
Campo de união message_type. É o tipo de mensagem. message_type pode ser apenas de um dos tipos a seguir:
session_output

SessionOutput

Opcional. Processando o resultado do agente do CES.
recognition_result

RecognitionResult

Opcional. Resultado do reconhecimento de fala em tempo real para a entrada de áudio.
interruption_signal

InterruptionSignal

Opcional. Indica que a resposta de áudio do agente foi interrompida.
end_session

EndSession

Opcional. Indica que a sessão foi encerrada.
go_away

GoAway

Opcional. Indica que o servidor será desconectado em breve e que o cliente precisa fechar parcialmente e reiniciar a conexão.

BigQueryExportSettings

Configurações para descrever os comportamentos de exportação do BigQuery para o app.

Campos
enabled

bool

Opcional. Indica se a exportação do BigQuery está ativada.
project

string

Opcional. O ID do projeto do conjunto de dados do BigQuery para exportar os dados.

Observação: se o conjunto de dados do BigQuery estiver em um projeto diferente do app, conceda o papel roles/bigquery.admin ao agente de serviço do CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.
dataset

string

Opcional. O conjunto de dados do BigQuery para exportar os dados.

Blob

Representa uma entrada ou saída de blob na conversa.

Campos
mime_type

string

Obrigatório. O tipo MIME padrão da IANA dos dados de origem.
data

bytes

Obrigatório. Bytes brutos do blob.

Callback

Um callback define a lógica personalizada a ser executada em vários estágios da interação do agente.

Campos
description

string

Opcional. Descrição legível do callback.
disabled

bool

Opcional. Se o callback está desativado. Os retornos de chamada desativados são ignorados pelo agente.
proactive_execution_enabled

bool

Opcional. Se ativado, o callback também será executado em saídas intermediárias do modelo. Essa configuração só afeta o retorno de chamada após o modelo. ATIVE COM CUIDADO. Normalmente, o callback do modelo só precisa ser executado depois de receber todas as respostas do modelo. Ativar a execução proativa pode ter implicações negativas no custo e na latência da execução. Portanto, essa opção só deve ser ativada em situações raras.
Campo de união callback. O callback a ser executado. callback pode ser apenas de um dos tipos a seguir:
python_code

string

Obrigatório. O código Python a ser executado para o callback.

Registro de alterações

Os registros de mudanças representam uma alteração feita no app ou em um recurso dele.

Campos
name

string

Identificador. O identificador exclusivo do changelog. Formato: projects/{project}/locations/{location}/apps/{app}/changelogs/{changelog}
author

string

Apenas saída. Endereço de e-mail do autor da mudança.
display_name

string

Apenas saída. Nome de exibição da mudança. Normalmente, é o nome de exibição do recurso que foi alterado.
description

string

Apenas saída. Descrição da mudança, que normalmente captura os campos alterados no recurso.
resource

string

Apenas saída. O recurso que foi alterado.
resource_type

string

Apenas saída. O tipo de recurso que foi alterado.
action

string

Apenas saída. A ação realizada no recurso.
original_resource

Struct

Apenas saída. O recurso original antes da mudança.
new_resource

Struct

Apenas saída. O novo recurso após a mudança.
dependent_resources[]

Struct

Apenas saída. Os recursos dependentes que foram alterados.
create_time

Timestamp

Apenas saída. O horário em que a mudança foi feita.
sequence_number

int64

Apenas saída. O número de sequência monotonicamente crescente do changelog.

ChannelProfile

Um ChannelProfile configura o comportamento do agente para um canal de comunicação específico, como UI da Web ou telefonia.

Campos
profile_id

string

Opcional. O identificador exclusivo do perfil do canal.
channel_type

ChannelProfile.ChannelType

Opcional. O tipo do perfil do canal.
persona_property

ChannelProfile.PersonaProperty

Opcional. A propriedade de persona do perfil do canal.
disable_dtmf

bool

Opcional. Indica se o DTMF (multifrequência de dois tons) será desativado.
disable_barge_in_control

bool

Opcional. Se o controle de interrupção do usuário na conversa deve ser desativado. - true: as interrupções do usuário são desativadas enquanto o agente está falando. - false: o agente mantém o controle automático sobre quando o usuário pode interromper.
web_widget_config

ChannelProfile.WebWidgetConfig

Opcional. A configuração do widget da Web.
noise_suppression_level

string

Opcional. O nível de supressão de ruído do perfil do canal. Os valores disponíveis são "low", "moderate", "high", "very_high".

ChannelType

O tipo do perfil do canal.

Tipos enumerados
UNKNOWN Tipo de canal desconhecido.
WEB_UI Canal da interface da Web.
API Canal da API.
TWILIO Canal do Twilio.
GOOGLE_TELEPHONY_PLATFORM Canal da plataforma de telefonia do Google.
CONTACT_CENTER_AS_A_SERVICE Canal de central de atendimento como serviço (CCaaS).
FIVE9 Canal da Five9.
CONTACT_CENTER_INTEGRATION Canal de integração de contact center de terceiros.

PersonaProperty

Representa a propriedade de persona de um canal.

Campos
persona

ChannelProfile.PersonaProperty.Persona

Opcional. A persona do canal.

Persona

A persona do canal.

Tipos enumerados
UNKNOWN Perfil UNKNOWN.
CONCISE O agente mantém as respostas concisas e diretas
CHATTY O agente fornece mais contexto, explicações e detalhes

WebWidgetConfig

Mensagem para configuração do widget da Web.

Campos
modality

ChannelProfile.WebWidgetConfig.Modality

Opcional. A modalidade do widget da Web.
theme

ChannelProfile.WebWidgetConfig.Theme

Opcional. O tema do widget da Web.
web_widget_title

string

Opcional. O título do widget da Web.
security_settings

ChannelProfile.WebWidgetConfig.SecuritySettings

Opcional. As configurações de segurança do widget da Web.

Modalidade

Modalidade do widget da Web.

Tipos enumerados
MODALITY_UNSPECIFIED Modalidade desconhecida.
CHAT_AND_VOICE O widget é compatível com entrada de texto e de voz.
VOICE_ONLY O widget só aceita entrada de voz.
CHAT_ONLY O widget só aceita entrada de chat.

SecuritySettings

Configurações de segurança para o widget da Web.

Campos
enable_public_access

bool

Opcional. Indica se o acesso público ao widget da Web está ativado. Se for true, o widget da Web será acessível publicamente. Se false, o widget da Web precisará ser integrado ao seu próprio sistema de autenticação e autorização para retornar credenciais válidas de acesso ao agente da CES.
enable_origin_check

bool

Opcional. Indica se a verificação de origem do widget da Web está ativada. Se true, o widget da Web vai verificar a origem do site que o carrega e permitir que ele seja carregado apenas na mesma origem ou em qualquer uma das origens permitidas.
allowed_origins[]

string

Opcional. As origens que podem hospedar o widget da Web. Uma origem é definida pela RFC 6454. Se estiver vazio, todas as origens serão permitidas. São permitidas no máximo 100 origens. Exemplo: "https://example.com"
enable_recaptcha

bool

Opcional. Indica se a verificação do reCAPTCHA para o widget da Web está ativada.

Tema

Tema do widget da Web.

Tipos enumerados
THEME_UNSPECIFIED Tema desconhecido.
LIGHT Tema claro.
DARK Tema escuro.

Chunk

Um trecho de conteúdo em uma mensagem.

Campos
Campo de união data. Dados de bloco. data pode ser apenas de um dos tipos a seguir:
text

string

Opcional. Dados de texto.
transcript

string

Opcional. Transcrição associada ao áudio.
blob

Blob

Opcional. Dados de blob.
payload

Struct

Opcional. Dados de payload personalizados.
image

Image

Opcional. Dados da imagem.
tool_call

ToolCall

Opcional. Solicitação de execução de ferramenta.
tool_response

ToolResponse

Opcional. Resposta de execução da ferramenta.
agent_transfer

AgentTransfer

Opcional. Evento de transferência de agente.
updated_variables

Struct

Uma struct representa variáveis que foram atualizadas na conversa, com chaves pelos nomes das variáveis.
default_variables

Struct

Uma struct representa variáveis padrão no início da conversa, com chaves de nomes de variáveis.

Citações

Citações associadas à resposta do agente.

Campos
cited_chunks[]

Citations.CitedChunk

Lista de informações citadas.

CitedChunk

Parte das informações citadas.

Campos
uri

string

URI usado para citação.
title

string

Título do documento citado.
text

string

Texto usado para citação.

ClientCertificateSettings

Configurações para certificados de cliente personalizados.

Campos
tls_certificate

string

Obrigatório. O certificado TLS codificado no formato PEM. Essa string precisa incluir as linhas de cabeçalho de início e rodapé de fim.
private_key

string

Obrigatório. O nome do recurso de versão do secret do Secret Manager que armazena a chave privada codificada no formato PEM. Formato: projects/{project}/secrets/{secret}/versions/{version}
passphrase

string

Opcional. O nome do recurso da versão do secret do Secret Manager que armazena a senha longa para descriptografar a chave privada. Deve ser deixado sem definição se a chave privada não estiver criptografada. Formato: projects/{project}/secrets/{secret}/versions/{version}

ClientFunction

Representa uma função do lado do cliente que o agente pode invocar. Quando a ferramenta é escolhida pelo agente, o controle é transferido para o cliente. O cliente é responsável por executar a função e retornar o resultado como um ToolResponse para continuar a interação com o agente.

Campos
name

string

Obrigatório. O nome da função.
description

string

Opcional. A descrição da função.
parameters

Schema

Opcional. O esquema dos parâmetros da função.
response

Schema

Opcional. O esquema da resposta da função.

CloudLoggingSettings

Configurações para descrever os comportamentos do Cloud Logging para o app.

Campos
enable_cloud_logging

bool

Opcional. Define se o Cloud Logging será ativado para as sessões.

CodeBlock

Um bloco de código a ser executado em vez de uma chamada de ferramenta real.

Campos
python_code

string

Obrigatório. Código Python que será invocado no modo simulado da ferramenta. Assinatura esperada da função Python: para capturar todas as chamadas de ferramenta: def fake_tool_call(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: para capturar uma chamada de ferramenta específica: def fake_{tool_id}(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: se a função retornar "None", a ferramenta real será invocada.

ConnectorTool

Uma ConnectorTool permite conexões com diferentes integrações. Consulte: https://cloud.google.com/integration-connectors/docs/overview.

Campos
connection

string

Obrigatório. O nome completo do recurso da conexão referenciada do Integration Connectors. Formato: projects/{project}/locations/{location}/connections/{connection}
action

Action

Obrigatório. Ação que a ferramenta vai usar.
auth_config

EndUserAuthConfig

Opcional. Configura como a autenticação é processada nos Integration Connectors. Por padrão, uma autenticação de administrador é transmitida nas solicitações da API Integration Connectors. É possível substituir essa configuração com outra de autenticação do usuário final. Observação: a conexão precisa ter a substituição de autenticação ativada para especificar uma configuração de EUC aqui. Caso contrário, a criação do ConnectorTool vai falhar. Consulte https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override para mais detalhes.
name

string

Opcional. O nome da ferramenta que pode ser usada pelo agente para decidir se vai chamar esse ConnectorTool.
description

string

Opcional. A descrição da ferramenta que pode ser usada pelo agente para decidir se deve chamar esse ConnectorTool.

ConnectorToolset

Um conjunto de ferramentas que gera ferramentas de uma conexão do Integration Connectors.

Campos
connection

string

Obrigatório. O nome completo do recurso da conexão referenciada do Integration Connectors. Formato: projects/{project}/locations/{location}/connections/{connection}
auth_config

EndUserAuthConfig

Opcional. Configura como a autenticação é processada nos Integration Connectors. Por padrão, uma autenticação de administrador é transmitida nas solicitações da API Integration Connectors. É possível substituir essa configuração com outra de autenticação do usuário final. Observação: a conexão precisa ter a substituição de autenticação ativada para especificar uma configuração de EUC aqui. Caso contrário, a criação do conjunto de ferramentas vai falhar. Consulte: https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override
connector_actions[]

Action

Obrigatório. A lista de ações do conector/operações de entidade para gerar ferramentas.

Conversa

Uma conversa representa uma interação entre um usuário final e o app CES.

Campos
name

string

Identificador. O identificador exclusivo da conversa. Formato: projects/{project}/locations/{location}/apps/{app}/conversations/{conversation}
start_time

Timestamp

Apenas saída. Carimbo de data/hora em que a conversa foi criada.
end_time

Timestamp

Apenas saída. Carimbo de data/hora em que a conversa foi concluída.
turns[]

Conversation.Turn

Obrigatório. As rodadas da conversa.
turn_count

int32

Apenas saída. O número de turnos na conversa.
channel_type
(deprecated)

Conversation.ChannelType

OBSOLETO. Use input_types.
source

Conversation.Source

Apenas saída. Indique a origem da conversa.
input_types[]

Conversation.InputType

Apenas saída. Os tipos de entrada da conversa.
entry_agent

string

Apenas saída. O agente que inicialmente lida com a conversa. Se não for especificado, a conversa será processada pelo agente raiz. Formato: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
deployment

string

Apenas saída. A implantação do app usado para processar a conversa. Formato: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
app_version

string

Apenas saída. A versão do app usada para processar a conversa. Formato: projects/{project}/locations/{location}/apps/{app}/versions/{version}
language_code

string

Apenas saída. O código do idioma da conversa.
messages[]
(deprecated)

Message

Obsoleto. Use turnos.

ChannelType

O tipo de canal da conversa.

Tipos enumerados
CHANNEL_TYPE_UNSPECIFIED Tipo de canal não especificado.
TEXT A conversa contém apenas mensagens de texto entre o usuário final e o agente.
AUDIO A conversa contém mensagens de áudio entre o usuário final e o agente.
MULTIMODAL As mensagens multimodais de conversa (por exemplo, imagem) entre o usuário final e o agente.

InputType

Tipo da mensagem de entrada.

Tipos enumerados
INPUT_TYPE_UNSPECIFIED Tipo de entrada não especificado.
INPUT_TYPE_TEXT A mensagem de entrada é texto.
INPUT_TYPE_AUDIO A mensagem de entrada é de áudio.
INPUT_TYPE_IMAGE A mensagem de entrada é uma imagem.
INPUT_TYPE_BLOB A mensagem de entrada é um arquivo blob.
INPUT_TYPE_TOOL_RESPONSE A mensagem de entrada é a resposta da ferramenta de função do cliente.
INPUT_TYPE_VARIABLES A mensagem de entrada são variáveis.

Origem

A origem da conversa.

Tipos enumerados
SOURCE_UNSPECIFIED Origem não especificada.
LIVE A conversa é do usuário final.
SIMULATOR A conversa é do simulador.
EVAL A conversa é da avaliação.

Turn

Todas as informações sobre uma única rodada na conversa.

Campos
messages[]

Message

Opcional. Lista de mensagens no turno da conversa, incluindo entrada do usuário, respostas do agente e eventos intermediários durante o processamento.
root_span

Span

Opcional. O intervalo principal do processamento da ação.

ConversationLoggingSettings

Configurações para descrever os comportamentos de registro de conversas do app.

Campos
disable_conversation_logging

bool

Opcional. Se a geração de registros de conversa deve ser desativada para as sessões.

CreateAgentRequest

Mensagem de solicitação para AgentService.CreateAgent.

Campos
parent

string

Obrigatório. O nome do recurso do app em que um agente será criado.
agent_id

string

Opcional. O ID a ser usado no agente, que se tornará o componente final do nome do recurso do agente. Se não for fornecido, um ID exclusivo será atribuído automaticamente ao agente.
agent

Agent

Obrigatório. O agente a ser criado.

CreateAppRequest

Mensagem de solicitação para AgentService.CreateApp.

Campos
parent

string

Obrigatório. O nome do recurso do local em que um app será criado.
app_id

string

Opcional. O ID a ser usado no app, que se tornará o componente final do nome do recurso do app. Se não for fornecido, um ID exclusivo será atribuído automaticamente ao app.
app

App

Obrigatório. O app a ser criado.

CreateAppVersionRequest

Mensagem de solicitação para AgentService.CreateAppVersion

Campos
parent

string

Obrigatório. O nome do recurso do app em que uma versão será criada.
app_version_id

string

Opcional. O ID a ser usado na versão do app, que se tornará o componente final do nome do recurso da versão do app. Se não for fornecido, um ID exclusivo será atribuído automaticamente à versão do app.
app_version

AppVersion

Obrigatório. A versão do app a ser criada.

CreateDeploymentRequest

Mensagem de solicitação para AgentService.CreateDeployment.

Campos
parent

string

Obrigatório. O app principal. Formato: projects/{project}/locations/{location}/apps/{app}
deployment_id

string

Opcional. O ID a ser usado na implantação, que se tornará o componente final do nome do recurso da implantação. Se não for fornecido, um ID exclusivo será atribuído automaticamente à implantação.
deployment

Deployment

Obrigatório. A implantação a ser criada.

CreateExampleRequest

Mensagem de solicitação para AgentService.CreateExample.

Campos
parent

string

Obrigatório. O nome do recurso do app em que um exemplo será criado.
example_id

string

Opcional. O ID a ser usado no exemplo, que se tornará o componente final do nome do recurso do exemplo. Se não for fornecido, um ID exclusivo será atribuído automaticamente ao exemplo.
example

Example

Obrigatório. O exemplo a ser criado.

CreateGuardrailRequest

Mensagem de solicitação para AgentService.CreateGuardrail.

Campos
parent

string

Obrigatório. O nome do recurso do app em que um guardrail será criado.
guardrail_id

string

Opcional. O ID a ser usado no guardrail, que se tornará o componente final do nome do recurso do guardrail. Se não for fornecido, um ID exclusivo será atribuído automaticamente à proteção.
guardrail

Guardrail

Obrigatório. A proteção a ser criada.

CreateToolRequest

Mensagem de solicitação para AgentService.CreateTool.

Campos
parent

string

Obrigatório. O nome do recurso do app em que a ferramenta será criada.
tool_id

string

Opcional. O ID a ser usado na ferramenta, que se tornará o componente final do nome do recurso da ferramenta. Se não for fornecido, um ID exclusivo será atribuído automaticamente à ferramenta.
tool

Tool

Obrigatório. A ferramenta a ser criada.

CreateToolsetRequest

Mensagem de solicitação para AgentService.CreateToolset.

Campos
parent

string

Obrigatório. O nome do recurso do app em que um conjunto de ferramentas será criado.
toolset_id

string

Opcional. O ID a ser usado no conjunto de ferramentas, que se tornará o componente final do nome do recurso do conjunto de ferramentas. Se não for fornecido, um ID exclusivo será atribuído automaticamente ao conjunto de ferramentas.
toolset

Toolset

Obrigatório. O conjunto de ferramentas a ser criado.

DataStore

Um recurso DataStore na Vertex AI para Pesquisa.

Campos
name

string

Obrigatório. Nome completo do recurso do DataStore. Formato: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}
type

DataStore.DataStoreType

Apenas saída. O tipo do repositório de dados. Este campo é somente leitura e preenchido pelo servidor.
document_processing_mode

DataStore.DocumentProcessingMode

Apenas saída. O modo de processamento de documentos para a conexão do repositório de dados. Definido apenas para repositórios de dados PUBLIC_WEB e UNSTRUCTURED.
display_name

string

Apenas saída. O nome de exibição do repositório de dados.
create_time

Timestamp

Apenas saída. Carimbo de data/hora em que o repositório de dados foi criado.
connector_config

DataStore.ConnectorConfig

Apenas saída. A configuração do conector para a conexão do repositório de dados.

ConnectorConfig

A configuração do conector para a conexão do repositório de dados.

Campos
collection

string

Nome do recurso da coleção a que o repositório de dados pertence.
collection_display_name

string

Nome de exibição da coleção a que o repositório de dados pertence.
data_source

string

O nome da fonte de dados. Exemplo: salesforce, jira, confluence, bigquery.

DataStoreType

O tipo do repositório de dados.

Tipos enumerados
DATA_STORE_TYPE_UNSPECIFIED Não especificado. Esse valor indica que o tipo de repositório de dados não foi especificado e, portanto, não será usado durante a pesquisa.
PUBLIC_WEB Um repositório de dados que contém conteúdo da Web público.
UNSTRUCTURED Um repositório de dados que contém dados particulares não estruturados.
FAQ Um repositório de dados que contém dados estruturados usados como perguntas frequentes.
CONNECTOR Um repositório de dados que é um conector para um serviço próprio ou de terceiros.

DocumentProcessingMode

O modo de processamento de documentos do repositório de dados.

Tipos enumerados
DOCUMENT_PROCESSING_MODE_UNSPECIFIED Não especificado.
DOCUMENTS Os documentos são processados como documentos.
CHUNKS Os documentos são convertidos em partes.

DataStoreSettings

Configurações relacionadas ao repositório de dados do app.

Campos
engines[]

DataStoreSettings.Engine

Apenas saída. Os mecanismos do app.

Mecanismo

Um mecanismo a que os repositórios de dados estão conectados. Consulte a Vertex AI para Pesquisa: https://cloud.google.com/generative-ai-app-builder/docs/enterprise-search-introduction.

Campos
name

string

Apenas saída. O nome do recurso do mecanismo. Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}
type

DataStoreSettings.Engine.Type

Apenas saída. O tipo de motor.

Tipo

O tipo de motor. Consulte a documentação disponível em https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1/SolutionType e https://cloud.google.com/generative-ai-app-builder/docs/create-datastore-ingest.

Tipos enumerados
TYPE_UNSPECIFIED Tipo de motor não especificado.
ENGINE_TYPE_CHAT Tipo de mecanismo de chat. O mecanismo SOLUTION_TYPE_CHAT do app. Todos os repositórios de dados do conector adicionados ao app também serão adicionados a esse mecanismo.

DataStoreTool

Ferramenta para extrair do repositório de dados ou mecanismo da Vertex AI para Pesquisa para embasamento. Aceita um datastore ou um mecanismo, mas não ambos. Consulte a Vertex AI para Pesquisa: https://cloud.google.com/generative-ai-app-builder/docs/enterprise-search-introduction.

Campos
name

string

Obrigatório. O nome da ferramenta do repositório de dados.
description

string

Opcional. A descrição da ferramenta.
boost_specs[]

DataStoreTool.BoostSpecs

Opcional. Aumente a especificação para impulsionar determinados documentos.
modality_configs[]

DataStoreTool.ModalityConfig

Opcional. As configurações de modalidade do repositório de dados.
filter_parameter_behavior

DataStoreTool.FilterParameterBehavior

Opcional. O comportamento do parâmetro de filtro.
Campo de união search_source. Define a origem da pesquisa, que pode ser um único DataStore ou um Engine. search_source pode ser apenas de um dos tipos a seguir:
data_store_source

DataStoreTool.DataStoreSource

Opcional. Pesquise em um único DataStore específico.
engine_source

DataStoreTool.EngineSource

Opcional. Pesquise em um mecanismo (potencialmente em vários DataStores).

BoostSpec

Aumente a especificação para impulsionar determinados documentos.

Campos
condition_boost_specs[]

DataStoreTool.BoostSpec.ConditionBoostSpec

Obrigatório. Uma lista de especificações de reforço.

ConditionBoostSpec

Especificação de otimização para uma condição.

Campos
condition

string

Obrigatório. Uma expressão que especifica uma condição de reforço. A sintaxe é a mesma da expressão de filtro. No momento, a única condição aceita é uma lista de códigos de idioma BCP-47. Exemplo: para aumentar as sugestões nos idiomas en ou fr: (lang_code: ANY("en", "fr"))
boost

float

Opcional. Intensidade da otimização, que precisa estar em [-1, 1]. Reforço negativo significa rebaixamento. O padrão é 0,0.

Definir como 1.0 dá uma grande promoção às sugestões. No entanto, isso não significa necessariamente que o resultado principal será uma sugestão otimizada.

Definir como -1,0 rebaixa muito as sugestões. No entanto, outras sugestões relevantes ainda podem aparecer.

Definir como 0,0 significa que não há otimização aplicada. A condição de reforço é ignorada.
boost_control_spec

DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec

Opcional. Especificação complexa para classificação personalizada com base no valor de atributo definido pelo cliente.

BoostControlSpec

Especificação para classificação personalizada com base no valor do atributo especificado pelo cliente. Ela oferece mais controles para classificação personalizada do que a combinação simples (condição, reforço) acima.

Campos
field_name

string

Opcional. O nome do campo cujo valor será usado para determinar a quantidade de reforço.
attribute_type

DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec.AttributeType

Opcional. O tipo de atributo a ser usado para determinar o valor do reforço. O valor do atributo pode ser derivado do valor do campo do field_name especificado. No caso de valores numéricos, é simples: attribute_value = numerical_field_value. No caso da atualização, attribute_value = (time.now() - datetime_field_value).
interpolation_type

DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec.InterpolationType

Opcional. O tipo de interpolação a ser aplicado para conectar os pontos de controle listados abaixo.
control_points[]

DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPoint

Opcional. Os pontos de controle usados para definir a curva. A função monotônica (definida pelo interpolation_type acima) passa pelos pontos de controle listados aqui.

AttributeType

O atributo(ou função) a que o ranking personalizado será aplicado.

Tipos enumerados
ATTRIBUTE_TYPE_UNSPECIFIED AttributeType não especificado.
NUMERICAL O valor do campo numérico será usado para atualizar dinamicamente o valor do reforço. Nesse caso, o attribute_value (o valor x) do ponto de controle será o valor real do campo numérico para o qual o boost_amount é especificado.
FRESHNESS Para o caso de uso de atualização, o valor do atributo será a duração entre a hora atual e a data no campo de data e hora especificado. O valor precisa ser formatado como um valor dayTimeDuration XSD (um subconjunto restrito de um valor de duração ISO 8601). O padrão é: [nD][T[nH][nM][nS]]. Por exemplo: 5D, 3DT12H30M, T24H.

ControlPoint

Os pontos de controle usados para definir a curva. A curva definida por esses pontos de controle só pode ser monotonicamente crescente ou decrescente(valores constantes são aceitáveis).

Campos
attribute_value

string

Opcional. Pode ser um dos seguintes: 1. O valor do campo numérico. 2. A especificação de duração para atualização. O valor precisa ser formatado como um valor dayTimeDuration XSD (um subconjunto restrito de um valor de duração ISO 8601). O padrão é: [nD][T[nH][nM][nS]].
boost_amount

float

Opcional. O valor entre -1 e 1 pelo qual aumentar a pontuação se o atributo "attribute_value" for avaliado como o valor especificado acima.

InterpolationType

O tipo de interpolação a ser aplicado. O padrão é linear (linear por partes).

Tipos enumerados
INTERPOLATION_TYPE_UNSPECIFIED O tipo de interpolação não foi especificado. Nesse caso, o padrão é "Linear".
LINEAR A interpolação linear por partes será aplicada.

BoostSpecs

Aumente as especificações para impulsionar determinados documentos. Para mais informações, consulte https://cloud.google.com/generative-ai-app-builder/docs/boosting.

Campos
data_stores[]

string

Obrigatório. O repositório de dados em que a configuração de reforço é aplicada. Nome completo do recurso do DataStore, como projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}.
spec[]

DataStoreTool.BoostSpec

Obrigatório. Uma lista de especificações de reforço.

DataStoreSource

Configuração para pesquisar em um DataStore específico.

Campos
filter

string

Opcional. Especificação de filtro para o DataStore. Consulte: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata
data_store

DataStore

Opcional. O repositório de dados.

EngineSource

Configuração para pesquisar em um mecanismo, possivelmente segmentando DataStores específicos.

Campos
engine

string

Obrigatório. Nome completo do recurso do mecanismo. Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}
data_store_sources[]

DataStoreTool.DataStoreSource

Opcional. Usado para segmentar DataStores específicos no mecanismo. Se estiver vazio, a pesquisa será aplicada a todos os DataStores associados ao mecanismo.
filter

string

Opcional. Um filtro aplicado à pesquisa no mecanismo. Não é relevante nem usado se "data_store_sources" for fornecido. Consulte: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata

FilterParameterBehavior

Comportamento do parâmetro de filtro.

Tipos enumerados
FILTER_PARAMETER_BEHAVIOR_UNSPECIFIED Comportamento padrão do filtro. Inclua o parâmetro de filtro para repositórios de dados de conectores. Para os outros tipos de armazenamento de dados, o parâmetro de entrada do filtro é omitido.
ALWAYS_INCLUDE Sempre inclua o parâmetro de filtro para todos os tipos de armazenamento de dados.
NEVER_INCLUDE O parâmetro de filtro nunca é incluído na lista de parâmetros da ferramenta, seja qual for o tipo de armazenamento de dados.

GroundingConfig

Configuração de embasamento.

Campos
grounding_level

float

Opcional. O limite de embasamento da resposta com base nas fontes recuperadas. O valor tem um intervalo configurável de [1, 5]. O nível é usado para definir o limite de embasamento da resposta. Isso significa que todas as respostas com uma pontuação de embasamento abaixo do limite vão retornar apenas snippets relevantes.

Por exemplo, um nível 3 significa que a pontuação de embasamento precisa ser 3 ou mais para que a resposta seja retornada.
disabled

bool

Opcional. Se o embasamento está desativado.

ModalityConfig

Se especificado, vai aplicar a configuração à modalidade especificada.

Campos
modality_type

DataStoreTool.ModalityConfig.ModalityType

Obrigatório. O tipo de modalidade.
rewriter_config

DataStoreTool.RewriterConfig

Opcional. A configuração do rewriter.
summarization_config

DataStoreTool.SummarizationConfig

Opcional. A configuração de resumo.
grounding_config

DataStoreTool.GroundingConfig

Opcional. A configuração de embasamento.

ModalityType

O tipo de modalidade.

Tipos enumerados
MODALITY_TYPE_UNSPECIFIED Tipo de modalidade não especificado.
TEXT Modalidade de texto.
AUDIO Modalidade de áudio.

RewriterConfig

Configuração do rewriter.

Campos
model_settings

ModelSettings

Obrigatório. Configurações do modelo de LLM.
prompt

string

Opcional. A definição do comando. Se não for definido, o comando padrão será usado.
disabled

bool

Opcional. Se o rewriter está desativado.

SummarizationConfig

Configuração de resumo.

Campos
model_settings

ModelSettings

Opcional. Configurações do modelo de LLM.
prompt

string

Opcional. A definição do comando. Se não for definido, o comando padrão será usado.
disabled

bool

Opcional. Se o resumo está desativado.

DeleteAgentRequest

Mensagem de solicitação para AgentService.DeleteAgent.

Campos
name

string

Obrigatório. O nome do recurso do agente a ser excluído.
force

bool

Opcional. Indica se o agente deve ser excluído à força, mesmo que ainda seja referenciado por outros apps/agentes/exemplos.

  • Se force = false, a exclusão vai falhar se outros agentes/exemplos fizerem referência a ele.
  • Se force = true, exclua o agente e remova-o de todos os apps/agentes/exemplos que o referenciam.
etag

string

Opcional. A ETag atual do agente. Se uma ETag não for fornecida, a exclusão vai substituir todas as mudanças simultâneas. Se uma ETag for fornecida e não corresponder à ETag atual do agente, a exclusão será bloqueada e um erro ABORTED será retornado.

DeleteAppRequest

Mensagem de solicitação para AgentService.DeleteApp.

Campos
name

string

Obrigatório. O nome do recurso do app a ser excluído.
etag

string

Opcional. A etag atual do app. Se uma etag não for fornecida, a exclusão vai substituir todas as mudanças simultâneas. Se uma ETag for fornecida e não corresponder à ETag atual do app, a exclusão será bloqueada e um erro ABORTED será retornado.

DeleteAppVersionRequest

Mensagem de solicitação para AgentService.DeleteAppVersion.

Campos
name

string

Obrigatório. O nome do recurso da versão do app a ser excluída.
etag

string

Opcional. A ETag atual da versão do app. Se uma ETag não for fornecida, a exclusão vai substituir todas as mudanças simultâneas. Se uma ETag for fornecida e não corresponder à ETag atual da versão do app, a exclusão será bloqueada e um erro ABORTED será retornado.

DeleteConversationRequest

Mensagem de solicitação para AgentService.DeleteConversation.

Campos
name

string

Obrigatório. O nome do recurso da conversa a ser excluída.
source
(deprecated)

Conversation.Source

Opcional. Indique a origem da conversa. Se não for definido, "Source.Live" será aplicado por padrão.

DeleteDeploymentRequest

Mensagem de solicitação para AgentService.DeleteDeployment.

Campos
name

string

Obrigatório. O nome da implantação a ser excluída. Formato: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
etag

string

Opcional. A ETag da implantação. Se uma ETag for fornecida e não corresponder à ETag atual da implantação, a exclusão será bloqueada e um erro ABORTED será retornado.

DeleteExampleRequest

Mensagem de solicitação para AgentService.DeleteExample.

Campos
name

string

Obrigatório. O nome do recurso do exemplo a ser excluído.
etag

string

Opcional. A ETag atual do exemplo. Se uma ETag não for fornecida, a exclusão vai substituir todas as mudanças simultâneas. Se uma ETag for fornecida e não corresponder à ETag atual do exemplo, a exclusão será bloqueada e um erro ABORTED será retornado.

DeleteGuardrailRequest

Mensagem de solicitação para AgentService.DeleteGuardrail.

Campos
name

string

Obrigatório. O nome do recurso da proteção a ser excluída.
force

bool

Opcional. Indica se a proteção precisa ser excluída à força, mesmo que ainda seja referenciada por apps/agentes.

  • Se force = false, a exclusão vai falhar se algum app/agente ainda fizer referência ao guardrail.
  • Se force = true, todas as referências atuais de apps/agentes serão removidas e a proteção será excluída.
etag

string

Opcional. A ETag atual da proteção. Se uma ETag não for fornecida, a exclusão vai substituir todas as mudanças simultâneas. Se uma ETag for fornecida e não corresponder à ETag atual do guardrail, a exclusão será bloqueada e um erro ABORTED será retornado.

DeleteToolRequest

Mensagem de solicitação para AgentService.DeleteTool.

Campos
name

string

Obrigatório. O nome do recurso da ferramenta a ser excluída.
force

bool

Opcional. Indica se a ferramenta deve ser excluída à força, mesmo que ainda seja referenciada por agentes/exemplos.

  • Se force = false, a exclusão vai falhar se algum agente ainda referenciar a ferramenta.
  • Se force = true, todas as referências atuais dos agentes serão removidas e a ferramenta será excluída.
etag

string

Opcional. A ETag atual da ferramenta. Se uma ETag não for fornecida, a exclusão vai substituir todas as mudanças simultâneas. Se uma ETag for fornecida e não corresponder à ETag atual da ferramenta, a exclusão será bloqueada e um erro ABORTED será retornado.

DeleteToolsetRequest

Mensagem de solicitação para AgentService.DeleteToolset.

Campos
name

string

Obrigatório. O nome do recurso do conjunto de ferramentas a ser excluído.
force

bool

Opcional. Indica se o conjunto de ferramentas deve ser excluído à força, mesmo que ainda seja referenciado por apps/agentes.

  • Se force = false, a exclusão vai falhar se algum agente ainda fizer referência ao conjunto de ferramentas.
  • Se force = true, todas as referências atuais dos agentes serão removidas e o conjunto de ferramentas será excluído.
etag

string

Opcional. A ETag atual do conjunto de ferramentas. Se uma ETag não for fornecida, a exclusão vai substituir todas as mudanças simultâneas. Se uma ETag for fornecida e não corresponder à ETag atual do conjunto de ferramentas, a exclusão será bloqueada e um erro ABORTED será retornado.

Implantação

Uma implantação representa uma versão imutável e consultável do app. Ela é usada para implantar uma versão do app com um perfil de canal específico.

Campos
name

string

Identificador. O nome do recurso da implantação. Formato: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
display_name

string

Obrigatório. Nome de exibição da implantação.
app_version

string

Opcional. O nome do recurso da versão do app a ser implantada. Formato: projects/{project}/locations/{location}/apps/{app}/versions/{version}. Use projects/{project}/locations/{location}/apps/{app}/versions/- para usar o app em rascunho.
channel_profile

ChannelProfile

Obrigatório. O perfil do canal usado na implantação.
create_time

Timestamp

Apenas saída. Carimbo de data/hora em que a implantação foi criada.
update_time

Timestamp

Apenas saída. Carimbo de data/hora em que essa implantação foi atualizada pela última vez.
etag

string

Apenas saída. Etag usada para garantir que o objeto não mudou durante uma operação de leitura-modificação-gravação. Se a ETag estiver vazia, a atualização vai substituir todas as mudanças simultâneas.

EndSession

Indica que a sessão foi encerrada devido à conclusão bem-sucedida (por exemplo, o usuário diz "Tchau!" ) ou uma transferência para um agente.

O agente não vai processar mais entradas depois que a sessão for encerrada, e o cliente vai fazer um fechamento parcial e se desconectar após receber todas as respostas restantes do agente.

Campos
metadata

Struct

Opcional. Fornece mais informações sobre o indicador de fim de sessão, como o motivo do encerramento.

EndUserAuthConfig

Configuração de autenticação do usuário final usada para chamadas de conexão. Os valores do campo precisam ser os nomes das variáveis de contexto no formato $context.variables.<name_of_variable>.

Campos
Campo de união auth_config. A configuração de autenticação. auth_config pode ser apenas de um dos tipos a seguir:
oauth2_auth_code_config

EndUserAuthConfig.Oauth2AuthCodeConfig

Autenticação de código de autorização do OAuth 2.0.
oauth2_jwt_bearer_config

EndUserAuthConfig.Oauth2JwtBearerConfig

Autenticação de concessão de autorização OAuth 2.0 do perfil JWT.

Oauth2AuthCodeConfig

Configuração de autenticação do código de autorização do OAuth 2.0.

Campos
oauth_token

string

Obrigatório. Nome do parâmetro do token OAuth a ser transmitido. Precisa estar no formato $context.variables.<name_of_variable>.

Oauth2JwtBearerConfig

Configuração de autenticação de concessão de autorização OAuth 2.0 do perfil JWT.

Campos
issuer

string

Obrigatório. Nome do parâmetro do emissor a ser transmitido. Precisa estar no formato $context.variables.<name_of_variable>.
subject

string

Obrigatório. Nome do parâmetro de assunto a ser transmitido. Precisa estar no formato $context.variables.<name_of_variable>.
client_key

string

Obrigatório. Nome do parâmetro do cliente a ser transmitido. Precisa estar no formato $context.variables.<name_of_variable>.

ErrorHandlingSettings

Configurações para descrever como os erros devem ser tratados no app.

Campos
error_handling_strategy

ErrorHandlingSettings.ErrorHandlingStrategy

Opcional. A estratégia a ser usada para tratamento de erros.

ErrorHandlingStrategy

Define a estratégia para lidar com erros.

Tipos enumerados
ERROR_HANDLING_STRATEGY_UNSPECIFIED Estratégia de tratamento de erros não especificada. O padrão é FALLBACK_RESPONSE.
NONE Nenhum processamento específico está ativado.
FALLBACK_RESPONSE Uma mensagem substituta será retornada ao usuário em caso de erros do LLM.

EvaluationMetricsThresholds

Configurações de limite para métricas em uma avaliação.

Campos
golden_evaluation_metrics_thresholds

EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds

Opcional. Os limites das métricas de avaliação de ouro.
hallucination_metric_behavior
(deprecated)

EvaluationMetricsThresholds.HallucinationMetricBehavior

Opcional. Descontinuado: use golden_hallucination_metric_behavior. O comportamento da métrica de alucinação é usado atualmente para avaliações de ouro.
golden_hallucination_metric_behavior

EvaluationMetricsThresholds.HallucinationMetricBehavior

Opcional. O comportamento da métrica de alucinação para avaliações de ouro.
scenario_hallucination_metric_behavior

EvaluationMetricsThresholds.HallucinationMetricBehavior

Opcional. O comportamento da métrica de alucinação para avaliações de cenário.

GoldenEvaluationMetricsThresholds

Configurações para avaliações de ouro.

Campos
turn_level_metrics_thresholds

EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.TurnLevelMetricsThresholds

Opcional. Os limites das métricas no nível da rodada.
expectation_level_metrics_thresholds

EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.ExpectationLevelMetricsThresholds

Opcional. Os limites das métricas de nível de expectativa.
tool_matching_settings

EvaluationMetricsThresholds.ToolMatchingSettings

Opcional. As configurações de correspondência de ferramentas. Uma chamada de ferramenta extra é uma chamada de ferramenta presente na execução, mas que não corresponde a nenhuma chamada de ferramenta na expectativa de ouro.

ExpectationLevelMetricsThresholds

Limites de métricas de nível de expectativa.

Campos
tool_invocation_parameter_correctness_threshold

float

Opcional. O limite de sucesso para a correção de parâmetros de invocação de ferramentas individuais. Precisa ser um número de ponto flutuante entre 0 e 1. O padrão é 1,0.

TurnLevelMetricsThresholds

Ativar os limites das métricas no nível da rodada.

Campos
semantic_similarity_channel

EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.TurnLevelMetricsThresholds.SemanticSimilarityChannel

Opcional. O canal de similaridade semântica a ser usado para avaliação.
semantic_similarity_success_threshold

int32

Opcional. O limite de sucesso para similaridade semântica. O valor precisa ser um número inteiro entre 0 e 4. O padrão é ">= 3".
overall_tool_invocation_correctness_threshold

float

Opcional. O limite de sucesso para a correção geral da invocação da ferramenta. Precisa ser um número de ponto flutuante entre 0 e 1. O padrão é 1,0.

SemanticSimilarityChannel

Canal de similaridade semântica a ser usado.

Tipos enumerados
SEMANTIC_SIMILARITY_CHANNEL_UNSPECIFIED Métrica não especificada. O padrão é TEXT.
TEXT Use a similaridade semântica de texto.
AUDIO Use a similaridade semântica de áudio.

HallucinationMetricBehavior

O comportamento da métrica de alucinação. Independente do comportamento, a métrica sempre será calculada. A diferença é que, quando desativada, a métrica não é usada para calcular a pontuação geral da avaliação.

Tipos enumerados
HALLUCINATION_METRIC_BEHAVIOR_UNSPECIFIED Comportamento não especificado da métrica de alucinação.
DISABLED Desativa a métrica de alucinação.
ENABLED Ative a métrica de alucinação.

ToolMatchingSettings

Configurações para correspondência de chamadas de ferramentas.

Campos
extra_tool_call_behavior

EvaluationMetricsThresholds.ToolMatchingSettings.ExtraToolCallBehavior

Opcional. Comportamento para chamadas de função extras. O padrão é FAIL.

ExtraToolCallBehavior

Define o comportamento quando uma chamada de ferramenta extra é encontrada. Uma chamada de ferramenta extra é uma chamada de ferramenta presente na execução, mas que não corresponde a nenhuma chamada de ferramenta na expectativa de ouro.

Tipos enumerados
EXTRA_TOOL_CALL_BEHAVIOR_UNSPECIFIED Comportamento não especificado. O padrão é FAIL.
FAIL Falha na avaliação se uma chamada de ferramenta extra for encontrada.
ALLOW Permita a chamada de ferramenta extra.

Evento

Entrada de evento.

Campos
event

string

Obrigatório. O nome do evento.

Exemplo

Um exemplo representa uma conversa entre o usuário e os agentes.

Campos
name

string

Identificador. O identificador exclusivo do exemplo. Formato: projects/{project}/locations/{location}/apps/{app}/examples/{example}
display_name

string

Obrigatório. Nome de exibição do exemplo.
description

string

Opcional. Descrição legível do exemplo.
entry_agent

string

Opcional. O agente que inicialmente lida com a conversa. Se não for especificado, o exemplo vai representar uma conversa processada pelo agente raiz. Formato: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
messages[]

Message

Opcional. A coleção de mensagens que compõem a conversa.
create_time

Timestamp

Apenas saída. Carimbo de data/hora em que o exemplo foi criado.
update_time

Timestamp

Apenas saída. Carimbo de data/hora da última atualização do exemplo.
invalid

bool

Apenas saída. O exemplo pode ficar inválido se os recursos referenciados forem excluídos. Exemplos inválidos não serão usados como exemplos few-shot.
etag

string

Etag usada para garantir que o objeto não mudou durante uma operação de leitura-modificação-gravação. Se a ETag estiver vazia, a atualização vai substituir todas as mudanças simultâneas.

ExecuteToolRequest

Mensagem de solicitação para ToolService.ExecuteTool.

Campos
parent

string

Obrigatório. O nome do recurso do app a que a ferramenta/conjunto de ferramentas pertence. Formato: projects/{project}/locations/{location}/apps/{app}
args

Struct

Opcional. Os parâmetros e valores de entrada da ferramenta no formato de objeto JSON.
variables

Struct

Opcional. As variáveis disponíveis para a execução da ferramenta.
Campo de união tool_identifier. O identificador da ferramenta a ser executada. Ela pode ser uma ferramenta persistente ou de um conjunto de ferramentas. tool_identifier pode ser apenas de um dos tipos a seguir:
tool

string

Opcional. O nome da ferramenta a ser executada. Formato: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
toolset_tool

ToolsetTool

Opcional. A ferramenta do conjunto de ferramentas a ser executada. Apenas uma ferramenta precisa corresponder ao predicado do conjunto de ferramentas. Caso contrário, um erro será retornado.

ExecuteToolResponse

Mensagem de resposta para ToolService.ExecuteTool.

Campos
response

Struct

O resultado da execução da ferramenta no formato de objeto JSON. Use a chave "output" para especificar a resposta da ferramenta e a chave "error" para especificar os detalhes do erro (se houver). Se as chaves "output" e "error" não forem especificadas, toda a "response" será tratada como resultado da execução da ferramenta.
variables

Struct

Os valores das variáveis ao final da execução da ferramenta.
Campo de união tool_identifier. O identificador da ferramenta que foi executada. tool_identifier pode ser apenas de um dos tipos a seguir:
tool

string

O nome da ferramenta que foi executada. Formato: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
toolset_tool

ToolsetTool

A ferramenta do conjunto de ferramentas que foi executada.

ExecutionType

O tipo de execução da ferramenta ou do conjunto de ferramentas.

Tipos enumerados
EXECUTION_TYPE_UNSPECIFIED O tipo de execução não foi especificado. Quando não especificado, o padrão é SYNCHRONOUS.
SYNCHRONOUS A ferramenta é executada de forma síncrona. A sessão fica bloqueada até que a ferramenta retorne.
ASYNCHRONOUS A ferramenta é executada de forma assíncrona. A sessão vai continuar enquanto a ferramenta estiver sendo executada.

ExportAppRequest

Mensagem de solicitação para AgentService.ExportApp.

Campos
name

string

Obrigatório. O nome do recurso do app a ser exportado.
export_format

ExportAppRequest.ExportFormat

Obrigatório. O formato em que o app será exportado.
gcs_uri

string

Opcional. O URI do Google Cloud Storage para onde o app será exportado. O formato desse URI precisa ser gs://<bucket-name>/<object-name>. O arquivo do app exportado será gravado diretamente no objeto do GCS especificado.

ExportFormat

Formato de exportação do app.

Tipos enumerados
EXPORT_FORMAT_UNSPECIFIED O formato de exportação não foi especificado.
JSON O formato de exportação é JSON.
YAML O formato de exportação é YAML.

ExportAppResponse

Mensagem de resposta para AgentService.ExportApp.

Campos
Campo de união app. O app exportado. app pode ser apenas uma das seguintes opções:
app_content

bytes

Pasta do app compactada como um arquivo ZIP.
app_uri

string

O URI do Google Cloud Storage para onde o app foi exportado.

ExpressionCondition

Condição de expressão com base no estado da sessão.

Campos
expression

string

Obrigatório. A representação de string da condição cloud.api.Expression.

FileSearchTool

Com a ferramenta de pesquisa de arquivos, o agente pode pesquisar nos arquivos enviados pelo desenvolvedor do app/agente. Ele tem predefinições para oferecer uma pesquisa de qualidade relativamente boa nos arquivos enviados e um resumo dos resultados recuperados.

Campos
corpus_type

FileSearchTool.CorpusType

Opcional. O tipo de corpus. O padrão é FULLY_MANAGED.
name

string

Obrigatório. O nome da ferramenta.
description

string

Opcional. A descrição da ferramenta.
file_corpus

string

Opcional. O corpus em que os arquivos são armazenados. Formato: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}

CorpusType

O tipo do corpus de RAG da Vertex.

Tipos enumerados
CORPUS_TYPE_UNSPECIFIED Tipo de corpus não especificado.
USER_OWNED O corpus é criado e pertence ao usuário.
FULLY_MANAGED O corpus é criado pelo agente.

GenerateChatTokenRequest

Mensagem de solicitação para WidgetService.GenerateChatToken.

Campos
name

string

Obrigatório. O nome da sessão para gerar o token de chat. Formato: projects/{project}/locations/{location}/apps/{app}/sessions/{session}
deployment

string

Obrigatório. A implantação do app a ser usado na sessão. Formato: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
recaptcha_token

string

Opcional. O token do reCAPTCHA gerado pelo widget de chat do lado do cliente.

GenerateChatTokenResponse

Mensagem de resposta para WidgetService.GenerateChatToken.

Campos
chat_token

string

O token no escopo da sessão para o widget de chat se autenticar com as APIs de sessão.
expire_time

Timestamp

O horário em que o token de chat expira.

GetAgentRequest

Mensagem de solicitação para AgentService.GetAgent.

Campos
name

string

Obrigatório. O nome do recurso do agente a ser recuperado.

GetAppRequest

Mensagem de solicitação para AgentService.GetApp.

Campos
name

string

Obrigatório. O nome do recurso do app a ser recuperado.

GetAppVersionRequest

Mensagem de solicitação para AgentService.GetAppVersion.

Campos
name

string

Obrigatório. O nome do recurso da versão do app a ser recuperada.

GetChangelogRequest

Mensagem de solicitação para AgentService.GetChangelog.

Campos
name

string

Obrigatório. O nome do recurso da mudança a ser recuperada.

GetConversationRequest

Mensagem de solicitação para AgentService.GetConversation.

Campos
name

string

Obrigatório. O nome do recurso da conversa a ser recuperada.
source
(deprecated)

Conversation.Source

Opcional. Indique a origem da conversa. Se não for definido, todas as fontes serão pesquisadas.

GetDeploymentRequest

Mensagem de solicitação para AgentService.GetDeployment.

Campos
name

string

Obrigatório. O nome da implantação. Formato: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}

GetExampleRequest

Mensagem de solicitação para AgentService.GetExample.

Campos
name

string

Obrigatório. O nome do recurso do exemplo a ser recuperado.

GetGuardrailRequest

Mensagem de solicitação para AgentService.GetGuardrail.

Campos
name

string

Obrigatório. O nome do recurso da proteção a ser recuperada.

GetToolRequest

Mensagem de solicitação para AgentService.GetTool.

Campos
name

string

Obrigatório. O nome do recurso da ferramenta a ser recuperada.

GetToolsetRequest

Mensagem de solicitação para AgentService.GetToolset.

Campos
name

string

Obrigatório. O nome do recurso do conjunto de ferramentas a ser recuperado.

GoAway

Esse tipo não tem campos.

Indica que o servidor será desconectado em breve e que o cliente precisa fechar parcialmente e reiniciar a conexão.

GoogleSearchSuggestions

Sugestões de pesquisa de Google Search Tool.

Campos
htmls[]

string

Estilo HTML e CSS compatível para sugestões de pesquisa. O HTML e o CSS fornecidos se adaptam automaticamente às configurações do dispositivo, sendo exibidos no modo claro ou escuro indicado por @media(prefers-color-scheme).
web_search_queries[]

WebSearchQuery

Lista de consultas usadas para realizar a pesquisa no Google, além dos URIs de resultados da pesquisa que formam as sugestões de pesquisa.

GoogleSearchTool

Representa uma ferramenta para realizar pesquisas Google na Web para embasamento. Consulte https://cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool#google-search.

Campos
name

string

Obrigatório. O nome da ferramenta.
description

string

Opcional. Descrição da finalidade da ferramenta.
context_urls[]

string

Opcional. O conteúdo será extraído diretamente desses URLs para contexto e embasamento. Exemplo: "https://example.com/path.html". São permitidos no máximo 20 URLs.
preferred_domains[]

string

Opcional. Especifica os domínios em que os resultados da pesquisa serão restritos. Exemplo: "example.com", "another.site". É possível especificar no máximo 20 domínios.
exclude_domains[]

string

Opcional. Lista de domínios a serem excluídos dos resultados da pesquisa. Exemplo: "example.com". É possível excluir no máximo 2.000 domínios.
prompt_config

GoogleSearchTool.PromptConfig

Opcional. Instruções de comando transmitidas ao planejador sobre como os resultados da pesquisa devem ser processados para texto e voz.

PromptConfig

Configurações de comando usadas pelo modelo ao processar ou resumir os resultados da Pesquisa Google.

Campos
text_prompt

string

Opcional. Define o comando usado para as instruções do sistema ao interagir com o agente em conversas por chat. Se não for definido, o comando padrão será usado.
voice_prompt

string

Opcional. Define o comando usado para as instruções do sistema ao interagir com o agente em conversas por voz. Se não for definido, o comando padrão será usado.

Proteção

O Guardrail contém uma lista de verificações e controles para manter os agentes seguros.

Campos
name

string

Identificador. O identificador exclusivo da proteção. Formato: projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}
display_name

string

Obrigatório. Nome de exibição da proteção.
description

string

Opcional. Descrição da proteção.
enabled

bool

Opcional. Se a proteção está ativada.
action

TriggerAction

Opcional. Ação a ser tomada quando o guardrail é acionado.
create_time

Timestamp

Apenas saída. Carimbo de data/hora em que a proteção foi criada.
update_time

Timestamp

Apenas saída. Carimbo de data/hora da última atualização da proteção.
etag

string

Etag usada para garantir que o objeto não mudou durante uma operação de leitura-modificação-gravação. Se a ETag estiver vazia, a atualização vai substituir todas as mudanças simultâneas.
Campo de união guardrail_type. Tipo de proteção. guardrail_type pode ser apenas de um dos tipos a seguir:
content_filter

Guardrail.ContentFilter

Opcional. Proteção que proíbe o uso de determinados conteúdos na conversa.
llm_prompt_security

Guardrail.LlmPromptSecurity

Opcional. Proteção que bloqueia a conversa se o comando for considerado inseguro com base na classificação do LLM.
llm_policy

Guardrail.LlmPolicy

Opcional. Proteção que bloqueia a conversa se a resposta do LLM for considerada uma violação da política com base na classificação do LLM.
model_safety

Guardrail.ModelSafety

Opcional. Proteção que bloqueia a conversa se a resposta do LLM for considerada não segura com base nas configurações de segurança do modelo.
code_callback

Guardrail.CodeCallback

Opcional. Proteção que pode bloquear a conversa com base no resultado da execução do callback.

CodeCallback

Proteção que bloqueia a conversa com base nos callbacks de código fornecidos.

Campos
before_agent_callback

Callback

Opcional. O callback a ser executado antes da chamada do agente. Cada função de callback precisa retornar uma estrutura (por exemplo, um dict ou objeto) que contenha pelo menos: - "decision": "OK" ou "TRIGGER". - "reason": uma string que explica a decisão. Uma decisão "TRIGGER" pode interromper o processamento.
after_agent_callback

Callback

Opcional. O callback a ser executado depois que o agente for chamado. Cada função de callback precisa retornar uma estrutura (por exemplo, um dict ou objeto) que contenha pelo menos: - "decision": "OK" ou "TRIGGER". - "reason": uma string que explica a decisão. Uma decisão "TRIGGER" pode interromper o processamento.
before_model_callback

Callback

Opcional. O callback a ser executado antes de chamar o modelo. Se houver várias chamadas para o modelo, o callback será executado várias vezes. Cada função de callback precisa retornar uma estrutura (por exemplo, um dict ou objeto) que contenha pelo menos: - "decision": "OK" ou "TRIGGER". - "reason": uma string que explica a decisão. Uma decisão "TRIGGER" pode interromper o processamento.
after_model_callback

Callback

Opcional. O callback a ser executado depois que o modelo é chamado. Se houver várias chamadas para o modelo, o callback será executado várias vezes. Cada função de callback precisa retornar uma estrutura (por exemplo, um dict ou objeto) que contenha pelo menos: - "decision": "OK" ou "TRIGGER". - "reason": uma string que explica a decisão. Uma decisão "TRIGGER" pode interromper o processamento.

ContentFilter

Proteção que proíbe o uso de determinados conteúdos na conversa.

Campos
banned_contents[]

string

Opcional. Lista de frases proibidas. Isso se aplica às entradas do usuário e às respostas do agente.
banned_contents_in_user_input[]

string

Opcional. Lista de frases proibidas. Aplica-se apenas às entradas do usuário.
banned_contents_in_agent_response[]

string

Opcional. Lista de frases proibidas. Aplicável apenas às respostas do agente.
match_type

Guardrail.ContentFilter.MatchType

Obrigatório. Tipo de correspondência para o filtro de conteúdo.
disregard_diacritics

bool

Opcional. Se for verdadeiro, os diacríticos serão ignorados durante a correspondência.

MatchType

Tipo de correspondência para o filtro de conteúdo.

Tipos enumerados
MATCH_TYPE_UNSPECIFIED O tipo de correspondência não foi especificado.
SIMPLE_STRING_MATCH O conteúdo é correspondido para substrings caractere por caractere.
WORD_BOUNDARY_STRING_MATCH O conteúdo só vai corresponder se o padrão encontrado no texto estiver cercado por delimitadores de palavras. As frases proibidas também podem conter delimitadores de palavras.
REGEXP_MATCH O conteúdo é correspondido usando a sintaxe de expressão regular.

LlmPolicy

Proteção que bloqueia a conversa se a resposta do LLM for considerada uma violação da política com base na classificação do LLM.

Campos
max_conversation_messages

int32

Opcional. Ao verificar essa política, considere as últimas "n" mensagens na conversa. Quando não definido, um valor padrão de 10 será usado.
model_settings

ModelSettings

Opcional. Configurações do modelo.
prompt

string

Obrigatório. Solicitação de política.
policy_scope

Guardrail.LlmPolicy.PolicyScope

Obrigatório. Define quando aplicar a verificação de política durante a conversa. Se definida como POLICY_SCOPE_UNSPECIFIED, a política será aplicada à entrada do usuário. Ao aplicar a política à resposta do agente, uma latência adicional será introduzida antes que o agente possa responder.
fail_open

bool

Opcional. Se ocorrer um erro durante a verificação da política, falhe ao abrir e não acione o guardrail.
allow_short_utterance

bool

Opcional. Por padrão, a verificação de política do LLM é ignorada para frases curtas. Ao ativar essa configuração, a verificação de política é aplicada a todas as declarações, incluindo aquelas que normalmente seriam ignoradas.

PolicyScope

Define quando aplicar a verificação de política durante a conversa.

Tipos enumerados
POLICY_SCOPE_UNSPECIFIED O escopo da política não foi especificado.
USER_QUERY A verificação de política é acionada com a entrada do usuário.
AGENT_RESPONSE A verificação de política é acionada na resposta do agente. Aplicar esse escopo de política vai introduzir mais latência antes que o agente possa responder.
USER_QUERY_AND_AGENT_RESPONSE A verificação de política é acionada na entrada do usuário e na resposta do agente. Aplicar esse escopo de política vai introduzir mais latência antes que o agente possa responder.

LlmPromptSecurity

Proteção que bloqueia a conversa se a entrada for considerada insegura com base na classificação do LLM.

Campos
fail_open

bool

Opcional. Determina o comportamento quando a proteção encontra um erro de LLM. - Se for "true", a proteção será ignorada. - Se for "false" (padrão): o guardrail é acionado/bloqueado.

Observação: se uma política personalizada for fornecida, esse campo será ignorado em favor da configuração "fail_open" da política.
Campo de união security_config. Define o modo de configuração de segurança. O usuário precisa escolher uma das seguintes configurações. security_config pode ser apenas de um dos tipos a seguir:
default_settings

Guardrail.LlmPromptSecurity.DefaultSecuritySettings

Opcional. Use as configurações de segurança padrão predefinidas do sistema. Para selecionar esse modo, inclua uma mensagem "default_settings" vazia na solicitação. O campo "default_prompt_template" será preenchido pelo servidor na resposta.
custom_policy

Guardrail.LlmPolicy

Opcional. Use uma LlmPolicy definida pelo usuário para configurar a proteção de segurança.

DefaultSecuritySettings

Configuração das configurações de segurança padrão do sistema.

Campos
default_prompt_template

string

Apenas saída. O modelo de solicitação padrão usado pelo sistema. Este campo é para fins de exibição e mostra ao usuário qual comando o sistema usa por padrão. É OUTPUT_ONLY.

ModelSafety

Substituições das configurações de segurança do modelo. Quando essa opção está definida, ela substitui as configurações padrão e aciona a proteção se a resposta for considerada insegura.

Campos
safety_settings[]

Guardrail.ModelSafety.SafetySetting

Obrigatório. Lista de configurações de segurança.

HarmBlockThreshold

Níveis de limites baseados em probabilidade para bloqueio.

Tipos enumerados
HARM_BLOCK_THRESHOLD_UNSPECIFIED Limite de bloqueio de danos não especificado.
BLOCK_LOW_AND_ABOVE Bloquear o limite inferior e superior (ou seja, bloquear mais).
BLOCK_MEDIUM_AND_ABOVE Bloquear o limite médio e acima.
BLOCK_ONLY_HIGH Bloquear apenas o limite superior (ou seja, bloquear menos).
BLOCK_NONE Bloquear nenhum
OFF Desative o filtro de segurança.

HarmCategory

Categoria de dano.

Tipos enumerados
HARM_CATEGORY_UNSPECIFIED A categoria de danos não foi especificada.
HARM_CATEGORY_HATE_SPEECH A categoria de danos é discurso de ódio.
HARM_CATEGORY_DANGEROUS_CONTENT A categoria de danos é um conteúdo perigoso.
HARM_CATEGORY_HARASSMENT A categoria de dano é assédio.
HARM_CATEGORY_SEXUALLY_EXPLICIT A categoria de dano é conteúdo sexualmente explícito.

SafetySetting

Configuração de segurança.

Campos
category

Guardrail.ModelSafety.HarmCategory

Obrigatório. A categoria de dano.
threshold

Guardrail.ModelSafety.HarmBlockThreshold

Obrigatório. O limite do bloqueio de danos.

Imagem

Representa uma entrada ou saída de imagem na conversa.

Campos
mime_type

string

Obrigatório. O tipo MIME padrão da IANA dos dados de origem. Os tipos de imagem compatíveis incluem: * image/png * image/jpeg * image/webp
data

bytes

Obrigatório. Bytes brutos da imagem.

ImportAppRequest

Mensagem de solicitação para AgentService.ImportApp.

Campos
parent

string

Obrigatório. O nome do recurso pai com o local do app a ser importado.
display_name

string

Opcional. O nome de exibição do app a ser importado. * Se o app for criado na importação e o nome de exibição for especificado, o app importado vai usar esse nome. Se for detectado um conflito com um app existente, um carimbo de data/hora será anexado ao nome de exibição para torná-lo exclusivo. * Se o app for uma reimportação, esse campo não poderá ser definido. Fornecer um nome de exibição durante a reimportação vai resultar em um erro INVALID_ARGUMENT.
app_id

string

Opcional. O ID a ser usado para o app importado. * Se não for especificado, um ID exclusivo será atribuído automaticamente ao app. * Caso contrário, o app importado vai usar esse ID como o componente final do nome do recurso. Se um app com o mesmo ID já existir no local especificado do projeto, o conteúdo dele será substituído.
import_options

ImportAppRequest.ImportOptions

Opcional. Opções que regem o processo de importação do app.
ignore_app_lock

bool

Opcional. Flag para substituir o bloqueio do app durante a importação. Se definido como "true", o processo de importação vai ignorar o bloqueio do app.
Campo de união app. O app a ser importado. app pode ser apenas de um dos tipos a seguir:
gcs_uri

string

O URI do Google Cloud Storage de onde o app será importado. O formato desse URI precisa ser gs://<bucket-name>/<object-name>.
app_content

bytes

Bytes brutos que representam o arquivo ZIP compactado com a estrutura de pastas do app.

ImportOptions

Opções de configuração para o processo de importação de apps. Essas opções controlam o comportamento da importação, principalmente quando surgem conflitos com dados de apps atuais.

Campos
conflict_resolution_strategy

ImportAppRequest.ImportOptions.ConflictResolutionStrategy

Opcional. A estratégia a ser usada ao resolver conflitos durante a importação.

ConflictResolutionStrategy

Define a estratégia para lidar com conflitos quando um app com o mesmo ID já existe ou quando recursos importados (como agentes, ferramentas etc.) têm os mesmos nomes de exibição que os recursos atuais no app.

Tipos enumerados
CONFLICT_RESOLUTION_STRATEGY_UNSPECIFIED A estratégia de resolução de conflitos não foi especificada.
REPLACE Substituir os dados atuais pelos importados. Se um app com o mesmo app_id já existir, o conteúdo dele será atualizado com base no app importado. Os recursos (app, agentes, ferramentas, exemplos, proteções, conjuntos de ferramentas) no app importado que tiverem o mesmo nome de exibição dos recursos atuais vão substituir os existentes. - Os recursos importados com novos nomes de exibição serão criados. - Os recursos atuais que não têm um nome de exibição correspondente no app importado não serão alterados.
OVERWRITE Substituir os dados atuais pelos importados. Se um app com o mesmo app_id já existir, o conteúdo dele será substituído pelo app importado. Os recursos atuais (agentes, ferramentas, exemplos, proteções, conjuntos de ferramentas) no app serão excluídos. - Os recursos importados serão criados como novos recursos.

ImportAppResponse

Mensagem de resposta para AgentService.ImportApp.

Campos
name

string

O nome do recurso do app importado.
warnings[]

string

Mensagens de aviso geradas durante o processo de importação. Se ocorrerem erros em recursos específicos, eles não serão incluídos no app importado, e o erro será mencionado aqui.

InputAudioConfig

O InputAudioConfig configura como o agente do CES deve interpretar os dados de áudio recebidos.

Campos
audio_encoding

AudioEncoding

Obrigatório. A codificação dos dados de áudio de entrada.
sample_rate_hertz

int32

Obrigatório. A taxa de amostragem (em Hertz) dos dados de áudio de entrada.
noise_suppression_level

string

Opcional. Define se a redução de ruído será ativada no áudio de entrada. Os valores disponíveis são "low", "moderate", "high", "very_high".

InterruptionSignal

Indica que a resposta de áudio do agente foi interrompida. O cliente precisa interromper imediatamente a reprodução de áudio atual (por exemplo, devido à interrupção do usuário ou à geração de uma nova resposta do agente).

Campos
barge_in

bool

Se a interrupção foi causada por um evento de interrupção do usuário.

LanguageSettings

Configurações de idioma do app.

Campos
default_language_code

string

Opcional. O código de idioma padrão do app.
supported_language_codes[]

string

Opcional. Lista de códigos de idiomas compatíveis com o app, além do default_language_code.
enable_multilingual_support

bool

Opcional. Ativa o suporte multilíngue. Se for verdadeiro, os agentes no app vão usar instruções pré-criadas para melhorar o processamento de entradas multilíngues.
fallback_action

string

Opcional. A ação a ser realizada quando um agente recebe entrada em um idioma sem suporte.

Pode ser uma ação predefinida ou uma chamada de função personalizada. Os valores válidos são: - O nome completo do recurso de uma ferramenta, que aciona a execução de uma ferramenta específica. - Uma ação predefinida do sistema, como "escalar" ou "sair", que aciona um sinal EndSession com o metadata correspondente para encerrar a conversa.

ListAgentsRequest

Mensagem de solicitação para AgentService.ListAgents.

Campos
parent

string

Obrigatório. O nome do recurso do app de que os agentes serão listados.
page_size

int32

Opcional. Tamanho da página solicitada. O servidor pode retornar menos resultados do que o solicitado. Se não for especificado, o servidor escolherá um padrão apropriado.
page_token

string

Opcional. O valor next_page_token retornado de uma chamada AgentService.ListAgents de lista anterior.
filter

string

Opcional. Filtro a ser aplicado ao listar os agentes. Consulte https://google.aip.dev/160 para mais detalhes.
order_by

string

Opcional. Campo de classificação. Somente "name" e "create_time" são aceitos. Consulte https://google.aip.dev/132#ordering para mais detalhes.

ListAgentsResponse

Mensagem de resposta para AgentService.ListAgents.

Campos
agents[]

Agent

A lista de agentes.
next_page_token

string

Um token que pode ser enviado como ListAgentsRequest.page_token para recuperar a próxima página. A ausência desse campo indica que não há páginas subsequentes.

ListAppVersionsRequest

Mensagem de solicitação para AgentService.ListAppVersions.

Campos
parent

string

Obrigatório. O nome do recurso do app para listar as versões dele.
page_size

int32

Opcional. Tamanho da página solicitada. O servidor pode retornar menos resultados do que o solicitado. Se não for especificado, o servidor escolherá um padrão apropriado.
page_token

string

Opcional. O valor next_page_token retornado de uma chamada AgentService.ListAppVersions de lista anterior.
filter

string

Opcional. Filtro a ser aplicado ao listar as versões do app. Consulte https://google.aip.dev/160 para mais detalhes.
order_by

string

Opcional. Campo de classificação. Somente "name" e "create_time" são aceitos. Consulte https://google.aip.dev/132#ordering para mais detalhes.

ListAppVersionsResponse

Mensagem de resposta para AgentService.ListAppVersions.

Campos
app_versions[]

AppVersion

A lista de versões do app.
next_page_token

string

Um token que pode ser enviado como ListAppVersionsRequest.page_token para recuperar a próxima página. A ausência desse campo indica que não há páginas subsequentes.

ListAppsRequest

Mensagem de solicitação para AgentService.ListApps.

Campos
parent

string

Obrigatório. O nome do recurso do local em que os apps serão listados.
page_size

int32

Opcional. Tamanho da página solicitada. O servidor pode retornar menos resultados do que o solicitado. Se não for especificado, o servidor escolherá um padrão apropriado.
page_token

string

Opcional. O valor next_page_token retornado de uma chamada AgentService.ListApps de lista anterior.
filter

string

Opcional. Filtro a ser aplicado ao listar os apps. Consulte https://google.aip.dev/160 para mais detalhes.
order_by

string

Opcional. Campo de classificação. Somente "name" e "create_time" são aceitos. Consulte https://google.aip.dev/132#ordering para mais detalhes.

ListAppsResponse

Mensagem de resposta para AgentService.ListApps.

Campos
apps[]

App

A lista de apps.
next_page_token

string

Um token que pode ser enviado como ListAppsRequest.page_token para recuperar a próxima página. A ausência desse campo indica que não há páginas subsequentes.
unreachable[]

string

Lista não ordenada. Locais que não puderam ser alcançados.

ListChangelogsRequest

Mensagem de solicitação para AgentService.ListChangelogs.

Campos
parent

string

Obrigatório. O nome do recurso do app para listar os changelogs.
page_size

int32

Opcional. Tamanho da página solicitada. O servidor pode retornar menos resultados do que o solicitado. Se não for especificado, o servidor escolherá um padrão apropriado.
page_token

string

Opcional. O valor next_page_token retornado de uma chamada AgentService.ListChangelogs de lista anterior.
filter

string

Opcional. Filtro a ser aplicado ao listar os registros de mudanças. Consulte https://google.aip.dev/160 para mais detalhes.

A string de filtro pode ser usada para filtrar por action, resource_type, resource_name, author e create_time. O comparador : pode ser usado para correspondência parcial sem distinção entre maiúsculas e minúsculas em campos de string, enquanto = realiza uma correspondência exata com distinção entre maiúsculas e minúsculas.

Exemplos: * action:update (correspondência parcial sem diferenciação de maiúsculas e minúsculas) * action="Create" (correspondência exata com diferenciação de maiúsculas e 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

Opcional. Campo de classificação. Somente "name" e "create_time" são aceitos. Consulte https://google.aip.dev/132#ordering para mais detalhes.

ListChangelogsResponse

Mensagem de resposta para AgentService.ListChangelogs.

Campos
changelogs[]

Changelog

A lista de registros de mudanças.
next_page_token

string

Um token que pode ser enviado como ListChangelogsRequest.page_token para recuperar a próxima página. A ausência desse campo indica que não há páginas subsequentes.

ListConversationsRequest

Mensagem de solicitação para AgentService.ListConversations.

Campos
parent

string

Obrigatório. O nome do recurso do app de que as conversas serão listadas.
page_size

int32

Opcional. Tamanho da página solicitada. O servidor pode retornar menos resultados do que o solicitado. Se não for especificado, o servidor escolherá um padrão apropriado.
page_token

string

Opcional. O valor next_page_token retornado de uma chamada AgentService.ListConversations de lista anterior.
filter

string

Opcional. Filtro a ser aplicado ao listar as conversas. Consulte https://google.aip.dev/160 para mais detalhes.
source

Conversation.Source

Opcional. Indique a origem da conversa. Se não for definido, "Source.Live" será aplicado por padrão. Será descontinuado em favor do campo sources.
sources[]

Conversation.Source

Opcional. Indique as fontes das conversas. Se não for definido, todas as fontes disponíveis serão aplicadas por padrão.

ListConversationsResponse

Mensagem de resposta para AgentService.ListConversations.

Campos
conversations[]

Conversation

A lista de conversas.
next_page_token

string

Um token que pode ser enviado como ListConversationsRequest.page_token para recuperar a próxima página. A ausência desse campo indica que não há páginas subsequentes.

ListDeploymentsRequest

Mensagem de solicitação para AgentService.ListDeployments.

Campos
parent

string

Obrigatório. O app principal. Formato: projects/{project}/locations/{location}/apps/{app}
page_size

int32

Opcional. O número máximo de implantações a serem retornadas. O serviço pode retornar um valor inferior a este. Se não for especificado, no máximo 50 implantações serão retornadas. O valor máximo é 1.000. Valores maiores serão convertidos para 1.000.
page_token

string

Opcional. Um token de página recebido de uma chamada ListDeployments anterior. Forneça isso para recuperar a página subsequente.

Ao paginar, todos os outros parâmetros fornecidos para ListDeployments precisam corresponder à chamada que forneceu o token da página.
order_by

string

Opcional. Campo de classificação. Somente "name" e "create_time" são aceitos. Consulte https://google.aip.dev/132#ordering para mais detalhes.

ListDeploymentsResponse

Mensagem de resposta para AgentService.ListDeployments.

Campos
deployments[]

Deployment

A lista de implantações.
next_page_token

string

Um token, que pode ser enviado como page_token para recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes.

ListExamplesRequest

Mensagem de solicitação para AgentService.ListExamples.

Campos
parent

string

Obrigatório. O nome do recurso do app para listar exemplos.
page_size

int32

Opcional. Tamanho da página solicitada. O servidor pode retornar menos resultados do que o solicitado. Se não for especificado, o servidor escolherá um padrão apropriado.
page_token

string

Opcional. O valor next_page_token retornado de uma chamada AgentService.ListExamples de lista anterior.
filter

string

Opcional. Filtro a ser aplicado ao listar os exemplos. Consulte https://google.aip.dev/160 para mais detalhes.
order_by

string

Opcional. Campo de classificação. Somente "name" e "create_time" são aceitos. Consulte https://google.aip.dev/132#ordering para mais detalhes.

ListExamplesResponse

Mensagem de resposta para AgentService.ListExamples.

Campos
examples[]

Example

A lista de exemplos.
next_page_token

string

Um token que pode ser enviado como ListExamplesRequest.page_token para recuperar a próxima página. A ausência desse campo indica que não há páginas subsequentes.

ListGuardrailsRequest

Mensagem de solicitação para AgentService.ListGuardrails.

Campos
parent

string

Obrigatório. O nome do recurso do app em que os mecanismos de proteção serão listados.
page_size

int32

Opcional. Tamanho da página solicitada. O servidor pode retornar menos resultados do que o solicitado. Se não for especificado, o servidor escolherá um padrão apropriado.
page_token

string

Opcional. O valor next_page_token retornado de uma chamada AgentService.ListGuardrails de lista anterior.
filter

string

Opcional. Filtro a ser aplicado ao listar as proteções. Consulte https://google.aip.dev/160 para mais detalhes.
order_by

string

Opcional. Campo de classificação. Somente "name" e "create_time" são aceitos. Consulte https://google.aip.dev/132#ordering para mais detalhes.

ListGuardrailsResponse

Mensagem de resposta para AgentService.ListGuardrails.

Campos
guardrails[]

Guardrail

A lista de proteções.
next_page_token

string

Um token que pode ser enviado como ListGuardrailsRequest.page_token para recuperar a próxima página. A ausência desse campo indica que não há páginas subsequentes.

ListToolsRequest

Mensagem de solicitação para AgentService.ListTools.

Campos
parent

string

Obrigatório. O nome do recurso do app em que as ferramentas serão listadas.
page_size

int32

Opcional. Tamanho da página solicitada. O servidor pode retornar menos resultados do que o solicitado. Se não for especificado, o servidor escolherá um padrão apropriado.
page_token

string

Opcional. O valor next_page_token retornado de uma chamada AgentService.ListTools de lista anterior.
filter

string

Opcional. Filtro a ser aplicado ao listar as ferramentas. Use "include_system_tools=true" para incluir ferramentas do sistema na resposta. Consulte https://google.aip.dev/160 para mais detalhes.
order_by

string

Opcional. Campo de classificação. Somente "name" e "create_time" são aceitos. Consulte https://google.aip.dev/132#ordering para mais detalhes.

ListToolsResponse

Mensagem de resposta para AgentService.ListTools.

Campos
tools[]

Tool

A lista de ferramentas.
next_page_token

string

Um token que pode ser enviado como ListToolsRequest.page_token para recuperar a próxima página. A ausência desse campo indica que não há páginas subsequentes.

ListToolsetsRequest

Mensagem de solicitação para AgentService.ListToolsets.

Campos
parent

string

Obrigatório. O nome do recurso do app em que os conjuntos de ferramentas serão listados.
page_size

int32

Opcional. Tamanho da página solicitada. O servidor pode retornar menos resultados do que o solicitado. Se não for especificado, o servidor escolherá um padrão apropriado.
page_token

string

Opcional. O valor next_page_token retornado de uma chamada AgentService.ListToolsets de lista anterior.
filter

string

Opcional. Filtro a ser aplicado ao listar os conjuntos de ferramentas. Consulte https://google.aip.dev/160 para mais detalhes.
order_by

string

Opcional. Campo de classificação. Somente "name" e "create_time" são aceitos. Consulte https://google.aip.dev/132#ordering para mais detalhes.

ListToolsetsResponse

Mensagem de resposta para AgentService.ListToolsets.

Campos
toolsets[]

Toolset

A lista de conjuntos de ferramentas.
next_page_token

string

Um token que pode ser enviado como ListToolsetsRequest.page_token para recuperar a próxima página. A ausência desse campo indica que não há páginas subsequentes.

LoggingSettings

Configurações para descrever os comportamentos de registro do app.

Campos
redaction_config

RedactionConfig

Opcional. Configuração de como os dados sensíveis devem ser encobridos.
audio_recording_config

AudioRecordingConfig

Opcional. Configuração de como as interações de áudio devem ser gravadas.
bigquery_export_settings

BigQueryExportSettings

Opcional. Configurações para descrever os comportamentos de exportação do BigQuery para o app. Os dados de conversa serão exportados para tabelas do BigQuery se essa opção estiver ativada.
cloud_logging_settings

CloudLoggingSettings

Opcional. Configurações para descrever os comportamentos do Cloud Logging para o app.
conversation_logging_settings

ConversationLoggingSettings

Opcional. Configurações para descrever os comportamentos de registro de conversas do app.
evaluation_audio_recording_config

AudioRecordingConfig

Opcional. Configuração de como as interações de áudio devem ser gravadas para a avaliação. Por padrão, a gravação de áudio não está ativada para sessões de avaliação.
metric_analysis_settings

MetricAnalysisSettings

Opcional. Configurações para descrever os comportamentos de coleta de dados de conversa para o pipeline de análise de LLM do app.

McpTool

Uma ferramenta do MCP. Consulte https://modelcontextprotocol.io/specification/2025-06-18/server/tools para mais detalhes.

Campos
name

string

Obrigatório. O nome da ferramenta do MCP.
description

string

Opcional. A descrição da ferramenta MCP.
input_schema

Schema

Opcional. O esquema dos argumentos de entrada da ferramenta MCP.
output_schema

Schema

Opcional. O esquema dos argumentos de saída da ferramenta MCP.
server_address

string

Obrigatório. O endereço do servidor MCP, por exemplo, "https://example.com/mcp/". Se o servidor for criado com o SDK do MCP, o URL vai ter o sufixo "/mcp/". Somente servidores baseados em transporte HTTP de streaming são compatíveis. É o mesmo que o "server_address" no McpToolset. Consulte https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http para mais detalhes.
api_authentication

ApiAuthentication

Opcional. Informações de autenticação necessárias para executar a ferramenta no servidor MCP. Para a autenticação de token de portador, o token se aplica apenas à execução da ferramenta, não à listagem de ferramentas. Isso exige que as ferramentas possam ser listadas sem autenticação.
tls_config

TlsConfig

Opcional. A configuração de TLS. Inclui os certificados de servidor personalizados em que o cliente deve confiar.
service_directory_config

ServiceDirectoryConfig

Opcional. Configuração do Diretório de serviços para VPC-SC, usada para resolver nomes de serviços em um perímetro.

McpToolset

Um conjunto de ferramentas que contém uma lista de ferramentas oferecidas pelo servidor MCP.

Campos
server_address

string

Obrigatório. O endereço do servidor MCP, por exemplo, "https://example.com/mcp/". Se o servidor for criado com o SDK do MCP, o URL vai ter o sufixo "/mcp/". Somente servidores baseados em transporte HTTP de streaming são compatíveis. Consulte https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http para mais detalhes.
api_authentication

ApiAuthentication

Opcional. Informações de autenticação necessárias para acessar ferramentas e executar uma ferramenta no servidor MCP. Para a autenticação de token de portador, o token se aplica apenas à execução da ferramenta, não à listagem de ferramentas. Isso exige que as ferramentas possam ser listadas sem autenticação.
service_directory_config

ServiceDirectoryConfig

Opcional. Configuração do Diretório de serviços para VPC-SC, usada para resolver nomes de serviços em um perímetro.
tls_config

TlsConfig

Opcional. A configuração de TLS. Inclui os certificados de servidor personalizados em que o cliente deve confiar.

Mensagem

Uma mensagem em uma conversa.

Campos
role

string

Opcional. A função na conversa, por exemplo, usuário, agente.
chunks[]

Chunk

Opcional. Conteúdo da mensagem como uma série de partes.
event_time

Timestamp

Opcional. Carimbo de data/hora em que a mensagem foi enviada ou recebida. Não pode ser usado se a mensagem fizer parte de um example.

MetricAnalysisSettings

Configurações para descrever os comportamentos de coleta de dados de conversa para o pipeline de métricas de análise de LLM.

Campos
llm_metrics_opted_out

bool

Opcional. Se os dados de conversa serão coletados para métricas de análise de LLM. Se for "true", os dados de conversa não serão coletados para métricas de análise de LLM. Caso contrário, eles serão coletados.

ModelSettings

As configurações do modelo contêm várias configurações para o modelo de LLM.

Campos
model

string

Opcional. O modelo de LLM que o agente deve usar. Se não estiver definido, o agente vai herdar o modelo do agente principal.
temperature

double

Opcional. Se definido, essa temperatura será usada para o modelo LLM. A temperatura controla a aleatoriedade das respostas do modelo. Temperaturas mais baixas produzem respostas mais previsíveis. Temperaturas mais altas produzem respostas mais criativas.

OAuthConfig

Configurações para autenticação com OAuth.

Campos
oauth_grant_type

OAuthConfig.OauthGrantType

Obrigatório. Tipos de concessão do OAuth.
client_id

string

Obrigatório. O ID do cliente do provedor OAuth.
client_secret_version

string

Obrigatório. O nome do recurso da versão do secret do Secret Manager que armazena a chave secreta do cliente. Formato: projects/{project}/secrets/{secret}/versions/{version}

Observação: conceda o papel roles/secretmanager.secretAccessor ao agente de serviço do CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.
token_endpoint

string

Obrigatório. O endpoint de token no provedor OAuth para troca por um token de acesso.
scopes[]

string

Opcional. Os escopos do OAuth a serem concedidos.

OauthGrantType

Tipos de concessão do OAuth. Somente a concessão de credenciais do cliente é compatível.

Tipos enumerados
OAUTH_GRANT_TYPE_UNSPECIFIED Não especificado. O padrão é CLIENT_CREDENTIAL.
CLIENT_CREDENTIAL Representa o fluxo de credenciais do cliente.

Omnichannel

Representa um recurso omnichannel.

Campos
name

string

Identificador. O identificador exclusivo do recurso omnicanal. Formato: projects/{project}/locations/{location}/omnichannels/{omnichannel}
display_name

string

Obrigatório. Nome de exibição do recurso omnicanal.
description

string

Opcional. Descrição legível do recurso omnichannel.
create_time

Timestamp

Apenas saída. Carimbo de data/hora em que o recurso omnichannel foi criado.
update_time

Timestamp

Apenas saída. Carimbo de data/hora em que o recurso omnicanal foi atualizado pela última vez.
etag

string

Apenas saída. Etag usada para garantir que o objeto não mudou durante uma operação de leitura-modificação-gravação.
integration_config

OmnichannelIntegrationConfig

Opcional. A configuração de integração para o recurso omnicanal.

OmnichannelIntegrationConfig

OmnichannelIntegrationConfig contém todas as configurações de integração de apps.

Campos
channel_configs

map<string, OmnichannelIntegrationConfig.ChannelConfig>

Opcional. Várias configurações para processar eventos do app.
subscriber_configs

map<string, OmnichannelIntegrationConfig.SubscriberConfig>

Opcional. Várias configurações de assinantes.
routing_configs

map<string, OmnichannelIntegrationConfig.RoutingConfig>

Opcional. A chave de routing_configs é uma chave de app_configs, e o valor é um RoutingConfig, que contém a chave do assinante.

CesAppConfig

Configurações para o app CES.

Campos
app

string

O identificador exclusivo do app do CES. Formato: projects/{project}/locations/{location}/apps/{app}

ChannelConfig

O ChannelConfig contém configurações para várias integrações de apps.

Campos
Campo de união channel_config. A configuração do app. channel_config pode ser apenas uma das seguintes opções:
whatsapp_config

OmnichannelIntegrationConfig.WhatsappConfig

Configuração do WhatsApp.

RoutingConfig

A configuração de roteamento especifica como/quem rotear eventos de app para um assinante.

Campos
subscriber_key

string

A chave do assinante.

SubscriberConfig

Configurações de assinantes.

Campos
Campo de união subscriber_config. A configuração do assinante. subscriber_config pode ser apenas de um dos tipos a seguir:
ces_app_config

OmnichannelIntegrationConfig.CesAppConfig

Ces app config.

WhatsappConfig

Como o Omnichannel deve receber/responder a eventos do WhatsApp.

Campos
phone_number_id

string

O ID do número de telefone associado à conta do WhatsApp Business.
phone_number

string

O número de telefone usado para enviar/receber mensagens.
whatsapp_business_account_id

string

O ID da conta do WhatsApp Business (WABA) do cliente.
webhook_verify_token

string

O token de verificação configurado no painel de apps da Meta para verificação de webhook.
whatsapp_business_token

string

O token de acesso para autenticar chamadas de API para a API do WhatsApp Cloud. https://developers.facebook.com/docs/whatsapp/business-management-api/get-started/#business-integration-system-user-access-tokens
meta_business_portfolio_id

string

O ID do portfólio de negócios da Meta (MBP). https://www.facebook.com/business/help/1710077379203657

OmnichannelOperationMetadata

Representa os metadados da operação de longa duração.

Campos
create_time

Timestamp

Somente saída: a hora em que a operação foi criada.
end_time

Timestamp

Somente saída: a hora em que a operação terminou de ser executada.
status_message

string

Apenas saída. Status legível da operação, caso haja um.
requested_cancellation

bool

Apenas saída. Identifica se o usuário solicitou o cancelamento da operação.

OpenApiTool

Uma ferramenta de API remota definida por um esquema OpenAPI.

Campos
open_api_schema

string

Obrigatório. O esquema OpenAPI no formato JSON ou YAML.
name

string

Opcional. O nome da ferramenta. Se não for fornecido, o nome da ferramenta será derivado do esquema OpenAPI, de operation.operationId.
description

string

Opcional. A descrição da ferramenta. Se não for fornecida, a descrição da ferramenta será derivada do esquema OpenAPI, do operation.description ou do operation.summary.
api_authentication

ApiAuthentication

Opcional. Informações de autenticação exigidas pela API.
tls_config

TlsConfig

Opcional. A configuração de TLS. Inclui os certificados de servidor personalizados em que o cliente vai confiar.
service_directory_config

ServiceDirectoryConfig

Opcional. Configuração do Diretório de serviços.
ignore_unknown_fields

bool

Opcional. Se for verdadeiro, o agente vai ignorar campos desconhecidos na resposta da API.
url

string

Opcional. O URL do servidor do esquema da API aberta. Esse campo só é definido em ferramentas nas dependências do ambiente durante o processo de exportação se o esquema contiver um URL do servidor. Durante o processo de importação, se esse URL estiver presente nas dependências do ambiente e o esquema tiver o marcador de posição $env_var, ele vai substituir o marcador no esquema.

OpenApiToolset

Um conjunto de ferramentas que contém uma lista de ferramentas definidas por um esquema da OpenAPI.

Campos
open_api_schema

string

Obrigatório. O esquema OpenAPI do conjunto de ferramentas.
api_authentication

ApiAuthentication

Opcional. Informações de autenticação exigidas pela API.
tls_config

TlsConfig

Opcional. A configuração de TLS. Inclui os certificados de servidor personalizados
service_directory_config

ServiceDirectoryConfig

Opcional. Configuração do Diretório de serviços.
ignore_unknown_fields

bool

Opcional. Se for "true", o agente vai ignorar campos desconhecidos na resposta da API para todas as operações definidas no esquema OpenAPI.
url

string

Opcional. O URL do servidor do esquema da API aberta. Esse campo só é definido em conjuntos de ferramentas nas dependências do ambiente durante o processo de exportação se o esquema contiver um URL de servidor. Durante o processo de importação, se esse URL estiver presente nas dependências do ambiente e o esquema tiver o marcador de posição $env_var, ele vai substituir o marcador no esquema.

OperationMetadata

Representa os metadados da operação de longa duração.

Campos
create_time

Timestamp

Somente saída: a hora em que a operação foi criada.
end_time

Timestamp

Somente saída: a hora em que a operação terminou de ser executada.
status_message

string

Apenas saída. Status legível da operação, caso haja um.
requested_cancellation

bool

Apenas saída. Identifica se o usuário solicitou o cancelamento da operação. As operações que foram canceladas têm o valor google.longrunning.Operation.error com um google.rpc.Status.code de 1, correspondente a Code.CANCELLED.

OutputAudioConfig

O OutputAudioConfig configura como o agente do CES deve sintetizar as respostas de áudio enviadas.

Campos
audio_encoding

AudioEncoding

Obrigatório. A codificação dos dados de áudio de saída.
sample_rate_hertz

int32

Obrigatório. A taxa de amostragem (em Hertz) dos dados de áudio de saída.

PythonCodeCondition

Bloco de código Python para avaliar a condição.

Campos
python_code

string

Obrigatório. O código Python a ser executado.

PythonFunction

Uma ferramenta de função Python.

Campos
name

string

Opcional. O nome da função Python a ser executada. Precisa corresponder a um nome de função Python definido no código Python. Diferencia maiúsculas de minúsculas. Se o nome não for fornecido, a primeira função definida no código Python será usada.
python_code

string

Opcional. O código Python a ser executado para a ferramenta.
description

string

Apenas saída. A descrição da função Python, analisada da docstring do código Python.

RecognitionResult

Resultado do reconhecimento de fala para a entrada de áudio.

Campos
transcript

string

Opcional. Segmentos de fala do usuário concatenados capturados durante a vez atual.

RedactionConfig

Configuração para instruir como os dados sensíveis devem ser tratados.

Campos
enable_redaction

bool

Opcional. Se for verdadeiro, a edição será aplicada em vários cenários de geração de registros, incluindo histórico de conversas, Cloud Logging e gravação de áudio.
inspect_template

string

Opcional. Nome do modelo de inspeção do DLP para configurar a detecção de tipos de dados sensíveis.

Formato: projects/{project}/locations/{location}/inspectTemplates/{inspect_template}
deidentify_template

string

Opcional. Nome do modelo de desidentificação do DLP para instruir sobre como desidentificar conteúdo.

Formato: projects/{project}/locations/{location}/deidentifyTemplates/{deidentify_template}

RestoreAppVersionRequest

Mensagem de solicitação para AgentService.RestoreAppVersion

Campos
name

string

Obrigatório. O nome do recurso da versão do app a ser restaurada.

RestoreAppVersionResponse

Esse tipo não tem campos.

Mensagem de resposta para AgentService.RestoreAppVersion.

RetrieveToolSchemaRequest

Mensagem de solicitação para ToolService.RetrieveToolSchema.

Campos
parent

string

Obrigatório. O nome do recurso do app a que a ferramenta/conjunto de ferramentas pertence. Formato: projects/{project}/locations/{location}/apps/{app}
Campo de união tool_identifier. O identificador da ferramenta para recuperar o esquema. Ela pode ser uma ferramenta persistente ou de um conjunto de ferramentas. tool_identifier pode ser apenas de um dos tipos a seguir:
tool

string

Opcional. O nome da ferramenta para recuperar o esquema. Formato: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
toolset_tool

ToolsetTool

Opcional. A ferramenta do conjunto de ferramentas para recuperar o esquema. Apenas uma ferramenta precisa corresponder ao predicado do conjunto de ferramentas. Caso contrário, um erro será retornado.

RetrieveToolSchemaResponse

Mensagem de resposta para ToolService.RetrieveToolSchema.

Campos
input_schema

Schema

O esquema dos parâmetros de entrada da ferramenta.
output_schema

Schema

O esquema dos parâmetros de saída da ferramenta.
Campo de união tool_identifier. O identificador da ferramenta a que o esquema se destina. tool_identifier pode ser apenas de um dos tipos a seguir:
tool

string

O nome da ferramenta para a qual o esquema é destinado. Formato: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
toolset_tool

ToolsetTool

A ferramenta do conjunto de ferramentas a que o esquema se destina.

RetrieveToolsRequest

Mensagem de solicitação para ToolService.RetrieveTools.

Campos
toolset

string

Obrigatório. O nome do conjunto de ferramentas para o qual as ferramentas serão recuperadas. Formato: projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}
tool_ids[]

string

Opcional. Os identificadores das ferramentas a serem recuperadas do conjunto de ferramentas. Se estiver vazio, todas as ferramentas no conjunto serão retornadas.

RetrieveToolsResponse

Mensagem de resposta para ToolService.RetrieveTools.

Campos
tools[]

Tool

A lista de ferramentas incluídas no conjunto especificado.

RunSessionRequest

Mensagem de solicitação para SessionService.RunSession.

Campos
config

SessionConfig

Obrigatório. A configuração da sessão.
inputs[]

SessionInput

Obrigatório. Entradas para a sessão.

RunSessionResponse

Mensagem de resposta para SessionService.RunSession.

Campos
outputs[]

SessionOutput

Saídas da sessão.

Esquema

Representa um subconjunto selecionado de um objeto de esquema da OpenAPI 3.0.

Campos
type

Schema.Type

Obrigatório. O tipo dos dados.
properties

map<string, Schema>

Opcional. Propriedades de Type.OBJECT.
required[]

string

Opcional. Propriedades obrigatórias de Type.OBJECT.
description

string

Opcional. A descrição dos dados.
items

Schema

Opcional. Esquema dos elementos de Type.ARRAY.
nullable

bool

Opcional. Indica se o valor pode ser nulo.
unique_items

bool

Opcional. Indica que os itens na matriz precisam ser exclusivos. Aplicável apenas a TYPE.ARRAY.
prefix_items[]

Schema

Opcional. Esquemas dos elementos iniciais de Type.ARRAY.
additional_properties

Schema

Opcional. Pode ser um booleano ou um objeto e controla a presença de propriedades adicionais.
any_of[]

Schema

Opcional. O valor precisa ser validado em relação a qualquer um (um ou mais) dos subesquemas na lista.
enum[]

string

Opcional. Valores possíveis do elemento de tipo primitivo com formato de enumeração. Exemplos: 1. Podemos definir a direção como : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. Podemos definir o número do apartamento como : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
default

Value

Opcional. Valor padrão dos dados.
ref

string

Opcional. Permite referências indiretas entre nós de esquema. O valor precisa ser uma referência válida a um filho do defs raiz.

Por exemplo, o esquema a seguir define uma referência a um nó de esquema chamado "Pet":

type: object
properties:
  pet:
    ref: #/defs/Pet
defs:
  Pet:
    type: object
    properties:
      name:
        type: string

O valor da propriedade "pet" é uma referência ao nó de esquema chamado "Pet". Confira detalhes em https://json-schema.org/understanding-json-schema/structuring (em inglês).
defs

map<string, Schema>

Opcional. Um mapa de definições para uso por ref. Permitido apenas na raiz do esquema.
title

string

Opcional. O título do esquema.
min_items

int64

Opcional. Número mínimo de elementos para Type.ARRAY.
max_items

int64

Opcional. Número máximo de elementos para Type.ARRAY.
minimum

double

Opcional. Valor mínimo para Type.INTEGER e Type.NUMBER.
maximum

double

Opcional. Valor máximo para Type.INTEGER e Type.NUMBER.

Tipo

Tipos de dados da OpenAPI.

Tipos enumerados
TYPE_UNSPECIFIED Tipo não especificado.
STRING Tipo de string.
INTEGER Tipo inteiro.
NUMBER Tipo de número.
BOOLEAN Tipo booleano.
OBJECT Tipo de objeto.
ARRAY Tipo de matriz.

ServiceAccountAuthConfig

Configurações para autenticação usando uma conta de serviço personalizada.

Campos
service_account

string

Obrigatório. O endereço de e-mail da conta de serviço usada para autenticação. O CES usa essa conta de serviço para trocar um token de acesso, que é enviado no cabeçalho Authorization da solicitação.

A conta de serviço precisa ter o papel roles/iam.serviceAccountTokenCreator concedido ao agente de serviço do CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.
scopes[]

string

Opcional. Os escopos do OAuth a serem concedidos. Se não for especificado, o escopo padrão https://www.googleapis.com/auth/cloud-platform será usado.

ServiceAgentIdTokenAuthConfig

Esse tipo não tem campos.

Configurações para autenticação com token de ID gerado pelo agente de serviço.

ServiceDirectoryConfig

Configuração para ferramentas que usam o Diretório de serviços.

Campos
service

string

Obrigatório. O nome do serviço do Diretório de serviços. Formato: projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}. O local do diretório de serviços precisa ser o mesmo do app.

SessionConfig

A configuração da sessão.

Campos
session

string

Obrigatório. O identificador exclusivo da sessão. Formato: projects/{project}/locations/{location}/apps/{app}/sessions/{session}
input_audio_config

InputAudioConfig

Opcional. Configuração para processar o áudio de entrada.
output_audio_config

OutputAudioConfig

Opcional. Configuração para gerar o áudio de saída.
historical_contexts[]

Message

Opcional. O contexto histórico da sessão, incluindo entradas do usuário, respostas do agente e outras mensagens. Normalmente, o agente do CES gerencia a sessão automaticamente para que o cliente não precise preencher esse campo explicitamente. No entanto, o cliente pode substituir os contextos históricos para forçar o início da sessão em um determinado estado.
entry_agent

string

Opcional. O agente de entrada para processar a sessão. Se não for especificado, a sessão será processada pelo root agent do app. Formato: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
deployment

string

Opcional. A implantação do app a ser usado na sessão. Formato: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
time_zone

string

Opcional. O fuso horário do usuário. Se fornecido, o agente vai usar o fuso horário para variáveis relacionadas a data e hora. Caso contrário, o agente vai usar o fuso horário especificado em App.time_zone_settings.

O formato é o fuso horário do banco de dados IANA. Por exemplo: "America/Los_Angeles".
remote_dialogflow_query_parameters

SessionConfig.RemoteDialogflowQueryParameters

Opcional. QueryParameters a serem enviados ao agente remoto do Dialogflow quando o controle da sessão for transferido para ele.

RemoteDialogflowQueryParameters

QueryParameters a serem enviados ao agente remoto do Dialogflow quando o controle da sessão for transferido para ele.

Campos
webhook_headers

map<string, string>

Opcional. Os cabeçalhos HTTP a serem enviados como webhook_headers em QueryParameters.
payload

Struct

Opcional. O payload a ser enviado em QueryParameters.
end_user_metadata

Struct

Opcional. Os metadados do usuário final a serem enviados em QueryParameters.

SessionInput

Entrada para a sessão.

Campos
will_continue

bool

Opcional. Uma flag para indicar se a mensagem atual é um fragmento de uma entrada maior na sessão de streaming bidirecional.

Quando definido como true, o agente adia o processamento até receber uma mensagem subsequente em que will_continue seja false ou até que o sistema detecte um ponto final na entrada de áudio.

OBSERVAÇÃO: esse campo não se aplica a entradas de áudio e DTMF, já que elas são sempre processadas automaticamente com base no sinal de encerramento.
Campo de união input_type. O tipo da entrada. input_type pode ser apenas de um dos tipos a seguir:
text

string

Opcional. Dados de texto do usuário final.
dtmf

string

Opcional. Dígitos DTMF do usuário final.
audio

bytes

Opcional. Dados de áudio do usuário final.
tool_responses

ToolResponses

Opcional. Resultados da execução das chamadas de função do cliente.
image

Image

Opcional. Dados de imagem do usuário final.
blob

Blob

Opcional. Dados de blob do usuário final.
variables

Struct

Opcional. Variáveis contextuais da sessão, com chave pelo nome. Somente as variáveis declaradas no app serão usadas pelo agente da CES.

Variáveis não reconhecidas ainda serão enviadas ao [agente do Dialogflow][Agent.RemoteDialogflowAgent] como parâmetros de sessão adicionais.
event

Event

Opcional. Entrada de evento.

SessionOutput

Saída da sessão.

Campos
turn_index

int32

Indica a ordem sequencial da rodada de conversa a que esta saída pertence, começando em 1.
turn_completed

bool

Se for verdadeiro, o agente do CES detectou o fim da conversa atual e não vai fornecer mais resultados para essa vez.
diagnostic_info

SessionOutput.DiagnosticInfo

Opcional. As informações de diagnóstico contêm detalhes da execução durante o processamento da entrada. Preenchido apenas no último SessionOutput (com turn_completed=true) para cada turno.
Campo de união output_type. O tipo da saída. output_type pode ser apenas de um dos tipos a seguir:
text

string

Texto de saída do agente da CES.
audio

bytes

Saída de áudio do agente da CES.
tool_calls

ToolCalls

Solicitação para o cliente executar as ferramentas.
citations

Citations

Citações que fornecem as informações de origem do texto gerado pelo agente.
google_search_suggestions

GoogleSearchSuggestions

As sugestões retornadas da Pesquisa Google como resultado da invocação do GoogleSearchTool.
end_session

EndSession

Indica que a sessão foi encerrada.
payload

Struct

Payload personalizado com saída estruturada do agente da CES.

DiagnosticInfo

Contém detalhes da execução durante o processamento.

Campos
messages[]

Message

Lista das mensagens que ocorreram durante o processamento.
root_span

Span

Um rastreamento de todo o processamento da solicitação, representado como um período raiz. Esse intervalo pode conter intervalos filhos aninhados para operações específicas.

Período

Um intervalo é uma unidade de trabalho ou uma única operação durante o processamento da solicitação.

Campos
name

string

Apenas saída. O nome do intervalo.
start_time

Timestamp

Apenas saída. O horário de início do intervalo.
end_time

Timestamp

Apenas saída. O horário de término do período.
duration

Duration

Apenas saída. A duração do período.
attributes

Struct

Apenas saída. Atributos de chave-valor associados ao intervalo.
child_spans[]

Span

Apenas saída. Os intervalos filhos aninhados neste intervalo.

SynthesizeSpeechConfig

Configuração de como a resposta do agente deve ser sintetizada.

Campos
voice

string

Opcional. Nome da voz. Se não for definido, o serviço vai escolher uma voz com base nos outros parâmetros, como language_code.

Para conferir a lista de vozes disponíveis, consulte Vozes e idiomas compatíveis do Cloud Text-to-Speech.
speaking_rate

double

Opcional. A taxa/velocidade de fala no intervalo [0,25, 2,0]. 1,0 é a velocidade nativa normal compatível com a voz específica. 2,0 é duas vezes mais rápido e 0,5 é metade da velocidade nativa. Valores fora do intervalo [0,25, 2,0] vão retornar um erro.

SystemTool

Ferramenta de sistema predefinida.

Campos
name

string

Obrigatório. O nome da ferramenta do sistema.
description

string

Apenas saída. A descrição da ferramenta do sistema.

TimeZoneSettings

Configurações de fuso horário do app.

Campos
time_zone

string

Opcional. O fuso horário do app do banco de dados de fuso horário, por exemplo, America/Los_Angeles, Europe/Paris.

TlsConfig

A configuração de TLS.

Campos
ca_certs[]

TlsConfig.CaCert

Obrigatório. Especifica uma lista de certificados de CA personalizados permitidos para verificação HTTPS.

CaCert

O certificado de CA.

Campos
display_name

string

Obrigatório. O nome dos certificados de CA personalizados permitidos. Isso pode ser usado para desambiguar os certificados de CA personalizados.
cert

bytes

Obrigatório. Os certificados de CA personalizados permitidos (no formato DER) para verificação HTTPS. Isso substitui o repositório de confiança SSL padrão. Se estiver vazio ou não especificado, o CES vai usar o armazenamento de confiança padrão do Google para verificar certificados. Observação: verifique se os certificados do servidor HTTPS estão assinados com "subject alt name". Por exemplo, um certificado pode ser autoassinado usando o seguinte 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'")

Ferramenta

Uma ferramenta representa uma ação que o agente do CES pode realizar para alcançar determinadas metas.

Campos
name

string

Identificador. O identificador exclusivo da ferramenta. Formato: - projects/{project}/locations/{location}/apps/{app}/tools/{tool} para

projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool} para ferramentas recuperadas de um conjunto de ferramentas. Essas ferramentas são dinâmicas e somente de saída. Elas não podem ser referenciadas diretamente onde uma ferramenta é esperada.
display_name

string

Apenas saída. O nome de exibição da ferramenta, derivado com base no tipo dela. Por exemplo, o nome de exibição de uma [ClientFunction][Tool.ClientFunction] é derivado da propriedade name.
execution_type

ExecutionType

Opcional. O tipo de execução da ferramenta.
create_time

Timestamp

Apenas saída. Carimbo de data/hora em que a ferramenta foi criada.
update_time

Timestamp

Apenas saída. Carimbo de data/hora da última atualização da ferramenta.
etag

string

Etag usada para garantir que o objeto não mudou durante uma operação de leitura-modificação-gravação. Se a ETag estiver vazia, a atualização vai substituir todas as mudanças simultâneas.
generated_summary

string

Apenas saída. Se a ferramenta for gerada pelo assistente de LLM, esse campo vai conter um resumo descritivo da geração.
tool_fake_config

ToolFakeConfig

Opcional. Configuração para o comportamento da ferramenta no modo simulado.
Campo de união tool_type. O tipo da ferramenta. tool_type pode ser apenas de um dos tipos a seguir:
client_function

ClientFunction

Opcional. A função do cliente.
open_api_tool

OpenApiTool

Opcional. A ferramenta de API aberta.
google_search_tool

GoogleSearchTool

Opcional. A ferramenta de pesquisa do Google.
connector_tool

ConnectorTool

Opcional. A ferramenta Integration Connectors.
data_store_tool

DataStoreTool

Opcional. A ferramenta de repositório de dados.
python_function

PythonFunction

Opcional. A ferramenta de função Python.
mcp_tool

McpTool

Opcional. A ferramenta MCP. Uma ferramenta do MCP não pode ser criada ou atualizada diretamente e é gerenciada pelo conjunto de ferramentas do MCP.
file_search_tool

FileSearchTool

Opcional. A ferramenta de pesquisa de arquivos.
system_tool

SystemTool

Opcional. A ferramenta do sistema.
widget_tool

WidgetTool

Opcional. A ferramenta de widget.

ToolCall

Solicitação para o cliente ou o agente executar a ferramenta especificada.

Campos
id

string

Opcional. O identificador exclusivo da chamada de função. Se preenchido, o cliente vai retornar o resultado da execução com o código correspondente em ToolResponse.
display_name

string

Apenas saída. Nome de exibição da ferramenta.
args

Struct

Opcional. Os parâmetros e valores de entrada da ferramenta no formato de objeto JSON.
Campo de união tool_identifier. O identificador da ferramenta a ser executada. Ela pode ser uma ferramenta persistente ou de um conjunto de ferramentas. tool_identifier pode ser apenas de um dos tipos a seguir:
tool

string

Opcional. O nome da ferramenta a ser executada. Formato: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
toolset_tool

ToolsetTool

Opcional. A ferramenta do conjunto de ferramentas a ser executada.

ToolCalls

Solicitação para que o cliente execute as ferramentas e retorne os resultados da execução antes de continuar a sessão.

Campos
tool_calls[]

ToolCall

Opcional. A lista de chamadas de ferramentas a serem executadas.

ToolFakeConfig

Configuração para o comportamento da ferramenta no modo simulado.

Campos
enable_fake_mode

bool

Opcional. Indica se a ferramenta está usando o modo simulado.
Campo de união tool_response. A resposta é estática ou fornecida por uma função Python. tool_response pode ser apenas de um dos tipos a seguir:
code_block

CodeBlock

Opcional. Bloco de código que será executado em vez de uma chamada de ferramenta real.

ToolResponse

O resultado da execução de uma ferramenta específica do cliente ou do agente.

Campos
id

string

Opcional. O código correspondente do tool call a que a resposta se refere.
display_name

string

Apenas saída. Nome de exibição da ferramenta.
response

Struct

Obrigatório. O resultado da execução da ferramenta no formato de objeto JSON. Use a chave "output" para especificar a resposta da ferramenta e a chave "error" para especificar os detalhes do erro (se houver). Se as chaves "output" e "error" não forem especificadas, toda a "response" será tratada como resultado da execução da ferramenta.
Campo de união tool_identifier. O identificador da ferramenta que foi executada. Ela pode ser uma ferramenta persistente ou de um conjunto de ferramentas. tool_identifier pode ser apenas de um dos tipos a seguir:
tool

string

Opcional. O nome da ferramenta a ser executada. Formato: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
toolset_tool

ToolsetTool

Opcional. A ferramenta do conjunto de ferramentas que foi executada.

ToolResponses

Resultados da execução das chamadas de função solicitadas do cliente.

Campos
tool_responses[]

ToolResponse

Opcional. A lista de resultados da execução da ferramenta.

Conjunto de ferramentas

Um conjunto de ferramentas representa um grupo de ferramentas gerenciadas dinamicamente que podem ser usadas pelo agente.

Campos
name

string

Identificador. O identificador exclusivo do conjunto de ferramentas. Formato: projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}
display_name

string

Opcional. O nome de exibição do conjunto de ferramentas. Precisa ser exclusivo no mesmo app.
description

string

Opcional. A descrição do conjunto de ferramentas.
create_time

Timestamp

Apenas saída. Carimbo de data/hora em que o conjunto de ferramentas foi criado.
update_time

Timestamp

Apenas saída. Carimbo de data/hora da última atualização do conjunto de ferramentas.
etag

string

ETag usada para garantir que o objeto não tenha sido alterado durante uma operação de leitura-modificação-gravação. Se a ETag estiver vazia, a atualização vai substituir todas as mudanças simultâneas.
execution_type

ExecutionType

Opcional. O tipo de execução das ferramentas no conjunto de ferramentas.
tool_fake_config

ToolFakeConfig

Opcional. Configuração para o comportamento das ferramentas no modo simulado.
Campo de união toolset_type. O tipo do conjunto de ferramentas. toolset_type pode ser apenas de um dos tipos a seguir:
mcp_toolset

McpToolset

Opcional. Um conjunto de ferramentas que contém uma lista de ferramentas oferecidas pelo servidor MCP.
open_api_toolset

OpenApiToolset

Opcional. Um conjunto de ferramentas que contém uma lista de ferramentas definidas por um esquema da OpenAPI.
connector_toolset

ConnectorToolset

Opcional. Um conjunto de ferramentas que gera ferramentas de uma conexão do Integration Connectors.

ToolsetTool

Uma ferramenta criada com um conjunto de ferramentas.

Campos
toolset

string

Obrigatório. O nome do recurso do conjunto de ferramentas de que essa ferramenta deriva. Formato: projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}
tool_id

string

Opcional. O ID da ferramenta para filtrar as ferramentas e recuperar o esquema.

TransferRule

Regra para transferência para um agente específico.

Campos
child_agent

string

Obrigatório. O nome do recurso do agente filho a que a regra se aplica. Formato: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
direction

TransferRule.Direction

Obrigatório. A direção da transferência.
Campo de união rule_type. O tipo de regra. rule_type pode ser apenas de um dos tipos a seguir:
deterministic_transfer

TransferRule.DeterministicTransfer

Opcional. Uma regra que transfere imediatamente para o agente de destino quando a condição é atendida.
disable_planner_transfer

TransferRule.DisablePlannerTransfer

Opcional. Regra que impede a transferência do planejador para o agente de destino.

DeterministicTransfer

Regra de transferência determinista. Quando a condição é avaliada como verdadeira, a transferência ocorre.

Campos
Campo de união condition_type. A condição a ser avaliada. condition_type pode ser apenas de um dos tipos a seguir:
expression_condition

ExpressionCondition

Opcional. Uma regra que avalia uma condição de estado da sessão. Se a condição for avaliada como verdadeira, a transferência vai ocorrer.
python_code_condition

PythonCodeCondition

Opcional. Uma regra que usa um bloco de código Python para avaliar as condições. Se a condição for avaliada como verdadeira, a transferência vai ocorrer.

Direção

A direção da transferência.

Tipos enumerados
DIRECTION_UNSPECIFIED Direção não especificada.
PARENT_TO_CHILD Transferência do agente principal para o secundário.
CHILD_TO_PARENT Transferir do agente secundário para o principal.

DisablePlannerTransfer

Uma regra que impede a transferência do planejador para o agente de destino.

Campos
expression_condition

ExpressionCondition

Obrigatório. Se a condição for avaliada como verdadeira, o planejador não poderá transferir para o agente de destino.

TriggerAction

Ação realizada quando uma determinada pré-condição é atendida.

Campos
Campo de união action. A ação a ser tomada. action pode ser apenas de um dos tipos a seguir:
respond_immediately

TriggerAction.RespondImmediately

Opcional. Responder imediatamente com uma resposta pré-configurada.
transfer_agent

TriggerAction.TransferAgent

Opcional. Transfira a conversa para outro agente.
generative_answer

TriggerAction.GenerativeAnswer

Opcional. Responda com uma resposta generativa.

GenerativeAnswer

O agente vai responder imediatamente com uma resposta generativa.

Campos
prompt

string

Obrigatório. O comando a ser usado para a resposta generativa.

RespondImmediately

O agente vai responder imediatamente com uma resposta pré-configurada.

Campos
responses[]

TriggerAction.Response

Obrigatório. As respostas predefinidas para o agente escolher. A resposta é escolhida aleatoriamente.

Resposta

Representa uma resposta do agente.

Campos
text

string

Obrigatório. Texto para o agente responder.
disabled

bool

Opcional. Se a resposta está desativada. As respostas desativadas não são usadas pelo agente.

TransferAgent

O agente vai transferir a conversa para outro agente.

Campos
agent

string

Obrigatório. O nome do agente para quem a conversa será transferida. O agente precisa estar no mesmo app que o agente atual. Formato: projects/{project}/locations/{location}/apps/{app}/agents/{agent}

UpdateAgentRequest

Mensagem de solicitação para AgentService.UpdateAgent.

Campos
agent

Agent

Obrigatório. O agente a ser atualizado.
update_mask

FieldMask

Opcional. A máscara de campo é usada para controlar quais campos são atualizados. Se a máscara não estiver presente, todos os campos serão atualizados.

UpdateAppRequest

Mensagem de solicitação para AgentService.UpdateApp.

Campos
app

App

Obrigatório. O app a ser atualizado.
update_mask

FieldMask

Opcional. A máscara de campo é usada para controlar quais campos são atualizados. Se a máscara não estiver presente, todos os campos serão atualizados.

UpdateDeploymentRequest

Mensagem de solicitação para AgentService.UpdateDeployment.

Campos
deployment

Deployment

Obrigatório. A implantação a ser atualizada.
update_mask

FieldMask

Opcional. Lista de campos a serem atualizados.

UpdateExampleRequest

Mensagem de solicitação para AgentService.UpdateExample.

Campos
example

Example

Obrigatório. O exemplo a ser atualizado.
update_mask

FieldMask

Opcional. A máscara de campo é usada para controlar quais campos são atualizados. Se a máscara não estiver presente, todos os campos serão atualizados.

UpdateGuardrailRequest

Mensagem de solicitação para AgentService.UpdateGuardrail.

Campos
guardrail

Guardrail

Obrigatório. A proteção a ser atualizada.
update_mask

FieldMask

Opcional. A máscara de campo é usada para controlar quais campos são atualizados. Se a máscara não estiver presente, todos os campos serão atualizados.

UpdateToolRequest

Mensagem de solicitação para AgentService.UpdateTool.

Campos
tool

Tool

Obrigatório. A ferramenta a ser atualizada.
update_mask

FieldMask

Opcional. A máscara de campo é usada para controlar quais campos são atualizados. Se a máscara não estiver presente, todos os campos serão atualizados.

UpdateToolsetRequest

Mensagem de solicitação para AgentService.UpdateToolset.

Campos
toolset

Toolset

Obrigatório. O conjunto de ferramentas a ser atualizado.
update_mask

FieldMask

Opcional. A máscara de campo é usada para controlar quais campos são atualizados. Se a máscara não estiver presente, todos os campos serão atualizados.

WebSearchQuery

Representa uma única consulta de pesquisa na Web e o URI de pesquisa associado.

Campos
query

string

O texto da consulta de pesquisa.
uri

string

O URI da página de resultados da Pesquisa Google para a consulta.

WidgetTool

Representa uma ferramenta de widget que o agente pode invocar. Quando a ferramenta é escolhida pelo agente, ele retorna o widget ao cliente. O cliente é responsável por processar o widget e gerar a próxima consulta do usuário para continuar a interação com o agente.

Campos
name

string

Obrigatório. O nome de exibição da ferramenta de widget.
description

string

Opcional. A descrição da ferramenta de widget.
widget_type

WidgetTool.WidgetType

Opcional. O tipo da ferramenta de widget. Se não for especificado, o tipo padrão será "CUSTOMIZED".
Campo de união input. A entrada da ferramenta de widget. input pode ser apenas de um dos tipos a seguir:
parameters

Schema

Opcional. Os parâmetros de entrada da ferramenta de widget.

WidgetType

Todos os tipos de widgets disponíveis. Novos valores podem ser adicionados a essa enumeração no futuro.

Tipos enumerados
WIDGET_TYPE_UNSPECIFIED Tipo de widget não especificado.
CUSTOM Tipo de widget personalizado.
PRODUCT_DETAILS Widget de detalhes do produto.
QUICK_ACTIONS Widget de ações rápidas.
PRODUCT_COMPARISON Widget de comparação de produtos.
ADVANCED_PRODUCT_DETAILS Widget de detalhes avançados do produto.
SHORT_FORM Widget de formato curto.
OVERALL_SATISFACTION Widget de satisfação geral.
ORDER_SUMMARY Widget de resumo do pedido.
APPOINTMENT_DETAILS Widget de detalhes do horário.
APPOINTMENT_SCHEDULER Widget de agendamento de horários.
CONTACT_FORM Widget de formulário de contato.