Für jede Unterhaltungsrunde findet eine Interaktion statt. Während einer Interaktion sendet ein Endnutzer eine Eingabe an die Agent-App und die Agent-App eine Antwort sendet. Sie können die Vertex AI Agents API verwenden, um mit der Agent-App zu interagieren während der Laufzeit.
Hinweise
Bevor Sie diese Anleitung lesen, sollten Sie mit Folgendem vertraut sein:
- Erstellen Sie eine neue Agent-App oder verwenden Sie weiterhin die Agent-App, die Sie in der App erstellt haben Erstellen Sie eine Agent-Anwendung.
IDs erfassen
In den folgenden Beispielen sind mehrere IDs als Eingabe erforderlich. So finden Sie Ihre Projekt-ID, Regions-ID und App-ID:
Rufen Sie die Agent Builder-Konsole auf:
Ihre Projekt-ID wird oben in der Konsole angezeigt.
In der Spalte Standort werden Regions-IDs angezeigt.
Wählen Sie eine App aus.
Das Browser-URL-Pfadsegment nach
agents/
enthält die Agent-App-ID.
Außerdem benötigen Sie eine Sitzungs-ID.
A
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.
Wählen Sie ein Protokoll und eine Version für die Sitzungsreferenz aus:
Protokoll | V3 | V3beta1 |
---|---|---|
REST | Sitzungsressource | Sitzungsressource |
RPC | Sitzungsschnittstelle | Sitzungsschnittstelle |
C++ | SessionsClient | Nicht verfügbar |
C# | SessionsClient | Nicht verfügbar |
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 |
REST
Ersetzen Sie diese Werte in den folgenden Anfragedaten:
- PROJECT_ID: Ihre Google Cloud-Projekt-ID
- AGENT_ID: Ihre 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-Regionusa
. 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 anfordern:
{ "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:
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" }