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

Métodos
cancel POST /tasks/{id}:cancel
Cancela uma tarefa em andamento.
get GET /tasks/{id}
Recebe o estado mais recente de uma tarefa.
list GET /tasks
Lista as tarefas que correspondem ao filtro especificado.
subscribe GET /tasks/{id}:subscribe
Inscreve-se para receber atualizações de tarefas que não estão em um estado terminal.

Recurso REST: tasks.pushNotificationConfigs

Métodos
create POST /tasks/{taskId}/pushNotificationConfigs
Cria uma configuração de notificação push para uma tarefa.
delete DELETE /tasks/{taskId}/pushNotificationConfigs/{id}
Exclui uma configuração de notificação push para uma tarefa.
get GET /tasks/{taskId}/pushNotificationConfigs/{id}
Recebe uma configuração de notificação push para uma tarefa.
list GET /tasks/{taskId}/pushNotificationConfigs
Recebe uma lista de notificações push configuradas para uma tarefa.

Recurso REST: v1.projects.locations

Métodos
get GET /v1/{name=projects/*/locations/*}
Extrai informações sobre um local.
list GET /v1/{name=projects/*}/locations
Lista informações sobre os locais compatíveis com este serviço.

Recurso REST: v1.projects.locations.apps

Métodos
create POST /v1/{parent=projects/*/locations/*}/apps
Cria um novo app no projeto e local especificados.
delete DELETE /v1/{name=projects/*/locations/*/apps/*}
Exclui o app especificado.
executeTool POST /v1/{parent=projects/*/locations/*/apps/*}:executeTool
Executa a ferramenta especificada com os argumentos fornecidos.
exportApp POST /v1/{name=projects/*/locations/*/apps/*}:exportApp
Exporta o app especificado.
get GET /v1/{name=projects/*/locations/*/apps/*}
Recebe os detalhes do app especificado.
getExtendedAgentCard GET /v1/{tenant=projects/*/locations/*/apps/*}/extendedAgentCard
Recebe o card do agente estendido para o agente autenticado.
importApp POST /v1/{parent=projects/*/locations/*}/apps:importApp
Importa o app especificado.
list GET /v1/{parent=projects/*/locations/*}/apps
Lista os apps no projeto e local especificados.
patch PATCH /v1/{app.name=projects/*/locations/*/apps/*}
Atualiza o app especificado.
retrieveToolSchema POST /v1/{parent=projects/*/locations/*/apps/*}:retrieveToolSchema
Recupera o esquema da ferramenta especificada.

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

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

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

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

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

Métodos
batchDelete POST /v1/{parent=projects/*/locations/*/apps/*}/conversations:batchDelete
Exclui em lote as conversas especificadas.
delete DELETE /v1/{name=projects/*/locations/*/apps/*/conversations/*}
Exclui a conversa especificada.
get GET /v1/{name=projects/*/locations/*/apps/*/conversations/*}
Recebe detalhes da conversa especificada.
list GET /v1/{parent=projects/*/locations/*/apps/*}/conversations
Lista as conversas no app especificado.

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

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

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

Métodos
send POST /v1/{tenant=projects/*/locations/*/apps/*/deployments/*}/message:send
Envia uma mensagem para um agente.
stream POST /v1/{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: v1.projects.locations.apps.examples

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

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

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

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

Métodos
send POST /v1/{tenant=projects/*/locations/*/apps/*}/message:send
Envia uma mensagem para um agente.
stream POST /v1/{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: v1.projects.locations.apps.sessions

Métodos
generateChatToken POST /v1/{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 /v1/{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 /v1/{config.session=projects/*/locations/*/apps/*/sessions/*}:streamRunSession
Inicia uma interação de turno único com o agente do CES.

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

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

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

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

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

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

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

Métodos
send POST /v1/{tenant=projects/*/locations/*/apps/*/versions/*}/message:send
Envia uma mensagem para um agente.
stream POST /v1/{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 da REST: v1.projects.locations.operations

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