Interaksi dengan API

Untuk setiap giliran percakapan, interaksi terjadi. Selama interaksi, pengguna akhir mengirimkan input ke aplikasi agen dan aplikasi agen mengirimkan respons. Anda dapat menggunakan Vertex AI Conversation API untuk berinteraksi dengan aplikasi agen saat runtime.

Catatan: Pada perubahan mendatang, Vertex AI Conversation akan memiliki API-nya sendiri.

Sebelum memulai

Anda harus melakukan hal berikut sebelum membaca panduan ini:

1. Buat aplikasi agen baru atau lanjutkan menggunakan aplikasi agen yang Anda buat di Membuat aplikasi agen.

Kumpulkan ID

Contoh di bawah ini memerlukan beberapa ID sebagai input. Untuk menemukan project ID, ID wilayah, dan ID aplikasi Anda:

1. Buka konsol Vertex AI Conversation:

   Konsol Vertex AI Conversation

2. Project ID Anda ditampilkan di bagian atas konsol.

3. Kolom Location menampilkan ID wilayah.

4. Pilih aplikasi.

5. Segmen jalur URL browser setelah agents/ berisi ID aplikasi agen.

Anda juga memerlukan ID sesi. Sesi mewakili percakapan antara aplikasi agen dan pengguna akhir. Anda membuat ID sesi unik di awal percakapan dan menggunakannya untuk setiap pergantian percakapan. Untuk tujuan mencoba API, Anda dapat menggunakan ID string apa pun yang berukuran maksimal 36 byte, seperti test-session-123.

Intent deteksi panggilan

Contoh berikut memanggil metode Sessions.detectIntent. Buka referensi Session API

Pilih protokol dan versi untuk Referensi sesi:

Protokol	V3	V3beta1
REST	Referensi sesi	Referensi sesi
RPC	Antarmuka sesi	Antarmuka sesi
C++	SessionsClient	Tidak tersedia
C#	SessionsClient	Tidak tersedia
Go	SessionsClient	Tidak tersedia
Java	SessionsClient	SessionsClient
Node.js	SessionsClient	SessionsClient
PHP	Tidak tersedia	Tidak tersedia
Python	SessionsClient	SessionsClient
Ruby	Tidak tersedia	Tidak tersedia

Tutup

REST

Sebelum menggunakan salah satu data permintaan, lakukan penggantian berikut:

• PROJECT_ID: project ID Google Cloud Anda
• AGENT_ID: ID agen playbook Anda, yang sesuai dengan ID agen Dialogflow
• REGION_ID: ID wilayah Anda
• SUBDOMAIN_REGION: jika ID wilayah Anda adalah us, wilayah subdomain adalah usa. Jika tidak, region subdomain sama dengan ID wilayah
• SESSION_ID: ID sesi Anda
• END_USER_INPUT: input pengguna akhir, misalnya: Saya ingin membeli kemeja

Metode HTTP dan URL:

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

Meminta isi JSON:

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

Untuk mengirim permintaan Anda, perluas salah satu opsi berikut:

curl (Linux, macOS, atau Cloud Shell)

Catatan: Perintah berikut mengasumsikan bahwa Anda telah login ke CLI gcloud dengan akun pengguna Anda dengan menjalankan gcloud init atau gcloud auth login, atau menggunakan Cloud Shell, yang secara otomatis membuat Anda login ke CLI gcloud. Anda dapat memeriksa akun yang aktif saat ini dengan menjalankan gcloud auth list.

Simpan isi permintaan dalam file bernama request.json, dan jalankan perintah berikut:

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)

Catatan: Perintah berikut mengasumsikan bahwa Anda telah login ke CLI gcloud dengan akun pengguna Anda dengan menjalankan gcloud init atau gcloud auth login. Anda dapat memeriksa akun yang aktif saat ini dengan menjalankan gcloud auth list.

Simpan isi permintaan dalam file bernama request.json, dan jalankan perintah berikut:

$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

Anda akan menerima respons JSON yang mirip dengan yang berikut ini:

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