Interaktionen mit der API

Für jede Unterhaltungsrunde findet eine Interaktion statt. Während einer Interaktion sendet ein Endnutzer eine Eingabe an die Agent-Anwendung und die Agent-Anwendung eine Antwort. Sie können die Vertex AI Agents API verwenden, um während der Laufzeit mit der Agent-Anwendung zu interagieren.

Hinweis: In den bevorstehenden Änderungen haben Vertex AI-Agents eine eigene API.

Hinweise

Bevor Sie diese Anleitung lesen, sollten Sie mit Folgendem vertraut sein:

1. Erstellen Sie eine neue Agent-Anwendung oder verwenden Sie weiter die Agent-Anwendung, die Sie unter Agent-Anwendung erstellen erstellt haben.

IDs erfassen

In den folgenden Beispielen sind mehrere IDs als Eingabe erforderlich. So finden Sie Ihre Projekt-ID, Regions-ID und Anwendungs-ID:

1. Rufen Sie die Agent Builder-Konsole auf:

   Agent Builder-Konsole

2. Ihre Projekt-ID wird oben in der Konsole angezeigt.

3. In der Spalte Standort werden die Regions-IDs angezeigt.

4. Wählen Sie eine App aus.

5. Das Browser-URL-Pfadsegment nach agents/ enthält die Agent-App-ID.

Außerdem benötigen Sie eine Sitzungs-ID. Eine Sitzung stellt eine Unterhaltung zwischen einer Agent-Anwendung und einem Endnutzer dar. Zu Beginn einer Unterhaltung erstellen Sie eine eindeutige Sitzungs-ID und verwenden sie für jede Unterhaltungsrunde. Zum Testen der API können Sie eine beliebige String-ID verwenden, die höchstens 36 Byte beträgt, z. B. test-session-123.

Intent-Erkennung aufrufen

In den folgenden Beispielen wird die Methode Sessions.detectIntent aufgerufen. Zur Session API-Referenz

Wählen Sie ein Protokoll und eine Version für die Sitzungsreferenz aus:

Protokoll	V3	V3beta1
REST	Sitzungsressource	Sitzungsressource
RPC	Sitzungsoberfläche	Sitzungsoberfläche
C++	SessionsClient	Nicht verfügbar
C#	SessionsClient	Nicht verfügbar
Einfach loslegen (Go)	SessionsClient	Nicht verfügbar
Java	SessionsClient	SessionsClient
Node.js	SessionsClient	SessionsClient
PHP	Nicht verfügbar	Nicht verfügbar
Python	SessionsClient	SessionsClient
Ruby	Nicht verfügbar	Nicht verfügbar

Schließen

REST

Bevor Sie die Anfragedaten verwenden, ersetzen Sie die folgenden Werte:

• PROJECT_ID: Ihre Google Cloud-Projekt-ID
• AGENT_ID: Die Playbook-Agent-ID, die der Dialogflow-Agent-ID entspricht
• REGION_ID: Ihre Regions-ID
• SUBDOMAIN_REGION: Wenn Ihre Regions-ID us lautet, ist die Subdomain-Region usa. Andernfalls entspricht die Subdomain-Region der Regions-ID.
• SESSION_ID: Sitzungs-ID
• END_USER_INPUT: die Endnutzereingabe, z. B. „Ich möchte ein T-Shirt kaufen“

HTTP-Methode und URL:

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

JSON-Text der Anfrage:

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

Wenn Sie die Anfrage senden möchten, maximieren Sie eine der folgenden Optionen:

curl (Linux, macOS oder Cloud Shell)

Hinweis: Beim folgenden Befehl wird davon ausgegangen, dass Sie sich mit Ihrem Nutzerkonto in der gcloud-Befehlszeile angemeldet haben. Dazu führen Sie gcloud init oder gcloud auth login aus oder verwenden Cloud Shell, wo Sie automatisch in der gcloud-Befehlszeile angemeldet werden. Um herauszufinden, welches Konto gerade aktiv ist, führen Sie gcloud auth list aus.

Speichern Sie den Anfragetext in einer Datei mit dem Namen request.json und führen Sie den folgenden Befehl aus:

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)

Hinweis: Beim folgenden Befehl wird davon ausgegangen, dass Sie sich mit Ihrem Nutzerkonto in der gcloud-Befehlszeile angemeldet haben. Dazu führen Sie gcloud init oder gcloud auth login aus. Um herauszufinden, welches Konto gerade aktiv ist, führen Sie gcloud auth list aus.

Speichern Sie den Anfragetext in einer Datei mit dem Namen request.json und führen Sie den folgenden Befehl aus:

$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

Sie sollten in etwa folgende JSON-Antwort erhalten:

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