Gemini Enterprise for Customer Experience API

Serviço: ces.googleapis.com

Para chamar esse serviço, recomendamos que você use as bibliotecas de cliente fornecidas pelo Google. Caso o aplicativo precise usar bibliotecas próprias para chamar esse serviço, use as informações a seguir quando fizer as solicitações da API.

Documento de descoberta

Um Documento de descoberta é uma especificação legível por máquina para descrever e consumir APIs REST. Ele é usado para criar bibliotecas de cliente, plug-ins IDE e outras ferramentas que interagem com as APIs do Google. Um serviço pode fornecer vários documentos de descoberta. O serviço fornece o seguinte documento de descoberta:

Endpoint de serviço

Um endpoint de serviço é um URL de base que especifica o endereço de rede de um serviço de API. Um serviço pode ter vários endpoints. Este serviço tem o endpoint a seguir e todos os URIs abaixo são relativos a ele:

  • https://ces.googleapis.com

Recurso REST: v1beta1.projects.locations

Métodos
get GET /v1beta/{name=projects/*/locations/*}
Extrai informações sobre um local.
getSecuritySettings GET /v1beta/{name=projects/*/locations/*/securitySettings}
Recupera as configurações de segurança do projeto e do local.
list GET /v1beta/{name=projects/*}/locations
Lista informações sobre os locais compatíveis com este serviço.
updateSecuritySettings PATCH /v1beta/{securitySettings.name=projects/*/locations/*/securitySettings}
Atualiza as configurações de segurança do projeto e do local.

Recurso REST: v1beta.projects.locations.apps

Métodos
create POST /v1beta/{parent=projects/*/locations/*}/apps
Cria um novo app no projeto e local especificados.
delete DELETE /v1beta/{name=projects/*/locations/*/apps/*}
Exclui o app especificado.
executeTool POST /v1beta/{parent=projects/*/locations/*/apps/*}:executeTool
Executa a ferramenta especificada com os argumentos fornecidos.
exportApp POST /v1beta/{name=projects/*/locations/*/apps/*}:exportApp
Exporta o app especificado.
generateAppResource POST /v1beta/{parent=projects/*/locations/*/apps/*}:generateAppResource
Gera recursos específicos (por exemplo,
get GET /v1beta/{name=projects/*/locations/*/apps/*}
Recebe os detalhes do app especificado.
getExtendedAgentCard GET /v1beta/{tenant=projects/*/locations/*/apps/*}/extendedAgentCard
Recebe o card do agente estendido para o agente autenticado.
importApp POST /v1beta/{parent=projects/*/locations/*}/apps:importApp
Importa o app especificado.
importEvaluations POST /v1beta/{parent=projects/*/locations/*/apps/*}:importEvaluations
Importa avaliações para o app.
list GET /v1beta/{parent=projects/*/locations/*}/apps
Lista os apps no projeto e local especificados.
patch PATCH /v1beta/{app.name=projects/*/locations/*/apps/*}
Atualiza o app especificado.
retrieveToolSchema POST /v1beta/{parent=projects/*/locations/*/apps/*}:retrieveToolSchema
Recupera o esquema da ferramenta especificada.
runEvaluation POST /v1beta/{app=projects/*/locations/*/apps/*}:runEvaluation
Executa uma avaliação do app.
testPersonaVoice POST /v1beta/{app=projects/*/locations/*/apps/*}:testPersonaVoice
Testa a voz de uma persona.

Recurso REST: v1beta.projects.locations.apps.agents

Métodos
create POST /v1beta/{parent=projects/*/locations/*/apps/*}/agents
Cria um novo agente no app especificado.
delete DELETE /v1beta/{name=projects/*/locations/*/apps/*/agents/*}
Exclui o agente especificado.
get GET /v1beta/{name=projects/*/locations/*/apps/*/agents/*}
Recebe detalhes do agente especificado.
list GET /v1beta/{parent=projects/*/locations/*/apps/*}/agents
Lista os agentes no app especificado.
patch PATCH /v1beta/{agent.name=projects/*/locations/*/apps/*/agents/*}
Atualiza o agente especificado.

Recurso REST: v1beta.projects.locations.apps.changelogs

Métodos
get GET /v1beta/{name=projects/*/locations/*/apps/*/changelogs/*}
Recebe o changelog especificado.
list GET /v1beta/{parent=projects/*/locations/*/apps/*}/changelogs
Lista os registros de mudanças do app especificado.

Recurso REST: v1beta.projects.locations.apps.conversations

Métodos
batchDelete POST /v1beta/{parent=projects/*/locations/*/apps/*}/conversations:batchDelete
Exclui em lote as conversas especificadas.
delete DELETE /v1beta/{name=projects/*/locations/*/apps/*/conversations/*}
Exclui a conversa especificada.
generateEvaluation POST /v1beta/{conversation=projects/*/locations/*/apps/*/conversations/*}:generateEvaluation
Cria uma avaliação de ouro com base em uma conversa.
get GET /v1beta/{name=projects/*/locations/*/apps/*/conversations/*}
Recebe detalhes da conversa especificada.
list GET /v1beta/{parent=projects/*/locations/*/apps/*}/conversations
Lista as conversas no app especificado.

Recurso REST: v1beta.projects.locations.apps.deployments

Métodos
create POST /v1beta/{parent=projects/*/locations/*/apps/*}/deployments
Cria uma nova implantação no app especificado.
delete DELETE /v1beta/{name=projects/*/locations/*/apps/*/deployments/*}
Exclui a implantação especificada.
get GET /v1beta/{name=projects/*/locations/*/apps/*/deployments/*}
Recebe detalhes da implantação especificada.
getExtendedAgentCard GET /v1beta/{tenant=projects/*/locations/*/apps/*/deployments/*}/extendedAgentCard
Recebe o card do agente estendido para o agente autenticado.
list GET /v1beta/{parent=projects/*/locations/*/apps/*}/deployments
Lista as implantações no app especificado.
patch PATCH /v1beta/{deployment.name=projects/*/locations/*/apps/*/deployments/*}
Atualiza a implantação especificada.

Recurso REST: v1beta.projects.locations.apps.deployments.message

Métodos
send POST /v1beta/{tenant=projects/*/locations/*/apps/*/deployments/*}/message:send
Envia uma mensagem para um agente.
stream POST /v1beta/{tenant=projects/*/locations/*/apps/*/deployments/*}/message:stream
Envia uma mensagem de streaming para um agente, permitindo interação em tempo real e atualizações de status.

Recurso REST: v1beta.projects.locations.apps.evaluationDatasets

Métodos
create POST /v1beta/{parent=projects/*/locations/*/apps/*}/evaluationDatasets
Cria um conjunto de dados de avaliação.
delete DELETE /v1beta/{name=projects/*/locations/*/apps/*/evaluationDatasets/*}
Exclui um conjunto de dados de avaliação.
get GET /v1beta/{name=projects/*/locations/*/apps/*/evaluationDatasets/*}
Recebe detalhes do conjunto de dados de avaliação especificado.
list GET /v1beta/{parent=projects/*/locations/*/apps/*}/evaluationDatasets
Lista todos os conjuntos de dados de avaliação no app especificado.
patch PATCH /v1beta/{evaluationDataset.name=projects/*/locations/*/apps/*/evaluationDatasets/*}
Atualiza um conjunto de dados de avaliação.

Recurso REST: v1beta.projects.locations.apps.evaluationExpectations

Métodos
create POST /v1beta/{parent=projects/*/locations/*/apps/*}/evaluationExpectations
Cria uma expectativa de avaliação.
delete DELETE /v1beta/{name=projects/*/locations/*/apps/*/evaluationExpectations/*}
Exclui uma expectativa de avaliação.
get GET /v1beta/{name=projects/*/locations/*/apps/*/evaluationExpectations/*}
Recebe detalhes da expectativa de avaliação especificada.
list GET /v1beta/{parent=projects/*/locations/*/apps/*}/evaluationExpectations
Lista todas as expectativas de avaliação no app especificado.
patch PATCH /v1beta/{evaluationExpectation.name=projects/*/locations/*/apps/*/evaluationExpectations/*}
Atualiza uma expectativa de avaliação.

Recurso REST: v1beta.projects.locations.apps.evaluationRuns

Métodos
delete DELETE /v1beta/{name=projects/*/locations/*/apps/*/evaluationRuns/*}
Exclui uma execução de avaliação.
export POST /v1beta/{parent=projects/*/locations/*/apps/*}/evaluationRuns:export
Exporta execuções de avaliações.
get GET /v1beta/{name=projects/*/locations/*/apps/*/evaluationRuns/*}
Recebe detalhes da execução de avaliação especificada.
list GET /v1beta/{parent=projects/*/locations/*/apps/*}/evaluationRuns
Lista todas as execuções de avaliação no app especificado.

Recurso REST: v1beta.projects.locations.apps.evaluations

Métodos
create POST /v1beta/{parent=projects/*/locations/*/apps/*}/evaluations
Cria uma avaliação.
delete DELETE /v1beta/{name=projects/*/locations/*/apps/*/evaluations/*}
Exclui uma avaliação.
export POST /v1beta/{parent=projects/*/locations/*/apps/*}/evaluations:export
Exporta avaliações.
get GET /v1beta/{name=projects/*/locations/*/apps/*/evaluations/*}
Recebe detalhes da avaliação especificada.
list GET /v1beta/{parent=projects/*/locations/*/apps/*}/evaluations
Lista todas as avaliações no app especificado.
patch PATCH /v1beta/{evaluation.name=projects/*/locations/*/apps/*/evaluations/*}
Atualiza uma avaliação.
uploadEvaluationAudio POST /v1beta/{name=projects/*/locations/*/apps/*/evaluations/*}:uploadEvaluationAudio
Envia áudio para uso em avaliações de referência.

Recurso REST: v1beta.projects.locations.apps.evaluations.results

Métodos
delete DELETE /v1beta/{name=projects/*/locations/*/apps/*/evaluations/*/results/*}
Exclui um resultado de avaliação.
export POST /v1beta/{parent=projects/*/locations/*/apps/*/evaluations/*}/results:export
Exporta os resultados das avaliações.
get GET /v1beta/{name=projects/*/locations/*/apps/*/evaluations/*/results/*}
Recebe detalhes do resultado da avaliação especificada.
list GET /v1beta/{parent=projects/*/locations/*/apps/*/evaluations/*}/results
Lista todos os resultados de uma determinada avaliação.
runEvaluationResultMetrics POST /v1beta/{evaluationResultId=projects/*/locations/*/apps/*/evaluations/*/results/*}:runEvaluationResultMetrics
Executa métricas em um resultado de avaliação.

Recurso REST: v1beta.projects.locations.apps.examples

Métodos
create POST /v1beta/{parent=projects/*/locations/*/apps/*}/examples
Cria um novo exemplo no app especificado.
delete DELETE /v1beta/{name=projects/*/locations/*/apps/*/examples/*}
Exclui o exemplo especificado.
get GET /v1beta/{name=projects/*/locations/*/apps/*/examples/*}
Recebe detalhes do exemplo especificado.
list GET /v1beta/{parent=projects/*/locations/*/apps/*}/examples
Lista exemplos no app especificado.
patch PATCH /v1beta/{example.name=projects/*/locations/*/apps/*/examples/*}
Atualiza o exemplo especificado.

Recurso REST: v1beta.projects.locations.apps.guardrails

Métodos
create POST /v1beta/{parent=projects/*/locations/*/apps/*}/guardrails
Cria uma nova proteção no app especificado.
delete DELETE /v1beta/{name=projects/*/locations/*/apps/*/guardrails/*}
Exclui a proteção especificada.
get GET /v1beta/{name=projects/*/locations/*/apps/*/guardrails/*}
Recebe detalhes da proteção especificada.
list GET /v1beta/{parent=projects/*/locations/*/apps/*}/guardrails
Lista os guardrails no app especificado.
patch PATCH /v1beta/{guardrail.name=projects/*/locations/*/apps/*/guardrails/*}
Atualiza o guardrail especificado.

Recurso REST: v1beta.projects.locations.apps.message

Métodos
send POST /v1beta/{tenant=projects/*/locations/*/apps/*}/message:send
Envia uma mensagem para um agente.
stream POST /v1beta/{tenant=projects/*/locations/*/apps/*}/message:stream
Envia uma mensagem de streaming para um agente, permitindo interação em tempo real e atualizações de status.

Recurso REST: v1beta.projects.locations.apps.scheduledEvaluationRuns

Métodos
create POST /v1beta/{parent=projects/*/locations/*/apps/*}/scheduledEvaluationRuns
Cria uma execução de avaliação programada.
delete DELETE /v1beta/{name=projects/*/locations/*/apps/*/scheduledEvaluationRuns/*}
Exclui uma execução de avaliação programada.
get GET /v1beta/{name=projects/*/locations/*/apps/*/scheduledEvaluationRuns/*}
Recebe detalhes da execução de avaliação programada especificada.
list GET /v1beta/{parent=projects/*/locations/*/apps/*}/scheduledEvaluationRuns
Lista todas as execuções de avaliação programadas no app especificado.
patch PATCH /v1beta/{scheduledEvaluationRun.name=projects/*/locations/*/apps/*/scheduledEvaluationRuns/*}
Atualiza uma execução de avaliação programada.

Recurso REST: v1beta.projects.locations.apps.sessions

Métodos
generateChatToken POST /v1beta/{name=projects/*/locations/*/apps/*/sessions/*}:generateChatToken
Gera um token no escopo da sessão para o widget de chat se autenticar com as APIs Session.
runSession POST /v1beta/{config.session=projects/*/locations/*/apps/*/sessions/*}:runSession
Inicia uma interação de turno único com o agente do CES em uma sessão.
streamRunSession POST /v1beta/{config.session=projects/*/locations/*/apps/*/sessions/*}:streamRunSession
Inicia uma interação de turno único com o agente do CES.

Recurso REST: v1beta.projects.locations.apps.tools

Métodos
create POST /v1beta/{parent=projects/*/locations/*/apps/*}/tools
Cria uma nova ferramenta no app especificado.
delete DELETE /v1beta/{name=projects/*/locations/*/apps/*/tools/*}
Exclui a ferramenta especificada.
get GET /v1beta/{name=projects/*/locations/*/apps/*/tools/*}
Recebe detalhes da ferramenta especificada.
list GET /v1beta/{parent=projects/*/locations/*/apps/*}/tools
Lista as ferramentas no app especificado.
patch PATCH /v1beta/{tool.name=projects/*/locations/*/apps/*/tools/*}
Atualiza a ferramenta especificada.

Recurso REST: v1beta.projects.locations.apps.toolsets

Métodos
create POST /v1beta/{parent=projects/*/locations/*/apps/*}/toolsets
Cria um novo conjunto de ferramentas no app especificado.
delete DELETE /v1beta/{name=projects/*/locations/*/apps/*/toolsets/*}
Exclui o conjunto de ferramentas especificado.
get GET /v1beta/{name=projects/*/locations/*/apps/*/toolsets/*}
Recebe detalhes do conjunto de ferramentas especificado.
list GET /v1beta/{parent=projects/*/locations/*/apps/*}/toolsets
Lista os conjuntos de ferramentas no app especificado.
patch PATCH /v1beta/{toolset.name=projects/*/locations/*/apps/*/toolsets/*}
Atualiza o conjunto de ferramentas especificado.
retrieveTools POST /v1beta/{toolset=projects/*/locations/*/apps/*/toolsets/*}:retrieveTools
Recupera a lista de ferramentas incluídas no conjunto especificado.

Recurso REST: v1beta.projects.locations.apps.versions

Métodos
create POST /v1beta/{parent=projects/*/locations/*/apps/*}/versions
Cria uma versão do app especificado.
delete DELETE /v1beta/{name=projects/*/locations/*/apps/*/versions/*}
Exclui a versão do app especificada.
get GET /v1beta/{name=projects/*/locations/*/apps/*/versions/*}
Recebe detalhes da versão especificada do app.
getExtendedAgentCard GET /v1beta/{tenant=projects/*/locations/*/apps/*/versions/*}/extendedAgentCard
Recebe o card do agente estendido para o agente autenticado.
list GET /v1beta/{parent=projects/*/locations/*/apps/*}/versions
Lista todas as versões do app especificado.
patch PATCH /v1beta/{appVersion.name=projects/*/locations/*/apps/*/versions/*}
Atualiza a versão especificada do app.
restore POST /v1beta/{name=projects/*/locations/*/apps/*/versions/*}:restore
Restaura a versão especificada do app.

Recurso REST: v1beta.projects.locations.apps.versions.message

Métodos
send POST /v1beta/{tenant=projects/*/locations/*/apps/*/versions/*}/message:send
Envia uma mensagem para um agente.
stream POST /v1beta/{tenant=projects/*/locations/*/apps/*/versions/*}/message:stream
Envia uma mensagem de streaming para um agente, permitindo interação em tempo real e atualizações de status.

Recurso REST: v1beta.projects.locations.operations

Métodos
cancel POST /v1beta/{name=projects/*/locations/*/operations/*}:cancel
Inicia o cancelamento assíncrono em uma operação de longa duração.
delete DELETE /v1beta/{name=projects/*/locations/*/operations/*}
Exclui uma operação de longa duração.
get GET /v1beta/{name=projects/*/locations/*/operations/*}
Recebe o estado mais recente de uma operação de longa duração.
list GET /v1beta/{name=projects/*/locations/*}/operations
Lista as operações correspondentes ao filtro especificado na solicitação.