Erstellen benutzerdefinierter KI-Agenten mit der Agenten-API
Lernziele
- Beschreiben der erste Schritte mit der Agenten-API
- Starten einer Sitzung mit einem KI-Agenten mithilfe der Agenten-API und Verwalten des Sitzungslebenszyklus
Erste Schritte mit der Agenten-API
Sie sind Entwickler und haben die Aufgabe, Agentforce in Ihre Website zu integrieren, damit KI-Agenten von Salesforce Ihren Kunden mit schnellen, hilfreichen Antworten weiterhelfen können.
Sie wissen, dass dies Ihre Workflows vereinfachen und die Benutzerinteraktionen verbessern wird, aber wo fangen Sie an? Hier kommt die Agenten-API ins Spiel.
Wir geben Ihnen hier nun einen Überblick über die Schritte, mit denen Sie Agentforce mit der Agenten-API einrichten und betriebsbereit machen.
Schritt 1: Aktivieren von Agentforce und Aktivieren eines Agenten
Zuerst müssen Sie Agentforce in Ihrer Organisation aktivieren. Dies ist ein sehr wichtiger Schritt, da ohne ihn keine der nachfolgenden Konfigurationen funktionieren. Nach der Aktivierung von Agentforce müssen Sie mindestens einen Agenten aktivieren.
Die Agenten-API unterstützt Agenten vom Typ "Agentforce (Default)" (Agentforce (Standard)) nicht.
Schritt 2: Erstellen einer externen Client-Anwendung und Aktivieren von OAuth-Einstellungen
Als nächstes müssen Sie eine externe Client-Anwendung in Salesforce erstellen. Diese Anwendung verarbeitet den Flow für Client-Anmeldeinformationen, der für sichere API-Aufrufe unerlässlich ist. Aktivieren Sie OAuth-Einstellungen für die API.
Schritt 3: Feststellen von Verbraucherschlüssel und -geheimnis
Wenn Sie Ihre Anwendung eingerichtet haben, müssen Sie den Verbraucherschlüssel und das Verbrauchergeheimnis feststellen. Diese Anmeldeinformationen sind zum Authentifizieren Ihrer API-Aufrufe erforderlich. Sie finden sie in Ihrer externen Client-Anwendung.
Schritt 4: Erstellen eines Tokens
Sämtliche Aufrufe der Agenten-API erfordern ein Token. Dieses Token wird zum Authentifizieren Ihrer API-Aufrufe verwendet. Sie können ein Token unter Verwendung von Verbraucherschlüssel, Verbrauchergeheimnis und Ihrem Domänennamen erstellen.
Probieren Sie es aus: Rufen Sie die API auf
Jetzt kommt der spannende Teil – das Aufrufen der Agenten-API.
Vor dem Aufruf müssen Sie allerdings einige Informationen aus Ihrer Organisation sammeln. Weitere Informationen finden Sie unter Aufrufen der API (in englischer Sprache) im "Agent API Developer Guide".
Führen Sie diesen curl-Befehl in einer Befehlszeilenschnittstelle aus, um eine neue Agentensitzung mit der Agenten-API zu erstellen.
curl --location -X POST https://api.salesforce.com/einstein/ai-agent/v1/agents/{AGENT_ID}/sessions \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {ACCESS_TOKEN}' \
--data '{
"externalSessionKey": "{RANDOM_UUID}",
"instanceConfig": {
"endpoint": "https://{MY_DOMAIN_URL}"
},
"streamingCapabilities": {
"chunkTypes": ["Text"]
},
"bypassUser": true
}'Wird dieser Aufruf erfolgreich ausgeführt, erhalten Sie eine Antwort mit einer Sitzungs-ID und weiteren Informationen. Dies ist ein Beispiel für eine Antwort:
{
"sessionId": "80ab2e16-392e-4c12-b80a-f028a58400b5",
"_links": {
"self": null,
"messages": {
"href": "https://api.salesforce.com/einstein/ai-agent/v1/sessions/80ab2e16-392e-4c12-b80a-f028a58400b5/messages"
},
"messagesStream": {
"href": "https://api.salesforce.com/einstein/ai-agent/v1/sessions/80ab2e16-392e-4c12-b80a-f028a58400b5/messages/stream"
},
"session": {
"href": "https://api.salesforce.com/einstein/ai-agent/v1/agents/0XxHr000000ysOSKAY/sessions"
},
"end": {
"href": "https://api.salesforce.com/einstein/ai-agent/v1/sessions/80ab2e16-392e-4c12-b80a-f028a58400b5"
}
},
"messages": [
{
"type": "Inform",
"id": "d27b7308-f1ab-47bd-949c-0225d5e21a8e",
"feedbackId": "",
"planId": "",
"isContentSafe": true,
"message": "Hi, I'm an AI service assistant. How can I help you?",
"result": [],
"citedReferences": []
}
]
}Sie können jetzt damit beginnen, Nachrichten an den KI-Agenten zu senden.
Die Agenten-API unterstützt die Verarbeitung sowohl von synchronen als auch von Streaming-Nachrichten. Synchrone Nachrichten eignen sich ideal für Anwendungsfälle, bei denen Sie die vollständige Antwort in einem einzigen Aufruf erhalten sollten, während Streaming-Nachrichten besser für Echtzeit-Interaktionen wie Chat-Unterhaltungen geeignet sind.
Denken Sie daran, die Sitzung zu schließen, wenn Sie fertig sind.
Zu beachten
-
Datenverbrauch: Die Nutzung der Agenten-API wirkt sich auf den Guthabenverbrauch aus, wie unter Nutzung und Abrechnung von Agentforce und generativer AI beschrieben wird.
-
API-Timeouts: Für die Agenten-API gibt einen Timeout von 120 Sekunden. Überschreitet ein Aufruf diese Zeitbegrenzung, erhalten Sie eine HTTP 500-Antwort.
Zusammenfassung
Das war's auch schon. Verwenden Sie den Leitfaden Erste Schritte mit der Agenten-API (in englischer Sprache) und Beispielcode, um mit der Integration von Agentforce auf Ihrer Website zu beginnen und das Kundenerlebnis zu verbessern.