Package google.cloud.ces.v1beta

Í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 no 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 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 barreira de 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.

GenerateAppResource

rpc GenerateAppResource(GenerateAppResourceRequest) returns (Operation)

Gera recursos específicos (por exemplo, agente) no app usando o assistente de LLM.

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

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

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

GetChangelog

rpc GetChangelog(GetChangelogRequest) returns (Changelog)

Recebe o registro de alterações 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.

GetSecuritySettings

rpc GetSecuritySettings(GetSecuritySettingsRequest) returns (SecuritySettings)

Recupera as configurações de segurança do projeto e do local.

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.securitySettings.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 em questã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 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 no 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 alteraçõ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.changelogs.list

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

ListConversations

rpc ListConversations(ListConversationsRequest) returns (ListConversationsResponse)

Lista as conversas no app em questã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 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 fornecido.

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 as proteçõ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.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 atual 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.

UpdateAppVersion

rpc UpdateAppVersion(UpdateAppVersionRequest) returns (AppVersion)

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

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

UpdateSecuritySettings

rpc UpdateSecuritySettings(UpdateSecuritySettingsRequest) returns (SecuritySettings)

Atualiza as configurações de segurança do projeto e do local.

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

AssistantService

O serviço que gerencia recursos relacionados ao assistente no Pacote de Engajamento do Cliente (CES). O assistente, Arc, é um agente de conversação incorporado aos aplicativos do CES para ajudar os usuários a criar os próprios agentes.

ChatAiAssistant

rpc ChatAiAssistant(ChatAiAssistantRequest) returns (ChatAiAssistantResponse)

Executa o Arc, o assistente de IA, para a sessã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 app:

  • ces.apps.update

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

CreateAssistantSession

rpc CreateAssistantSession(CreateAssistantSessionRequest) returns (AssistantSession)

Cria uma nova sessão do assistente 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.assistantSessions.create

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

DeleteAssistantSession

rpc DeleteAssistantSession(DeleteAssistantSessionRequest) returns (Empty)

Exclui a sessão do assistente 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.

GetAssistantSession

rpc GetAssistantSession(GetAssistantSessionRequest) returns (AssistantSession)

Recebe detalhes da sessão do assistente 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.assistantSessions.get

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

ListAssistantSessions

rpc ListAssistantSessions(ListAssistantSessionsRequest) returns (ListAssistantSessionsResponse)

Lista todas as sessões do assistente 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.assistantSessions.list

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

RunAssistant

rpc RunAssistant(RunAssistantRequest) returns (RunAssistantResponse)

Executa o agente assistente para a sessão de assistente 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 app:

  • ces.apps.update

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

EvaluationService

O EvaluationService expõe métodos para realizar avaliações no app CES.

CreateEvaluation

rpc CreateEvaluation(CreateEvaluationRequest) returns (Evaluation)

Cria uma avaliaçã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 parent:

  • ces.evaluations.create

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

CreateEvaluationDataset

rpc CreateEvaluationDataset(CreateEvaluationDatasetRequest) returns (EvaluationDataset)

Cria um conjunto de dados de avaliaçã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 parent:

  • ces.evaluationDatasets.create

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

CreateEvaluationExpectation

rpc CreateEvaluationExpectation(CreateEvaluationExpectationRequest) returns (EvaluationExpectation)

Cria uma expectativa de avaliaçã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 parent:

  • ces.evaluationExpectations.create

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

CreateScheduledEvaluationRun

rpc CreateScheduledEvaluationRun(CreateScheduledEvaluationRunRequest) returns (ScheduledEvaluationRun)

Cria uma execução de avaliação programada.

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.

DeleteEvaluation

rpc DeleteEvaluation(DeleteEvaluationRequest) returns (Empty)

Exclui uma avaliaçã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 name:

  • ces.evaluations.delete

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

DeleteEvaluationDataset

rpc DeleteEvaluationDataset(DeleteEvaluationDatasetRequest) returns (Empty)

Exclui um conjunto de dados de avaliaçã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 name:

  • ces.evaluationDatasets.delete

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

DeleteEvaluationExpectation

rpc DeleteEvaluationExpectation(DeleteEvaluationExpectationRequest) returns (Empty)

Exclui uma expectativa de avaliaçã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 name:

  • ces.evaluationExpectations.delete

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

DeleteEvaluationResult

rpc DeleteEvaluationResult(DeleteEvaluationResultRequest) returns (Empty)

Exclui um resultado de avaliaçã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 name:

  • ces.evaluationResults.delete

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

DeleteEvaluationRun

rpc DeleteEvaluationRun(DeleteEvaluationRunRequest) returns (Operation)

Exclui uma execução de avaliaçã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 name:

  • ces.evaluationRuns.delete

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

DeleteScheduledEvaluationRun

rpc DeleteScheduledEvaluationRun(DeleteScheduledEvaluationRunRequest) returns (Empty)

Exclui uma execução de avaliação programada.

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.

ExportEvaluationResults

rpc ExportEvaluationResults(ExportEvaluationResultsRequest) returns (Operation)

Exporta os resultados das avaliações.

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

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

ExportEvaluationRuns

rpc ExportEvaluationRuns(ExportEvaluationRunsRequest) returns (Operation)

Exporta execuções de avaliações.

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 names:

  • ces.evaluationRuns.get

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

  • ces.evaluations.export

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

ExportEvaluations

rpc ExportEvaluations(ExportEvaluationsRequest) returns (Operation)

Exporta avaliações.

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

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

GenerateEvaluation

rpc GenerateEvaluation(GenerateEvaluationRequest) returns (Operation)

Cria uma avaliação de ouro com base em uma conversa.

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 conversation:

  • ces.conversations.get

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

GetEvaluation

rpc GetEvaluation(GetEvaluationRequest) returns (Evaluation)

Recebe detalhes da avaliaçã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.evaluations.get

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

GetEvaluationDataset

rpc GetEvaluationDataset(GetEvaluationDatasetRequest) returns (EvaluationDataset)

Recebe detalhes do conjunto de dados de avaliação 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.evaluationDatasets.get

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

GetEvaluationExpectation

rpc GetEvaluationExpectation(GetEvaluationExpectationRequest) returns (EvaluationExpectation)

Recebe detalhes da expectativa de avaliaçã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.evaluationExpectations.get

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

GetEvaluationResult

rpc GetEvaluationResult(GetEvaluationResultRequest) returns (EvaluationResult)

Recebe detalhes do resultado da avaliação 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.evaluationResults.get

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

GetEvaluationRun

rpc GetEvaluationRun(GetEvaluationRunRequest) returns (EvaluationRun)

Recebe detalhes da execução de avaliaçã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.evaluationRuns.get

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

GetScheduledEvaluationRun

rpc GetScheduledEvaluationRun(GetScheduledEvaluationRunRequest) returns (ScheduledEvaluationRun)

Recebe detalhes da execução de avaliação programada 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.

ImportEvaluations

rpc ImportEvaluations(ImportEvaluationsRequest) returns (Operation)

Importa avaliações para o 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 as seguintes permissões do IAM no recurso parent:

  • ces.evaluations.create
  • ces.evaluations.update

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

ListEvaluationDatasets

rpc ListEvaluationDatasets(ListEvaluationDatasetsRequest) returns (ListEvaluationDatasetsResponse)

Lista todos os conjuntos de dados de avaliação no app fornecido.

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

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

ListEvaluationExpectations

rpc ListEvaluationExpectations(ListEvaluationExpectationsRequest) returns (ListEvaluationExpectationsResponse)

Lista todas as expectativas de avaliação no app em questã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 parent:

  • ces.evaluationExpectations.list

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

ListEvaluationResults

rpc ListEvaluationResults(ListEvaluationResultsRequest) returns (ListEvaluationResultsResponse)

Lista todos os resultados de uma determinada avaliaçã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 parent:

  • ces.evaluationResults.list

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

ListEvaluationRuns

rpc ListEvaluationRuns(ListEvaluationRunsRequest) returns (ListEvaluationRunsResponse)

Lista todas as execuções de avaliaçã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.evaluationRuns.list

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

ListEvaluations

rpc ListEvaluations(ListEvaluationsRequest) returns (ListEvaluationsResponse)

Lista todas as avaliaçõ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.evaluations.list

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

ListScheduledEvaluationRuns

rpc ListScheduledEvaluationRuns(ListScheduledEvaluationRunsRequest) returns (ListScheduledEvaluationRunsResponse)

Lista todas as execuções de avaliação programadas 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.

RunEvaluation

rpc RunEvaluation(RunEvaluationRequest) returns (Operation)

Executa uma avaliação 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 app:

  • ces.apps.runEvaluation

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

RunEvaluationResultMetrics

rpc RunEvaluationResultMetrics(RunEvaluationResultMetricsRequest) returns (Operation)

Executa métricas em um resultado de avaliação atual.

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.

TestPersonaVoice

rpc TestPersonaVoice(TestPersonaVoiceRequest) returns (TestPersonaVoiceResponse)

Testa a voz de uma persona. Também aceita uma persona padrã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 app:

  • ces.apps.get

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

UpdateEvaluation

rpc UpdateEvaluation(UpdateEvaluationRequest) returns (Evaluation)

Atualiza uma avaliaçã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 name:

  • ces.evaluations.update

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

UpdateEvaluationDataset

rpc UpdateEvaluationDataset(UpdateEvaluationDatasetRequest) returns (EvaluationDataset)

Atualiza um conjunto de dados de avaliaçã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 name:

  • ces.evaluationDatasets.update

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

UpdateEvaluationExpectation

rpc UpdateEvaluationExpectation(UpdateEvaluationExpectationRequest) returns (EvaluationExpectation)

Atualiza uma expectativa de avaliaçã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 name:

  • ces.evaluationExpectations.update

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

UpdateScheduledEvaluationRun

rpc UpdateScheduledEvaluationRun(UpdateScheduledEvaluationRunRequest) returns (ScheduledEvaluationRun)

Atualiza uma execução de avaliação programada.

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.

UploadEvaluationAudio

rpc UploadEvaluationAudio(UploadEvaluationAudioRequest) returns (UploadEvaluationAudioResponse)

Faz upload de áudio para uso em avaliações de referência. Armazena o áudio no bucket do Cloud Storage definido em "App.logging_settings.evaluation_audio_recording_config.gcs_bucket" e retorna uma transcriçã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 name:

  • ces.evaluations.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 streams de saída multimodais em tempo real.

--- Fluxo 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 deve incluir InputAudioConfig e OutputAudioConfig para definir os parâmetros de processamento e síntese de áudio.

  2. Interação: fluxo de mensagens subsequentes SessionInput que contém dados de entrada do usuário em tempo real.

  3. Encerramento: o cliente precisa fechar parcialmente o stream quando não houver mais entrada do usuário. Ele também precisa ser semifechado 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 e 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 da vez (mensagem final da vez): contém SessionOutput com turn_completed definido como verdadeiro. 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. Interrompa 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.

CancelAssistantTurn

rpc CancelAssistantTurn(CancelAssistantTurnRequest) returns (CancelAssistantTurnResponse)

Cancela a vez em andamento da sessão do assistente, se houver: a interrupção explícita do usuário para uma vez em execução separada de qualquer stream. Um cancelamento que chega em uma tarefa que não hospeda a vez a substitui pela época da vez da sessão, encerrando-a em uma renovação de concessã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 name:

  • ces.assistantSessions.get

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

GenerateOnboardingSuggestions

rpc GenerateOnboardingSuggestions(GenerateOnboardingSuggestionsRequest) returns (GenerateOnboardingSuggestionsResponse)

Gera sugestões de integração personalizadas para o estado zero do Arc: classifica o usuário que faz a solicitação (novo / explorando / retornando) com base no histórico de sessões do assistente no app e retorna chips de sugestão de resposta (retomar uma sessão, continuar o trabalho ou começar algo novo) para renderizar antes que qualquer mensagem seja enviada.

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

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.

StreamChatAiAssistant

rpc StreamChatAiAssistant(StreamChatAiAssistantRequest) returns (StreamChatAiAssistantResponse)

Executa o Arc, o assistente de IA, para a sessão de assistente especificada em um modo de streaming.

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

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

StreamRunSession

rpc StreamRunSession(RunSessionRequest) returns (RunSessionResponse)

Inicia uma interação de turno único com o agente do CES. Usa streaming do lado do servidor para fornecer resultados incrementais e respostas parciais à medida que são gerados.

Por padrão, as respostas completas (por exemplo, mensagens de callbacks ou respostas completas de LLM) são enviadas ao cliente assim que ficam disponíveis. Para ativar o streaming de blocos de texto individuais diretamente do modelo, defina enable_text_streaming como verdadeiro.

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 fornecida. O esquema é calculado em tempo real para a instância fornecida 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 que os widgets interajam com as APIs do CES.

GenerateChatToken

rpc GenerateChatToken(GenerateChatTokenRequest) returns (GenerateChatTokenResponse)

Gera um token com escopo de sessão para o widget de chat se autenticar com as APIs de 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.

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 para usar 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 a ferramenta usar. 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 da 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 da ConnectorTool vai falhar.
LIST Operação de lista.
GET Receber operação.
CREATE Operação de criação.
UPDATE Operação de atualização.
DELETE Excluir operação.

ActiveTurnInfo

Informações de anexo em tempo real para uma sessão que está em execução, desconectada do cliente ou estacionada para ser retirada por outra tarefa do servidor.

Campos
turn_id

string

Identifica a vez. É repetido por snapshots de retomada na API de streaming.

status

ActiveTurnInfo.Status

Status atual do anexo.

start_time

Timestamp

Apenas saída. Quando a vez começou.

last_progress_time

Timestamp

Apenas saída. Quando o turno persistiu o progresso pela última vez.

orphan_deadline_time

Timestamp

Apenas saída. Quando a vez será encerrada se nenhum cliente se conectar.

Status

Como a vez em andamento se relaciona com as tarefas do cliente e do servidor.

Tipos enumerados
STATUS_UNSPECIFIED Não especificado.
RUNNING A rodada está sendo executada com pelo menos um cliente conectado.
DISCONNECTED A vez está sendo executada sem nenhum cliente anexado.
RESUMING A vez é estacionada para retirada: a próxima anexação continua.
ABANDONED A concessão do servidor da rodada expirou, e nenhuma tarefa está conduzindo-a. A próxima leitura a sela para uma parcial confirmada. Não é possível anexar.

Agente

Um agente é o elemento básico 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 que o agente seja chamado. Os callbacks fornecidos são executados sequencialmente na ordem exata em que são fornecidos 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 callbacks que serão executados depois que o agente for chamado. Os callbacks fornecidos são executados sequencialmente na ordem exata em que são fornecidos 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 que o modelo seja 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 são fornecidos 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 são fornecidos 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 que a ferramenta seja 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 são fornecidos 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 que serão 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 são fornecidos 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 em que o agente foi atualizado pela última vez.

guardrails[]

string

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

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.

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 agentes. Se houver várias regras correspondentes, a primeira da lista será usada.

validation_errors[]

string

Apenas saída. Configurações incorretas ou erros no agente que podem afetar a qualidade dele.

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 remoto do Dialogflow que 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.

remote_a2a_agent

Agent.RemoteA2aAgent

Opcional. O agente A2A remoto que será usado para a execução do agente.

AgentToolset

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

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.

RemoteA2aAgent

O agente que vai transferir a execução para um agente A2A remoto.

Campos
a2a_config

RemoteA2aConfig

Obrigatório. A configuração da conexão A2A.

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

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 de 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 de 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 definidas no agente do Dialogflow devem ser respeitadas.

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

string

Opcional. O nome da variável que contém o código do idioma a ser usado na sessão do Dialogflow. Se não for especificado, o código de idioma padrão do agente do Dialogflow será usado.

AgentCard

O AgentCard transmite informações importantes sobre um agente remoto. É uma versão reduzida do AgentCard definido no protocolo A2A https://a2a-protocol.org/dev/specification/#441-agentcard

Campos
name

string

Obrigatório. Um nome do agente legível por humanos.

description

string

Obrigatório. Uma descrição do domínio de ação/espaço de solução do agente.

supported_interfaces[]

AgentInterface

Obrigatório. Lista ordenada de interfaces compatíveis. A primeira entrada é preferencial.

version

string

Obrigatório. A versão do agente.

skills[]

AgentSkill

Obrigatório. As habilidades representam uma unidade de capacidade que um agente pode realizar. Isso pode parecer um pouco abstrato, mas representa um conjunto mais focado de ações que o agente tem grande probabilidade de realizar com sucesso.

AgentInterface

Declara uma combinação de URL de destino, transporte e versão de protocolo para interagir com o agente. Isso permite que os agentes exponham a mesma funcionalidade em vários mecanismos de vinculação de protocolo.

Campos
url

string

Obrigatório. O URL em que essa interface está disponível. Precisa ser um URL HTTPS absoluto válido em produção. Exemplo: "https://api.example.com/a2a/v1", "https://grpc.example.com/a2a"

protocol_binding

string

Obrigatório. A vinculação de protocolo compatível com este URL. Essa é uma string de formato aberto, que pode ser facilmente estendida para outras vinculações de protocolo. Os principais oficialmente compatíveis são JSONRPC, GRPC e HTTP+JSON.

tenant

string

ID do locatário a ser usado na solicitação ao chamar o agente.

protocol_version

string

Obrigatório. A versão do protocolo A2A que essa interface expõe. Use a versão secundária mais recente compatível por versão principal. Exemplos: "0.3", "1.0"

AgentRegistryDeployment

Configuração e status da implantação do Agent Registry.

Campos
agent_registry_service_name

string

Opcional. Apenas saída. O nome do recurso do serviço do Agent Registry implantado. Formato: projects/{project}/locations/{location}/services/{service}

AgentSkill

Representa uma capacidade ou função distinta que um agente pode executar.

Campos
id

string

Obrigatório. Um identificador exclusivo para a habilidade do agente.

name

string

Obrigatório. Um nome legível por humanos para a habilidade.

description

string

Obrigatório. Uma descrição detalhada da habilidade.

tags[]

string

Obrigatório. Um conjunto de palavras-chave que descrevem as capacidades da habilidade.

examples[]

string

Exemplos de comandos ou cenários que essa habilidade pode processar.

input_modes[]

string

O conjunto de tipos de mídia de entrada compatíveis com essa habilidade, que substitui os padrões do agente.

output_modes[]

string

O conjunto de tipos de mídia de saída compatíveis com essa habilidade, que substitui os padrões do agente.

AgentTool

Representa uma ferramenta que permite que o agente chame outro agente.

Campos
name

string

Obrigatório. O nome da ferramenta do agente.

description

string

Opcional. Descrição da finalidade da ferramenta.

agent

string

Opcional. O nome do recurso do agente que é o ponto de entrada da ferramenta. Formato: projects/{project}/locations/{location}/agents/{agent}

AgentTransfer

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

Campos
target_agent

string

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

display_name

string

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

AggregatedMetrics

Métricas agregadas para uma avaliação ou conjunto de dados de avaliação.

Campos
metrics_by_app_version[]

AggregatedMetrics.MetricsByAppVersion

Apenas saída. Métricas agregadas, agrupadas por ID da versão do app.

HallucinationMetrics

Métricas para resultados de alucinação.

Campos
score

float

Apenas saída. A pontuação média de alucinação (0 a 1).

MetricsByAppVersion

Métricas agregadas por versão do app.

Campos
app_version_id

string

Apenas saída. O ID da versão do app.

tool_metrics[]

AggregatedMetrics.ToolMetrics

Apenas saída. Métricas de cada ferramenta nessa versão do app.

semantic_similarity_metrics[]

AggregatedMetrics.SemanticSimilarityMetrics

Apenas saída. Métricas de semelhança semântica nesta versão do app.

hallucination_metrics[]

AggregatedMetrics.HallucinationMetrics

Apenas saída. Métricas de alucinação nesta versão do app.

tool_call_latency_metrics[]

AggregatedMetrics.ToolCallLatencyMetrics

Apenas saída. Métricas de latência de chamada de ferramenta nesta versão do app.

turn_latency_metrics[]

AggregatedMetrics.TurnLatencyMetrics

Apenas saída. Métricas de latência de turno nesta versão do app.

pass_count

int32

Apenas saída. O número de vezes que a avaliação foi aprovada.

fail_count

int32

Apenas saída. O número de vezes que a avaliação falhou.

metrics_by_turn[]

AggregatedMetrics.MetricsByTurn

Apenas saída. Métricas agregadas por turno nesta versão do app.

MetricsByTurn

Métricas agregadas por turno.

Campos
turn_index

int32

Apenas saída. O índice de turno (baseado em 0).

tool_metrics[]

AggregatedMetrics.ToolMetrics

Apenas saída. Métricas de cada ferramenta neste turno.

semantic_similarity_metrics[]

AggregatedMetrics.SemanticSimilarityMetrics

Apenas saída. Métricas de semelhança semântica neste turno.

hallucination_metrics[]

AggregatedMetrics.HallucinationMetrics

Apenas saída. Métricas de alucinação dentro deste turno.

tool_call_latency_metrics[]

AggregatedMetrics.ToolCallLatencyMetrics

Apenas saída. Métricas de latência de chamada de ferramenta neste turno.

turn_latency_metrics[]

AggregatedMetrics.TurnLatencyMetrics

Apenas saída. Métricas de latência de turno neste turno.

SemanticSimilarityMetrics

Métricas para resultados de similaridade semântica.

Campos
score

float

Apenas saída. A pontuação média de similaridade semântica (0 a 4).

ToolCallLatencyMetrics

Métricas de latência de chamada de ferramenta.

Campos
tool

string

Apenas saída. O nome da ferramenta.

average_latency

Duration

Apenas saída. A latência média das chamadas de ferramenta.

ToolMetrics

Métricas de uma única ferramenta.

Campos
tool

string

Apenas saída. O nome da ferramenta.

pass_count

int32

Apenas saída. O número de vezes que a ferramenta foi aprovada.

fail_count

int32

Apenas saída. O número de vezes que a ferramenta falhou.

TurnLatencyMetrics

Métricas de latência de turno.

Campos
average_latency

Duration

Apenas saída. A latência média dos turnos.

AmbientSoundConfig

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

Campos
volume_gain_db

double

Opcional. Ganho de volume (em dB) do volume nativo normal compatível com o 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 melhorar a naturalidade da conversa. source pode ser apenas de um dos tipos a seguir:
prebuilt_ambient_noise
(deprecated)

AmbientSoundConfig.PrebuiltAmbientNoise

Opcional. Descontinuado: o uso de prebuilt_ambient_noise foi descontinuado e substituído por 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 a 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 predefinido.

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 do 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. Por exemplo, 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. Local da chave na solicitação.

RequestLocation

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

Tipos enumerados
REQUEST_LOCATION_UNSPECIFIED Não especificado. Este 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, proteções) 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 configurar 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 do 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 outras informações relevantes para os detalhes ou usos pretendidos do app.

create_time

Timestamp

Apenas saída. Carimbo de data/hora de quando o app foi criado.

update_time

Timestamp

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

etag

string

Apenas saída. 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.

deployment_count

int32

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

client_certificate_settings

ClientCertificateSettings

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

vpc_sc_settings

VpcScSettings

Opcional. Configurações do VPC-SC 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.

evaluation_personas[]

EvaluationPersona

Opcional. As personas de avaliação do app. Esse campo é usado para definir as personas que podem ser usadas para avaliação. É possível definir no máximo 30 personas.

evaluation_settings

EvaluationSettings

Opcional. As configurações de avaliação do app.

validation_errors[]

string

Apenas saída. Configurações incorretas ou avisos no app.

dashboard_settings

DashboardSettings

Opcional. Configurações de painel específicas do app para vincular e configurar painéis do Contact Center Insights.

ToolExecutionMode

Define o comportamento de execução da ferramenta se várias ferramentas forem 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 puder 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

No Pacote de engajamento do cliente (CES), uma versão do app é um snapshot dele 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 de quando a versão do app foi criada.

update_time

Timestamp

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

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

ArtifactChunk

Um fragmento de um artefato de documento (por exemplo, um TDD de markdown) que o assistente está gerando. As diferenças de conteúdo são transmitidas enquanto o documento está sendo escrito para que os clientes possam renderizar uma prévia em tempo real. O bloco FINALIZED carrega o URI do Cloud Storage depois que o arquivo é mantido.

Campos
artifact_id

string

Identificador do artefato, estável em todos os blocos de um artefato no stream.

display_name

string

O nome do arquivo mostrado ao usuário, por exemplo, "hotel_booking_tdd.md". Definido como STARTED (e repetido em FINALIZED).

mime_type

string

O tipo de mídia IANA do conteúdo do artefato, por exemplo, "text/markdown".

content_delta

string

Conteúdo de artefato incremental. Definido em blocos DELTA.

gcs_uri

string

O objeto do Cloud Storage em que o artefato foi mantido. Definido em blocos FINALIZED.

state

ArtifactChunk.State

Posição do ciclo de vida desse bloco.

target_app

string

Apenas saída. O app para o qual o artefato foi produzido, quando foi produzido para um. Formato: projects/{project}/locations/{location}/apps/{app}

Estado

Posição do ciclo de vida desse bloco no stream do artefato.

Tipos enumerados
STATE_UNSPECIFIED Padrão não utilizado.
STARTED O assistente começou a gerar o artefato.
DELTA Um incremento de conteúdo; content_delta está definido.
FINALIZED O artefato foi mantido. gcs_uri está definido.
FAILED Falha na geração ou persistência. O artefato não foi salvo.
CLOSED O documento terminou de ser transmitido: o conteúdo foi totalmente entregue por blocos content_delta. A persistência ainda pode ocorrer. Um bloco FINALIZED com um gcs_uri é enviado se e quando o artefato é salvo.

AssistantChunk

Um bloco de dados em uma mensagem do assistente.

Campos
create_time

Timestamp

Opcional. Carimbo de data/hora de quando o bloco foi criado ou emitido.

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

string

Opcional. Dados de texto.

thought

string

Opcional. Pensamento gerado pelo modelo.

payload

Struct

Opcional. Payload que contém respostas estruturadas, como o relatório de qualidade, o nome da versão do agente, as respostas sugeridas etc.

typed_payload

TypedPayload

Opcional. Payload digitado que contém respostas estruturadas.

AssistantConfirmationRequest

Uma pergunta ou confirmação que o assistente precisa que seja respondida antes que uma ação do agente possa continuar. O agente solicitante é pausado e só é retomado quando a resposta chega em um StreamChatAiAssistantRequest.confirmation_response posterior.

Campos
confirmation_id

string

Identificador que correlaciona essa solicitação com a resposta dela. Invisível para os clientes. Precisa ser repetido literalmente na solicitação de resposta.

context

string

Contexto que descreve o que está sendo confirmado (por exemplo, a ação que o agente quer realizar ou a pergunta que precisa ser respondida). Renderizado como texto simples, não Markdown.

positive_label

string

Rótulo para a ação de aprovação de uma confirmação binária (por exemplo, "Publicar"). Não definido quando questions é preenchido.

negative_label

string

Rótulo para a ação de recusa de uma confirmação binária (por exemplo, "Ainda não"). Não definido quando questions é preenchido.

questions[]

OptionQuestionsChunk.Question

Formulário de confirmação de múltipla escolha. Quando preenchido, o card renderiza uma lista de opções selecionáveis, e o submit_text da opção escolhida (ou o texto de formato livre do usuário) é retornado como AssistantConfirmationResponse.answer_text.

tool

string

Nome da chamada de ferramenta em que o agente pausou (por exemplo, "update_app"), para o cabeçalho do card. Não definido para perguntas puras.

agent_name

string

Rótulo de exibição do agente que gerou a confirmação (por exemplo, "Contract Architect") para o cabeçalho do card.

expire_time

Timestamp

Horário após o qual não é mais possível responder a essa confirmação. Um cartão expirado é renderizado como inativo, e o servidor recusa a confirmação na próxima vez para que o agente pausado não espere indefinidamente.

targets[]

AssistantConfirmationRequest.Target

Tudo o que a ação confirmada vai mudar para que o console possa renderizar "Atualizar 2 apps" e um selo por app. Vazio para cards legados de destino único.

Destino

Um recurso que será alterado pela ação confirmada.

Campos
resource

string

O recurso que será alterado, como um nome de recurso completo.

display_name

string

Nome de exibição do recurso ou app para o card.

action

string

A ação, por exemplo, CREATE, UPDATE, DELETE, COPY, LINK.

target_app

string

O app ao qual o recurso pertence ou vazio para uma ação com escopo de local, como criar um app. Formato: projects/{project}/locations/{location}/apps/{app}

AssistantConfirmationResponse

A resposta do usuário a um AssistantConfirmationRequest, enviada na próxima chamada SessionService.StreamChatAiAssistant para retomar o agente pausado.

Campos
confirmation_id

string

O AssistantConfirmationRequest.confirmation_id que está sendo respondido.

Campo de união response. A resposta do usuário. response pode ser apenas de um dos tipos a seguir:
confirmed

bool

Resposta binária: "true" aprova a ação pausada, "false" a recusa.

answer_text

string

O submit_text da opção escolhida ou o texto livre do usuário. A ação pausada é cancelada, e o texto é entregue ao agente para que ele tome as medidas necessárias.

AssistantMessage

Uma mensagem em uma sessão do assistente.

Campos
role

string

Obrigatório. Função na conversa "usuário" ou "modelo".

chunks[]

AssistantChunk

Opcional. Conteúdo da mensagem como blocos.

event_time

Timestamp

Obrigatório. Carimbo de data/hora de quando a mensagem foi enviada ou recebida.

attached_gcs_uris[]

string

Opcional. URIs do Cloud Storage para arquivos enviados pelo usuário durante essa rodada. Isso permite que os anexos sejam mantidos e renderizados na UI do histórico de sessões. Exemplo: "gs://cxas-transient-uploads/uuid/prd.pdf"

AssistantOutput

A saída do agente assistente.

Campos
message

AssistantMessage

Obrigatório. A resposta do agente assistente.

user_response_suggestions

UserResponseSuggestions

Apenas saída. Respostas sugeridas do usuário pelo agente assistente.

AssistantSession

Uma sessão do assistente representa uma conversa entre um usuário e o agente assistente.

Campos
name

string

Obrigatório. Identificador. O identificador exclusivo da sessão. Formato: projects/{project}/locations/{location}/apps/{app}/assistantSessions/{session}

requestor

string

Apenas saída. O usuário que iniciou a sessão.

messages[]

AssistantMessage

Opcional. Histórico de mensagens na sessão.

state

AssistantSessionState

Apenas saída. O status da sessão do assistente.

create_time

Timestamp

Apenas saída. A hora em que a sessão do assistente foi criada.

update_time

Timestamp

Apenas saída. A hora em que a sessão do assistente foi atualizada pela última vez.

user_response_suggestions

UserResponseSuggestions

Apenas saída. Respostas sugeridas do usuário pelo agente assistente.

display_name

string

Opcional. O nome de exibição da sessão do assistente.

artifacts[]

AssistantSessionArtifact

Apenas saída. Artefatos de documentos (por exemplo, TDDs gerados em markdown) produzidos pelo assistente nesta sessão. Apenas ponteiros. O conteúdo do arquivo fica no bucket do Cloud Storage do cliente.

session_checkpoint

SessionCheckpoint

Apenas saída. Ponto de verificação da sessão que contém a intenção do usuário e o resumo do histórico contínuo.

active_turn

ActiveTurnInfo

Apenas saída. Informações de anexo para a vez em execução desta sessão. Não definido quando nenhuma curva está em execução.

touched_apps[]

string

Apenas saída. Apps que essa sessão segmentou ou mudou (somente sessões com escopo de projeto), para tags de histórico. Formato: projects/{project}/locations/{location}/apps/{app}

AssistantSessionArtifact

Um artefato de documento gerado pelo assistente em uma sessão, armazenado como um arquivo no bucket do Cloud Storage do cliente.

Campos
id

string

Apenas saída. O identificador exclusivo do artefato na sessão.

display_name

string

Apenas saída. O nome do arquivo mostrado ao usuário, por exemplo, "hotel_booking_tdd.md".

gcs_uri

string

Apenas saída. O objeto do Cloud Storage que contém o conteúdo do artefato. Exemplo: "gs://{project}-agent-assist-artifacts/agent-assist-generated/1_tdd.md"

mime_type

string

Apenas saída. O tipo de mídia IANA do conteúdo do artefato, por exemplo, "text/markdown".

create_time

Timestamp

Apenas saída. Quando o artefato foi mantido.

turn_index

int32

Apenas saída. Índice da mensagem em [AssistantSession.messages] que produziu o artefato, para colocar o ícone do artefato quando o histórico for restaurado.

AssistantSessionState

O status da sessão do assistente.

Tipos enumerados
ASSISTANT_SESSION_STATE_UNSPECIFIED O valor padrão. Esse valor será usado se o status não for especificado.
PROCESSING O agente assistente está processando a solicitação como uma tarefa de longa duração.
IDLE O agente assistente está inativo e não tem solicitações ou respostas pendentes.
PENDING_REVIEW O agente assistente terminou de processar uma tarefa de longa duração e tem uma resposta pronta para o usuário.

AssistantSuggestion

Um único chip de sugestão de resposta de integração personalizado para o estado zero do Arc.

Campos
suggestion_id

string

Identificador estável para essa sugestão, que é enviado e recebido pelos clientes no registro de interações.

label

string

Rótulo do ícone mostrado ao usuário (no máximo 60 caracteres).

rationale

string

Explicação curta opcional de por que essa sugestão é mostrada (dica / pop-over de justificativa).

icon

AssistantSuggestion.Icon

Dica de ícone para o ícone.

source

AssistantSuggestion.Source

Como essa sugestão foi gerada.

candidate_type

string

Tipo de candidato da tabela de regras em kebab-case (por exemplo, "resume-pending-review"), para métricas.

Campo de união action. O que acontece ao ativar o chip. action pode ser apenas de um dos tipos a seguir:
seed_prompt

string

Preencha o editor com este texto. O usuário revisa e envia.

load_session

AssistantSuggestion.LoadSession

Abra uma sessão do assistente.

send_message

string

Preencha o editor com este texto e envie imediatamente. Usado apenas para chips de resposta rápida em uma conversa de integração ativa.

Ícone

Dica de ícone para o ícone.

Tipos enumerados
ICON_UNSPECIFIED Ícone não especificado.
RESUME Retomar uma sessão anterior.
BUILD Crie algo novo.
EVALUATE Sugestão relacionada à avaliação.
DEPLOY Sugestão relacionada à implantação.
EXPLORE Sugestão de exploração / descoberta.
FIX Corrigir um erro ou estado de falha.

LoadSession

Parâmetros para a ação load_session.

Campos
assistant_session_id

string

Identificador da sessão do assistente a ser aberta (o segmento final do nome do recurso AssistantSession).

Origem

Como essa sugestão foi gerada.

Tipos enumerados
SOURCE_UNSPECIFIED Origem não especificada.
RULE Candidato determinista de tabela de regras com frase de modelo.
LLM_RANKED Candidato da tabela de regras reclassificado e formulado pela etapa de formulação do LLM.

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 que compactam amostras de áudio de 14 bits usando a lei G.711 PCMU/A.

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 o 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 tiver "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 se engajar novamente. Se não for definido, o agente não vai pedir ao usuário para se reengajar.

ambient_sound_config

AmbientSoundConfig

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

custom_voice_samples[]

CustomVoiceSample

Opcional. Configura amostras de voz personalizadas para clonagem de voz.

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 do 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. Descontinuado: o uso de disable_barge_in foi suspenso em favor de disable_barge_in_control em ChannelProfile.

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.

barge_in_awareness

bool

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

BatchDeleteConversationsRequest

Mensagem de solicitação para AgentService.BatchDeleteConversations.

Campos
parent

string

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

conversations[]

string

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

BatchDeleteConversationsResponse

Mensagem de resposta para AgentService.BatchDeleteConversations.

Campos
deleted_conversations[]

string

A lista de conversas que foram 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 pelo 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. Resultado do processamento 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 o BigQuery Export está ativado.

project

string

Opcional. O ID do projeto do conjunto de dados do BigQuery para onde os dados serão exportados.

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 ID do 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 por humanos do callback.

disabled

bool

Opcional. Se o callback está desativado. Os callbacks desativados são ignorados pelo agente.

proactive_execution_enabled

bool

Opcional. Se ativado, o callback também será executado em saídas de modelo intermediárias. Essa configuração afeta apenas a chamada de retorno "After model". ATIVE COM CUIDADO. Normalmente, a chamada de retorno after_model_callback só precisa ser executada depois de receber todas as respostas do modelo. A ativação da execução proativa pode ter implicações negativas no custo e na latência da execução e 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.

CancelAssistantTurnRequest

Solicitação para cancelar a vez em andamento de uma sessão do assistente.

Campos
name

string

Obrigatório. A sessão do assistente em que a vez em andamento será cancelada.

turn_id

string

Opcional. A rodada a ser cancelada. Se estiver vazio, cancela a rodada em execução. Um cancelamento que nomeia uma rodada que não está mais em execução não tem efeito.

CancelAssistantTurnResponse

Resposta para CancelAssistantTurn.

Campos
cancelled

bool

Se uma rodada em andamento foi encontrada e solicitada para ser interrompida (diretamente nesta tarefa ou por uma preempção de época para uma rodada hospedada em outro lugar).

Registro de alterações

Os registros de alterações representam uma mudança feita no app ou em um recurso dele.

Campos
name

string

Identificador. O identificador exclusivo do registro de alterações. Formato: projects/{project}/locations/{location}/apps/{app}/changelogs/{changelog}

author

string

Apenas saída. O endereço de e-mail do autor da mudança.

display_name

string

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

description

string

Apenas saída. Descrição da alteração, 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 que foi 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. A hora em que a mudança foi feita.

sequence_number

int64

Apenas saída. O número de sequência monotonicamente crescente do registro de alterações.

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.

web_widget_config

ChannelProfile.WebWidgetConfig

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

whatsapp_config

ChannelProfile.WhatsAppConfig

Opcional. Configuração específica para implantações do WhatsApp.

instagram_config

ChannelProfile.InstagramConfig

Opcional. Configuração específica para implantações do Instagram.

disable_dtmf

bool

Opcional. Se a DTMF (frequência múltipla de dois tons) deve ser desativada.

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.

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 da 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).
CONTACT_CENTER_AS_A_SERVICE_CHAT Canal de central de atendimento como serviço (chat de CCaaS).
FIVE9 Canal da Five9.
CONTACT_CENTER_INTEGRATION Canal de integração de central de atendimento de terceiros.
WHATSAPP Canal do WhatsApp.
INSTAGRAM canal do Instagram.

InstagramConfig

Configuração específica para implantações do Instagram.

Campos
instagram_account_id

string

Obrigatório. O ID da conta do Instagram.

display_name

string

Apenas saída. O nome da página comercial da Meta que foi buscado.

thumbnail_url

string

Apenas saída. O URL da miniatura do perfil comercial da Meta que foi buscado.

description

string

Apenas saída. A descrição da página ou do perfil comercial da Meta.

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 Persona UNKNOWN.
CONCISE O agente mantém as respostas concisas e diretas.
CHATTY O agente fornece mais contexto, explicações e detalhes

WebWidgetConfig

Mensagem de 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 aceita entrada de texto e voz.
VOICE_ONLY O widget só aceita entrada de voz.
CHAT_ONLY O widget só aceita entrada de chat.
CHAT_VOICE_AND_VIDEO O widget aceita entradas de chat, voz e vídeo.

SecuritySettings

Configurações de segurança do 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 for false, o widget da Web precisará ser integrado ao seu próprio sistema de autenticação e autorização para retornar credenciais válidas para acessar o agente do CES.

enable_origin_check

bool

Opcional. Indica se a verificação de origem do widget da Web está ativada. Se for true, o widget da Web vai verificar a origem do site que o carrega e só vai permitir que ele seja carregado 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. É permitido um máximo de 100 origens. Exemplo: "https://example.com"

enable_recaptcha

bool

Opcional. Indica se a verificação 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.

WhatsAppConfig

Configuração específica para implantações do WhatsApp.

Campos
waba_id

string

Obrigatório. O ID da conta do WhatsApp Business.

phone_number_id

string

Obrigatório. O ID do número de telefone da Meta.

phone_number

string

Opcional. O número de telefone no formato E.164.

display_name

string

Apenas saída. O nome da página comercial da Meta que foi buscado.

thumbnail_url

string

Apenas saída. O URL da miniatura do perfil comercial da Meta que foi buscado.

description

string

Apenas saída. A descrição da página ou do perfil comercial da Meta.

ChatAiAssistantRequest

Mensagem de solicitação para AssistantService.ChatAiAssistant.

Campos
app

string

Obrigatório. O app para o qual o assistente será executado. Formato: projects/{project}/locations/{location}/apps/{app}

assistant_session

string

Obrigatório. A sessão do assistente que será usada para executar o assistente. Formato: projects/{project}/locations/{location}/apps/{app}/assistantSessions/{assistant_session}

message

string

Obrigatório. A mensagem a ser enviada ao agente assistente.

attached_gcs_uris[]

string

Opcional. URIs do Cloud Storage para arquivos enviados pelo usuário durante essa rodada. Exemplo: "gs://cxas-transient-uploads/uuid/prd.pdf"

context_token

string

Opcional. Token de contexto de integração opaco retornado por SessionService.GenerateOnboardingSuggestions. Quando definido e ainda atualizado, o servidor reutiliza o snapshot de integração calculado para o estado zero em vez de recalcular para a primeira rodada de conversa.

ChatAiAssistantResponse

Mensagem de resposta para AssistantService.ChatAiAssistant.

Campos
event_id

string

Identificador exclusivo do evento.

event_time

Timestamp

Carimbo de data/hora de quando o evento ocorreu.

ui_event

UiEvent

Opcional. Payload do evento UI.

Campo de união event. O payload do evento. event pode ser apenas de um dos tipos a seguir:
text_chunk

string

Token de texto (para streaming de respostas do Gemini palavra por palavra)

status_message

string

Atualização de status simples

session_checkpoint

SessionCheckpoint

Evento de recapitulação de checkpoint/compactação da sessão que contém a intenção do usuário e o resumo contínuo.

Pedaço

Um trecho de conteúdo em uma mensagem.

Campos
Campo de união data. Dividir dados em blocos. 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 da execução da ferramenta.

agent_transfer

AgentTransfer

Opcional. Evento de transferência do agente.

updated_variables

Struct

Uma estrutura representa as variáveis que foram atualizadas na conversa, identificadas pelos nomes das variáveis.

default_variables

Struct

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

Citações

Citações associadas à resposta do agente.

Campos
cited_chunks[]

Citations.CitedChunk

Lista de informações citadas.

inline_citations[]

Citations.InlineCitation

Opcional. Lista de citações inline na resposta do agente.

CitedChunk

Informação citada.

Campos
uri

string

URI usado para citação.

title

string

Título do documento citado.

text

string

Texto usado para citação.

requires_attribution

bool

Se essa citação exige que a atribuição seja mostrada aos usuários finais.

InlineCitation

Uma citação inline no texto da resposta.

Campos
start_index

int32

O índice inicial (em bytes) do segmento de texto na resposta do agente.

end_index

int32

O índice final (em bytes) do segmento de texto na resposta do agente.

cited_chunk_indices[]

int32

Os índices dos trechos citados que dão suporte a esse segmento de texto. Os índices se referem aos elementos em cited_chunks.

ClientCertificateSettings

Configurações para certificados do 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 da versão do secret do SecretManager 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 SecretManager que armazena a senha longa para descriptografar a chave privada. Não deve ser definida 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. Se o Cloud Logging deve 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 de simulação da ferramenta. Assinatura de função Python esperada: 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 do Integration Connectors referenciada. Formato: projects/{project}/locations/{location}/connections/{connection}

action

Action

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

auth_config

EndUserAuthConfig

Opcional. Configura como a autenticação é processada no Integration Connectors. Por padrão, uma autenticação de administrador é transmitida nas solicitações de API do Integration Connectors. É possível substituí-la por uma configuração de autenticação de usuário final diferente. 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 da 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 deve chamar essa ConnectorTool.

description

string

Opcional. A descrição da ferramenta que pode ser usada pelo agente para decidir se deve chamar essa 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 do Integration Connectors referenciada. Formato: projects/{project}/locations/{location}/connections/{connection}

auth_config

EndUserAuthConfig

Opcional. Configura como a autenticação é processada no Integration Connectors. Por padrão, uma autenticação de administrador é transmitida nas solicitações de API do Integration Connectors. É possível substituí-la por uma configuração de autenticação de usuário final diferente. 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 as quais as ferramentas serão geradas.

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 de quando a conversa foi criada.

end_time

Timestamp

Apenas saída. Carimbo de data/hora de quando a conversa foi concluída.

turns[]

Conversation.Turn

Obrigatório. As interações na 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 lida inicialmente 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 de idioma da conversa.

messages[]
(deprecated)

Message

Obsoleto. Use as curvas.

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 da 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 Entrada de texto.
INPUT_TYPE_EVENT Entrada de evento.
INPUT_TYPE_AUDIO Entrada de áudio.
INPUT_TYPE_IMAGE Entrada de imagem.
INPUT_TYPE_BLOB Entrada de blob.
INPUT_TYPE_TOOL_RESPONSE Entrada de resposta da ferramenta de função do cliente.
INPUT_TYPE_VARIABLES Entrada de variáveis.

Origem

A origem da conversa.

Tipos enumerados
SOURCE_UNSPECIFIED Origem não especificada.
LIVE A conversa é do usuário final ao vivo.
SIMULATOR A conversa é do simulador.
EVAL A conversa é da avaliação.
AGENT_TOOL A conversa é de uma ferramenta de agente. A ferramenta de agente executa o agente em uma sessão separada, que é mantida para fins de teste e depuração.

Turn

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

Campos
messages[]

Message

Opcional. Lista de mensagens na rodada de conversa, incluindo entrada do usuário, respostas do agente e eventos intermediários durante o processamento.

root_span

Span

Opcional. O período raiz do processamento da ação.

user_intended_text

string

Opcional. O texto de informações empíricas pretendido do autor da chamada simulado (Polysynth). Preenchido apenas quando as métricas de taxa de erro de palavras estão ativadas.

ConversationLoggingSettings

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

Campos
disable_conversation_logging

bool

Opcional. Se o registro de conversas deve ser desativado para as sessões.

retention_window

Duration

Opcional. Controla a janela de retenção da conversa. Se não for definido, a conversa será retida por 365 dias.

CreateAgentRequest

Mensagem de solicitação para AgentService.CreateAgent.

Campos
parent

string

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

agent_id

string

Opcional. O ID a ser usado para o 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 o 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.

CreateAssistantSessionRequest

Mensagem de solicitação para AssistantService.CreateAssistantSession.

Campos
parent

string

Obrigatório. O app para criar a sessão do assistente no formato: projects/{project}/locations/{location}/apps/{app}

assistant_session_id

string

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

assistant_session_messages[]

AssistantMessage

Opcional. As mensagens para propagar a sessão do assistente.

CreateDeploymentRequest

Mensagem de solicitação para AgentService.CreateDeployment.

Campos
parent

string

Obrigatório. O app pai. 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.

CreateEvaluationDatasetRequest

Mensagem de solicitação para EvaluationService.CreateEvaluationDataset.

Campos
parent

string

Obrigatório. O app para o qual a avaliação será criada. Formato: projects/{project}/locations/{location}/apps/{app}

evaluation_dataset_id

string

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

evaluation_dataset

EvaluationDataset

Obrigatório. O conjunto de dados de avaliação a ser criado.

CreateEvaluationExpectationRequest

Mensagem de solicitação para EvaluationService.CreateEvaluationExpectation.

Campos
parent

string

Obrigatório. O app para o qual a expectativa de avaliação será criada. Formato: projects/{project}/locations/{location}/apps/{app}

evaluation_expectation_id

string

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

evaluation_expectation

EvaluationExpectation

Obrigatório. A expectativa de avaliação a ser criada.

CreateEvaluationRequest

Mensagem de solicitação para EvaluationService.CreateEvaluation.

Campos
parent

string

Obrigatório. O app para o qual a avaliação será criada. Formato: projects/{project}/locations/{location}/apps/{app}

evaluation_id

string

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

evaluation

Evaluation

Obrigatório. A avaliaçã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 a proteção será criada.

guardrail_id

string

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

guardrail

Guardrail

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

CreateScheduledEvaluationRunRequest

Mensagem de solicitação para EvaluationService.CreateScheduledEvaluationRun.

Campos
parent

string

Obrigatório. O app para o qual a execução de avaliação programada será criada. Formato: projects/{project}/locations/{location}/apps/{app}

scheduled_evaluation_run_id

string

Opcional. O ID a ser usado para a execução de avaliação programada, que se tornará o componente final do nome do recurso da execução de avaliação programada. Se não for fornecido, um ID exclusivo será atribuído automaticamente.

scheduled_evaluation_run

ScheduledEvaluationRun

Obrigatório. A execução de avaliação programada a ser criada.

CreateToolRequest

Mensagem de solicitação para AgentService.CreateTool.

Campos
parent

string

Obrigatório. O nome do recurso do app em que uma 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 o 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.

CustomVoiceSample

Configuração de uma amostra de voz personalizada usada para clonagem de voz.

Campos
name

string

Opcional. O nome definido pelo usuário para a amostra de voz personalizada.

voice_sample_gcs_uri

string

Opcional. O URI do Cloud Storage para a amostra de áudio para clonagem de voz. A amostra de áudio precisa ser um arquivo WAV de canal único de 24 kHz.

consent_audio_gcs_uri

string

Opcional. Áudio de consentimento para clonagem de voz.

voice_instruction

string

Opcional. Instruções em linguagem natural para estilo, tom, ritmo ou pronúncia da voz.

preview_audio_content

bytes

Apenas saída. Áudio de prévia sintetizado para voz personalizada, formatado como WAV canônico (LINEAR16, 24 kHz, 16 bits, mono).

preview_text

string

Opcional. Texto para sintetizar o áudio de prévia da voz personalizada.

warnings[]

CustomVoiceSample.Warning

Apenas saída. Mensagens de aviso encontradas durante o processamento da clonagem de voz (por exemplo, nível de áudio baixo).

voice_instruction_mode

CustomVoiceSample.VoiceInstructionMode

Opcional. Modo de instrução para a amostra de voz. Se não for especificado, o padrão será NO_INSTRUCTION.

VoiceInstructionMode

Modo de instrução para a amostra de voz.

Tipos enumerados
VOICE_INSTRUCTION_MODE_UNSPECIFIED Modo de instrução não especificado. O padrão é NO_INSTRUCTION.
NO_INSTRUCTION Nenhuma instrução de voz será usada.
GENERATE_INSTRUCTION A instrução de voz será gerada automaticamente pela IA com base na amostra de áudio.
CUSTOM_INSTRUCTION Instrução de voz personalizada fornecida pelo usuário.

Aviso

Uma mensagem de aviso encontrada durante o processamento da amostra de voz.

Campos
message

string

Apenas saída. Uma descrição legível por humanos do aviso.

type

CustomVoiceSample.Warning.WarningType

Apenas saída. O tipo do aviso.

WarningType

Tipo de aviso encontrado durante o processamento da amostra de voz.

Tipos enumerados
WARNING_TYPE_UNSPECIFIED Tipo de aviso não especificado.
LOW_AUDIO_LEVEL O nível de áudio da amostra de voz está muito baixo (por exemplo, baixa amplitude RMS).

DashboardSettings

Configurações dos painéis associados ao app, que aparecem na visualização do Monitoring.

Campos
default_dashboard

string

Opcional. O nome do recurso do painel padrão do Contact Center Insights associado ao app. Esse é o painel que será exibido quando os usuários acessarem a visualização de monitoramento do app.

Formato: projects/{project}/locations/{location}/dashboards/{dashboard}

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. O 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, então ele 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 privados 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 blocos.

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 ao qual 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 mecanismo.

Tipo

O tipo de mecanismo. 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 mecanismo 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 serão adicionados a esse mecanismo.

DataStoreTool

Ferramenta para extrair do repositório de dados ou do mecanismo da Vertex AI para Pesquisa para embasamento. Aceita um repositório de dados 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. Especificação de otimizaçã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

Especificação de otimização para impulsionar determinados documentos.

Campos
condition_boost_specs[]

DataStoreTool.BoostSpec.ConditionBoostSpec

Obrigatório. Uma lista de especificações de otimizaçã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 otimizaçã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 impulsionar 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 oferece 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 dá às sugestões um grande rebaixamento. No entanto, outras sugestões relevantes ainda podem ser mostradas.

Definir como 0.0 significa que nenhuma otimização foi aplicada. A condição de otimização é ignorada.

boost_control_spec

DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec

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

BoostControlSpec

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

Campos
field_name

string

Opcional. O nome do campo cujo valor será usado para determinar o valor do aumento.

attribute_type

DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec.AttributeType

Opcional. O tipo de atributo a ser usado para determinar o valor do aumento. O valor do atributo pode ser derivado do valor do campo do field_name especificado. No caso de valores numéricos, é simples, ou seja, attribute_value = numerical_field_value. No entanto, no caso de 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) ao qual a classificação personalizada será aplicada.

Tipos enumerados
ATTRIBUTE_TYPE_UNSPECIFIED AttributeType não especificado.
NUMERICAL O valor do campo numérico será usado para atualizar dinamicamente o valor do aumento. 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 o horário atual e a data no campo de data e hora especificado. O valor precisa ser formatado como um valor XSD dayTimeDuration (um subconjunto restrito de um valor de duração ISO 8601). O padrão para isso é: [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 aumentar ou diminuir de forma monotônica (valores constantes são aceitáveis).

Campos
attribute_value

string

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

boost_amount

float

Opcional. O valor entre -1 e 1 para aumentar a pontuação se o 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 em trechos será aplicada.

BoostSpecs

Especificações de otimização para otimizar 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 otimizaçã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 otimizaçã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 visando 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. Use 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 filtro de inclusão para repositórios de dados do conector. Para os demais tipos de armazenamento de dados, o parâmetro de entrada do filtro é omitido.
ALWAYS_INCLUDE Sempre inclua o filtro de inclusão para todos os tipos de repositório de dados.
NEVER_INCLUDE O parâmetro de filtro nunca é incluído na lista de parâmetros de ferramenta, independentemente do tipo de repositório 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, o que 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 de 3 significa que a pontuação de embasamento precisa ser 3 ou maior para que a resposta seja retornada.

disabled

bool

Opcional. Se o embasamento está desativado.

ModalityConfig

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

Campos
modality_type

DataStoreTool.ModalityConfig.ModalityType

Obrigatório. O tipo de modalidade.

rewriter_config

DataStoreTool.RewriterConfig

Opcional. A configuração do reescritor.

summarization_config

DataStoreTool.SummarizationConfig

Opcional. A configuração de resumo.

grounding_config

DataStoreTool.GroundingConfig

Opcional. A configuração de embasamento.

snippets_config

DataStoreTool.SnippetsConfig

Opcional. A configuração dos snippets.

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

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 reescritor está desativado.

SnippetsConfig

Configuração de snippets.

Campos
enable_snippets

bool

Opcional. Se os snippets estão ativados.

max_snippets

int32

Opcional. Número de snippets que serão retornados por consulta. Se não for definido, retorna todos os snippets do serviço por padrão.

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 a geração de resumos está desativada.

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 de forma forçada, mesmo que ainda seja referenciado por outros apps/agentes/exemplos.

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

string

Opcional. A ETag atual do agente. Se uma etag não for fornecida, a exclusão vai substituir todas as alterações simultâneas. Se uma etag for fornecida e não corresponder à 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 alterações simultâneas. Se uma etag for fornecida e não corresponder à 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 alterações 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.

DeleteAssistantSessionRequest

Mensagem de solicitação para AssistantService.DeleteAssistantSession.

Campos
name

string

Obrigatório. O nome da sessão do assistente que será excluída. Formato: projects/{project}/locations/{location}/apps/{app}/assistantSessions/{assistant_session}

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 à atual da implantação, a exclusão será bloqueada e um erro ABORTED será retornado.

DeleteEvaluationDatasetRequest

Mensagem de solicitação para EvaluationService.DeleteEvaluationDataset.

Campos
name

string

Obrigatório. O nome do recurso do conjunto de dados de avaliação a ser excluído.

etag

string

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

DeleteEvaluationExpectationRequest

Mensagem de solicitação para EvaluationService.DeleteEvaluationExpectation.

Campos
name

string

Obrigatório. O nome do recurso da expectativa de avaliação a ser excluída.

etag

string

Opcional. A ETag atual da expectativa de avaliação. Se uma etag não for fornecida, a exclusão vai substituir todas as alterações simultâneas. Se uma etag for fornecida e não corresponder à etag atual da expectativa de avaliação, a exclusão será bloqueada e um erro ABORTED será retornado.

DeleteEvaluationRequest

Mensagem de solicitação para EvaluationService.DeleteEvaluation.

Campos
name

string

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

force

bool

Opcional. Indica se a avaliação deve ser excluída de forma forçada, mesmo que ainda seja referenciada por conjuntos de dados de avaliação.

  • Se for force = false, a exclusão vai falhar se algum conjunto de dados ainda fizer referência à avaliação.
  • Se for force = true, todas as referências atuais dos conjuntos de dados serão removidas, e a avaliação será excluída.
etag

string

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

DeleteEvaluationResultRequest

Mensagem de solicitação para EvaluationService.DeleteEvaluationResult.

Campos
name

string

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

DeleteEvaluationRunOperationMetadata

Esse tipo não tem campos.

Metadados de operação para EvaluationService.DeleteEvaluationRun.

DeleteEvaluationRunRequest

Mensagem de solicitação para EvaluationService.DeleteEvaluationRun.

Campos
name

string

Obrigatório. O nome do recurso da execução de avaliação a ser excluída.

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 alterações 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 que será excluída.

force

bool

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

  • Se for force = false, a exclusão vai falhar se algum app/agente ainda fizer referência à proteção.
  • Se force = true, todas as referências 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 alterações simultâneas. Se uma etag for fornecida e não corresponder à atual da proteção, a exclusão será bloqueada e um erro ABORTED será retornado.

DeleteScheduledEvaluationRunRequest

Mensagem de solicitação para EvaluationService.DeleteScheduledEvaluationRun.

Campos
name

string

Obrigatório. O nome do recurso da execução de avaliação programada a ser excluída.

etag

string

Opcional. A ETag do ScheduledEvaluationRun. Se fornecido, ele precisa corresponder à ETag do servidor.

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 for force = false, a exclusão vai falhar se algum agente ainda fizer referência à 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 alterações simultâneas. Se uma etag for fornecida e não corresponder à 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 for 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 alterações simultâneas. Se uma etag for fornecida e não corresponder à atual do conjunto de ferramentas, a exclusão será bloqueada e um erro ABORTED será retornado.

DeployChannelResponse

Mensagem de resposta para AgentService.DeployChannel.

Campos
deployment

Deployment

A implantação criada.

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

channel_profile

ChannelProfile

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

create_time

Timestamp

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

update_time

Timestamp

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

etag

string

Apenas saída. 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.

experiment_config

ExperimentConfig

Opcional. Configuração do experimento para a implantação.

whatsapp_credentials

WhatsAppCredentials

Opcional. Somente entrada. Credenciais efêmeras do WhatsApp necessárias ao configurar um perfil de canal do WhatsApp.

instagram_credentials

InstagramCredentials

Opcional. Somente entrada. Credenciais temporárias do Instagram necessárias ao configurar um perfil de canal do Instagram.

model_settings

ModelSettings

Opcional. Configurações do modelo para a implantação. Substitui as configurações do modelo definidas nos níveis do app/agente. Observação: a substituição das configurações do modelo no nível da implantação é restrita por uma lista de permissões. Entre em contato com a equipe do CXAS para ativar esse campo.

modality

Deployment.Modality

Opcional. A modalidade da implantação. Observação: a substituição de modalidade no nível da implantação é protegida por uma lista de permissões. Entre em contato com a equipe do CXAS para ativar esse campo.

agent_registry_deployment

AgentRegistryDeployment

Opcional. Configuração para implantar esta implantação no Agent Registry. Se presente, essa implantação será publicada no Agent Registry.

Modalidade

A modalidade da implantação.

Tipos enumerados
MODALITY_UNSPECIFIED Modalidade desconhecida.
MODALITY_TEXT Modalidade de texto.
MODALITY_VOICE Modalidade de voz.
MODALITY_VIDEO Modalidade de vídeo.

EndSession

Indica que a sessão foi encerrada, seja por conclusão bem-sucedida (por exemplo, o usuário diz "Até logo!" ) ou um encaminhamento para um supervisor.

O agente não vai processar mais entradas após o encerramento da sessão, e o cliente precisa fechar parcialmente e se desconectar depois de receber todas as respostas restantes do agente.

Campos
metadata

Struct

Opcional. Fornece mais informações sobre o indicador de encerramento da 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 do código de autorização do OAuth 2.0.

oauth2_jwt_bearer_config

EndUserAuthConfig.Oauth2JwtBearerConfig

Autenticação de concessão de autorização do 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 do JWT Profile OAuth 2.0 Authorization Grant.

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

EndpointControlPolicy

Define a política de controle de endpoints no nível do projeto/local.

Campos
enforcement_scope

EndpointControlPolicy.EnforcementScope

Opcional. O escopo em que a lista allowed_origins desta política é aplicada.

allowed_origins[]

string

Opcional. As origens HTTP(s) permitidas que as ferramentas no app podem chamar diretamente. A aplicação depende do valor de enforcement_scope e do status de VPC-SC do projeto. Se um número de porta não for fornecido, todas as portas serão permitidas. Caso contrário, o número da porta precisa ser exatamente igual. Por exemplo, "https://example.com" vai corresponder a "https://example.com:443" e a qualquer outra porta. "https://example.com:443" só vai corresponder a "https://example.com:443".

EnforcementScope

Define o escopo em que a lista allowed_origins dessa política é aplicada.

Tipos enumerados
ENFORCEMENT_SCOPE_UNSPECIFIED Não especificado. Essa política será tratada como VPCSC_ONLY.
VPCSC_ONLY Essa política se aplica somente quando o VPC-SC está ativo.
ALWAYS Essa política SEMPRE se aplica, independentemente do status do VPC-SC.

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 o tratamento de erros.

fallback_response_config

ErrorHandlingSettings.FallbackResponseConfig

Opcional. Configuração para processar respostas de fallback.

end_session_config

ErrorHandlingSettings.EndSessionConfig

Opcional. Configuração para encerrar a sessão em caso de erros do sistema (por exemplo, erros de LLM).

EndSessionConfig

Configuração para encerrar a sessão em caso de erros do sistema (por exemplo, erros de LLM).

Campos
escalate_session

bool

Opcional. Se a sessão deve ser encaminhada em EndSession. Se a sessão for encaminhada, metadata in EndSession vai conter session_escalated = true. Consulte https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/deploy/google-telephony-platform#transfer_a_call_to_a_human_agent para mais detalhes.

ErrorHandlingStrategy

Define a estratégia para lidar com erros.

Tipos enumerados
ERROR_HANDLING_STRATEGY_UNSPECIFIED Estratégia de tratamento de erros não especificada.
NONE Nenhum tratamento específico está ativado.
FALLBACK_RESPONSE Uma mensagem de fallback será retornada ao usuário em caso de erros do sistema (por exemplo, erros de LLM).
END_SESSION Um sinal EndSession será emitido em caso de erros do sistema (por exemplo, erros de LLM).

FallbackResponseConfig

Configuração para processar respostas de fallback.

Campos
custom_fallback_messages

map<string, string>

Opcional. As mensagens de fallback em caso de erros do sistema (por exemplo, erros de LLM), mapeadas pelo código de idioma compatível.

max_fallback_attempts

int32

Opcional. O número máximo de tentativas de substituição antes que o agente emita o sinal EndSession.

Avaliação

Uma avaliação representa todas as informações necessárias para simular e avaliar um agente.

Campos
name

string

Identificador. O identificador exclusivo desta avaliação. Formato: projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}

display_name

string

Obrigatório. Nome de exibição da avaliação definido pelo usuário. Exclusivo em um app.

description

string

Opcional. Descrição da avaliação definida pelo usuário.

tags[]

string

Opcional. Tags definidas pelo usuário para categorizar a avaliação.

evaluation_datasets[]

string

Apenas saída. Lista de conjuntos de dados de avaliação a que a avaliação pertence. Formato: projects/{project}/locations/{location}/apps/{app}/evaluationDatasets/{evaluationDataset}

create_time

Timestamp

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

created_by

string

Apenas saída. O usuário que criou a avaliação.

update_time

Timestamp

Apenas saída. Carimbo de data/hora de quando a avaliação foi atualizada pela última vez.

last_updated_by

string

Apenas saída. O usuário que atualizou a avaliação pela última vez.

evaluation_runs[]

string

Apenas saída. As EvaluationRuns associadas a esta avaliação.

etag

string

Apenas saída. 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.

aggregated_metrics

AggregatedMetrics

Apenas saída. As métricas agregadas para essa avaliação em todas as execuções.

last_completed_result

EvaluationResult

Apenas saída. O resultado mais recente desta avaliação.

invalid

bool

Apenas saída. Se a avaliação é inválida. Isso pode acontecer se uma avaliação estiver referenciando uma ferramenta, um conjunto de ferramentas ou um agente que foi excluído.

last_ten_results[]

EvaluationResult

Apenas saída. Os últimos 10 resultados desta avaliação. Isso só será preenchido se include_last_ten_results estiver definido como verdadeiro em ListEvaluationsRequest ou GetEvaluationRequest.

evaluation_metrics_threshold_override

EvaluationMetricsThresholds

Opcional. Substitui os limites de métricas para essa avaliação específica.

evaluation_metrics_config_override

EvaluationMetricsConfig

Opcional. Substitui a configuração de métricas para essa avaliação específica.

Campo de união inputs. As entradas para a avaliação inputs podem ser apenas uma das seguintes:
golden

Evaluation.Golden

Opcional. As etapas de referência a serem avaliadas.

scenario

Evaluation.Scenario

Opcional. A configuração de um cenário.

Golden

As etapas necessárias para reproduzir uma conversa de ouro.

Campos
turns[]

Evaluation.GoldenTurn

Obrigatório. As interações de ouro necessárias para reproduzir uma conversa de ouro. O número máximo de turnos permitidos é 100.

evaluation_expectations[]

string

Opcional. As expectativas de avaliação para avaliar a conversa reproduzida. Formato: projects/{project}/locations/{location}/apps/{app}/evaluationExpectations/{evaluationExpectation}

GoldenExpectation

Representa um único requisito verificável.

Campos
note

string

Opcional. Uma observação para esse requisito, útil para relatar quando verificações específicas falham. Por exemplo, "Check_Payment_Tool_Called".

skip_evaluation

bool

Opcional. Se definido como verdadeiro, essa expectativa específica não será avaliada.

expectation_level_metrics_thresholds_override

EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.ExpectationLevelMetricsThresholds

Opcional. Substitui as métricas no nível da etapa.

agent_response_semantic_similarity_metrics_config_override

EvaluationMetricsConfig.SemanticSimilarityMetricsConfig

Opcional. Substituições para métricas de similaridade semântica de agent_response.

agent_response_hallucination_metrics_config_override

EvaluationMetricsConfig.HallucinationMetricsConfig

Opcional. Substituições para métricas de alucinação de agent_response.

comparison_type

EvaluationMetricsConfig.ComparisonType

Opcional. O tipo de comparação a ser usado na verificação de expectativa.

Campo de união condition. A verificação real a ser realizada. condition pode ser apenas de um dos tipos a seguir:
tool_call

ToolCall

Opcional. Verifique se uma ferramenta específica foi chamada com os parâmetros.

tool_response

ToolResponse

Opcional. Verifique se uma ferramenta específica teve a resposta esperada.

agent_response

Message

Opcional. Verifique se o agente respondeu corretamente. O papel "agente" está implícito.

agent_transfer

AgentTransfer

Opcional. Verifique se o agente transferiu a conversa para outro agente.

updated_variables

Struct

Opcional. Verifique se o agente atualizou as variáveis de sessão para os valores esperados. Usado para também capturar atualizações de variáveis de agente para avaliações de ouro.

mock_tool_response

ToolResponse

Opcional. A resposta da ferramenta a ser simulada, com os parâmetros de interesse especificados. Os parâmetros não especificados serão alucinados pelo LLM.

no_tool_calls

bool

Opcional. Verifique se nenhuma ferramenta foi chamada durante essa rodada.

GoldenTurn

Um turno de ouro define um único turno em uma conversa de ouro.

Campos
steps[]

Evaluation.Step

Obrigatório. As etapas necessárias para reproduzir uma conversa de ouro.

root_span

Span

Opcional. O período raiz da rodada de ouro para processar e manter informações de áudio. O URI do áudio precisa conter áudio salvo em uma taxa de amostragem de 16 Khz.

turn_level_metrics_thresholds_override

EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.TurnLevelMetricsThresholds

Opcional. Substituições para limites de métricas no nível da rodada.

hallucination_metric_behavior_override

EvaluationMetricsThresholds.HallucinationMetricBehavior

Opcional. Substituição do comportamento da métrica de alucinação no nível da rodada.

Cenário

A configuração de um cenário

Campos
task

string

Obrigatório. A tarefa que será segmentada pelo cenário.

user_facts[]

Evaluation.Scenario.UserFact

Opcional. Os fatos do usuário que serão usados pelo cenário.

max_turns

int32

Opcional. O número máximo de turnos a serem simulados. O valor máximo permitido é 100. O valor padrão é 100.

rubrics[]

string

Obrigatório. As rubricas para pontuar o cenário.

scenario_expectations[]

Evaluation.ScenarioExpectation

Obrigatório. O ScenarioExpectations para avaliar a conversa produzida pela simulação do usuário.

variable_overrides

Struct

Opcional. Variáveis / parâmetros de sessão como contexto para a sessão, com chave por nomes de variáveis. Os membros dessa estrutura vão substituir os valores padrão definidos pelo sistema.

Observação: eles são diferentes dos fatos do usuário, que são fatos conhecidos pelo usuário. As variáveis são parâmetros conhecidos pelo agente, como o MDN (número de telefone) transmitido pelo sistema de telefonia.

task_completion_behavior
(deprecated)

Evaluation.Scenario.TaskCompletionBehavior

Opcional. Obsoleto. Use user_goal_behavior.

user_goal_behavior

Evaluation.Scenario.UserGoalBehavior

Opcional. O comportamento esperado da meta do usuário.

evaluation_expectations[]

string

Opcional. As expectativas de avaliação para avaliar a conversa produzida pela simulação. Formato: projects/{project}/locations/{location}/apps/{app}/evaluationExpectations/{evaluationExpectation}

milestones[]

Evaluation.Scenario.Milestone

Opcional. Os marcos deste cenário.

scenario_execution_mode

EvaluationSettings.ScenarioExecutionMode

Opcional. O modo de execução para avaliações de cenário.

Marco

Representa um único marco no cenário. Usado para orientar o comportamento do simulador de usuário para seguir um protocolo. O simulador de usuário executa o marco sequencialmente e só passa para o próximo se o success_criteria desse marco for atingido.

Campos
goal

string

Obrigatório. A meta do marco.

max_turn_count

int32

Opcional. O número máximo de turnos para este marco.

success_criteria

string

Opcional. Os critérios de sucesso do marco.

protocol

string

Opcional. As diretrizes que o agente deve seguir durante a conversa.

static_utterance

string

Opcional. Uma frase estática que o simulador vai enviar exatamente, em vez de gerar dinamicamente a entrada do usuário.

event

Event

Opcional. Uma entrada de evento para enviar em vez da geração dinâmica.

TaskCompletionBehavior

O comportamento esperado da tarefa do usuário. Isso é usado para determinar se o cenário foi bem-sucedido.

Tipos enumerados
TASK_COMPLETION_BEHAVIOR_UNSPECIFIED Comportamento não especificado. O padrão é TASK_SATISFIED.
TASK_SATISFIED A tarefa do usuário precisa ser concluída.
TASK_REJECTED A tarefa do usuário deve ser rejeitada.

UserFact

Fatos sobre o usuário como um par de chave-valor.

Campos
name

string

Obrigatório. O nome do fato do usuário.

value

string

Obrigatório. O valor do fato do usuário.

UserGoalBehavior

O comportamento esperado da meta do usuário. Isso é usado para determinar se o cenário foi bem-sucedido.

Tipos enumerados
USER_GOAL_BEHAVIOR_UNSPECIFIED Comportamento não especificado. O padrão é USER_GOAL_SATISFIED.
USER_GOAL_SATISFIED A meta do usuário deve ser concluída com sucesso.
USER_GOAL_REJECTED A meta do usuário deve ser rejeitada.
USER_GOAL_IGNORED Ignorar o status da meta do usuário.

ScenarioExpectation

A expectativa para avaliar a conversa produzida pela simulação.

Campos
Campo de união expectation. A expectativa para avaliar a conversa produzida pela simulação. expectation pode ser apenas de um dos tipos a seguir:
tool_expectation

Evaluation.ScenarioExpectation.ToolExpectation

Opcional. O par de chamada de ferramenta e resposta a ser avaliado.

agent_response

Message

Opcional. A resposta do agente a ser avaliada.

ToolExpectation

O par de chamada de ferramenta e resposta a ser avaliado.

Campos
expected_tool_call

ToolCall

Obrigatório. A chamada de ferramenta esperada, com os parâmetros de interesse especificados. Os parâmetros não especificados serão alucinados pelo LLM.

mock_tool_response

ToolResponse

Obrigatório. A resposta da ferramenta a ser simulada, com os parâmetros de interesse especificados. Os parâmetros não especificados serão alucinados pelo LLM.

Etapa

Uma etapa define uma ação singular que vai acontecer durante a avaliação.

Campos
Campo de união step. A etapa a ser realizada. step pode ser apenas de um dos tipos a seguir:
user_input

SessionInput

Opcional. Entrada do usuário para a conversa.

agent_transfer

AgentTransfer

Opcional. Transferir a conversa para outro agente.

expectation

Evaluation.GoldenExpectation

Opcional. Executa uma expectativa na rodada atual.

EvaluationConfig

EvaluationConfig define as configurações para executar a avaliação.

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

evaluation_channel

EvaluationConfig.EvaluationChannel

Opcional. O canal a ser avaliado.

tool_call_behaviour

EvaluationToolCallBehaviour

Opcional. Especifica se a avaliação deve usar chamadas de ferramentas reais ou falsas.

EvaluationChannel

O canal a ser avaliado.

Tipos enumerados
EVALUATION_CHANNEL_UNSPECIFIED Canal de avaliação não especificado.
TEXT Canal de avaliação somente de texto.
AUDIO Canal de avaliação de áudio.

EvaluationDataset

Um conjunto de dados de avaliação representa um conjunto de avaliações agrupadas com base em tags compartilhadas.

Campos
name

string

Identificador. O identificador exclusivo desse conjunto de dados de avaliação. Formato: projects/{project}/locations/{location}/apps/{app}/evaluationDatasets/{evaluationDataset}

display_name

string

Obrigatório. Nome de exibição definido pelo usuário do conjunto de dados de avaliação. Exclusivo em um app.

evaluations[]

string

Opcional. Avaliações incluídas neste conjunto de dados.

create_time

Timestamp

Apenas saída. Carimbo de data/hora de quando o conjunto de dados de avaliação foi criado.

update_time

Timestamp

Apenas saída. Carimbo de data/hora em que o conjunto de dados de avaliação foi atualizado pela última vez.

etag

string

Apenas saída. 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.

created_by

string

Apenas saída. O usuário que criou o conjunto de dados de avaliação.

last_updated_by

string

Apenas saída. O usuário que atualizou o conjunto de dados de avaliação pela última vez.

aggregated_metrics

AggregatedMetrics

Apenas saída. As métricas agregadas para esse conjunto de dados de avaliação em todas as execuções.

EvaluationErrorInfo

Informações sobre um erro encontrado durante uma execução de avaliação.

Campos
error_type

EvaluationErrorInfo.ErrorType

Apenas saída. O tipo de erro.

error_message

string

Apenas saída. A mensagem de erro.

session_id

string

Apenas saída. O ID da sessão da conversa que causou o erro.

user_facing_error_message

string

Apenas saída. A mensagem de erro voltada ao usuário.

ErrorType

O tipo de erro

Tipos enumerados
ERROR_TYPE_UNSPECIFIED Tipo de erro não especificado.
RUNTIME_FAILURE Falha durante a execução do ambiente de execução.
CONVERSATION_RETRIEVAL_FAILURE Falha ao recuperar a conversa do ambiente de execução do CES.
METRIC_CALCULATION_FAILURE Falha ao calcular uma métrica / resultado.
EVALUATION_UPDATE_FAILURE Falha ao atualizar a avaliação.
QUOTA_EXHAUSTED A cota acabou.
USER_SIMULATION_FAILURE Falha durante a simulação do usuário.

EvaluationExpectation

Uma expectativa de avaliação representa um critério específico para avaliação.

Campos
name

string

Identificador. O identificador exclusivo dessa expectativa de avaliação. Formato: projects/{project}/locations/{location}/apps/{app}/evaluationExpectations/{evaluation_expectation}

display_name

string

Obrigatório. Nome de exibição definido pelo usuário. Precisa ser exclusivo no app.

tags[]

string

Opcional. Tags definidas pelo usuário para expectativas. Pode ser usado para filtrar expectativas.

create_time

Timestamp

Apenas saída. Carimbo de data/hora de quando a expectativa de avaliação foi criada.

update_time

Timestamp

Apenas saída. Carimbo de data/hora de quando a expectativa de avaliação foi atualizada pela última vez.

etag

string

Apenas saída. 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.

Campo de união criteria. A definição dos critérios usados para avaliação. criteria pode ser apenas de um dos tipos a seguir:
llm_criteria

EvaluationExpectation.LlmCriteria

Opcional. Critérios de avaliação com base em um comando de LLM.

LlmCriteria

Configuração para critérios de avaliação baseados em LLM.

Campos
prompt

string

Obrigatório. O comando/as instruções fornecidas ao avaliador do LLM.

EvaluationMetricsConfig

Configura as métricas de uma avaliação.

Campos
golden_metrics_config

EvaluationMetricsConfig.GoldenMetricsConfig

Opcional. Configuração das métricas de ouro para a avaliação.

scenario_metrics_config

EvaluationMetricsConfig.ScenarioMetricsConfig

Opcional. Configuração das métricas de cenário para a avaliação.

ComparisonType

Tipos de comparação compatíveis para verificar a resposta do agente.

Tipos enumerados
COMPARISON_TYPE_UNSPECIFIED Tipo de comparação não especificado. O comportamento padrão é SEMANTIC_SIMILARITY para respostas de agentes e chamadas de ferramentas.
EQUALS Correspondência exata de string.
CONTAINS Correspondência de substring (verifica se a string esperada está contida na resposta real).
SEMANTIC_SIMILARITY Correspondência de similaridade semântica (avalia a similaridade de significado usando um LLM).

ExpectationsMetMetricsConfig

Configuração das métricas de nível de expectativa para a avaliação. Para desativar a métrica, defina a mensagem, mas não defina o campo enable_expectations_met_metrics como verdadeiro (ou defina-o explicitamente como falso). Para remover a configuração e voltar ao comportamento padrão, omita a mensagem inteira.

Campos
enable_expectations_met_metrics

bool

Opcional. Se as métricas de nível de expectativa devem ser calculadas para a avaliação.

GoldenMetricsConfig

Configuração das métricas de ouro para a avaliação.

Campos
semantic_similarity_metrics_config

EvaluationMetricsConfig.SemanticSimilarityMetricsConfig

Opcional. Configuração global para métricas de similaridade semântica.

tool_correctness_metrics_config

EvaluationMetricsConfig.ToolCorrectnessMetricsConfig

Opcional. Configuração para métricas de precisão da ferramenta no nível da rodada.

step_tool_correctness_metrics_config

EvaluationMetricsConfig.ToolCorrectnessMetricsConfig

Opcional. Configuração para métricas de precisão da ferramenta no nível da etapa.

HallucinationMetricsConfig

Configuração das métricas de alucinação para a avaliação. Para desativar a métrica, defina a mensagem, mas não defina o campo enable_hallucination_metrics como verdadeiro (ou defina-o explicitamente como falso). Para remover a configuração e voltar ao comportamento padrão, omita a mensagem inteira.

Campos
enable_hallucination_metrics

bool

Opcional. Se as métricas de alucinação devem ser calculadas para a avaliação.

ScenarioMetricsConfig

Configuração das métricas de cenário para a avaliação.

Campos
user_goal_met_metrics_config

EvaluationMetricsConfig.UserGoalMetMetricsConfig

Opcional. Configuração para métricas de meta do usuário atingida.

expectations_met_metrics_config

EvaluationMetricsConfig.ExpectationsMetMetricsConfig

Opcional. Configuração para métricas de nível de expectativa.

SemanticSimilarityMetricsConfig

Configuração de métricas de similaridade para a avaliação. Para desativar a métrica, defina a mensagem, mas não defina o campo enable_semantic_similarity_metrics como verdadeiro (ou defina-o explicitamente como falso). Para remover a configuração e voltar ao comportamento padrão, omita a mensagem inteira.

Campos
enable_semantic_similarity_metrics

bool

Opcional. Se as métricas de similaridade semântica devem ser calculadas para a avaliação.

ToolCorrectnessMetricsConfig

Configuração de métricas de precisão para a avaliação. Para desativar a métrica, defina a mensagem, mas não defina o campo enable_tool_correctness_metrics como verdadeiro (ou defina-o explicitamente como falso). Para remover a configuração e voltar ao comportamento padrão, omita a mensagem inteira.

Campos
enable_tool_correctness_metrics

bool

Opcional. Se as métricas de correção da ferramenta devem ser calculadas para a avaliação.

UserGoalMetMetricsConfig

Configuração das métricas de meta do usuário atingida para a avaliação. Para desativar a métrica, defina a mensagem, mas não defina o campo enable_user_goal_met_metrics como verdadeiro (ou defina-o explicitamente como falso). Para remover a configuração e voltar ao comportamento padrão, omita a mensagem inteira.

Campos
enable_user_goal_met_metrics

bool

Opcional. Se as métricas de meta do usuário atingida devem ser calculadas para a avaliação.

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 referência.

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 referência.

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 de métricas do nível de expectativa.

tool_matching_settings

EvaluationMetricsThresholds.ToolMatchingSettings

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

ExpectationLevelMetricsThresholds

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

Campos
tool_invocation_parameter_correctness_threshold

float

Opcional. O limite de sucesso para a correção do parâmetro de invocação de ferramenta individual. Precisa ser um número de ponto flutuante entre 0 e 1. O padrão é 1.0.

TurnLevelMetricsThresholds

Limites de métricas no nível da rodada.

Campos
semantic_similarity_channel

EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.TurnLevelMetricsThresholds.SemanticSimilarityChannel

Opcional. O canal de semelhança 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 precisão geral da invocação de ferramentas. 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 semelhança semântica de texto.
AUDIO Use a semelhança semântica de áudio.

HallucinationMetricBehavior

O comportamento da métrica de alucinação. Independentemente 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 Desativar a métrica de alucinação.
ENABLED Ativar a métrica de alucinação.

ToolMatchingSettings

Configurações para chamadas de ferramentas correspondentes.

Campos
extra_tool_call_behavior

EvaluationMetricsThresholds.ToolMatchingSettings.ExtraToolCallBehavior

Opcional. Comportamento para chamadas de ferramentas 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 que está presente na execução, mas 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.

EvaluationPersona

Um perfil representa um usuário final em uma avaliação.

Campos
name

string

Obrigatório. O identificador exclusivo da persona. Formato: projects/{project}/locations/{location}/apps/{app}/evaluationPersonas/{evaluationPersona}

description

string

Opcional. A descrição da persona.

display_name

string

Obrigatório. O nome de exibição da persona. Exclusivo em um app.

personality

string

Obrigatório. Uma instrução para o agente sobre como se comportar na avaliação.

speech_config

EvaluationPersona.SpeechConfig

Opcional. Configuração de como a persona soa (configurações de TTS).

SpeechConfig

Configuração para geração de conversão da Text-to-Speech.

Campos
speaking_rate

double

Opcional. A velocidade da fala. 1,0 é normal. Valores menores são mais lentos (por exemplo, 0,8), e valores maiores são mais rápidos (por exemplo, 1,5). Útil para testar como o agente lida com pessoas que falam rápido.

environment

EvaluationPersona.SpeechConfig.BackgroundEnvironment

Opcional. O ambiente de áudio simulado.

voice_id

string

Opcional. O identificador/sotaque de voz específico a ser usado. Exemplo: "en-US-Wavenet-D" ou "en-GB-Standard-A"

BackgroundEnvironment

Ambiente de áudio simulado.

Tipos enumerados
BACKGROUND_ENVIRONMENT_UNSPECIFIED Ambiente de segundo plano não especificado.
CALL_CENTER Ambiente de call center.
TRAFFIC Ambiente com ruído de trânsito.
KIDS_NOISE Ambiente com barulho de crianças.
CAFE Ambiente de café.

EvaluationResult

Um resultado de avaliação representa a saída da execução de uma avaliação.

Campos
name

string

Identificador. O identificador exclusivo do resultado da avaliação. Formato: projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}/results/{result}

display_name

string

Obrigatório. Nome de exibição do resultado da avaliação. Exclusivo em uma avaliação. Por padrão, ele tem o seguinte formato: " resultado - ".

create_time

Timestamp

Apenas saída. Carimbo de data/hora em que o resultado da avaliação foi criado.

evaluation_status

EvaluationResult.Outcome

Apenas saída. O resultado da avaliação. Preenchido apenas se execution_state for COMPLETE.

evaluation_run

string

Apenas saída. A execução de avaliação que produziu esse resultado. Formato: projects/{project}/locations/{location}/apps/{app}/evaluationRuns/{evaluationRun}

persona

EvaluationPersona

Apenas saída. A persona usada para gerar a conversa para o resultado da avaliação.

error_info

EvaluationErrorInfo

Apenas saída. Informações de erro para o resultado da avaliação.

error
(deprecated)

Status

Apenas saída. Descontinuado: use error_info. Erros encontrados durante a execução.

initiated_by

string

Apenas saída. O usuário que iniciou a execução de avaliação que gerou esse resultado.

app_version

string

Apenas saída. A versão do app usada para gerar a conversa que resultou nesse resultado. Formato: projects/{project}/locations/{location}/apps/{app}/versions/{version}

app_version_display_name

string

Apenas saída. O nome de exibição do app_version em que a avaliação foi executada.

changelog

string

Apenas saída. O registro de alterações da versão do app em que a avaliação foi executada. Isso é preenchido se o usuário executar a avaliação na versão mais recente/rascunho.

changelog_create_time

Timestamp

Apenas saída. O horário de criação do registro de alterações da versão do app em que a avaliação foi executada. Isso é preenchido se o usuário executar a avaliação na versão mais recente/rascunho.

execution_state

EvaluationResult.ExecutionState

Apenas saída. O estado da execução do resultado da avaliação.

evaluation_metrics_thresholds

EvaluationMetricsThresholds

Apenas saída. Os limites de avaliação do resultado.

config

EvaluationConfig

Apenas saída. A configuração usada na execução de avaliação que gerou esse resultado.

golden_run_method

GoldenRunMethod

Apenas saída. O método usado para executar a avaliação de referência.

root_span

Span

Apenas saída. O período raiz da execução da avaliação, que inclui informações sobre cada etapa da avaliação.

outcome_metadata

EvaluationResult.OutcomeMetadata

Apenas saída. Os metadados de resultado da avaliação. Preenchido apenas se execution_state for COMPLETE.

Campo de união result. O resultado da avaliação. Preenchido apenas quando execution_state é COMPLETED. result pode ser apenas de um dos tipos a seguir:
golden_result

EvaluationResult.GoldenResult

Apenas saída. O resultado de uma avaliação de respostas ideais.

scenario_result

EvaluationResult.ScenarioResult

Apenas saída. O resultado de uma avaliação de cenário.

EvaluationExpectationResult

O resultado de uma única expectativa de avaliação.

Campos
evaluation_expectation

string

Apenas saída. A expectativa de avaliação. Formato: projects/{project}/locations/{location}/apps/{app}/evaluationExpectations/{evaluation_expectation}

prompt

string

Apenas saída. O comando usado para a avaliação.

outcome

EvaluationResult.Outcome

Apenas saída. O resultado da expectativa de avaliação.

explanation

string

Apenas saída. A explicação do resultado.

ExecutionState

O estado da execução do resultado da avaliação.

Tipos enumerados
EXECUTION_STATE_UNSPECIFIED O estado de execução do resultado da avaliação não foi especificado.
QUEUED A execução do resultado da avaliação está na fila.
RUNNING A execução do resultado da avaliação está em andamento.
COMPLETED A execução do resultado da avaliação foi concluída.
ERROR Falha na execução do resultado da avaliação devido a um erro interno.
CANCELLED A execução do resultado da avaliação foi cancelada.

GoldenExpectationOutcome

Especifica a expectativa e o resultado dela.

Campos
expectation

Evaluation.GoldenExpectation

Apenas saída. A expectativa que foi avaliada.

outcome

EvaluationResult.Outcome

Apenas saída. O resultado da expectativa.

semantic_similarity_result
(deprecated)

EvaluationResult.SemanticSimilarityResult

Apenas saída. O resultado da verificação de semelhança semântica.

tool_invocation_result

EvaluationResult.GoldenExpectationOutcome.ToolInvocationResult

Apenas saída. O resultado da verificação de invocação da ferramenta.

Campo de união result. O resultado da expectativa. result pode ser apenas de um dos tipos a seguir:
observed_tool_call

ToolCall

Apenas saída. O resultado da expectativa de chamada de ferramenta.

observed_tool_response

ToolResponse

Apenas saída. O resultado da expectativa de resposta da ferramenta.

observed_agent_response

Message

Apenas saída. O resultado da expectativa de resposta do agente.

observed_agent_transfer

AgentTransfer

Apenas saída. O resultado da expectativa de transferência do agente.

observed_payload

Struct

Apenas saída. Um payload personalizado observado. Não há expectativas para payloads personalizados. Isso é usado apenas para o cálculo de métricas. O resultado é sempre SKIPPED.

ToolInvocationResult

O resultado da verificação de invocação da ferramenta.

Campos
outcome

EvaluationResult.Outcome

Apenas saída. O resultado da verificação de invocação da ferramenta. Isso é determinado comparando o parameter_correctness_score com o limite. Se a pontuação for igual ou maior que o limite, o resultado será PASS (APROVADO). Caso contrário, o resultado será FAIL.

explanation

string

Apenas saída. Uma explicação em texto livre para o resultado da invocação da ferramenta.

parameter_correctness_score

float

Apenas saída. A pontuação de precisão do parâmetro de invocação da ferramenta. Indica a porcentagem de parâmetros da chamada de ferramenta esperada que também estavam presentes na chamada de ferramenta real.

GoldenResult

O resultado de uma avaliação de ouro.

Campos
turn_replay_results[]

EvaluationResult.GoldenResult.TurnReplayResult

Apenas saída. O resultado da execução de cada turno da conversa de ouro.

evaluation_expectation_results[]

EvaluationResult.EvaluationExpectationResult

Apenas saída. Os resultados das expectativas de avaliação.

TurnReplayResult

O resultado da execução de um único turno da conversa de ouro.

Campos
conversation

string

Apenas saída. A conversa que foi gerada para essa vez.

expectation_outcome[]

EvaluationResult.GoldenExpectationOutcome

Apenas saída. O resultado de cada expectativa.

hallucination_result

EvaluationResult.HallucinationResult

Apenas saída. O resultado da verificação de alucinação.

tool_invocation_score
(deprecated)

float

Apenas saída. Obsoleto. Use OverallToolInvocationResult.

turn_latency

Duration

Apenas saída. Duração da curva.

tool_call_latencies[]

EvaluationResult.ToolCallLatency

Apenas saída. A latência de cada chamada de ferramenta no turno.

semantic_similarity_result

EvaluationResult.SemanticSimilarityResult

Apenas saída. O resultado da verificação de semelhança semântica.

overall_tool_invocation_result

EvaluationResult.OverallToolInvocationResult

Apenas saída. O resultado da verificação geral de invocação da ferramenta.

error_info

EvaluationErrorInfo

Apenas saída. Informações sobre o erro que ocorreu durante essa rodada.

span_latencies[]

EvaluationResult.SpanLatency

Apenas saída. A latência dos períodos na vez.

tool_ordered_invocation_score

float

Apenas saída. A pontuação geral de invocação ordenada de ferramentas para este turno. Indica a porcentagem geral de ferramentas da vez esperada que foram realmente invocadas na ordem esperada.

HallucinationResult

O resultado da verificação de alucinação para uma única rodada.

Campos
label

string

Apenas saída. O rótulo associado a cada pontuação. Pontuação 1: justificada Pontuação 0: não justificada Pontuação -1: sem declaração para avaliar

explanation

string

Apenas saída. A explicação da pontuação de alucinação.

score

int32

Apenas saída. A pontuação de alucinação. Pode ser -1, 0, 1.

Resultado

O resultado da avaliação ou expectativa.

Tipos enumerados
OUTCOME_UNSPECIFIED O resultado da avaliação não foi especificado.
PASS A avaliação/expectativa foi aprovada. No caso de uma avaliação, isso significa que todas as expectativas foram atendidas.
FAIL Falha na avaliação/expectativa. No caso de uma avaliação, isso significa que pelo menos uma expectativa não foi atendida.
SKIPPED A avaliação/expectativa foi ignorada.

OutcomeMetadata

Metadados sobre o resultado da avaliação.

Tipos enumerados
OUTCOME_METADATA_UNSPECIFIED Metadados de resultado não especificados.
GRACEFUL_HANDOFF A avaliação resultou em uma transferência tranquila para um representante humano.

OverallToolInvocationResult

O resultado da verificação geral de invocação da ferramenta.

Campos
outcome

EvaluationResult.Outcome

Apenas saída. O resultado da verificação de invocação da ferramenta. Isso é determinado comparando o tool_invocation_score com o overall_tool_invocation_correctness_threshold. Se a pontuação for igual ou maior que o limite, o resultado será PASS (APROVADO). Caso contrário, o resultado será FAIL.

tool_invocation_score

float

A pontuação geral de invocação de ferramentas para este turno. Indica a porcentagem geral de ferramentas da vez esperada que foram realmente invocadas.

ScenarioExpectationOutcome

O resultado de uma expectativa de cenário.

Campos
expectation

Evaluation.ScenarioExpectation

Apenas saída. A expectativa que foi avaliada.

outcome

EvaluationResult.Outcome

Apenas saída. O resultado do ScenarioExpectation.

Campo de união result. O resultado da expectativa. result pode ser apenas de um dos tipos a seguir:
observed_tool_call

EvaluationResult.ScenarioExpectationOutcome.ObservedToolCall

Apenas saída. A chamada de ferramenta observada.

observed_agent_response

Message

Apenas saída. A resposta observada do agente.

ObservedToolCall

A chamada de ferramenta e a resposta observadas.

Campos
tool_call

ToolCall

Apenas saída. A chamada de ferramenta observada.

tool_response

ToolResponse

Apenas saída. A resposta observada da ferramenta.

ScenarioResult

O resultado de uma avaliação de cenário.

Campos
conversation

string

Apenas saída. A conversa que foi gerada no cenário.

task

string

Apenas saída. A tarefa usada ao executar o cenário para esse resultado.

user_facts[]

Evaluation.Scenario.UserFact

Apenas saída. Os fatos do usuário que foram usados pelo cenário para esse resultado.

expectation_outcomes[]

EvaluationResult.ScenarioExpectationOutcome

Apenas saída. O resultado de cada expectativa.

rubric_outcomes[]

EvaluationResult.ScenarioRubricOutcome

Apenas saída. O resultado da rubrica.

hallucination_result[]

EvaluationResult.HallucinationResult

Apenas saída. O resultado da verificação de alucinação. Haverá um resultado de alucinação para cada turno na conversa.

task_completion_result
(deprecated)

EvaluationResult.TaskCompletionResult

Apenas saída. O resultado da verificação de conclusão da tarefa.

tool_call_latencies[]

EvaluationResult.ToolCallLatency

Apenas saída. A latência de cada execução de chamada de ferramenta na conversa.

user_goal_satisfaction_result

EvaluationResult.UserGoalSatisfactionResult

Apenas saída. O resultado da verificação de satisfação do objetivo do usuário.

span_latencies[]

EvaluationResult.SpanLatency

Apenas saída. A latência dos períodos na conversa.

evaluation_expectation_results[]

EvaluationResult.EvaluationExpectationResult

Apenas saída. Os resultados das expectativas de avaliação.

milestone_results[]

EvaluationResult.ScenarioResult.MilestoneResult

Apenas saída. Os resultados de cada marco no cenário.

all_expectations_satisfied

bool

Apenas saída. Se todas as expectativas foram atendidas para essa vez.

task_completed

bool

Apenas saída. Se a tarefa foi concluída para essa vez. É uma combinação de todas as expectativas atendidas, sem alucinações e com a satisfação do objetivo do usuário.

MilestoneResult

Representa o resultado da execução de um marco.

Campos
milestone

Evaluation.Scenario.Milestone

Apenas saída. O marco que está sendo monitorado.

status

EvaluationResult.ScenarioResult.MilestoneResult.MilestoneStatus

Apenas saída. O status atual do marco.

justification

string

Apenas saída. A justificativa para o status atual.

MilestoneStatus

O status do marco.

Tipos enumerados
MILESTONE_STATUS_UNSPECIFIED Status não especificado.
NOT_STARTED O marco ainda não começou.
IN_PROGRESS O marco está em andamento.
COMPLETED O marco foi concluído.

ScenarioRubricOutcome

O resultado da avaliação com base na rubrica.

Campos
rubric

string

Apenas saída. A rubrica usada para avaliar a conversa.

score_explanation

string

Apenas saída. A resposta do avaliador à rubrica.

score

float

Apenas saída. A pontuação da conversa de acordo com a rubrica.

SemanticSimilarityResult

O resultado da verificação de semelhança semântica.

Campos
label

string

Apenas saída. O rótulo associado a cada pontuação. Pontuação 4: totalmente consistente Pontuação 3: consistente na maior parte Pontuação 2: parcialmente consistente (pequenas omissões) Pontuação 1: inconsistente na maior parte (grandes omissões) Pontuação 0: completamente inconsistente / contraditório

explanation

string

Apenas saída. A explicação da pontuação de semelhança semântica.

outcome

EvaluationResult.Outcome

Apenas saída. O resultado da verificação de semelhança semântica. Isso é determinado comparando a pontuação com o semantic_similarity_success_threshold. Se a pontuação for igual ou maior que o limite, o resultado será PASS (APROVADO). Caso contrário, o resultado será FAIL.

score

int32

Apenas saída. A pontuação de similaridade semântica. Pode ser 0, 1, 2, 3 ou 4.

SpanLatency

A latência de uma execução de período.

Campos
type

EvaluationResult.SpanLatency.Type

Apenas saída. O tipo de período.

display_name

string

Apenas saída. O nome de exibição do período. Aplicável a períodos de ferramentas e proteções.

start_time

Timestamp

Apenas saída. O horário de início do período.

end_time

Timestamp

Apenas saída. O horário de término do período.

execution_latency

Duration

Apenas saída. A latência do período.

Campo de união identifier. O identificador do item específico com base no tipo dele. identifier pode ser apenas de um dos tipos a seguir:
resource

string

Apenas saída. O nome do recurso da proteção ou dos períodos da ferramenta.

toolset

ToolsetTool

Apenas saída. O identificador da ferramenta do conjunto de ferramentas.

model

string

Apenas saída. O nome do período do LLM.

callback

string

Apenas saída. O nome do período de callback do usuário.

Tipo

O tipo de período. Outros valores podem ser adicionados no futuro.

Tipos enumerados
TYPE_UNSPECIFIED Valor padrão. Esse valor não é usado.
TOOL Período de chamada de ferramenta.
USER_CALLBACK Período de callback do usuário.
GUARDRAIL Período de proteção.
LLM Período do LLM.

TaskCompletionResult

O resultado da verificação de conclusão da tarefa para a conversa.

Campos
label

string

Apenas saída. O rótulo associado a cada pontuação. Pontuação 1: tarefa concluída Pontuação 0: tarefa não concluída Pontuação -1: meta do usuário indefinida

explanation

string

Apenas saída. A explicação da pontuação de conclusão da tarefa.

score

int32

Apenas saída. A pontuação de conclusão da tarefa. Pode ser -1, 0, 1

ToolCallLatency

A latência de uma execução de chamada de ferramenta.

Campos
tool

string

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

display_name

string

Apenas saída. O nome de exibição da ferramenta.

start_time

Timestamp

Apenas saída. O horário de início da execução da chamada de ferramenta.

end_time

Timestamp

Apenas saída. O horário de término da execução da chamada de ferramenta.

execution_latency

Duration

Apenas saída. A latência da execução da chamada de ferramenta.

UserGoalSatisfactionResult

O resultado de uma verificação de satisfação do objetivo do usuário em uma conversa.

Campos
label

string

Apenas saída. O rótulo associado a cada pontuação. Pontuação 2: transferência sem problemas Pontuação 1: tarefa do usuário concluída Pontuação 0: tarefa do usuário não concluída Pontuação -1: tarefa do usuário não especificada

explanation

string

Apenas saída. A explicação para a pontuação de satisfação do usuário com a tarefa.

score

int32

Apenas saída. A pontuação de satisfação do usuário com a tarefa. Pode ser -1, 0, 1, 2.

EvaluationRun

Uma execução de avaliação representa todos os resultados de uma execução de avaliação.

Campos
name

string

Identificador. O identificador exclusivo da execução de avaliação. Formato: projects/{project}/locations/{location}/apps/{app}/evaluationRuns/{evaluationRun}

display_name

string

Opcional. Nome de exibição definido pelo usuário da execução de avaliação. Padrão: " run - ".

evaluation_results[]

string

Apenas saída. Os resultados da avaliação que fazem parte desta execução. Formato: projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}/results/{result}

create_time

Timestamp

Apenas saída. Carimbo de data/hora de quando a execução de avaliação foi criada.

initiated_by

string

Apenas saída. O usuário que iniciou a execução da avaliação.

app_version

string

Apenas saída. A versão do app a ser avaliada. Formato: projects/{project}/locations/{location}/apps/{app}/versions/{version}

app_version_display_name

string

Apenas saída. O nome de exibição do app_version em que a avaliação foi executada.

changelog

string

Apenas saída. O registro de alterações da versão do app em que a avaliação foi executada. Isso é preenchido se o usuário executar a avaliação na versão mais recente/rascunho.

changelog_create_time

Timestamp

Apenas saída. O horário de criação do registro de alterações da versão do app em que a avaliação foi executada. Isso é preenchido se o usuário executar a avaliação na versão mais recente/rascunho.

evaluations[]

string

Apenas saída. As avaliações que fazem parte dessa execução. A lista pode conter avaliações de qualquer tipo. Esse campo é mutuamente exclusivo com evaluation_dataset. Formato: projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}

evaluation_dataset

string

Apenas saída. O conjunto de dados de avaliação associado a essa execução. Esse campo é mutuamente exclusivo com evaluations. Formato: projects/{project}/locations/{location}/apps/{app}/evaluationDatasets/{evaluationDataset}

evaluation_type

EvaluationRun.EvaluationType

Apenas saída. O tipo das avaliações nesta execução.

state

EvaluationRun.EvaluationRunState

Apenas saída. O estado da execução da avaliação.

progress

EvaluationRun.Progress

Apenas saída. O progresso da execução da avaliação.

config

EvaluationConfig

Apenas saída. A configuração usada na execução.

error
(deprecated)

Status

Apenas saída. Descontinuado: use error_info. Erros encontrados durante a execução.

error_info

EvaluationErrorInfo

Apenas saída. Informações de erro para a execução da avaliação.

evaluation_run_summaries

map<string, EvaluationRun.EvaluationRunSummary>

Apenas saída. Mapa do nome da avaliação para EvaluationRunSummary.

latency_report

LatencyReport

Apenas saída. Relatório de latência da execução da avaliação.

run_count

int32

Apenas saída. O número de vezes que as avaliações dentro da execução foram realizadas.

persona_run_configs[]

PersonaRunConfig

Apenas saída. A configuração a ser usada para a execução por persona.

optimization_config

OptimizationConfig

Opcional. Configuração para executar a etapa de otimização após a execução da avaliação. Se não for definida, a etapa de otimização não será executada.

scheduled_evaluation_run

string

Apenas saída. O nome do recurso da execução de avaliação programada que criou essa execução de avaliação. Esse campo só será definido se a execução de avaliação tiver sido criada por uma execução de avaliação programada. Formato: projects/{project}/locations/{location}/apps/{app}/scheduledEvaluationRuns/{scheduled_evaluation_run}

golden_run_method

GoldenRunMethod

Apenas saída. O método usado para executar a avaliação.

operation

string

Apenas saída. A operação que criou essa execução de avaliação. Formato: projects/{project}/locations/{location}/operations/{operation}

EvaluationRunState

O estado da execução da avaliação.

Tipos enumerados
EVALUATION_RUN_STATE_UNSPECIFIED O estado da execução da avaliação não foi especificado.
QUEUED Indica que a execução da avaliação está na fila.
RUNNING A execução da avaliação está em andamento.
COMPLETED A execução da avaliação foi concluída.
ERROR A execução da avaliação tem um erro.
CANCELLED A execução da avaliação foi cancelada.

EvaluationRunSummary

Contém o resumo das contagens de resultados aprovados e reprovados para uma avaliação específica em uma execução de avaliação.

Campos
passed_count

int32

Apenas saída. Número de resultados aprovados para a avaliação associada nesta execução.

failed_count

int32

Apenas saída. Número de resultados com falha para a avaliação associada nesta execução.

error_count

int32

Apenas saída. Número de resultados de erro para a avaliação associada nesta execução.

EvaluationType

O tipo das avaliações nesta execução. Outros valores podem ser adicionados no futuro.

Tipos enumerados
EVALUATION_TYPE_UNSPECIFIED O tipo de avaliação não foi especificado.
GOLDEN Avaliação de referência.
SCENARIO Avaliação de cenário.
MIXED Indica que a execução inclui uma combinação de avaliações de ouro e de cenário.

Progresso

O progresso da execução da avaliação.

Campos
total_count

int32

Apenas saída. Número total de resultados de avaliação nesta execução.

failed_count

int32

Apenas saída. Número de resultados de avaliação concluídos com o resultado FAIL. (EvaluationResult.execution_state é COMPLETED e EvaluationResult.evaluation_status é FAIL).

error_count

int32

Apenas saída. Número de resultados de avaliação que não foram executados. (EvaluationResult.execution_state é ERROR).

completed_count

int32

Apenas saída. Número de resultados de avaliação concluídos. (EvaluationResult.execution_state é COMPLETED).

passed_count

int32

Apenas saída. Número de resultados de avaliação concluídos com o resultado PASS. (EvaluationResult.execution_state é COMPLETED e EvaluationResult.evaluation_status é PASS).

cancelled_count

int32

Apenas saída. Número de resultados de avaliação que foram cancelados. (EvaluationResult.execution_state é CANCELLED).

EvaluationRunCachingSettings

Configurações para o armazenamento em cache da execução de avaliação.

Campos
run_caching_mode

EvaluationRunCachingSettings.EvaluationRunCachingMode

Opcional. O modo de armazenamento em cache a ser usado na execução da avaliação. Se não for definido, o padrão será FORCE_RUN.

EvaluationRunCachingMode

O comportamento de armazenamento em cache do resultado da avaliação. Controla se o resultado da última avaliação concluída (se houver) será retornado ou se uma nova avaliação será executada.

Tipos enumerados
EVALUATION_RUN_CACHING_MODE_UNSPECIFIED O modo de armazenamento em cache da execução não foi especificado.
FORCE_RUN Sempre execute uma simulação completa em tempo real, independentemente de haver registros de alterações.
SKIP_IF_UNCHANGED Pule a execução e copie os resultados verificados anteriores se nenhuma dependência tiver sido modificada e o canal de avaliação/método de execução forem os mesmos.

EvaluationSettings

Configurações para avaliação.

Campos
scenario_conversation_initiator

EvaluationSettings.ScenarioConversationInitiator

Opcional. Quem inicia a conversa em uma avaliação de cenário.

golden_run_method

GoldenRunMethod

Opcional. O método padrão usado para executar avaliações de referência. Ele será usado se nenhum golden_run_method for especificado no RunEvaluationRequest.

golden_evaluation_tool_call_behaviour

EvaluationToolCallBehaviour

Opcional. Configura o comportamento padrão de chamada de ferramenta para avaliações de referência.

scenario_evaluation_tool_call_behaviour

EvaluationToolCallBehaviour

Opcional. Configura o comportamento padrão de chamada de ferramenta para avaliações de cenário.

metrics_config

EvaluationMetricsConfig

Opcional. Configura as métricas padrão para avaliações.

scenario_execution_mode

EvaluationSettings.ScenarioExecutionMode

Opcional. O modo de execução para avaliações de cenário. Se não for fornecido, o padrão será QUALITY_OPTIMIZED.

evaluation_run_caching_settings

EvaluationRunCachingSettings

Opcional. As configurações de armazenamento em cache a serem usadas na execução da avaliação.

ScenarioConversationInitiator

Determina quem inicia a conversa em uma sessão de avaliação de cenário.

Tipos enumerados
SCENARIO_CONVERSATION_INITIATOR_UNSPECIFIED Não especificado. O padrão é USER.
USER O usuário inicia a conversa.
AGENT O agente inicia a conversa.

ScenarioExecutionMode

O modo de execução para avaliações de cenário.

Tipos enumerados
SCENARIO_EXECUTION_MODE_UNSPECIFIED Modo de execução não especificado. O padrão é QUALITY_OPTIMIZED.
QUALITY_OPTIMIZED Modo otimizado para qualidade.
SPEED_OPTIMIZED Modo otimizado para velocidade.

EvaluationToolCallBehaviour

Configura o comportamento da chamada de ferramenta para execuções de avaliação.

Tipos enumerados
EVALUATION_TOOL_CALL_BEHAVIOUR_UNSPECIFIED Comportamento de chamada de ferramenta não especificado. O padrão será chamadas de ferramentas reais.
REAL Use chamadas de ferramentas reais.
FAKE Usar chamadas de ferramentas falsas.

Evento

Entrada de evento.

Campos
event

string

Obrigatório. O nome do evento.

variables

Struct

Opcional. Variáveis adicionais associadas ao evento.

Exemplo

Um exemplo representa uma conversa de amostra 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 por humanos do exemplo.

entry_agent

string

Opcional. O agente que lida inicialmente 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 de quando o exemplo foi atualizado pela última vez.

invalid

bool

Apenas saída. O exemplo pode se tornar inválido se os recursos de referência 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 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.

ExecuteToolRequest

Mensagem de solicitação para ToolService.ExecuteTool.

Campos
parent

string

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

args

Struct

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

mock_config

MockConfig

Opcional. Configuração simulada para a execução da ferramenta. Se esse campo for definido, as ferramentas que chamam outras ferramentas serão simuladas com base nos padrões e respostas fornecidos.

Campo de união tool_identifier. O identificador da ferramenta a ser executada. 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 deve corresponder ao predicado do conjunto de ferramentas. Caso contrário, um erro será retornado.

Campo de união tool_execution_context. O contexto adicional a ser fornecido para a execução da ferramenta tool_execution_context pode ser apenas um dos seguintes:
variables

Struct

Opcional. As variáveis disponíveis para a execução da ferramenta.

context

Struct

Opcional. O [ToolCallContext](https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/python#environment para mais detalhes) que será transmitido para a ferramenta Python.

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 no final da execução da ferramenta.

citations

Citations

Citações que fornecem as informações de origem para a execução da ferramenta.

google_search_suggestions

GoogleSearchSuggestions

As sugestões retornadas da Pesquisa Google como resultado da invocação da ferramenta Pesquisa Google durante a 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 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 é bloqueada até que a ferramenta retorne.
ASYNCHRONOUS A ferramenta é executada de forma assíncrona. A sessão vai continuar enquanto a ferramenta estiver em execução.

ExperimentConfig

Experimento para a implantação.

Campos
version_release

ExperimentConfig.VersionRelease

Opcional. Versão do experimento.

Estado

Estado do experimento.

Tipos enumerados
STATE_UNSPECIFIED Estado não especificado.
PENDING Descontinuado: este estado não é mais usado.
RUNNING Estado em execução. O experimento está em execução e é válido.
DONE Descontinuado: este estado não é mais usado.
EXPIRED Descontinuado: este estado não é mais usado.

VersionRelease

Versão do experimento.

Campos
state

ExperimentConfig.State

Opcional. Estado da versão.

traffic_allocations[]

ExperimentConfig.VersionRelease.TrafficAllocation

Opcional. As alocações de tráfego para a versão.

TrafficAllocation

Alocação de tráfego para a versão.

Campos
id

string

Opcional. ID da alocação de tráfego. String de formato livre, com até 128 caracteres.

traffic_percentage

int32

Opcional. Porcentagem de tráfego da alocação de tráfego. Precisa ser entre 0 e 100.

app_version

string

Opcional. Versão do app da alocação de tráfego. Formato: projects/{project}/locations/{location}/apps/{app}/versions/{version}

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 para exportar o app.

gcs_uri

string

Opcional. O URI do Google Cloud Storage para o qual 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 Cloud Storage especificado.

app_version

string

Opcional. O nome do recurso da versão do app a ser exportada. Formato: projects/{project}/locations/{location}/apps/{app}/versions/{version}.

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 só pode ser 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 o qual o app foi exportado.

ExportEvaluationResultsOperationMetadata

Esse tipo não tem campos.

Metadados de operação para EvaluationService.ExportEvaluationResults.

ExportEvaluationResultsRequest

Mensagem de solicitação para EvaluationService.ExportEvaluationResults.

Campos
parent

string

Obrigatório. O nome do recurso da avaliação de onde os resultados serão exportados. Formato: projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}

names[]

string

Obrigatório. Os nomes de recursos dos resultados da avaliação a serem exportados.

export_options

ExportOptions

Opcional. As opções de exportação para os resultados da avaliação.

ExportEvaluationResultsResponse

Mensagem de resposta para EvaluationService.ExportEvaluationResults.

Campos
Campo de união evaluation_results. Os resultados da avaliação exportados. evaluation_results pode ser apenas de um dos tipos a seguir:
evaluation_results_content

bytes

O conteúdo dos resultados da avaliação exportados. Ele será preenchido se gcs_uri não tiver sido especificado na solicitação.

evaluation_results_uri

string

A pasta do URI do Google Cloud Storage em que os resultados da avaliação exportados foram gravados. Será preenchido se gcs_uri tiver sido especificado na solicitação.

ExportEvaluationRunsOperationMetadata

Esse tipo não tem campos.

Metadados de operação para EvaluationService.ExportEvaluationRuns.

ExportEvaluationRunsRequest

Mensagem de solicitação para EvaluationService.ExportEvaluationRuns.

Campos
parent

string

Obrigatório. O nome do recurso do app de onde as execuções de avaliação serão exportadas. Formato: projects/{project}/locations/{location}/apps/{app}

names[]

string

Obrigatório. Os nomes dos recursos das execuções de avaliação a serem exportadas.

export_options

ExportOptions

Opcional. As opções de exportação para as execuções de avaliação.

ExportEvaluationRunsResponse

Mensagem de resposta para EvaluationService.ExportEvaluationRuns.

Campos
Campo de união evaluation_runs. As execuções de avaliação exportadas. evaluation_runs pode ser apenas de um dos tipos a seguir:
evaluation_runs_content

bytes

O conteúdo das execuções de avaliação exportadas. Ele será preenchido se gcs_uri não tiver sido especificado na solicitação.

evaluation_runs_uri

string

A pasta do URI do Google Cloud Storage em que as execuções de avaliação exportadas foram gravadas. Será preenchido se gcs_uri tiver sido especificado na solicitação.

ExportEvaluationsRequest

Mensagem de solicitação para EvaluationService.ExportEvaluations.

Campos
parent

string

Obrigatório. O nome do recurso do app de onde as avaliações serão exportadas. Formato: projects/{project}/locations/{location}/apps/{app}

names[]

string

Obrigatório. Os nomes dos recursos das avaliações a serem exportadas.

export_options

ExportOptions

Opcional. As opções de exportação para as avaliações.

include_evaluation_results

bool

Opcional. Inclui os resultados da avaliação na exportação. Pelo menos um dos campos include_evaluation_results ou include_evaluations precisa ser definido.

include_evaluations

bool

Opcional. Inclui avaliações na exportação. Pelo menos um dos campos include_evaluation_results ou include_evaluations precisa ser definido.

ExportEvaluationsResponse

Mensagem de resposta para EvaluationService.ExportEvaluations.

Campos
failed_evaluations

map<string, string>

Apenas saída. Um mapa de nomes de recursos de avaliação que não puderam ser exportados, com o motivo da falha.

Campo de união evaluations. As avaliações exportadas. evaluations pode ser apenas de um dos tipos a seguir:
evaluations_content

bytes

O conteúdo das avaliações exportadas. Ele será preenchido se gcs_uri não tiver sido especificado na solicitação.

evaluations_uri

string

A pasta do URI do Google Cloud Storage em que as avaliações exportadas foram gravadas. Será preenchido se gcs_uri tiver sido especificado na solicitação.

ExportOptions

Opções para exportar recursos de avaliação do CES.

Campos
export_format

ExportOptions.ExportFormat

Opcional. O formato para exportar os resultados da avaliação. O padrão será JSON se não for especificado.

gcs_uri

string

Opcional. O URI do Google Cloud Storage em que os resultados da avaliação exportados serão gravados.

ExportFormat

O formato para exportar os itens. O padrão será JSON se não for especificado.

Tipos enumerados
EXPORT_FORMAT_UNSPECIFIED Formato não especificado.
JSON ou JSON.
YAML exibidas no formato YAML.

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.

FileContext

Arquivos que serão usados como contexto. Os arquivos podem ser fornecidos como bytes brutos.

Campos
Campo de união file. Arquivo fornecido como contexto. file pode ser apenas de um dos tipos a seguir:
file_bytes

FileContext.FileBytes

Opcional. Arquivo fornecido como bytes brutos.

FileBytes

Arquivo fornecido como bytes brutos.

Campos
file_name

string

Obrigatório. O nome do arquivo fornecido como bytes brutos.

mime_type

string

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

data

bytes

Obrigatório. Bytes brutos do arquivo.

FileSearchTool

A ferramenta de pesquisa de arquivos permite que o agente pesquise 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 do 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 estã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.

GenerateAppResourceOperationMetadata

Metadados de operação para AgentService.GenerateAppResource.

Campos
generation_type

GenerateAppResourceOperationMetadata.GenerationType

Apenas saída. O tipo da operação.

message

string

Apenas saída. Status legível por humanos da operação, caso haja um.

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.

target

string

Apenas saída. O nome do recurso do app associado à operação. Formato: projects/{project}/locations/{location}/apps/{app}.

partial_errors[]

Status

Apenas saída. Mensagens de erro do processo de geração de recursos.

GenerationType

O tipo da operação de geração.

Tipos enumerados
GENERATION_TYPE_UNSPECIFIED Tipo de operação não especificado.
AGENT_RESTRUCTURE Tipo de reestruturação de instruções do agente.
AGENT_REFINE Tipo de refinamento de instrução do agente.
AGENT_CREATE Criação de agente com base no tipo.
TOOL_CREATE Tipo de criação da ferramenta.
SCENARIO_CREATE Tipo de criação de cenário.
SCENARIO_CREATE_FROM_TRANSCRIPTS Tipo de criação de cenário com base em transcrições.
EVALUATION_PERSONA_CREATE Tipo de geração de persona de avaliação.
QUALITY_REPORT_CREATE Tipo de geração de relatório de qualidade.
INSTRUCTION_FOLLOWING_FIX Tipo de correção de instrução (usado para correções de escalada).

GenerateAppResourceRequest

Mensagem de solicitação para AgentService.GenerateAppResource.

Campos
parent

string

Obrigatório. O nome do recurso do app para o qual o recurso será gerado.

refine_instructions[]

GenerateAppResourceRequest.RefineInstructions

Opcional. Lista de instruções de refinamento a serem usadas para refinar o recurso.

tool_generation_config

GenerateAppResourceRequest.ToolGenerationConfig

Opcional. A configuração a ser usada para gerar a ferramenta.

app_generation_config

GenerateAppResourceRequest.AppGenerationConfig

Opcional. A configuração a ser usada para gerar os agentes e as ferramentas.

evaluation_generation_config

GenerateAppResourceRequest.EvaluationGenerationConfig

Opcional. A configuração que será usada para gerar as avaliações.

evaluation_personas_generation_config

GenerateAppResourceRequest.EvaluationPersonasGenerationConfig

Opcional. A configuração que será usada para gerar as personas de avaliação.

quality_report_generation_config

GenerateAppResourceRequest.QualityReportGenerationConfig

Opcional. A configuração a ser usada para a geração de relatórios de qualidade.

hill_climbing_fix_config

GenerateAppResourceRequest.HillClimbingFixConfig

Opcional. A configuração que será usada para correções de escalada.

Campo de união resource. O recurso a ser gerado. resource pode ser apenas de um dos tipos a seguir:
agent

Agent

O recurso de agente que será usado pelo assistente de LLM. Pode ficar vazio para gerar um novo agente.

tool

Tool

O recurso de ferramenta a ser usado pelo assistente de LLM pode estar vazio para gerar uma nova ferramenta.

toolset

Toolset

O recurso do conjunto de ferramentas que será usado pelo assistente de LLM. Pode estar vazio para gerar um novo conjunto de ferramentas.

app_version_context

GenerateAppResourceRequest.AppVersionContext

O contexto da versão do app que especifica o snapshot de base e o agente de destino.

AppGenerationConfig

A configuração a ser usada para gerar o app.

Campos
context

string

Opcional. O contexto que descreve os requisitos dos agentes e das ferramentas a serem gerados.

file_contexts[]

FileContext

Opcional. Os arquivos que serão usados como contexto.

dataset_id

string

Opcional. O conjunto de dados de insights que será usado para buscar dados de conversas e gerar os agentes e as ferramentas. Formato: projects/{project}/locations/{location}/datasets/{dataset}.

generate_evaluations

bool

Opcional. Se as avaliações do app devem ser geradas. Se for verdadeiro, o contexto fornecido será usado para gerar os dados de avaliação.

gcs_location

string

Opcional. O local do Cloud Storage para armazenar os dados de perguntas e respostas gerados que serão usados pela ferramenta do Datastore. Esses dados são gerados apenas quando os dados de conversa são usados como fonte de entrada. O local precisa estar no mesmo projeto que o app. Formato: gs://....

AppVersionContext

O contexto da versão do app que especifica o snapshot de base e o agente de destino.

Campos
app_version

string

O nome do recurso da versão do app que será usada pelo assistente de LLM. Formato: projects/{project}/locations/{location}/apps/{app}/versions/{version}

agent_resource_name

string

O nome do recurso do agente de destino a ser usado pelo assistente de LLM. Formato: projects/{project}/locations/{location}/apps/{app}/agents/{agent}

EvaluationGenerationConfig

A configuração que será usada para gerar as avaliações.

Campos
dataset_id

string

Opcional. O conjunto de dados de insights que será usado para buscar dados de conversas e gerar as avaliações. Formato: projects/{project}/locations/{location}/datasets/{dataset}.

EvaluationPersonasGenerationConfig

Esse tipo não tem campos.

A configuração que será usada para gerar as personas de avaliação.

HillClimbingFixConfig

A configuração que será usada para correções de escalada.

Campos
quality_report

QualityReport

Obrigatório. O relatório de qualidade usado para informar a correção de acordo com as instruções.

QualityReportGenerationConfig

A configuração a ser usada para a geração de relatórios de qualidade.

Campos
evaluation_run

string

Obrigatório. A execução de avaliação usada para informar a análise do relatório de qualidade.

algorithm

GenerateAppResourceRequest.QualityReportGenerationConfig.LossAttributionAlgorithm

Opcional. O algoritmo de atribuição de perda a ser usado.

LossAttributionAlgorithm

O algoritmo a ser usado para atribuição de perda.

Tipos enumerados
LOSS_ATTRIBUTION_ALGORITHM_UNSPECIFIED Não especificado.
APP_CENTRIC Atribuição de perda centrada em apps. Trata o app como uma única unidade.
AGENT_CENTRIC Atribuição de perda centrada no agente. Atribui a perda a agentes individuais.

RefineInstructions

As instruções a serem usadas para refinar uma parte do recurso. A parte do recurso pode ser especificada com um índice inicial, um índice final e uma máscara de campo. Por exemplo, se você quiser refinar uma parte das instruções do agente, especifique o índice do primeiro caractere das instruções, o índice do último caractere das instruções e a máscara de campo como "instruções".

Campos
start_index

int64

Obrigatório. O primeiro caractere (inclusive) do texto a ser refinado.

end_index

int64

Obrigatório. O último caractere (inclusive) do texto a ser refinado.

field_mask

FieldMask

Obrigatório. O campo do recurso que está sendo refinado. Só é permitido um campo por RefineInstructions. Se você estiver refinando as instruções do agente, a máscara de campo precisa ser "instructions".

instructions

string

Obrigatório. As instruções para refinar o recurso.

ToolGenerationConfig

A configuração a ser usada para gerar uma ferramenta.

Campos
context

string

Opcional. O contexto que descreve a ferramenta a ser gerada. Pode ficar vazio se a solicitação e a resposta da ferramenta forem fornecidas.

file_contexts[]

FileContext

Opcional. Os arquivos que serão usados como contexto.

open_api_toolset_generation_config

GenerateAppResourceRequest.ToolGenerationConfig.OpenApiToolsetGenerationConfig

Opcional. A configuração a ser usada para gerar um esquema de API aberta.

OpenApiToolsetGenerationConfig

A configuração a ser usada para gerar um esquema de API aberta.

Campos
uri

string

Obrigatório. O URI de base da ferramenta.

operation_generation_configs[]

GenerateAppResourceRequest.ToolGenerationConfig.OpenApiToolsetGenerationConfig.OperationGenerationConfig

Obrigatório. A lista de operações que serão adicionadas ao esquema de API aberta.

OperationGenerationConfig

A configuração a ser usada para gerar uma operação no esquema de API da OpenAPI.

Campos
method

string

Obrigatório. O URI da ferramenta. Isso inclui parâmetros de consulta e de caminho, se houver.

path

string

Obrigatório. O caminho da ferramenta a ser anexado ao URI base. Isso inclui parâmetros de consulta e de caminho, se houver.

request_json

string

Obrigatório. Um exemplo de solicitação para a ferramenta no formato JSON. Pule se a ferramenta não for compatível com o corpo da solicitação.

response_json

string

Obrigatório. Um exemplo de resposta da ferramenta no formato JSON.

GenerateAppResourceResponse

Mensagem de resposta para AgentService.GenerateAppResource.

Campos
generate_result_info

GenerateAppResourceResponse.GenerateResultInfo

Informações adicionais sobre o resultado gerado.

Campo de união generated_resource. O recurso gerado. generated_resource pode ser apenas de um dos tipos a seguir:
agent

Agent

Agente gerado pelo assistente de LLM.

toolset

Toolset

Conjunto de ferramentas gerado pelo assistente de LLM. Oferece suporte à geração de esquemas do conjunto de ferramentas da OpenAPI.

app_snapshot

AppSnapshot

Resumo do app gerado pelo assistente de LLM. Esse snapshot contém o app, os agentes e as ferramentas gerados pelo assistente de LLM.

tools

GenerateAppResourceResponse.Tools

A lista de ferramentas geradas pelo assistente de LLM.

evaluations

GenerateAppResourceResponse.Evaluations

Avaliações geradas pelo assistente de LLM.

app_resources

GenerateAppResourceResponse.AppResources

Os recursos do app gerados pelo assistente de LLM.

quality_report

QualityReport

O relatório de qualidade gerado pelo assistente de LLM.

AppResources

A lista de recursos do app gerados pelo assistente de LLM.

Campos
app_snapshot

AppSnapshot

O resumo do app gerado pelo assistente de LLM. Esse snapshot contém o app, os agentes e as ferramentas gerados pelo assistente de LLM.

evaluations[]

Evaluation

A lista de avaliações geradas pelo assistente de LLM.

Avaliações

A lista de avaliações geradas pelo assistente de LLM.

Campos
evaluations[]

Evaluation

A lista de avaliações geradas.

GenerateResultInfo

Isso fornece mais informações sobre o resultado gerado.

Campos
explanation

string

Uma explicação das mudanças no recurso gerado.

Ferramentas

A lista de ferramentas geradas pelo assistente de LLM.

Campos
tools[]

Tool

A lista de ferramentas geradas pelo assistente de LLM.

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 usada na sessão. Formato: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}

recaptcha_token

string

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

live_handoff_enabled

bool

Opcional. Indica se a transferência em tempo real está ativada para a sessão.

GenerateChatTokenResponse

Mensagem de resposta para WidgetService.GenerateChatToken.

Campos
chat_token

string

O token com escopo de 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.

GenerateEvaluationOperationMetadata

Esse tipo não tem campos.

Metadados de operação para EvaluationService.GenerateEvaluation.

GenerateEvaluationRequest

Mensagem de solicitação para EvaluationService.GenerateEvaluation.

Campos
conversation

string

Obrigatório. A conversa para criar a avaliação de ouro. Formato: projects/{project}/locations/{location}/apps/{app}/conversations/{conversation}

source
(deprecated)

Conversation.Source

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

evaluation_type

GenerateEvaluationRequest.EvaluationType

Opcional. O tipo de avaliação a ser gerada. O padrão será GOLDEN se não for especificado.

EvaluationType

O tipo de avaliação a ser gerada.

Tipos enumerados
EVALUATION_TYPE_UNSPECIFIED Tipo não especificado. O padrão é GOLDEN.
GOLDEN Avaliação de referência.
SCENARIO Avaliação de cenário.

GenerateOnboardingSuggestionsRequest

Mensagem de solicitação para SessionService.GenerateOnboardingSuggestions.

Campos
name

string

Obrigatório. O app cujo estado zero está sendo renderizado. Formato: projects/{project}/locations/{location}/apps/{app}

max_suggestions

int32

Opcional. Número máximo de sugestões a serem retornadas. O padrão é 4 quando não definido.

GenerateOnboardingSuggestionsResponse

Mensagem de resposta para SessionService.GenerateOnboardingSuggestions.

Campos
user_profile

GenerateOnboardingSuggestionsResponse.UserProfile

Classificação do histórico do usuário solicitante.

suggestions[]

AssistantSuggestion

Sugestões personalizadas, classificadas por relevância.

context_token

string

Token opaco que captura o snapshot de integração usado para gerar essas sugestões. Os clientes o repetem no primeiro StreamChatAiAssistantRequest para que o servidor possa reutilizar o snapshot.

UserProfile

Classificação do histórico do usuário que fez a solicitação com o assistente neste app.

Tipos enumerados
USER_PROFILE_UNSPECIFIED Perfil não especificado.
NEW Não há sessões do assistente com mensagens.
EXPLORING Uma ou duas sessões do assistente com mensagens.
RETURNING Mais de duas sessões do assistente com mensagens.

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.

GetAssistantSessionRequest

Mensagem de solicitação para AssistantService.GetAssistantSession.

Campos
name

string

Obrigatório. O nome da sessão do assistente a ser recuperada. Formato: projects/{project}/locations/{location}/apps/{app}/assistantSessions/{assistant_session}

GetChangelogRequest

Mensagem de solicitação para AgentService.GetChangelog.

Campos
name

string

Obrigatório. O nome do recurso do registro de alterações a ser recuperado.

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 definida, todas as origens 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}

GetEvaluationDatasetRequest

Mensagem de solicitação para EvaluationService.GetEvaluationDataset.

Campos
name

string

Obrigatório. O nome do recurso do conjunto de dados de avaliação a ser recuperado.

GetEvaluationExpectationRequest

Mensagem de solicitação para EvaluationService.GetEvaluationExpectation.

Campos
name

string

Obrigatório. O nome do recurso da expectativa de avaliação a ser recuperada.

GetEvaluationRequest

Mensagem de solicitação para EvaluationService.GetEvaluation.

Campos
name

string

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

GetEvaluationResultRequest

Mensagem de solicitação para EvaluationService.GetEvaluationResult.

Campos
name

string

Obrigatório. O nome do recurso do resultado da avaliação a ser recuperado.

GetEvaluationRunRequest

Mensagem de solicitação para EvaluationService.GetEvaluationRun.

Campos
name

string

Obrigatório. O nome do recurso da execução de avaliação a ser recuperada.

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.

GetScheduledEvaluationRunRequest

Mensagem de solicitação para EvaluationService.GetScheduledEvaluationRun.

Campos
name

string

Obrigatório. O nome do recurso da execução de avaliação programada a ser recuperada.

GetSecuritySettingsRequest

Mensagem de solicitação para AgentService.GetSecuritySettings.

Campos
name

string

Obrigatório. O nome do recurso das configurações de segurança a serem recuperadas. Formato: projects/{project}/locations/{location}/securitySettings

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 seu 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 Google, com os 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á buscado 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 para restringir os resultados da pesquisa. Exemplo: "example.com", "another.site". É possível especificar no máximo 20 domínios.

exclude_domains[]

string

Opcional. Lista de domínios que serão excluídos dos resultados da pesquisa. Exemplo: "example.com". É possível excluir até 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 do Google.

Campos
text_prompt

string

Opcional. Define o comando usado para as instruções do sistema ao interagir com o agente em conversas de 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

A barreira de proteção 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 a proteção for acionada.

create_time

Timestamp

Apenas saída. Carimbo de data/hora de quando a barreira de proteção foi criada.

update_time

Timestamp

Apenas saída. Carimbo de data/hora de quando a proteção foi atualizada pela última vez.

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.

Campo de união guardrail_type. Tipo de barreira 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 insegura 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.

supervisor

Guardrail.Supervisor

Opcional. Proteção que executa a intervenção do supervisor.

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 que o agente seja 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.

after_agent_callback

Callback

Opcional. O callback a ser executado depois que o agente é 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 que o modelo seja 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.

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. Aplica-se à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. Aplica-se 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.

sensitive_words_exemptions[]

string

Opcional. Entradas da lista de palavras sensíveis que essa proteção permite. Válido apenas quando match_type é SENSITIVE_WORDS. Cada valor precisa ser igual a uma entrada da lista (não diferencia maiúsculas de minúsculas, espaços em branco ao redor são ignorados). Outros valores não têm efeito. Aplica-se apenas a esta proteção. No máximo 1.000 entradas de até 256 caracteres cada.

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 por substrings caractere por caractere.
WORD_BOUNDARY_STRING_MATCH O conteúdo só será correspondente 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 A correspondência do conteúdo é feita usando a sintaxe de expressão regular.
SENSITIVE_WORDS O conteúdo é comparado com uma lista de palavras e frases sensíveis gerenciada pelo sistema. Anexar uma proteção com esse tipo de correspondência a um app ou agente substitui o filtro padrão de palavras sensíveis para os agentes afetados. Desative a proteção para desativar o filtro padrão.

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. Comando de política. Oferece suporte a marcadores de posição de variáveis de sessão ({var}), bem como a {agent_system_instruction} para injetar as instruções do sistema resolvidas do agente.

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 em aberto e não acione a proteção.

allow_short_utterance

bool

Opcional. Por padrão, a verificação da política de LLM é ignorada para enunciados curtos. Ativar essa configuração aplica a verificação de política a todas as falas, 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 na entrada do usuário.
AGENT_RESPONSE A verificação de política é acionada na resposta do agente. A aplicação desse escopo de política vai introduzir uma latência adicional antes que o agente possa responder.
USER_QUERY_AND_AGENT_RESPONSE A verificação de política é acionada tanto na entrada do usuário quanto na resposta do agente. A aplicação desse escopo de política vai introduzir uma latência adicional 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 verdadeiro: a proteção é ignorada. - Se for falso (padrão): a proteção é acionada/bloqueada.

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 definições de segurança padrão do sistema.

Campos
default_prompt_template

string

Apenas saída. O modelo de comando padrão usado pelo sistema. Este campo serve para mostrar 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 é definida, ela substitui as configurações padrão e aciona a proteção se a resposta for considerada não segura.

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.
HARM_CATEGORY_PROFANITY A categoria de dano é linguagem obscena.
HARM_CATEGORY_TOXIC A categoria de dano é tóxica.

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.

Supervisor

Proteção que executa a intervenção do supervisor.

Campos
type

Guardrail.Supervisor.Type

Opcional. O tipo do supervisor.

detection_mode

Guardrail.Supervisor.DetectionMode

Opcional. O modo de detecção do supervisor.

DetectionMode

Modo de detecção do supervisor.

Tipos enumerados
DETECTION_MODE_UNSPECIFIED O modo de detecção não foi especificado. O padrão é NON_BLOCKING.
NON_BLOCKING Modo de detecção sem bloqueio. A resposta não é bloqueada quando a detecção do supervisor está em andamento.
BLOCKING Modo de detecção de bloqueio. A resposta é bloqueada quando a detecção do supervisor está em andamento.

Tipo

Tipo de supervisor.

Tipos enumerados
TYPE_UNSPECIFIED Tipo não especificado.
INVALID_TEXT Tipo de problema de texto inválido.
LANGUAGE_SHIFT Tipo de problema de mudança de idioma.
SPEAKER_SHIFT Tipo de problema de mudança de locutor.
AUDIO_MISMATCH Tipo de problema de incompatibilidade de áudio.
MISSING_TOOL_CALL Tipo de problema de chamada de ferramenta ausente.
CUSTOM Tipo de problema personalizado.
CHOPPY_AUDIO Tipo de problema de áudio entrecortado.
PROFANITY Tipo de problema de linguagem obscena do agente.

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.

alt_text

string

Opcional. O texto alternativo 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 um conflito for detectado com um app atual, um carimbo de data/hora será adicionado ao nome de exibição para torná-lo único. * Se o app for uma reimportação, esse campo não deverá 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 usará esse ID como o componente final do nome do recurso. Se já houver um app com o mesmo ID no local especificado no 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 de app durante a importação. Se definido como verdadeiro, 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.

Campo de união json_patch. Os patches JSON a serem aplicados ao app importado. json_patch pode ser apenas um dos seguintes:
json_patch_content

string

Opcional. Conteúdo do patch como uma string JSON.

json_patch_gcs_uri

string

Opcional. Um URI do Cloud Storage que aponta para um arquivo JSON que contém os patches.

ImportOptions

Opções de configuração para o processo de importação de apps. Essas opções controlam como a importação se comporta, principalmente quando surgem conflitos com os dados do app.

Campos
conflict_resolution_strategy

ImportAppRequest.ImportOptions.ConflictResolutionStrategy

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

validate_only

bool

Opcional. Sinalização para simular o processo de importação. Se definido como verdadeiro, o processo de importação vai realizar apenas validações e não vai fazer mudanças no app atual nem criar um novo.

ConflictResolutionStrategy

Define a estratégia para lidar com conflitos quando um app com o mesmo ID já existe ou quando os recursos importados (como agentes, ferramentas etc.) têm os mesmos nomes de exibição que os recursos atuais nesse 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 dados importados. Se já houver um app com o mesmo app_id, 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 atuais. - Os recursos importados com novos nomes de exibição serão criados. - Os recursos 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 já houver um app com o mesmo app_id, 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 que foi 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.

ImportEvaluationsOperationMetadata

Representa os metadados da operação de longa duração para EvaluationService.ImportEvaluations.

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 por humanos da operação, caso haja um.

ImportEvaluationsRequest

Mensagem de solicitação para EvaluationService.ImportEvaluations.

Campos
parent

string

Obrigatório. O app para importar as avaliações. Formato: projects/{project}/locations/{location}/apps/{app}

import_options

ImportEvaluationsRequest.ImportOptions

Opcional. Opções que regem o processo de importação das avaliações.

Campo de união source. A origem das avaliações que serão importadas. source pode ser apenas de um dos tipos a seguir:
conversation_list

ImportEvaluationsRequest.ConversationList

As conversas de onde as avaliações serão importadas.

gcs_uri

string

O URI do Google Cloud Storage de onde as avaliações serão importadas. O formato desse URI precisa ser gs://<bucket-name>/<object-name>.

csv_content

bytes

Bytes brutos que representam o arquivo CSV com a estrutura de avaliações.

ConversationList

Uma lista de nomes de recursos de conversa.

Campos
conversations[]

string

Opcional. Nomes de recursos de conversa.

ImportOptions

Opções de configuração para o processo de importação de avaliação. Essas opções controlam como a importação se comporta, principalmente quando surgem conflitos com dados de avaliações atuais.

Campos
conflict_resolution_strategy

ImportEvaluationsRequest.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 já existe uma avaliação com o mesmo ID no app.

Tipos enumerados
CONFLICT_RESOLUTION_STRATEGY_UNSPECIFIED A estratégia de resolução de conflitos não foi especificada.
OVERWRITE Substitua a avaliação atual pela nova.
SKIP Manter a avaliação atual e pular a nova.
DUPLICATE Manter a avaliação atual e duplicar a nova como uma nova avaliação.

ImportEvaluationsResponse

Mensagem de resposta para EvaluationService.ImportEvaluations.

Campos
evaluations[]

Evaluation

A lista de avaliações que foram importadas para o app.

evaluation_results[]

EvaluationResult

A lista de resultados da avaliação que foram importados para o app.

evaluation_runs[]

EvaluationRun

A lista de execuções de avaliação que foram importadas para o app.

error_messages[]

string

Opcional. Uma lista de mensagens de erro associadas a avaliações que não foram importadas.

import_failure_count

int32

O número de avaliações que não foram importadas ou que foram importadas com um ou mais erros.

evaluation_result_import_failure_count

int32

O número de resultados de avaliação que não foram importados ou que foram importados com um ou mais erros.

evaluation_run_import_failure_count

int32

O número de execuções de avaliação que não foram importadas ou que foram importadas com um ou mais erros.

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. Se a supressão de ruído deve ser ativada no áudio de entrada. Os valores disponíveis são "low", "moderate", "high", "very_high".

InstagramCredentials

Credenciais efêmeras da Meta para integração nativa do Instagram.

Campos
auth_code

string

Obrigatório. O código de autenticação da Meta fornecido pelo fluxo de inscrição incorporado.

conversation_profile_id

string

Opcional. O ID do perfil de conversa a ser usado na implantação.

InterruptionSignal

Indica que a resposta de áudio do agente foi interrompida. O cliente precisa interromper imediatamente qualquer 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 é 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 true, os agentes no app vão usar instruções predefinidas para melhorar o processamento de entradas multilíngues.

fallback_action
(deprecated)

string

Opcional. Descontinuado: este recurso não é mais compatível. Use enable_multilingual_support para melhorar o processamento de entradas multilíngues. A ação a ser realizada quando um agente recebe uma entrada em um idioma sem suporte.

Pode ser uma ação predefinida ou uma chamada de ferramenta personalizada. Os valores válidos são: - O nome completo do recurso de uma ferramenta, que aciona uma execução 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.

LatencyReport

Relatório de latência da execução da avaliação.

Campos
tool_latencies[]

LatencyReport.ToolLatency

Apenas saída. Lista não ordenada. Métricas de latência para cada ferramenta.

callback_latencies[]

LatencyReport.CallbackLatency

Apenas saída. Lista não ordenada. Métricas de latência para cada callback.

guardrail_latencies[]

LatencyReport.GuardrailLatency

Apenas saída. Lista não ordenada. Métricas de latência para cada proteção.

llm_call_latencies[]

LatencyReport.LlmCallLatency

Apenas saída. Lista não ordenada. Métricas de latência para cada chamada de LLM.

session_count

int32

Apenas saída. O número total de sessões consideradas no relatório de latência.

CallbackLatency

Métricas de latência para um único callback.

Campos
stage

string

Apenas saída. O estágio do callback.

latency_metrics

LatencyReport.LatencyMetrics

Apenas saída. As métricas de latência do callback.

GuardrailLatency

Métricas de latência para uma única proteção.

Campos
guardrail

string

Apenas saída. O nome da barreira de proteção. Formato: projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}.

guardrail_display_name

string

Apenas saída. O nome de exibição da proteção.

latency_metrics

LatencyReport.LatencyMetrics

Apenas saída. As métricas de latência da proteção.

LatencyMetrics

Métricas de latência de um componente.

Campos
p50_latency

Duration

Apenas saída. A latência no 50º percentil.

p90_latency

Duration

Apenas saída. A latência no 90º percentil.

p99_latency

Duration

Apenas saída. A latência do 99º percentil.

call_count

int32

Apenas saída. O número de vezes que o recurso foi chamado.

LlmCallLatency

Métricas de latência para uma única chamada de LLM.

Campos
model

string

Apenas saída. O nome do modelo.

latency_metrics

LatencyReport.LatencyMetrics

Apenas saída. As métricas de latência da chamada de LLM.

ToolLatency

Métricas de latência para uma única ferramenta.

Campos
tool_display_name

string

Apenas saída. O nome de exibição da ferramenta.

latency_metrics

LatencyReport.LatencyMetrics

Apenas saída. As métricas de latência da ferramenta.

Campo de união tool_identifier. O identificador da ferramenta. tool_identifier pode ser apenas de um dos tipos a seguir:
tool

string

Apenas saída. Formato: projects/{project}/locations/{location}/apps/{app}/tools/{tool}.

toolset_tool

ToolsetTool

Apenas saída. O identificador da ferramenta do conjunto de ferramentas.

ListAgentsRequest

Mensagem de solicitação para AgentService.ListAgents.

Campos
parent

string

Obrigatório. O nome do recurso do app que contém os agentes a serem 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 de lista AgentService.ListAgents 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 para 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.

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 de lista AgentService.ListAppVersions 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 para 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 de lista AgentService.ListApps 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 para 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.

ListAssistantSessionsRequest

Mensagem de solicitação para AssistantService.ListAssistantSessions.

Campos
parent

string

Obrigatório. O app de onde as sessões do assistente serão listadas. Formato: projects/{project}/locations/{location}/apps/{app}

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 de lista AssistantService.ListAssistantSessions anterior.

filter

string

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

ListAssistantSessionsResponse

Mensagem de resposta para AssistantService.ListAssistantSessions.

Campos
assistant_sessions[]

AssistantSession

A lista de sessões do assistente.

next_page_token

string

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

ListChangelogsRequest

Mensagem de solicitação para AgentService.ListChangelogs.

Campos
parent

string

Obrigatório. O nome do recurso do app que contém os registros de alterações a serem 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 de lista AgentService.ListChangelogs anterior.

filter

string

Opcional. Filtro a ser aplicado ao listar os registros de alterações. 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 que não diferencia maiúsculas de minúsculas em campos de string, enquanto = realiza uma correspondência exata que diferencia maiúsculas de minúsculas.

Exemplos: * action:update (correspondência parcial que não diferencia maiúsculas de minúsculas) * action="Create" (correspondência exata que diferencia maiúsculas de minúsculas) * resource_type:agent * resource_name:my-agent * author:me@example.com * create_time > "2025-01-01T00:00:00Z" * create_time <= "2025-01-01T00:00:00Z" AND resource_type:tool

order_by

string

Opcional. Campo para 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 alterações.

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 que contém as conversas a serem 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 de lista AgentService.ListConversations 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 pai. 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 para 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.

ListEvaluationDatasetsRequest

Mensagem de solicitação para EvaluationService.ListEvaluationDatasets.

Campos
parent

string

Obrigatório. O nome do recurso do app que contém os conjuntos de dados de avaliação a serem 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 de lista EvaluationService.ListEvaluationDatasets anterior.

filter

string

Opcional. Filtro a ser aplicado ao listar os conjuntos de dados de avaliação. Consulte https://google.aip.dev/160 para mais detalhes.

order_by

string

Opcional. Campo para classificação. Somente "name", "create_time" e "update_time" são aceitos. Os campos de horário são ordenados em ordem decrescente, e o campo de nome é ordenado em ordem crescente. Se não for incluído, "update_time" será o padrão. Consulte https://google.aip.dev/132#ordering para mais detalhes.

ListEvaluationDatasetsResponse

Mensagem de resposta para EvaluationService.ListEvaluationDatasets.

Campos
evaluation_datasets[]

EvaluationDataset

A lista de conjuntos de dados de avaliação.

next_page_token

string

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

ListEvaluationExpectationsRequest

Mensagem de solicitação para EvaluationService.ListEvaluationExpectations.

Campos
parent

string

Obrigatório. O nome do recurso do app para listar as expectativas de avaliação.

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 de lista EvaluationService.ListEvaluationExpectations anterior.

filter

string

Opcional. Filtro a ser aplicado ao listar as expectativas de avaliação. Consulte https://google.aip.dev/160 para mais detalhes.

order_by

string

Opcional. Campo para classificação. Somente "name", "create_time" e "update_time" são aceitos. Os campos de horário são ordenados em ordem decrescente, e o campo de nome é ordenado em ordem crescente. Se não for incluído, "update_time" será o padrão. Consulte https://google.aip.dev/132#ordering para mais detalhes.

ListEvaluationExpectationsResponse

Mensagem de resposta para EvaluationService.ListEvaluationExpectations.

Campos
evaluation_expectations[]

EvaluationExpectation

A lista de expectativas de avaliação.

next_page_token

string

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

ListEvaluationResultsRequest

Mensagem de solicitação para EvaluationService.ListEvaluationResults.

Campos
parent

string

Obrigatório. O nome do recurso da avaliação que contém os resultados a serem listados. Para filtrar por execução de avaliação, use - como o ID de avaliação e especifique o ID da execução de avaliação no filtro. Por exemplo: projects/{project}/locations/{location}/apps/{app}/evaluations/-

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 de lista EvaluationService.ListEvaluationResults anterior.

filter

string

Opcional. Filtro a ser aplicado ao listar os resultados da avaliação. Consulte https://google.aip.dev/160 para mais detalhes.

order_by

string

Opcional. Campo para classificação. Somente "name", "create_time" e "update_time" são aceitos. Os campos de horário são ordenados em ordem decrescente, e o campo de nome é ordenado em ordem crescente. Se não for incluído, "update_time" será o padrão. Consulte https://google.aip.dev/132#ordering para mais detalhes.

ListEvaluationResultsResponse

Mensagem de resposta para EvaluationService.ListEvaluationResults.

Campos
evaluation_results[]

EvaluationResult

A lista de resultados da avaliação.

next_page_token

string

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

ListEvaluationRunsRequest

Mensagem de solicitação para EvaluationService.ListEvaluationRuns.

Campos
parent

string

Obrigatório. O nome do recurso do app para listar as execuções de avaliação.

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 de lista EvaluationService.ListEvaluationRuns anterior.

filter

string

Opcional. Filtro a ser aplicado ao listar as execuções de avaliação. Consulte https://google.aip.dev/160 para mais detalhes.

order_by

string

Opcional. Campo para classificação. Somente "name", "create_time" e "update_time" são aceitos. Os campos de horário são ordenados em ordem decrescente, e o campo de nome é ordenado em ordem crescente. Se não for incluído, "update_time" será o padrão. Consulte https://google.aip.dev/132#ordering para mais detalhes.

ListEvaluationRunsResponse

Mensagem de resposta para EvaluationService.ListEvaluationRuns.

Campos
evaluation_runs[]

EvaluationRun

A lista de execuções de avaliação.

next_page_token

string

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

ListEvaluationsRequest

Mensagem de solicitação para EvaluationService.ListEvaluations.

Campos
parent

string

Obrigatório. O nome do recurso do app que contém as avaliações a serem 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 de lista EvaluationService.ListEvaluations anterior.

filter
(deprecated)

string

Opcional. Descontinuado: use evaluation_filter e evaluation_run_filter.

evaluation_filter

string

Opcional. Filtro a ser aplicado à avaliação ao listar as avaliações. Consulte https://google.aip.dev/160 para mais detalhes. Campos compatíveis: evaluation_datasets

evaluation_run_filter

string

Opcional. String de filtro para campos nos recursos EvaluationRun associados. Consulte https://google.aip.dev/160 para mais detalhes. Campos aceitos: create_time, initiated_by, app_version_display_name

order_by

string

Opcional. Campo para classificação. Somente "name", "create_time" e "update_time" são aceitos. Os campos de horário são ordenados em ordem decrescente, e o campo de nome é ordenado em ordem crescente. Se não for incluído, "update_time" será o padrão. Consulte https://google.aip.dev/132#ordering para mais detalhes.

last_ten_results

bool

Opcional. Se os últimos 10 resultados de cada avaliação devem ser incluídos na resposta.

ListEvaluationsResponse

Mensagem de resposta para EvaluationService.ListEvaluations.

Campos
evaluations[]

Evaluation

A lista de avaliações.

next_page_token

string

Um token que pode ser enviado como ListEvaluationsRequest.page_token para recuperar a próxima página. A ausência desse campo indica que não há 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 de lista AgentService.ListExamples 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 para 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 para listar as proteções.

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 de lista AgentService.ListGuardrails 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 para 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.

ListScheduledEvaluationRunsRequest

Mensagem de solicitação para EvaluationService.ListScheduledEvaluationRuns.

Campos
parent

string

Obrigatório. O nome do recurso do app que contém as execuções de avaliação programadas.

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 de lista EvaluationService.ListScheduledEvaluationRuns anterior.

filter

string

Opcional. Filtro a ser aplicado ao listar as execuções de avaliação programadas. Consulte https://google.aip.dev/160 para mais detalhes. No momento, é possível filtrar por: * request.evaluations:evaluation_id * request.evaluation_dataset:evaluation_dataset_id

order_by

string

Opcional. Campo para classificação. Os campos aceitos são: "name" (crescente), "create_time" (decrescente), "update_time" (decrescente), "next_scheduled_execution" (crescente) e "last_completed_run.create_time" (decrescente). Se não for incluído, "update_time" será o padrão. Consulte https://google.aip.dev/132#ordering para mais detalhes.

ListScheduledEvaluationRunsResponse

Mensagem de resposta para EvaluationService.ListScheduledEvaluationRuns.

Campos
scheduled_evaluation_runs[]

ScheduledEvaluationRun

A lista de execuções de avaliação programadas.

next_page_token

string

Um token que pode ser enviado como ListScheduledEvaluationRunsRequest.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 que contém as ferramentas a serem 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 de lista AgentService.ListTools 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 para 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 de onde 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 de lista AgentService.ListToolsets 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 para 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 geração de registros do app.

Campos
redaction_config

RedactionConfig

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

audio_recording_config

AudioRecordingConfig

Opcional. Configuração de como as interações de áudio devem ser gravadas. O áudio está sujeito à edição conforme configurado em RedactionConfig.

unredacted_audio_recording_config

AudioRecordingConfig

Opcional. Configura uma gravação extra de áudio sem edição. Isso pode ser usado para manter uma cópia de áudio bruta quando a edição de áudio é enabled, normalmente para fins de auditoria ou monitoramento.

bigquery_export_settings

BigQueryExportSettings

Opcional. Configura os comportamentos de exportação do BigQuery para o app. Os dados da conversa estão sujeitos a encobrimento, conforme configurado em RedactionConfig.

unredacted_bigquery_export_settings

BigQueryExportSettings

Opcional. Configura os comportamentos de exportação do BigQuery para o app. Os dados de conversa não editados serão exportados para tabelas do BigQuery se estiverem ativados.

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

name_override

string

Opcional. A substituição do nome da ferramenta MCP. Isso será preenchido se o nome tiver sido substituído por uma substituição do Toolset.

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 precisará ter o sufixo "/mcp/". Somente servidores baseados em transporte HTTP transmissível são compatíveis. É o mesmo que 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 do portador, o token se aplica apenas à execução de ferramentas, 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ço em um perímetro.

custom_headers

map<string, string>

Opcional. Os cabeçalhos personalizados que serão enviados na solicitação ao servidor MCP. Os valores precisam estar no formato $context.variables.<name_of_variable> e podem ser definidos nas variáveis de sessão. Consulte https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection para mais detalhes.

state

McpTool.State

Apenas saída. O estado de disponibilidade dinâmica da ferramenta no servidor externo.

Estado

Representa o estado de disponibilidade dinâmica da ferramenta.

Tipos enumerados
STATE_UNSPECIFIED Estado padrão.
ACTIVE A ferramenta está disponível e é oferecida ativamente pelo servidor.
INACTIVE A ferramenta está configurada ou fixada, mas não é oferecida pelo servidor no momento.
STALE A ferramenta existe no servidor, mas não corresponde à versão dele.

McpToolDefinition

Contêiner para os elementos de definição principais de uma ferramenta que são snapshots. Os esquemas no snapshot são usados como estão e não podem ser substituídos.

Campos
description

string

Apenas saída. A descrição da ferramenta MCP. Isso pode ser substituído por description_override em McpToolOverride.

input_schema

Schema

Apenas saída. O esquema dos argumentos de entrada da ferramenta MCP.

output_schema

Schema

Apenas saída. O esquema dos argumentos de saída da ferramenta MCP.

McpToolOverride

Substituições associadas a uma determinada ferramenta em um conjunto de ferramentas. Isso permite "fixar" ou "substituir" as definições de ferramentas do servidor dinâmico externo.

Campos
tool

string

Obrigatório. O nome original da ferramenta, conforme emitido pelo servidor MCP.

name_override

string

Opcional. Se presente, essa ferramenta usa esse nome no agente em vez do nome original. Isso é usado principalmente como um alias se o servidor MCP oferecer ferramentas com nomes ruins.

description_override

string

Opcional. Se presente, essa ferramenta usa essa descrição em vez da original do servidor.

snapshot

McpToolDefinition

Apenas saída. Se estiver presente, essa ferramenta será "Fixada" e usará os valores do snapshot como substitutos se o servidor ficar temporariamente indisponível ou se não houver uma substituição.

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 precisará ter o sufixo "/mcp/". Somente servidores baseados em transporte HTTP transmissível 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 do portador, o token se aplica apenas à execução de ferramentas, 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ço 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.

custom_headers

map<string, string>

Opcional. Os cabeçalhos personalizados que serão enviados na solicitação ao servidor MCP. Os valores precisam estar no formato $context.variables.<name_of_variable> e podem ser definidos nas variáveis de sessão. Consulte https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection para mais detalhes.

tool_overrides[]

McpToolOverride

Opcional. Substituições para ferramentas individuais dentro desse conjunto. Isso permite substituir detalhes específicos, como descrições, nomes ou fixar os estados das ferramentas para que não sejam totalmente dinâmicos.

Mensagem

Uma mensagem em uma conversa.

Campos
role

string

Opcional. O papel na conversa, por exemplo, usuário, agente.

chunks[]

Chunk

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

event_time

Timestamp

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

MetricAnalysisSettings

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

Campos
llm_metrics_opted_out

bool

Opcional. Se os dados de conversa devem ser coletados para métricas de análise de LLM. Se for verdadeiro, os dados da conversa não serão coletados para as métricas de análise do LLM. Caso contrário, os dados da conversa serão coletados.

MockConfig

Configuração de chamadas de ferramenta simuladas para a sessão.

Campos
mocked_tool_calls[]

MockedToolCall

Opcional. Todas as chamadas de ferramenta para simular durante a sessão.

unmatched_tool_call_behavior

MockConfig.UnmatchedToolCallBehavior

Obrigatório. Comportamento para chamadas de ferramentas que não correspondem a nenhum padrão de argumentos em mocked_tool_calls.

UnmatchedToolCallBehavior

O que fazer quando uma chamada de ferramenta não corresponde a nenhuma chamada simulada.

Tipos enumerados
UNMATCHED_TOOL_CALL_BEHAVIOR_UNSPECIFIED Valor padrão. Esse valor não é usado.
FAIL Gera um erro para qualquer chamada de ferramenta que não corresponda a um padrão de entrada esperado simulado.
PASS_THROUGH Para chamadas de ferramenta sem correspondência, transmita a chamada para a ferramenta real.

MockedToolCall

Uma chamada de ferramenta simulada.

Expressa a ferramenta de destino + um padrão para corresponder aos argumentos / entradas dessa ferramenta. Se o padrão corresponder, a resposta simulada será retornada.

Campos
tool
(deprecated)

string

Opcional. Obsoleto. Use tool_identifier.

expected_args_pattern

Struct

Obrigatório. Um padrão para corresponder aos argumentos / entradas de todas as chamadas de ferramenta enviadas. Se as entradas da chamada de ferramenta corresponderem a esse padrão, a saída simulada será retornada.

mock_response

Struct

Opcional. A resposta / saída simulada que será retornada se os argumentos / entradas da chamada de ferramenta corresponderem ao padrão.

Campo de união tool_identifier. O identificador da ferramenta a ser simulada. tool_identifier pode ser apenas de um dos tipos a seguir:
tool_id

string

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

toolset

ToolsetTool

Opcional. O conjunto de ferramentas a ser simulado.

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 for definido, o agente vai herdar o modelo do agente pai.

thinking_level

ModelSettings.ThinkingLevel

Opcional. O nível de raciocínio do modelo.

temperature

double

Opcional. Se definida, essa temperatura será usada para o modelo de 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.

ThinkingLevel

Configuração do nível de raciocínio do modelo.

Tipos enumerados
THINKING_LEVEL_UNSPECIFIED O nível de pensamento não foi especificado.
DEFAULT Nível de raciocínio padrão.
LOW Nível de raciocínio baixo.
MEDIUM Nível de raciocínio médio.
HIGH Nível de raciocínio alto.

OAuthConfig

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

Campos
oauth_grant_type

OAuthConfig.OauthGrantType

Obrigatório. Tipos de permissões de acesso 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 trocar por um token de acesso.

scopes[]

string

Opcional. Os escopos do OAuth a serem concedidos.

OauthGrantType

Tipos de permissões de acesso OAuth. Somente a concessão de credenciais do cliente é aceita.

Tipos enumerados
OAUTH_GRANT_TYPE_UNSPECIFIED Não especificado. O padrão é CLIENT_CREDENTIAL.
CLIENT_CREDENTIAL Representa o fluxo de credenciais do cliente.

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, de operation.description ou 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 de API aberta. Esse campo só é definido em ferramentas nas dependências do ambiente durante o processo de exportação se o esquema tiver 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.

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 verdadeiro, o agente vai ignorar campos desconhecidos na resposta da API para todas as operações definidas no esquema da OpenAPI.

url

string

Opcional. O URL do servidor do esquema de API aberta. Esse campo só é definido em conjuntos de ferramentas nas dependências do ambiente durante o processo de exportação se o esquema tiver 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.

OperationCompletedEvent

Evento enviado pelo cliente ou worker em segundo plano para retomar uma sessão do assistente após a conclusão de uma operação de longa duração (LRO, na sigla em inglês) assíncrona.

Campos
operation_name

string

O nome do recurso da operação (por exemplo, operations/{op}).

target_resource_name

string

O recurso principal visado ou produzido pela operação (por exemplo, ID da execução de avaliação, ID do app, ID do conjunto de dados).

operation_type

string

O tipo de operação ou o nome da ferramenta (por exemplo, "run_evaluation", "copy_app", "export_app").

status

string

Status da execução da operação (por exemplo, "SUCCEEDED", "FAILED", "CANCELLED").

deduplication_token

string

Token de eliminação de duplicação opcional (por exemplo, UUID) para evitar a execução de turnos duplicados em guias simultâneas do navegador.

error

Status

Status de erro canônico opcional se a operação falhar.

metadata

Struct

Metadados de resultado estruturados opcionais (por exemplo, pass_rate, total_examples, export_uri).

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

OptimizationConfig

Configuração para executar a etapa de otimização após a execução da avaliação.

Campos
generate_loss_report

bool

Opcional. Se um relatório de perda deve ser gerado.

assistant_session

string

Apenas saída. A sessão do assistente que será usada para a otimização com base nessa execução de avaliação. Formato: projects/{project}/locations/{location}/apps/{app}/assistantSessions/{assistantSession}

report_summary

string

Apenas saída. O resumo do relatório de perda.

should_suggest_fix

bool

Apenas saída. Se uma correção deve ser sugerida para as perdas.

status

OptimizationConfig.OptimizationStatus

Apenas saída. O status da execução da otimização.

error_message

string

Apenas saída. A mensagem de erro se a execução da otimização falhar.

loss_report

Struct

Apenas saída. O relatório de perda gerado.

OptimizationStatus

O status da execução da otimização.

Tipos enumerados
OPTIMIZATION_STATUS_UNSPECIFIED O status de otimização não foi especificado.
RUNNING A otimização está em execução.
COMPLETED A otimização foi concluída.
ERROR Falha na otimização devido a um erro interno.

OptionQuestionsChunk

Opções de esclarecimento estruturadas que o assistente pede para o usuário escolher, traduzidas do lado do servidor fora da vez do modelo (o bloco de opções é removido do texto transmitido e persistido). O console renderiza uma lista de opções navegável pelo teclado, fixada acima do editor.

Campos
questions[]

OptionQuestionsChunk.Question

As perguntas feitas nesta rodada. Mais de uma entrada aciona o paginador "1 de N" do console.

Opção

Uma única opção selecionável.

Campos
title

string

Título curto da opção em texto simples (sem markdown, sem numeração).

details

string

Detalhes opcionais de compensação mostrados como texto secundário.

submit_text

string

Texto opcional da mensagem a ser enviada quando a opção é escolhida. O padrão é title quando vazio.

Pergunta

Uma pergunta com as opções.

Campos
question

string

É o texto do cabeçalho da pergunta.

options[]

OptionQuestionsChunk.Option

As opções selecionáveis, em ordem de apresentação.

OutputAudioConfig

OutputAudioConfig configura como o agente do CES deve sintetizar as respostas de áudio de saída.

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.

PersonaRunConfig

Configuração para executar uma avaliação de uma persona específica.

Campos
persona

string

Opcional. A persona que será usada na avaliação. Formato: projects/{project}/locations/{location}/apps/{app}/evaluationPersonas/{evaluationPersona}

task_count

int32

Opcional. O número de tarefas a serem executadas para a persona.

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 do Python a ser executada. Precisa corresponder a um nome de função do 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 do Python, analisada da docstring do código Python.

service_directory_config

ServiceDirectoryConfig

Opcional. Configuração do Diretório de Serviços para a ferramenta.

QualityReport

O relatório que descreve os problemas de qualidade identificados no app.

Campos
issues[]

QualityReport.AgentIssues

Opcional. Os problemas agrupados por agente.

evaluation_runs[]

string

Opcional. Uma lista de execuções de avaliação usadas para gerar o relatório de qualidade. Formato: projects/{project}/locations/{location}/evaluationRuns/{evaluationRun}.

general_issues[]

QualityReport.Issue

Opcional. Problemas gerais que não são específicos de nenhum agente.

AgentIssues

Problemas identificados para um único agente.

Campos
agent

string

Opcional. O nome do agente relacionado aos problemas. Formato: projects/{project}/locations/{location}/apps/{app}/agents/{agent}

issues[]

QualityReport.Issue

Opcional. Lista de problemas encontrados para este agente.

Problema

O problema identificado.

Campos
description

string

Opcional. Descrição do problema encontrado.

occurrence_count

int32

Opcional. Quantas vezes o problema ocorreu.

proposed_solution

string

Opcional. Solução proposta para corrigir o problema modificando as instruções ou ferramentas.

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

Campos
enable_redaction

bool

Opcional. Se for true, a encobrimento 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 da 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 da DLP para instruir sobre como desidentificar o conteúdo.

Formato: projects/{project}/locations/{location}/deidentifyTemplates/{deidentify_template}

RemoteA2aConfig

Configuração compartilhada para se conectar a um agente A2A remoto.

Campos
api_authentication

ApiAuthentication

Opcional. Configuração de autenticação para chamar o agente remoto. Opcional se a referência do registro já processar a autenticação.

input_variable_mapping

map<string, string>

Opcional. Mapeamento de nomes de variáveis de entrada do agente remoto para nomes de variáveis do GECX.

output_variable_mapping

map<string, string>

Opcional. Mapeamento de nomes de variáveis de saída do agente remoto para nomes de variáveis do GECX.

streaming_enabled

bool

Opcional. Se o streaming está ativado para o agente remoto.

context_id

string

Opcional. Se não estiver vazio, as interações com o agente A2A remoto vão usar esse ID de contexto. Esse campo context_id pode se referir a uma variável de sessão como $context.variables.order_agent_session_id.

Campo de união agent_spec. Especificação do agente remoto. agent_spec pode ser apenas de um dos tipos a seguir:
agent_card

AgentCard

Opcional. O card completo do agente definido inline.

agent_registry

string

Opcional. Referência ao agente no Agent Registry. Formato: projects/{project}/locations/{location}/agents/{agent}

RemoteAgentTool

Representa uma ferramenta que permite ao agente chamar outro agente remoto.

Campos
name

string

Obrigatório. O nome da ferramenta.

description

string

Obrigatório. A descrição da ferramenta.

agent_card

AgentCard

Obrigatório. O card do agente remoto que essa ferramenta invoca.

api_authentication

ApiAuthentication

Opcional. Configuração de autenticação para chamar o agente remoto.

stateful_agent

bool

Opcional. Quando ativada, a interação entre o app CXAS e o agente remoto vai compartilhar o mesmo contexto. Se o agente remoto retornar um context_id, ele será mantido durante toda a sessão para essa ferramenta de agente remoto.

input_variable_mapping

map<string, string>

Opcional. Mapeamento de nomes de variáveis de entrada do agente remoto para nomes de variáveis do GECX.

output_variable_mapping

map<string, string>

Opcional. Mapeamento de nomes de variáveis de saída do agente remoto para nomes de variáveis do GECX.

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 ao qual 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. 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 deve 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 refere. tool_identifier pode ser apenas de um dos tipos a seguir:
tool

string

O nome da ferramenta a que o esquema se destina. 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 do conjunto serão retornadas.

bypass_persistence_config

bool

Opcional. Se for verdadeiro, as ferramentas retornadas vão conter descrições e esquemas brutos diretamente do servidor, ignorando as configurações de persistência armazenadas (substituições/snapshots).

RetrieveToolsResponse

Mensagem de resposta para ToolService.RetrieveTools.

Campos
tools[]

Tool

A lista de ferramentas incluídas no conjunto especificado.

RunAssistantRequest

Mensagem de solicitação para AssistantService.RunAssistant.

Campos
app

string

Obrigatório. O app para o qual o assistente será executado. Formato: projects/{project}/locations/{location}/apps/{app}

assistant_session

string

Obrigatório. A sessão do assistente que será usada para executar o assistente. Formato: projects/{project}/locations/{location}/apps/{app}/assistantSessions/{assistant_session}

message

AssistantMessage

Obrigatório. A mensagem a ser enviada ao agente assistente.

interaction_type

RunAssistantRequest.InteractionType

Opcional. Diferentes tipos de interação para a mensagem do assistente.

InteractionType

O tipo de interação da mensagem enviada ao assistente.

Tipos enumerados
INTERACTION_TYPE_UNSPECIFIED O valor padrão. Esse valor será usado se o tipo não for especificado.
NEW_MESSAGE A mensagem é uma entrada do usuário. A entrada do usuário é fornecida na lista de blocos.
POLL A mensagem é para consultar o estado da sessão do assistente.
DISMISS A mensagem é para dispensar a sessão do assistente que está aguardando análise. Isso vai mudar o estado da sessão do assistente para inativo.

RunAssistantResponse

Mensagem de resposta para AssistantService.RunAssistant.

Campos
output

AssistantOutput

Obrigatório. A saída do agente assistente.

state

AssistantSessionState

Apenas saída. O status da sessão do assistente.

RunEvaluationOperationMetadata

Metadados de operação para EvaluationService.RunEvaluation.

Campos
evaluations[]

string

Apenas saída. A lista de avaliações que foram executadas. Formato: projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}

evaluation_run

string

Apenas saída. A execução de avaliação que foi criada. Formato: projects/{project}/locations/{location}/apps/{app}/evaluationRuns/{evaluation_run}

create_time

Timestamp

Somente saída: a hora em que a operação foi criada.

end_time

Timestamp

Apenas saída. A hora em que a operação foi concluída.

verb

string

Apenas saída. O verbo da operação.

cancel_requested

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.

RunEvaluationRequest

Mensagem de solicitação para EvaluationService.RunEvaluation.

Campos
app

string

Obrigatório. O app a ser avaliado. Formato: projects/{project}/locations/{location}/apps/{app}

evaluations[]

string

Opcional. Lista de avaliações a serem executadas. Formato: projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}

evaluation_dataset

string

Opcional. Um conjunto de dados de avaliação para executar. Formato: projects/{project}/locations/{location}/apps/{app}/evaluationDatasets/{evaluationDataset}

display_name

string

Opcional. O nome de exibição da execução de avaliação.

app_version

string

Opcional. A versão do app a ser avaliada. É possível definir no máximo um de app_version ou deployment. Formato: projects/{project}/locations/{location}/apps/{app}/versions/{version}

config

EvaluationConfig

Opcional. A configuração a ser usada para a execução.

persona_run_configs[]

PersonaRunConfig

Opcional. A configuração a ser usada para a execução por persona.

optimization_config

OptimizationConfig

Opcional. Configuração para executar a etapa de otimização após a execução da avaliação. Se não for definida, a etapa de otimização não será executada.

scheduled_evaluation_run

string

Opcional. O nome do recurso do ScheduledEvaluationRun que está acionando essa execução de avaliação.

Se esse campo for definido, o campo scheduled_evaluation_run no recurso EvaluationRun criado será preenchido com esse valor. Formato: projects/{project}/locations/{location}/apps/{app}/scheduledEvaluationRuns/{scheduled_evaluation_run}

golden_run_method

GoldenRunMethod

Opcional. O método para executar a avaliação se ela for uma avaliação de referência. Se não for definido, o padrão será STABLE.

generate_latency_report

bool

Opcional. Se um relatório de latência deve ser gerado para a execução da avaliação.

evaluation_run_caching_settings

EvaluationRunCachingSettings

Opcional. As configurações de armazenamento em cache a serem usadas na execução da avaliação.

run_count

int32

Opcional. O número de vezes que a avaliação será executada. Se não for definido, o valor padrão será 1 por golden e 5 por cenário.

RunEvaluationResponse

Mensagem de resposta para EvaluationService.RunEvaluation.

Campos
evaluation_run

string

O nome da execução de avaliação que foi criada. Formato: projects/{project}/locations/{location}/apps/{app}/evaluationRuns/{evaluation_run}

RunEvaluationResultMetricsOperationMetadata

Esse tipo não tem campos.

Metadados de operação para EvaluationService.RunEvaluationResultMetrics.

RunEvaluationResultMetricsRequest

Mensagem de solicitação para EvaluationService.RunEvaluationResultMetrics.

Campos
evaluation_result_id

string

Obrigatório. O resultado da avaliação para o qual as métricas serão executadas. Formato: projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}/results/{evaluation_result_id}

RunEvaluationResultMetricsResponse

Mensagem de resposta para EvaluationService.RunEvaluationResultMetrics.

Campos
status

EvaluationResult.Outcome

Apenas saída. O status do cálculo das métricas de resultado da avaliação.

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.

ScheduledEvaluationRun

Representa uma configuração de execução de avaliação programada.

Campos
name

string

Identificador. O identificador exclusivo da configuração de execução da avaliação programada. Format: projects/{projectId}/locations/{locationId}/apps/{appId}/scheduledEvaluationRuns/{scheduledEvaluationRunId}

display_name

string

Obrigatório. Nome de exibição definido pelo usuário da configuração de execução de avaliação programada.

request

RunEvaluationRequest

Obrigatório. O RunEvaluationRequest a ser programado.

description

string

Opcional. Descrição definida pelo usuário da execução de avaliação programada.

scheduling_config

ScheduledEvaluationRun.SchedulingConfig

Obrigatório. Configuração do momento e da frequência de execução das avaliações.

active

bool

Opcional. Se esta configuração está ativa

last_completed_run

string

Apenas saída. A última EvaluationRun bem-sucedida dessa execução programada. Formato: projects/{project}/locations/{location}/apps/{app}/evaluationRuns/{evaluationRun}

total_executions

int32

Apenas saída. O número total de vezes que essa execução foi realizada

next_scheduled_execution_time

Timestamp

Apenas saída. A próxima vez que a execução está programada

create_time

Timestamp

Apenas saída. Carimbo de data/hora de quando a execução de avaliação programada foi criada.

created_by

string

Apenas saída. O usuário que criou a execução de avaliação programada.

update_time

Timestamp

Apenas saída. Carimbo de data/hora de quando a avaliação foi atualizada pela última vez.

last_updated_by

string

Apenas saída. O usuário que atualizou a avaliação pela última vez.

etag

string

Apenas saída. 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.

SchedulingConfig

Detalhes da configuração de programação de avaliação

Campos
frequency

ScheduledEvaluationRun.SchedulingConfig.Frequency

Obrigatório. A frequência com que a avaliação será executada

start_time

Timestamp

Obrigatório. Carimbo de data/hora de quando a avaliação deve começar.

days_of_week[]

int32

Opcional. Os dias da semana em que a avaliação será executada. Aplicável apenas às frequências semanal e quinzenal. 1 é segunda-feira, 2 é terça-feira, ..., 7 é domingo.

Frequência

As frequências em que as avaliações podem ser executadas

Tipos enumerados
FREQUENCY_UNSPECIFIED A frequência não foi especificada.
NONE Indica uma execução programada única que não deve ser repetida
DAILY Execute a avaliação diariamente.
WEEKLY Execute a avaliação semanalmente.
BIWEEKLY Realize a avaliação a cada duas semanas.

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. Aplica-se apenas a TYPE.ARRAY.

prefix_items[]

Schema

Opcional. Esquemas de elementos iniciais de Type.ARRAY.

additional_properties

Schema

Opcional. Pode ser um booleano ou um objeto, controla a presença de outras propriedades.

any_of[]

Schema

Opcional. O valor precisa ser validado em relação a qualquer um (ou mais) dos subesquemas na lista.

enum[]

string

Opcional. Valores possíveis do elemento de tipo primitivo com formato de tipo enumerado. 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 da raiz defs.

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ó do esquema chamado "Pet". Veja mais detalhes em https://json-schema.org/understanding-json-schema/structuring.

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 string.
INTEGER Tipo inteiro.
NUMBER Tipo de número.
BOOLEAN Tipo booleano.
OBJECT Tipo de objeto.
ARRAY Tipo de matriz.

SecuritySettings

Configurações de segurança no nível do projeto/local para o CES.

Campos
name

string

Identificador. O identificador exclusivo das configurações de segurança. Formato: projects/{project}/locations/{location}/securitySettings

endpoint_control_policy

EndpointControlPolicy

Opcional. Configurações relacionadas ao controle de endpoints.

create_time

Timestamp

Apenas saída. Horário de criação das configurações de segurança.

update_time

Timestamp

Apenas saída. Hora da última atualização das configurações de segurança.

etag

string

Apenas saída. Etag das configurações de segurança.

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

SessionCheckpoint

Checkpoint da sessão que contém a intenção do usuário inferida para o título da sessão e UI.

Campos
user_intent

string

Meta ou tópico inferido do usuário para a sessão (por exemplo, "Criar um agente de suporte de e-commerce").

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, então o cliente não precisa preencher esse campo de forma explícita. No entanto, o cliente pode, se quiser, 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 lidar com 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 usada 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 de fusos horários da IANA, por exemplo, "America/Los_Angeles".

use_tool_fakes

bool

Opcional. Se as simulações de ferramentas devem ser usadas na sessão. Se esse campo for definido, o agente vai tentar usar ferramentas falsas em vez de chamar as ferramentas reais.

remote_dialogflow_query_parameters

SessionConfig.RemoteDialogflowQueryParameters

Opcional. QueryParameters para enviar ao agente remoto do Dialogflow quando o controle da sessão for transferido para o agente remoto.

enable_text_streaming

bool

Opcional. Se a saída de texto do modelo deve ser transmitida ao cliente de forma incremental conforme é gerada. O valor padrão é false.

  • Quando desativada, a saída de texto do modelo é armazenada em buffer, e cada saída de texto enviada ao cliente é uma frase completa. Os clientes podem renderizar cada saída de texto em uma nova linha.
  • Quando ativada, cada saída de texto pode conter apenas parte de uma frase. Os clientes precisam concatenar saídas de texto consecutivas para renderizar a resposta completa.

OBSERVAÇÃO: esse recurso só está disponível para sessões de texto (não de voz) que usam StreamRunSession ou BidiRunSession.

include_llm_thought_summary

bool

Opcional. Se os resumos de pensamento do LLM devem ser incluídos nas saídas da sessão.

exclude_diagnostic_info

bool

Opcional. Se as informações de diagnóstico devem ser excluídas da saída da sessão.

include_progress_update

bool

Opcional. Se as atualizações de processamento intermediário devem ser incluídas para o cliente. Se ativada, a atualização será enviada de volta em SessionOutput.progress.

RemoteDialogflowQueryParameters

QueryParameters para enviar ao agente remoto do Dialogflow quando o controle da sessão for transferido para o agente remoto.

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 é false ou até que o sistema detecte um endpoint na entrada de áudio.

OBSERVAÇÃO: esse campo não se aplica a entradas de áudio e DTMF, porque elas são sempre processadas automaticamente com base no sinal de endpointing.

recording_control

SessionInput.RecordingControl

Opcional. Se a conversa pode ser gravada e registrada a partir de agora.

Use essa opção quando o app, e não o agente, decidir o que pode ser mantido: por exemplo, quando o usuário final precisa consentir com a gravação antes que qualquer informação sobre a chamada seja armazenada.

O valor permanece em vigor até que o cliente envie um diferente. Portanto, ele só precisa ser enviado quando a resposta mudar. O que estiver em vigor quando uma rodada for concluída decide essa rodada, tanto se o áudio chega ao bucket de gravação quanto se a transcrição chega ao histórico de conversas, ao BigQuery e ao Cloud Logging. Ela abrange o lado do agente e do usuário final.

As curvas que terminam antes do cliente enviar isso pela primeira vez são registradas de acordo com as configurações de registro do app, como se o campo não existisse.

Se mais de uma entrada na mesma solicitação definir esse valor, a última vai prevalecer.

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 ferramenta 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 para a sessão, identificadas por nome. Somente as variáveis declaradas no app serão usadas pelo agente do CES.

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

RecordingControl

O que o app decidiu pode ser gravado e registrado.

Esse tipo enumerado é extensível, e novos valores podem ser adicionados no futuro.

Tipos enumerados
RECORDING_CONTROL_UNSPECIFIED O app não está controlando a gravação. As configurações de registro do app decidem, como fazem para cada sessão que nunca define esse campo.
RECORDING_ENABLED A conversa pode ser gravada e registrada a partir de agora.
RECORDING_DISABLED A conversa não será mais gravada ou registrada.

SessionOutput

Saída da sessão.

Campos
turn_index

int32

Indica a ordem sequencial da rodada de conversa a que essa 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 respostas para ela.

diagnostic_info

SessionOutput.DiagnosticInfo

Opcional. As informações de diagnóstico contêm detalhes de execução durante o processamento da entrada. Preenchido apenas no último SessionOutput (com turn_completed=true) de 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 do CES.

audio

bytes

Áudio de saída do agente do 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 do CES.

image

Image

Imagem de saída do agente do CES.

progress

string

Atualização de progresso intermediária do agente do 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 trace de todo o processamento da solicitação, representado como um período raiz. Esse período pode conter períodos filhos aninhados para operações específicas.

Período

Um período é uma unidade de trabalho ou uma única operação durante o processamento da solicitação.

Campos
name

string

Apenas saída. O nome do período.

start_time

Timestamp

Apenas saída. O horário de início do período.

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 período.

child_spans[]

Span

Apenas saída. Os períodos filhos que estão aninhados neste período.

StreamChatAiAssistantRequest

Mensagem de solicitação para SessionService.StreamChatAiAssistant.

Campos
name

string

Obrigatório. A sessão do assistente que será usada para executar o assistente. Formato: projects/{project}/locations/{location}/apps/{app}/assistantSessions/{assistant_session}

message

string

Opcional. A mensagem a ser enviada ao agente assistente. Pode ficar vazio quando confirmation_response é definido (respondendo a uma confirmação pendente sem adicionar uma nova mensagem). Pelo menos um dos dois precisa ser fornecido.

attached_gcs_uris[]

string

Opcional. URIs do Cloud Storage para arquivos enviados pelo usuário durante essa rodada. Exemplo: "gs://cxas-transient-uploads/uuid/prd.pdf"

context_token

string

Opcional. Token de contexto de integração opaco retornado por SessionService.GenerateOnboardingSuggestions. Quando definido e ainda atualizado, o servidor reutiliza o snapshot de integração calculado para o estado zero em vez de recalcular para a primeira rodada de conversa.

confirmation_response

AssistantConfirmationResponse

Opcional. A resposta do usuário a um AssistantConfirmationRequest pendente. Quando definido, o servidor retoma o agente pausado com essa resposta em vez de (ou além de) iniciar uma nova rodada de comandos.

client_capabilities[]

StreamChatAiAssistantRequest.ClientCapability

Opcional. Recursos de resposta que este cliente pode renderizar. O servidor só emite eventos que precisam de uma capacidade (por exemplo, confirmation_request) quando ela é declarada. Assim, os clientes mais antigos nunca recebem eventos que seriam descartados silenciosamente.

operation_completed_event

OperationCompletedEvent

Opcional. Retoma uma sessão do assistente pausada aguardando a conclusão de uma operação de longa duração gerenciada pelo cliente.

resume_from_sequence_number

int64

Opcional. Cursor opcional para retomar e repetir eventos de uma rodada em andamento ou concluída.

attach_only

bool

Opcional. Flag opcional para anexar a uma conversa em andamento sem enviar uma nova mensagem.

ClientCapability

Recursos de resposta que um cliente pode declarar.

Tipos enumerados
CLIENT_CAPABILITY_UNSPECIFIED Recurso não especificado; ignorado.
CONFIRMATION_CARDS O cliente renderiza os cards AssistantConfirmationRequest e os responde usando confirmation_response.
CLIENT_MANAGED_LRO O cliente gerencia operações de longa duração fora de banda, sondando a operação e enviando operation_completed_event para retomar a vez. Se não for declarado, o servidor vai gerenciar a sondagem de LRO e concluir a vez inline.
PROJECT_SCOPE O cliente renderiza eventos de escopo do projeto: cards typed_payload, target_app em chamadas de ferramentas e respostas, targets em solicitações de confirmação e touched_apps na conclusão de turnos.

StreamChatAiAssistantResponse

Mensagem de resposta para SessionService.StreamChatAiAssistant.

Campos
event_id

string

Identificador exclusivo do evento.

event_time

Timestamp

Carimbo de data/hora de quando o evento ocorreu.

ui_event

UiEvent

Opcional. Payload do evento UI.

turn_metadata

TurnMetadata

Opcional. Metadados no nível da fala e categorização de intenção.

sequence_number

int64

Opcional. Número de sequência monotonicamente crescente para este turno da sessão.

turn_in_progress

bool

Opcional. Indica se a curva ainda está sendo executada em segundo plano.

Campo de união event. O payload do evento. event pode ser apenas de um dos tipos a seguir:
text_chunk

string

Token de texto (para transmitir as respostas do Gemini palavra por palavra).

status

Status

Atualização de status simples.

thought_chunk

string

Bloco de texto de pensamento (raciocínio do agente antes de gerar a resposta).

tool_call

ToolCall

Evento de execução de chamada de ferramenta.

tool_response

ToolResponse

Evento de resposta de chamada de ferramenta.

artifact_chunk

ArtifactChunk

Evento de artefato de documento gerado (deltas de prévia ao vivo + ponteiro final do Cloud Storage).

option_questions_chunk

OptionQuestionsChunk

Opções de esclarecimento estruturadas analisadas na vez do modelo. O console renderiza esses valores como uma lista de opções selecionáveis, em vez de texto bruto.

confirmation_request

AssistantConfirmationRequest

Uma confirmação de bloqueio em que o agente foi pausado. O agente é retomado quando a resposta chega no confirmation_response de uma solicitação posterior. Enviado apenas para clientes que declararam o recurso CONFIRMATION_CARDS na solicitação.

session_checkpoint

SessionCheckpoint

Evento de recapitulação de checkpoint/compactação da sessão que contém a intenção do usuário e o resumo contínuo.

resume_snapshot

TurnResumeSnapshot

Uma repetição compactada de uma rodada em andamento, enviada como o primeiro evento de cada anexação ou retomada antes de qualquer evento ao vivo. O cliente substitui qualquer estado renderizado localmente para essa rodada pelo conteúdo do snapshot.

handoff

TurnHandoffEvent

Informa ao cliente para se reconectar silenciosamente com resume_from_sequence_number: a tarefa que exibe esse stream está sendo encerrada e a vez vai continuar em outro lugar. Não é um erro. O stream é concluído normalmente após esse evento.

turn_completed

TurnCompletedEvent

A vez acabou. Enviado como o último evento de cada turno, no stream original e em cada stream anexado ou retomado, para que os clientes possam encerrar o turno com um sinal explícito, em vez de inferir isso do fechamento do stream.

SynthesizeSpeechConfig

Configuração de como a resposta do agente deve ser sintetizada.

Campos
voice

string

Opcional. Nome da voz. Se não for definida, o serviço vai escolher uma voz com base nos outros parâmetros, como language_code.

Para ver a lista de vozes disponíveis, consulte Vozes e idiomas compatíveis da 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.

model

string

Opcional. O modelo usado para sintetizar áudio. Valores compatíveis no momento: - "gemini-3.1-flash-tts-preview". Se estiver vazio, o Chirp3-HD será usado.

instruction

string

Opcional. A instrução usada para sintetizar a fala ao usar um modelo generativo.

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.

TestPersonaVoiceRequest

Mensagem de solicitação para EvaluationService.TestPersonaVoice.

Campos
app

string

Obrigatório. O nome do recurso do app para testar a voz da persona. Formato: projects/{project}/locations/{location}/apps/{app}

persona_id

string

Obrigatório. O ID da persona para testar a voz. Também aceita "default".

text

string

Obrigatório. O texto para testar a voz.

TestPersonaVoiceResponse

Mensagem de resposta para EvaluationService.TestPersonaVoice.

Campos
audio

bytes

Os bytes de dados de áudio da voz sintetizada.

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 de 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 eliminar a ambiguidade dos certificados de CA personalizados.

cert

bytes

Obrigatório. Os certificados de CA personalizados permitidos (no formato DER) para verificação de HTTPS. Isso substitui o repositório de confiança SSL padrão. Se esse campo estiver vazio ou não for especificado, o CES vai usar o repositório de confiança padrão do Google para verificar os certificados. Observação: verifique se os certificados do servidor HTTPS estão assinados com "nome alternativo do assunto". 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 atingir determinados objetivos.

Campos
name

string

Identificador. O nome do recurso da ferramenta. Formato:

  • projects/{project}/locations/{location}/apps/{app}/tools/{tool} para ferramentas independentes.
  • 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.

timeout

Duration

Opcional. O tempo limite para a execução da ferramenta. Se não for definido, o tempo limite padrão será de 30 segundos para ferramentas SYNCHRONOUS e de 60 segundos para ferramentas ASYNCHRONOUS.

create_time

Timestamp

Apenas saída. Carimbo de data/hora de quando a ferramenta foi criada.

update_time

Timestamp

Apenas saída. Carimbo de data/hora de quando a ferramenta foi atualizada pela última vez.

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.

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 do comportamento da ferramenta no modo simulado.

read_only

bool

Apenas saída. Indica se a ferramenta é somente leitura. Se for verdadeiro, a ferramenta não poderá ser modificada pelo usuário.

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

connector_tool

ConnectorTool

Opcional. A ferramenta Integration Connectors.

data_store_tool

DataStoreTool

Opcional. A ferramenta do repositório de dados.

python_function

PythonFunction

Opcional. A ferramenta de função do 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.

agent_tool

AgentTool

Opcional. A ferramenta do agente.

widget_tool

WidgetTool

Opcional. A ferramenta de widget.

remote_agent_tool

RemoteAgentTool

Opcional. A ferramenta de agente remoto.

ToolCall

Solicitação para que o cliente ou o agente execute a ferramenta especificada.

Campos
id

string

Opcional. O identificador exclusivo da chamada de ferramenta. 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 de entrada e os valores da ferramenta no formato de objeto JSON.

parent_tool_call_id

string

Apenas saída. O ID da chamada de ferramenta que causou esta, quando foi emitida por um subagente trabalhando em nome de uma chamada pai. Vazio para chamadas de nível superior. Permite que um cliente agrupe o trabalho de um subagente na chamada que o iniciou, em vez de renderizar cada etapa como um irmão.

agent_name

string

Apenas saída. Nome legível por humanos do agente que emitiu essa chamada, por exemplo, "Arquiteto de contratos". Vazio quando o agente raiz o emitiu.

target_app

string

Apenas saída. O app que essa chamada segmenta, derivado pelo assistente dos argumentos de recurso da chamada: um nome de recurso de app, PROJECT para ferramentas com escopo de local ou vazio para ferramentas locais de sessão. Defina apenas em sessões do assistente com escopo de projeto.

Campo de união tool_identifier. O identificador da ferramenta a ser executada. 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 ferramenta a serem executadas.

ToolFakeConfig

Configuração do comportamento da ferramenta no modo simulado.

Campos
enable_fake_mode

bool

Opcional. Se a ferramenta está usando o modo falso.

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.

parent_tool_call_id

string

Apenas saída. O ID da chamada de ferramenta que causou esta, quando foi emitida por um subagente trabalhando em nome de uma chamada pai. Vazio para chamadas de nível superior. Permite que um cliente agrupe o trabalho de um subagente na chamada que o iniciou, em vez de renderizar cada etapa como um irmão.

agent_name

string

Apenas saída. Nome legível por humanos do agente que emitiu essa chamada, por exemplo, "Arquiteto de contratos". Vazio quando o agente raiz o emitiu.

target_app

string

Apenas saída. O app que a ferramenta executada segmentou; espelha ToolCall.target_app.

Campo de união tool_identifier. O identificador da ferramenta que foi executada. 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 que foi executada.

ToolResponses

Resultados da execução das chamadas de ferramenta solicitadas pelo 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.

timeout

Duration

Opcional. O tempo limite para a execução do conjunto de ferramentas. Se não for definido, o tempo limite padrão será de 30 segundos para conjuntos de ferramentas SYNCHRONOUS e de 60 segundos para conjuntos de ferramentas ASYNCHRONOUS.

create_time

Timestamp

Apenas saída. Carimbo de data/hora de quando o conjunto de ferramentas foi criado.

update_time

Timestamp

Apenas saída. Carimbo de data/hora de quando o conjunto de ferramentas foi atualizado pela última vez.

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.

tool_fake_config

ToolFakeConfig

Opcional. Configuração do 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 base em um conjunto de ferramentas.

Campos
toolset

string

Obrigatório. O nome do recurso do conjunto de ferramentas de onde essa ferramenta é derivada. 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 ao qual 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 o planejador de transferir 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 pai para o agente filho.
CHILD_TO_PARENT Transferência do agente filho para o agente pai.

DisablePlannerTransfer

Uma regra que impede o planejador de transferir 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 condição prévia é 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. Responda imediatamente com uma resposta pré-configurada.

transfer_agent

TriggerAction.TransferAgent

Opcional. Transferir a conversa para outro agente.

generative_answer

TriggerAction.GenerativeAnswer

Opcional. Responder 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 automáticas que o agente pode escolher. A resposta é escolhida aleatoriamente.

Resposta

Representa uma resposta do agente.

Campos
text

string

Obrigatório. Texto para o agente responder.

disabled

bool

Opcional. Indica 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}

TurnCompletedEvent

Evento terminal de uma rodada (consulte StreamChatAiAssistantResponse.turn_completed).

Campos
turn_id

string

Identificador da conversão que terminou. Corresponde a TurnResumeSnapshot.turn_id e ActiveTurnInfo.turn_id.

reason

TurnCompletedEvent.Reason

Por que a vez terminou.

final_sequence_number

int64

Número de sequência do último evento produzido pela vez. Um cliente com um cursor mais baixo perdeu conteúdo e precisa recarregar a sessão para vê-lo.

touched_apps[]

string

Apps que foram segmentados ou alterados nesta rodada, para que o console possa atualizar exatamente as lojas desses apps. Somente sessões com escopo de projeto. Formato: projects/{project}/locations/{location}/apps/{app}

Motivo

Por que a vez terminou, para que um cliente que se conectou tarde possa expressar o resultado em vez de adivinhar com base em um stream vazio.

Tipos enumerados
REASON_UNSPECIFIED Não especificado.
COMPLETED A rodada foi concluída. A sessão mantém a saída confirmada.
ABANDONED Nenhuma tarefa estava mais impulsionando a vez. Ela foi selada para uma parcial confirmada e não pode ser continuada.
RESUME_UNAVAILABLE Este servidor não oferece anexação ou retomada para a sessão, então nada foi rastreado. O cliente precisa recarregar a sessão.

TurnHandoffEvent

Emitido antes que essa tarefa pare de exibir o stream no meio da conversa (por exemplo, uma reinicialização do servidor). O estado do turno é mantido. Uma reconexão com resume_from_sequence_number continua em outra tarefa.

Campos
turn_id

string

Identifica a curva para retomar.

reason

TurnHandoffEvent.Reason

Por que a transmissão está sendo transferida.

Motivo

Por que a transmissão está sendo transferida.

Tipos enumerados
REASON_UNSPECIFIED Não especificado.
SERVER_RESTART A tarefa de exibição está sendo encerrada (push de lançamento ou reprogramação).

TurnMetadata

Metadados no nível da fala e categorização de intenção.

Campos
contract_finalized

bool

Definido no evento de artefato final de uma rodada em que o rascunho do contrato foi publicado (uma revisão foi ativada). Terminal para o fluxo de esclarecimento deste rascunho: contract_progress é autoritativo e completo.

contract_streaming_phase

TurnMetadata.ContractStreamingPhase

Definido apenas em estimativas de progresso em andamento emitidas enquanto uma barreira de artefato de contrato está sendo transmitida e no evento de início de turno de revisão. Não definido em payloads autoritativos.

contract_draft_complete

bool

Definido no evento terminal de um rascunho de contrato em que todos os marcadores de posição são resolvidos (contract_progress é 100%), independentemente de o rascunho ter sido publicado ou não. Os clientes concluem e dispensam a exibição do progresso do contrato. A publicação é informada separadamente por contract_finalized.

ContractStreamingPhase

Fase de streaming do payload de progresso do contrato.

Tipos enumerados
CONTRACT_STREAMING_PHASE_UNSPECIFIED O payload é oficial (calculado com base em um documento de contrato completo, um snapshot persistente ou o estado de pré-rascunho). Os clientes precisam substituir qualquer progresso recebido anteriormente por ele.
DRAFTING Um rascunho inicial do contrato está sendo transmitido. contract_progress é uma estimativa em andamento: não decrescente dentro de uma barreira de artefato, limitada abaixo do intervalo oficial, com pillar_breakdowns carregando total_item_count == 0 para marcar os estados estimados do pilar.
REVISING Uma revisão de um contrato atual está sendo transmitida (por exemplo, após o envio de uma anotação). Mesma semântica de estimativa que DRAFTING.

TurnResumeSnapshot

Uma repetição compactada de uma rodada em andamento: tudo o que é necessário para renderizar a saída visível da rodada até o momento, além da posição em que os eventos ao vivo continuam.

Campos
turn_id

string

Identifica a curva que está sendo anexada.

resolved_sequence_number

int64

A posição que esse snapshot representa. Os eventos ao vivo seguem com sequence_number estritamente maior que esse. Quando o progresso liberado é menor que o resume_from_sequence_number solicitado pelo cliente, ele fica atrás do que o cliente já renderizou: o cliente precisa descartar o conteúdo renderizado dessa vez além dessa posição antes de aplicar o snapshot.

events[]

StreamChatAiAssistantResponse

Eventos compactados que reconstroem a saída visível da rodada, em ordem de renderização, usando as mesmas formas de evento da transmissão ao vivo.

orphan_deadline_time

Timestamp

Quando a rodada será encerrada se nenhum cliente permanecer conectado.

TypedPayload

Payload com um tipo. Usado pelo histórico do assistente (AssistantChunk) e pelo evento de streaming typed_payload. Ele fica aqui porque tanto assistant_service.proto quanto session_service.proto precisam dele.

Campos
display_name

string

Obrigatório. O nome de exibição do payload.

type

string

Obrigatório. O tipo do payload.

value

Struct

Obrigatório. O valor do payload.

metadata

Struct

Opcional. Os metadados do payload.

UiEvent

Representa um payload de evento UI.

Campos
mime_type

string

O tipo de mídia (tipo MIME) que indica o formato do payload do evento UI (por exemplo, "application/json+a2ui").

json_payload

string

O payload JSON que representa a superfície da A2UI.

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.

UpdateAppVersionRequest

Mensagem de solicitação para AgentService.UpdateAppVersion.

Campos
app_version

AppVersion

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

update_mask

FieldMask

Opcional. Lista de campos a serem atualizados. Se estiverem vazios, os campos display_name e description 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.

UpdateEvaluationDatasetRequest

Mensagem de solicitação para EvaluationService.UpdateEvaluationDataset.

Campos
evaluation_dataset

EvaluationDataset

Obrigatório. O conjunto de dados de avaliação 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.

UpdateEvaluationExpectationRequest

Mensagem de solicitação para EvaluationService.UpdateEvaluationExpectation.

Campos
evaluation_expectation

EvaluationExpectation

Obrigatório. A expectativa de avaliaçã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.

UpdateEvaluationRequest

Mensagem de solicitação para EvaluationService.UpdateEvaluation.

Campos
evaluation

Evaluation

Obrigatório. A avaliaçã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.

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.

UpdateScheduledEvaluationRunRequest

Mensagem de solicitação para EvaluationService.UpdateScheduledEvaluationRun.

Campos
scheduled_evaluation_run

ScheduledEvaluationRun

Obrigatório. A execução de avaliação programada 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.

UpdateSecuritySettingsRequest

Mensagem de solicitação para AgentService.UpdateSecuritySettings.

Campos
security_settings

SecuritySettings

Obrigatório. As configurações de segurança a serem atualizadas.

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.

UploadEvaluationAudioRequest

Mensagem de solicitação para EvaluationService.UploadEvaluationAudio.

Campos
name

string

Obrigatório. O nome do recurso da avaliação para o qual o áudio será enviado. Formato: projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}

audio_content

bytes

Obrigatório. Os bytes de áudio brutos. O formato do áudio precisa ser LINEAR16 de canal único com uma taxa de amostragem de 16 kHz (InputAudioConfig padrão).

previous_audio_gcs_uri

string

Opcional. O URI do Google Cloud Storage do arquivo de áudio enviado anteriormente que será excluído. Formato: gs://<bucket-name>/<object-name>

UploadEvaluationAudioResponse

Mensagem de resposta para EvaluationService.UploadEvaluationAudio.

Campos
audio_gcs_uri

string

O URI do Google Cloud Storage em que o arquivo de áudio enviado está armazenado. Formato: gs://<bucket-name>/<object-name>

transcript

string

A transcrição do áudio, gerada pela Cloud Speech-to-Text.

duration

Duration

A duração do áudio.

UserResponseSuggestions

Respostas sugeridas do usuário pelo agente assistente.

Campos
suggestions[]

string

Obrigatório. As respostas do usuário sugeridas pelo assistente. São sugestões para o usuário sobre como interagir com o assistente.

VpcScSettings

Configurações do VPC-SC para o app.

Campos
allowed_origins[]

string

Opcional. As origens HTTP(S) permitidas que as ferramentas da OpenAPI no app podem chamar diretamente quando o VPC Service Controls está ativado. Essas strings precisam corresponder exatamente à origem, incluindo a porta, se especificada. Por exemplo, "https://example.com" ou "https://example.com:443". Essa lista ainda não se aplica a ferramentas do Python que podem fazer chamadas HTTP diretas.

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 do Google para a consulta.

WhatsAppCredentials

Credenciais temporárias da Meta para integração nativa com o WhatsApp.

Campos
auth_code

string

Obrigatório. O código de autenticação da Meta fornecido pelo fluxo de inscrição incorporado.

pin

string

Obrigatório. O PIN de seis dígitos criado pelo usuário para a verificação em duas etapas.

phone_number

string

Obrigatório. O número de telefone para registrar no WhatsApp.

business_account_id

string

Obrigatório. O ID da conta empresarial que será usado para o número de telefone.

waba_id

string

Obrigatório. O ID da conta do WhatsApp Business.

conversation_profile_id

string

Opcional. O ID do perfil de conversa a ser usado na implantação.

WidgetTool

Representa uma ferramenta de widget que o agente pode invocar. Quando a ferramenta é escolhida pelo agente, ele retorna o widget para o 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.

ui_config

Struct

Opcional. Configuração para renderizar o widget.

data_mapping

WidgetTool.DataMapping

Opcional. O mapeamento que define como os dados de uma ferramenta de origem são mapeados para os parâmetros de entrada do widget.

text_response_config

WidgetTool.TextResponseConfig

Opcional. Configuração para respostas de texto sempre incluídas.

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.

DataMapping

Configuração para mapear dados de uma ferramenta de origem para os parâmetros de entrada do widget.

Campos
source_tool_name

string

Opcional. O nome do recurso da ferramenta que fornece os dados para o widget (por exemplo, uma ferramenta de pesquisa ou uma função personalizada). Formato: projects/{project}/locations/{location}/agents/{agent}/tools/{tool}

field_mappings

map<string, string>

Opcional. Um mapa de campos de parâmetros de entrada do widget para os campos de saída correspondentes da ferramenta de origem.

python_function

PythonFunction

Opcional. Configuração de uma função Python usada para transformar a saída da ferramenta de origem no formato de entrada do widget.

mode

WidgetTool.DataMapping.Mode

Opcional. O modo do mapeamento de dados.

python_script
(deprecated)

string

Descontinuado: use python_function.

Modo

A estratégia usada para mapear dados da ferramenta de origem para o widget.

Tipos enumerados
MODE_UNSPECIFIED Modo não especificado.
FIELD_MAPPING Use o mapa field_mappings para transformação de dados.
PYTHON_SCRIPT Use o python_script para transformação de dados.

TextResponseConfig

Configuração da resposta de texto retornada com o widget.

Campos
type

WidgetTool.TextResponseConfig.Type

Opcional. A estratégia para fornecer a resposta em texto.

static_text

string

Opcional. A resposta de texto estático a ser retornada quando o tipo é STATIC.

text_response_instruction

string

Opcional. Instrução para o LLM sobre como gerar a resposta de texto. Usado como a descrição do parâmetro de resposta de texto se o tipo for LLM_GENERATED.

Tipo

Define como a resposta de texto é produzida.

Tipos enumerados
TYPE_UNSPECIFIED Tipo não especificado.
NONE O LLM decide dinamicamente se vai gerar uma resposta de texto junto com o widget com base no contexto da conversa.
LLM_GENERATED O LLM é explicitamente solicitado a gerar uma resposta de texto.
STATIC Uma resposta de texto estática predefinida é sempre usada.

WidgetType

Todos os tipos de widget disponíveis. Novos valores podem ser adicionados a esse tipo enumerado 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 do produto avançados.
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 agendamento.
APPOINTMENT_SCHEDULER Widget de agendamento de horários.
CONTACT_FORM Widget de formulário de contato.