Interações com a API

Para cada conversa, ocorre uma interação. Durante uma interação, um usuário final envia uma entrada para o app do agente, e este envia uma resposta. É possível usar a API Vertex AI para Conversação para interagir com o app do agente no ambiente de execução.

Observação :nas próximas mudanças, a Vertex AI para Conversação terá a própria API.

Antes de começar

Faça o seguinte antes de ler este guia:

1. Crie um novo app agente ou continue usando o app criado em Criar um app de agente.

Coletar IDs

As amostras abaixo exigem vários IDs como entrada. Para encontrar os ID do projeto, da ID da região e do app:

1. Acesse o console da Vertex AI para Conversação:

   Console de conversação da Vertex AI

2. O ID do projeto vai aparecer na parte de cima do console.

3. A coluna Location mostra os IDs da região.

4. Selecione um app.

5. O segmento do caminho do URL do navegador após agents/ contém o ID do app do agente.

Você também precisa de um código de sessão. Uma sessão representa uma conversa entre um app agente e um usuário final. Você cria um código de sessão exclusivo no início de uma conversa e o usa para cada turno da conversa. Para testar a API, use qualquer ID de string com no máximo 36 bytes, como test-session-123.

Chamar intent de detecção

Os exemplos a seguir chamam o método Sessions.detectIntent. Acessar a referência da API Session

Selecione um protocolo e uma versão para a referência de sessão:

Protocolo	V3	V3beta1
REST	Recurso de sessão	Recurso de sessão
RPC (remote procedure call)	Interface da sessão	Interface da sessão
C++	SessionsClient	Indisponível
C#	SessionsClient	Indisponível
Go	SessionsClient	Indisponível
Java	SessionsClient	SessionsClient
Node.js	SessionsClient	SessionsClient
PHP	Indisponível	Indisponível
Python	SessionsClient	SessionsClient
Ruby	Indisponível	Indisponível

Fechar

REST

Antes de usar os dados da solicitação, faça as substituições a seguir:

• PROJECT_ID: o ID do projeto do Google Cloud
• AGENT_ID: seu ID do agente do playbook, que corresponde ao ID do agente do Dialogflow
• REGION_ID: o ID da sua região
• SUBDOMAIN_REGION: se o ID da região for us, a região do subdomínio será usa. Caso contrário, a região do subdomínio será igual ao ID da região.
• SESSION_ID: seu ID de sessão
• END_USER_INPUT: a entrada do usuário final, por exemplo: eu quero comprar uma camisa.

Método HTTP e URL:

POST https://SUBDOMAIN_REGION-dialogflow.googleapis.com/v3/projects/PROJECT_ID/locations/REGION_ID/agents/AGENT_ID/sessions/SESSION_ID:detectIntent

Corpo JSON da solicitação:

{
  "queryInput": {
    "text": {
      "text": "END_USER_INPUT"
    },
    "languageCode": "en"
  },
  "queryParams": {
    "timeZone": "America/Los_Angeles"
  }
}

Para enviar a solicitação, expanda uma destas opções:

curl (Linux, macOS ou Cloud Shell)

Observação: o comando a seguir pressupõe que você fez login na CLI gcloud com sua conta de usuário executando gcloud init ou gcloud auth login, ou usando o Cloud Shell, que faz login automaticamente na CLI gcloud. É possível verificar a conta ativa atual executando gcloud auth list.

Salve o corpo da solicitação em um arquivo com o nome request.json e execute o comando a seguir:

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "x-goog-user-project: PROJECT_ID" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://SUBDOMAIN_REGION-dialogflow.googleapis.com/v3/projects/PROJECT_ID/locations/REGION_ID/agents/AGENT_ID/sessions/SESSION_ID:detectIntent"

PowerShell (Windows)

Observação: O comando a seguir pressupõe que você fez login na CLI gcloud com sua conta de usuário executando gcloud init ou gcloud auth login . É possível verificar a conta ativa atual executando gcloud auth list.

Salve o corpo da solicitação em um arquivo com o nome request.json e execute o comando a seguir:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred"; "x-goog-user-project" = "PROJECT_ID" }

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://SUBDOMAIN_REGION-dialogflow.googleapis.com/v3/projects/PROJECT_ID/locations/REGION_ID/agents/AGENT_ID/sessions/SESSION_ID:detectIntent" | Select-Object -Expand Content

Você receberá uma resposta JSON semelhante a esta:

{
  "responseId": "a6cd27b0-5eaa-4f93-aa6e-11faf97dbb63",
  "queryResult": {
    "text": "I want to buy a shirt",
    "languageCode": "en",
    "responseMessages": [
      {
        "text": {
          "text": [
            "Great! I can help you with that. We have a wide variety of shirts to choose from. What size and color would you like?"
          ]
        }
      }
    ],
    "intentDetectionConfidence": 1,
    "diagnosticInfo": {
      "Session Id": "123",
      "Response Id": "a6cd27b0-5eaa-4f93-aa6e-11faf97dbb63"
    },
    "match": {
      "confidence": 1
    },
    "advancedSettings": {
      "loggingSettings": {}
    }
  },
  "responseType": "FINAL"
}