Para cada conversa, ocorre uma interação. Durante uma interação, um usuário final envia a entrada para o app do agente. e o app agente envia uma resposta. É possível usar a API Vertex AI Agents para interagir com o app do agente durante a execução.
Antes de começar
Faça o seguinte antes de ler este guia:
- Crie um novo app de agente ou continue usando o que você criou Crie um app de agente.
Coletar IDs
As amostras abaixo exigem vários IDs como entrada. Para encontrar o ID do projeto, o ID da região e o ID do app:
Acesse o console do Agent Builder:
O ID do projeto é exibido na parte superior do console.
A coluna Local mostra os IDs das regiões.
Selecione um app.
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.
Um
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
.
Selecione um protocolo e uma versão para a referência de sessão:
Protocolo | V3 | V3beta1 |
---|---|---|
REST | Recurso da sessão | Recurso da 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 |
REST
Antes de usar os dados da solicitação abaixo, 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: 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:
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" }