Data Analytics API with Gemini

A API Data Analytics com o Gemini (geminidataanalytics.googleapis.com) oferece métodos para consultar e analisar dados usando linguagem natural, além de criar e gerenciar os agentes de dados que interagem com seus dados em fontes de dados compatíveis.

Esse serviço está em pré-lançamento e sujeito aos Termos de ofertas pré-GA. Os desenvolvedores precisam selecionar o caminho de endpoint adequado com base nos requisitos de estabilidade:

  • v1:recomendada para recursos com disponibilidade geral que podem ser integrados a ambientes de produção.
  • v1beta:recomendado para integração em ambientes de produção durante o período de prévia.
  • v1alpha:destinada a testar recursos de acesso antecipado. Esses recursos podem mudar ou ser removidos, exigindo atualizações no seu código.

Saiba mais sobre os estágios de lançamento de produtos do Google Cloud.

Para guias de implementação detalhados, consulte a visão geral da API Conversational Analytics.

Serviço: geminidataanalytics.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. Este serviço apresenta os documentos de descoberta abaixo:

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://geminidataanalytics.googleapis.com

Recurso REST: v1beta.a2a.projects.locations.dataAgents.v1

Métodos
getCard GET /v1beta/a2a/{tenant=projects/*/locations/*/dataAgents/*}/v1/card
GetAgentCard retorna o card do agente.

Recurso REST: v1beta.a2a.projects.locations.dataAgents.v1.message

Métodos
send POST /v1beta/a2a/{tenant=projects/*/locations/*/dataAgents/*}/v1/message:send
Envie uma mensagem para o agente.
stream POST /v1beta/a2a/{tenant=projects/*/locations/*/dataAgents/*}/v1/message:stream
SendStreamingMessage é uma chamada de streaming que retorna um fluxo de eventos de atualização de tarefas até que a tarefa esteja em um estado interrompido ou terminal.

Recurso REST: v1beta1.projects.locations

Métodos
chat POST /v1beta/{parent=projects/*/locations/*}:chat
Responde a uma pergunta sobre dados gerando um fluxo de objetos Message.
get GET /v1beta/{name=projects/*/locations/*}
Extrai informações sobre um local.
list GET /v1beta/{name=projects/*}/locations
Lista informações sobre os locais compatíveis com este serviço.
queryData POST /v1beta/{parent=projects/*/locations/*}:queryData
Consulta dados de uma consulta do usuário em linguagem natural.

Recurso REST: v1beta.projects.locations.conversations

Métodos
create POST /v1beta/{parent=projects/*/locations/*}/conversations
Cria uma conversa para manter o histórico.
delete DELETE /v1beta/{name=projects/*/locations/*/conversations/*}
Exclui uma conversa.
get GET /v1beta/{name=projects/*/locations/*/conversations/*}
Busca os detalhes de uma única conversa usando o ID da conversa e o pai.
list GET /v1beta/{parent=projects/*/locations/*}/conversations
Lista todas as conversas de um determinado recurso pai.

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

Métodos
list GET /v1beta/{parent=projects/*/locations/*/conversations/*}/messages
Lista todas as mensagens de uma determinada conversa.

Recurso REST: v1beta.projects.locations.dataAgents

Métodos
create POST /v1beta/{parent=projects/*/locations/*}/dataAgents
Cria um DataAgent em determinado projeto e local.
createSync POST /v1beta/{parent=projects/*/locations/*}/dataAgents:createSync
Cria um DataAgent em determinado projeto e local de forma síncrona.
delete DELETE /v1beta/{name=projects/*/locations/*/dataAgents/*}
Exclui um único DataAgent.
deleteSync DELETE /v1beta/{name=projects/*/locations/*/dataAgents/*}:deleteSync
Exclui um único DataAgent de forma síncrona.
get GET /v1beta/{name=projects/*/locations/*/dataAgents/*}
Recupera os detalhes de um único DataAgent.
getIamPolicy POST /v1beta/{resource=projects/*/locations/*/dataAgents/*}:getIamPolicy
Recupera a política do IAM do DataAgent.
list GET /v1beta/{parent=projects/*/locations/*}/dataAgents
Lista os DataAgents em determinado projeto e local.
listAccessible GET /v1beta/{parent=projects/*/locations/*}/dataAgents:listAccessible
Lista os DataAgents acessíveis ao autor da chamada em determinado projeto e local.
patch PATCH /v1beta/{dataAgent.name=projects/*/locations/*/dataAgents/*}
Atualiza os parâmetros de um único DataAgent.
setIamPolicy POST /v1beta/{resource=projects/*/locations/*/dataAgents/*}:setIamPolicy
Define a política do IAM de um DataAgent.
updateSync PATCH /v1beta/{dataAgent.name=projects/*/locations/*/dataAgents/*}:updateSync
Atualiza os parâmetros de um único DataAgent de forma síncrona.

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.

Recurso REST: v1alpha.projects.locations

Métodos
chat POST /v1alpha/{parent=projects/*/locations/*}:chat
Responde a uma pergunta sobre dados gerando um fluxo de objetos Message.
get GET /v1alpha/{name=projects/*/locations/*}
Extrai informações sobre um local.
list GET /v1alpha/{name=projects/*}/locations
Lista informações sobre os locais compatíveis com este serviço.
queryData POST /v1alpha/{parent=projects/*/locations/*}:queryData
Consulta dados de uma consulta do usuário em linguagem natural.

Recurso REST: v1alpha.projects.locations.conversations

Métodos
create POST /v1alpha/{parent=projects/*/locations/*}/conversations
Cria uma conversa para manter o histórico.
delete DELETE /v1alpha/{name=projects/*/locations/*/conversations/*}
Exclui uma conversa.
get GET /v1alpha/{name=projects/*/locations/*/conversations/*}
Busca os detalhes de uma única conversa usando o ID da conversa e o pai.
list GET /v1alpha/{parent=projects/*/locations/*}/conversations
Lista todas as conversas de um determinado recurso pai.

Recurso REST: v1alpha.projects.locations.conversations.messages

Métodos
list GET /v1alpha/{parent=projects/*/locations/*/conversations/*}/messages
Lista todas as mensagens de uma determinada conversa.

Recurso REST: v1alpha.projects.locations.dataAgents

Métodos
create POST /v1alpha/{parent=projects/*/locations/*}/dataAgents
Cria um DataAgent em determinado projeto e local.
createSync POST /v1alpha/{parent=projects/*/locations/*}/dataAgents:createSync
Cria um DataAgent em determinado projeto e local de forma síncrona.
delete DELETE /v1alpha/{name=projects/*/locations/*/dataAgents/*}
Exclui um único DataAgent.
deleteSync DELETE /v1alpha/{name=projects/*/locations/*/dataAgents/*}:deleteSync
Exclui um único DataAgent de forma síncrona.
get GET /v1alpha/{name=projects/*/locations/*/dataAgents/*}
Recupera os detalhes de um único DataAgent.
getIamPolicy POST /v1alpha/{resource=projects/*/locations/*/dataAgents/*}:getIamPolicy
Recupera a política do IAM do DataAgent.
list GET /v1alpha/{parent=projects/*/locations/*}/dataAgents
Lista os DataAgents em determinado projeto e local.
listAccessible GET /v1alpha/{parent=projects/*/locations/*}/dataAgents:listAccessible
Lista os DataAgents acessíveis ao autor da chamada em determinado projeto e local.
patch PATCH /v1alpha/{dataAgent.name=projects/*/locations/*/dataAgents/*}
Atualiza os parâmetros de um único DataAgent.
setIamPolicy POST /v1alpha/{resource=projects/*/locations/*/dataAgents/*}:setIamPolicy
Define a política do IAM de um DataAgent.
updateSync PATCH /v1alpha/{dataAgent.name=projects/*/locations/*/dataAgents/*}:updateSync
Atualiza os parâmetros de um único DataAgent de forma síncrona.

Recurso REST: v1alpha.projects.locations.operations

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

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

Métodos
getCard GET /v1/a2a/{tenant=projects/*/locations/*/agents/*}/v1/card
GetAgentCard retorna o card do agente.

Recurso REST: v1.a2a.projects.locations.agents.v1.message

Métodos
send POST /v1/a2a/{tenant=projects/*/locations/*/agents/*}/v1/message:send
Envie uma mensagem para o agente.
stream POST /v1/a2a/{tenant=projects/*/locations/*/agents/*}/v1/message:stream
SendStreamingMessage é uma chamada de streaming que retorna um fluxo de eventos de atualização de tarefas até que a tarefa esteja em um estado interrompido ou terminal.