Interazioni con l'API

Ad ogni svolta della conversazione, avviene un'interazione. Durante un'interazione, un utente finale invia un input all'app dell'agente, mentre l'app dell'agente invia una risposta. Puoi utilizzare l'API Vertex AI Conversation per interagire con l'app dell'agente in fase di runtime.

Nota: nelle prossime modifiche, Vertex AI Conversation avrà la propria API.

Prima di iniziare

Prima di leggere questa guida, segui questi passaggi:

1. Crea una nuova app dell'agente o continua a utilizzare l'app dell'agente creata in Crea un'app dell'agente.

Raccogli ID

Gli esempi riportati di seguito richiedono diversi ID come input. Per trovare l'ID progetto, l'ID regione e l'ID app:

1. Vai a Vertex AI Conversation Console:

   Console Vertex AI Conversation

2. L'ID progetto viene visualizzato nella parte superiore della console.

3. La colonna Località mostra gli ID regione.

4. Seleziona un'app.

5. Il segmento del percorso dell'URL del browser dopo agents/ contiene l'ID app agente.

È necessario anche un ID sessione. Una sessione rappresenta una conversazione tra un'app agente e un utente finale. Puoi creare un ID sessione univoco all'inizio di una conversazione e utilizzarlo a ogni turno della conversazione. Per provare l'API, puoi utilizzare qualsiasi ID stringa di massimo 36 byte, ad esempio test-session-123.

Intento di rilevamento chiamata

Gli esempi riportati di seguito chiamano il metodo Sessions.detectIntent. Vai al riferimento dell'API Session

Seleziona un protocollo e una versione per il riferimento sessione:

Protocollo	V3	V3beta1
REST	Risorsa sessione	Risorsa sessione
RPC	Interfaccia sessione	Interfaccia sessione
C++	SessionsClient	Non disponibile
C#	SessionsClient	Non disponibile
Go	SessionsClient	Non disponibile
Java	SessionsClient	SessionsClient
Node.js	SessionsClient	SessionsClient
PHP	Non disponibile	Non disponibile
Python	SessionsClient	SessionsClient
Ruby	Non disponibile	Non disponibile

Close

REST

Prima di utilizzare i dati della richiesta, effettua le seguenti sostituzioni:

• PROJECT_ID: l'ID del tuo progetto Google Cloud
• AGENT_ID: l'ID agente playbook, che corrisponde all'ID agente Dialogflow
• REGION_ID: il tuo ID regione
• SUBDOMAIN_REGION: se l'ID regione è us, la regione del sottodominio è usa, altrimenti la regione del sottodominio è uguale all'ID regione
• SESSION_ID: il tuo ID sessione
• END_USER_INPUT: l'input utente finale, ad esempio "Voglio acquistare una camicia"

Metodo 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 della richiesta:

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

Per inviare la richiesta, espandi una di queste opzioni:

curl (Linux, macOS o Cloud Shell)

Nota: il comando seguente presuppone che tu abbia eseguito l'accesso all'interfaccia a riga di comando gcloud con il tuo account utente eseguendo gcloud init o gcloud auth login oppure utilizzando Cloud Shell, che ti consente di accedere automaticamente all'interfaccia a riga di comando di gcloud. . Puoi controllare l'account attualmente attivo eseguendo gcloud auth list.

Salva il corpo della richiesta in un file denominato request.json ed esegui questo comando:

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)

Nota: il comando seguente presuppone che tu abbia eseguito l'accesso all'interfaccia a riga di comando gcloud con il tuo account utente eseguendo gcloud init o gcloud auth login . Puoi controllare l'account attualmente attivo eseguendo gcloud auth list.

Salva il corpo della richiesta in un file denominato request.json ed esegui questo comando:

$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

Dovresti ricevere una risposta JSON simile alla seguente:

{
  "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"
}