Registrar e gerenciar agentes do Dialogflow

Nesta página, descrevemos como registrar e usar agentes do Dialogflow com o Gemini Enterprise.

Visão geral

Para usar um agente do Dialogflow com o Gemini Enterprise, primeiro é necessário implantar e registrar o agente. Ao registrar seu agente do Dialogflow, você vincula o agente implantado ao Gemini Enterprise para que eles possam se comunicar.

Antes de começar

Antes de registrar seu agente do Dialogflow, verifique se estas etapas foram concluídas:

Registrar um agente do Dialogflow com o Gemini Enterprise

É possível registrar seu agente do Dialogflow com o Gemini Enterprise usando o consoleGoogle Cloud ou a API REST. O registro disponibiliza seu agente para usuários em um app do Gemini Enterprise.

Console

Para registrar um agente do Dialogflow usando o console Google Cloud , siga estas etapas:

  1. No console Google Cloud , acesse a página Gemini Enterprise.

    Acesse Gemini Enterprise

  2. Selecione o projeto.

  3. Clique no nome do app em que você quer registrar o agente.

  4. Clique em Agentes > Adicionar agentes. O painel Escolha um tipo de agente aparece.

  5. No card Agente personalizado via Dialogflow, clique em Adicionar para registrar seu agente do Dialogflow no Gemini Enterprise. O painel Configuração é aberto.

  6. Para configurar o agente, siga estas etapas:

    1. Digite um nome no campo Nome do seu agente. Esse valor aparece no Gemini Enterprise como o nome de exibição do seu agente.

    2. Insira uma descrição no campo Descreva seu agente. Esse valor é usado por um LLM para determinar se o agente deve ser invocado em resposta a uma consulta do usuário.

    3. Insira o caminho do recurso do agente do Dialogflow que você quer registrar no Gemini Enterprise no campo Origem do agente do Dialogflow.

      Use este formato: projects/{project}/locations/{location}/agents/{agent}

      A opção Disponibilidade do agente, Quando selecionada, é definida por padrão.

    4. Na seção Configurações da ferramenta, insira uma descrição no campo Descrição da ferramenta. Essa descrição é usada pelo LLM para entender o objetivo da ferramenta e decidir quando usá-la.

    5. Insira o nome no campo Nome do parâmetro de entrada. Esse é o nome do parâmetro para a chamada de função. O nome do parâmetro dá uma dica ao LLM sobre o tipo de conteúdo que o parâmetro deve conter, como um question, um command ou um search_query.

    6. Insira a descrição no campo Descrição do parâmetro de entrada. Esta é uma descrição do parâmetro para a chamada de função. Essa descrição dá ao LLM mais informações sobre o parâmetro, como que tipo de conteúdo é esperado e quais ações devem ser realizadas.

    7. Clique em Criar.

curl

Este exemplo de código demonstra como registrar seu agente:

  curl -X POST \
    -H "Authorization: Bearer $(gcloud auth print-access-token)" \
    -H "Content-Type: application/json" \
    -H "X-Goog-User-Project: PROJECT_ID" \
    "https://discoveryengine.googleapis.com/v1alpha/projects/PROJECT_ID/locations/global/collections/default_collection/engines/APP_ID/assistants/default_assistant/agents" \
    -d '{
      "displayName": "DISPLAY_NAME",
      "description": "DESCRIPTION",
      "icon": {
        "uri": "ICON_URI"
      },
      "dialogflowAgentDefinition": {
        "dialogflowAgent": "projects/DIALOGFLOW_PROJECT_ID/locations/DIALOGFLOW_LOCATION/agents/DIALOGFLOW_AGENT_ID"
      }
    }'

Substitua as variáveis por valores:

  • PROJECT_ID: o ID do seu projeto do Google Cloud .
  • APP_ID: o ID do seu app Gemini Enterprise.
  • DISPLAY_NAME: o nome fácil de usar do seu agente que aparece no Gemini Enterprise.
  • DESCRIPTION: uma breve explicação do que seu agente faz que fica visível para os usuários no Gemini Enterprise. Por exemplo, extrair informações importantes das faturas enviadas para viagens a trabalho.
  • ICON_URI: o URI público de um ícone que aparece ao lado do nome do seu agente do Dialogflow. Você também pode fornecer uma imagem codificada em Base64 em icon.content.
  • DIALOGFLOW_PROJECT_ID: o ID do projeto Google Cloud que identifica a localização do seu agente do Dialogflow.
  • DIALOGFLOW_LOCATION: o local geográfico específico em que seu agente do Dialogflow está hospedado, como global ou us-central1.
  • DIALOGFLOW_AGENT_ID: o identificador exclusivo do seu agente do Dialogflow.

A resposta bem-sucedida a esse comando retorna todos os campos do recurso do agente do Dialogflow recém-criado, incluindo o nome exclusivo do recurso no campo "name". Esse nome de recurso pode ser usado para atualizações ou referências futuras.

Listar agentes conectados a um app

O exemplo de código a seguir demonstra como extrair os detalhes de todos os agentes conectados ao seu app:

REST 

curl -X GET \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
"https://ENDPOINT_LOCATION-discoveryengine.googleapis.com/v1alpha/projects/PROJECT_ID/locations/LOCATION/collections/default_collection/engines/APP_ID/assistants/default_assistant/agents"

Substitua as variáveis por valores:

  • ENDPOINT_LOCATION-: a multirregião da sua solicitação de API. Atribua um dos seguintes valores:
    • us- para a multirregião dos EUA
    • eu- para a multirregião da UE
    • global- para o local global
    Para mais informações, consulte Especificar uma multirregião para seu repositório de dados.
  • PROJECT_ID: o ID do seu projeto do Google Cloud .
  • LOCATION: a multirregião do seu app: global, us ou eu.
  • APP_ID: o ID do seu app Gemini Enterprise.

Se o agente não for pré-criado pelo Google, a resposta vai incluir um campo name nas primeiras linhas. O valor desse campo contém o ID do agente no final do caminho. Por exemplo, na resposta a seguir, o ID do agente é 12345678901234567890:

{
"name": "projects/123456/locations/global/collections/default_collection/engines/my-app/assistants/default_assistant/agents/12345678901234567890",
...
}

Ver detalhes de um agente do Dialogflow

O exemplo de código a seguir demonstra como recuperar os detalhes de um agente registrado no Gemini Enterprise:

REST 

curl -X GET \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
"https://ENDPOINT_LOCATION-discoveryengine.googleapis.com/v1alpha/projects/PROJECT_ID/locations/LOCATION/collections/default_collection/engines/APP_ID/assistants/default_assistant/agents/AGENT_ID"

Substitua as variáveis por valores:

  • ENDPOINT_LOCATION-: a multirregião da sua solicitação de API. Atribua um dos seguintes valores:
    • us- para a multirregião dos EUA
    • eu- para a multirregião da UE
    • global- para o local global
    Para mais informações, consulte Especificar uma multirregião para seu repositório de dados.
  • PROJECT_ID: o ID do seu projeto do Google Cloud .
  • LOCATION: a multirregião do seu app: global, us ou eu.
  • APP_ID: o ID do seu app Gemini Enterprise.
  • AGENT_ID: o ID do agente. Para encontrar o ID do agente, liste os agentes conectados ao seu app.

Atualizar um agente do Dialogflow

Todos os campos fornecidos durante o registro do agente podem ser atualizados. Os seguintes campos são obrigatórios durante o processo de atualização:

  • displayName
  • description
  • reasoning_engine

Ao atualizar um campo, todos os campos e valores precisam ser redefinidos na solicitação de atualização, mesmo que nenhum deles tenha sido alterado.

Este exemplo de código demonstra como atualizar o registro do seu agente do Dialogflow:

curl 

  curl -X PATCH \
    -H "Authorization: Bearer $(gcloud auth print-access-token)" \
    -H "Content-Type: application/json" \
    -H "X-Goog-User-Project: PROJECT_ID" \
  "https://discoveryengine.googleapis.com/v1alpha/AGENT_RESOURCE_NAME" \
    -d '{
      "displayName": "DISPLAY_NAME",
      "description": "DESCRIPTION",
      "icon": {
        "uri": "ICON_URI"
      },
      "dialogflowAgentDefinition": {
        "dialogflowAgent": "projects/PROJECT_ID/locations/REASONING_ENGINE_LOCATION/agents/DIALOGFLOW_AGENT_ID"
      }
    }'

Substitua as variáveis por valores:

  • PROJECT_ID: o ID do seu projeto do Google Cloud .
  • AGENT_RESOURCE_NAME: o nome do recurso do registro do agente a ser atualizado.
  • DISPLAY_NAME:o nome de exibição do agente.
  • DESCRIPTION: a descrição do agente que aparece no Gemini Enterprise. A descrição é apenas para benefício do usuário.
  • ICON_URI: o URI público de um ícone que aparece ao lado do nome do seu agente do Dialogflow. Também é possível fornecer uma imagem codificada em Base64 em icon.content.
  • REASONING_ENGINE_LOCATION: o local na nuvem do mecanismo de inferência em que você está criando um agente.
  • DIALOGFLOW_AGENT_ID: o identificador exclusivo do seu agente do Dialogflow.

Excluir um agente do Dialogflow

O exemplo de código a seguir demonstra como excluir um agente conectado ao seu app:

REST 

curl -X DELETE \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
"https://ENDPOINT_LOCATION-discoveryengine.googleapis.com/v1alpha/projects/PROJECT_ID/locations/LOCATION/collections/default_collection/engines/APP_ID/assistants/default_assistant/agents/AGENT_ID"

Substitua as variáveis por valores:

  • ENDPOINT_LOCATION-: a multirregião da sua solicitação de API. Atribua um dos seguintes valores:
    • us- para a multirregião dos EUA
    • eu- para a multirregião da UE
    • global- para o local global
    Para mais informações, consulte Especificar uma multirregião para seu repositório de dados.
  • PROJECT_ID: o ID do seu projeto do Google Cloud .
  • LOCATION: a multirregião do seu app: global, us ou eu
  • APP_ID: o ID do seu app Gemini Enterprise.
  • AGENT_ID: o ID do agente. Para encontrar o ID do agente, liste os agentes conectados ao seu app.