Playbook-Parameter

Playbooks können Kontextinformationen über explizit definierte Parameter akzeptieren und ausgeben. Parameter werden verwendet, um Informationen zu einer Unterhaltung zu speichern, z. B. Nutzerauswahlen, Ergebnisse von Aktionen usw. Sie können die Werte dieser Parameter zwischen Playbooks und Abläufen übergeben.

Parameterdeklaration

Sie können Eingabeparameter (Leseparameter) und Ausgabeparameter (Schreibparameter) definieren.

Parameter haben einen Namen, eine Beschreibung und einen der folgenden Typen:

  • String
  • Zahl
  • Boolesch
  • Toolspezifischer Parametertyp

Sie können auch angeben, ob ein Parameter eine Liste ist.

Eingabeparameter (Lesen)

Für jedes Playbook können Sie Eingabeparameter (auch Leseparameter genannt) definieren, mit denen Playbooks Werte verwenden können, die von Abläufen und anderen Playbooks übergeben werden. Ein Playbook kann beispielsweise den bevorzugten Namen eines Nutzers als Parameter erhalten und ihn verwenden, um sich persönlich beim Nutzer zu bedanken. Es kann auch eine Bestell-ID als Parameter erhalten und sie verwenden, um Bestelldetails mit einem Tool abzurufen.

Eingabeparameter werden pro Playbook definiert. Playbooks haben standardmäßig keinen Zugriff auf andere Parametertypen der Dialogflow CX-Konsole. Wenn ein Flow zu einem Playbook wechselt, werden Seiten- und Sitzungsparameter an das Playbook weitergegeben, wenn das Ziel-Playbook einen Eingabeparameter mit demselben Namen hat. Wenn Sie während eines Übergangs Informationen von einem Ablauf an ein Playbook weitergeben möchten, definieren Sie Playbook-Eingabeparameter mit demselben Namen wie ein Sitzungs- oder Seitenparameter, der vor dem Übergang vorhanden war.

Erstellen Sie Beispiele, um zu steuern, wie sich der Eingabeparameterwert auf Aktionen auswirken soll. Wenn ein Eingabeparameter beispielsweise beeinflussen soll, wie der Agent den Nutzer anspricht, erstellen Sie Beispiele, in denen ein Wert für den Parameter definiert wird, und verwenden Sie dann denselben Wert in Äußerungsaktionen innerhalb des Beispiels. Weitere Informationen finden Sie unter Parameter übergeben.

Ausgabeparameter (Schreiben, Rückgabe)

Für jedes Playbook können Sie Ausgabeparameter definieren, die auch als Schreibparameter und Rückgabeparameter bezeichnet werden. Mit diesen Parametern können Playbooks Informationen ausgeben, die von anderen Abläufen oder Playbooks verwendet werden können. Ein Playbook kann beispielsweise eine Bestellnummer von einem Nutzer erfassen und über einen Ausgabeparameter ausgeben. Oder ein Playbook kann ein Tool verwenden, um einen Flug zu buchen und die Bestätigungsnummer über einen Ausgabeparameter auszugeben.

Erstellen Sie Beispiele, um zu steuern, wie das Playbook den Wert für jeden Ausgabeparameter bestimmen soll. Wenn beispielsweise ein Ausgabeparameter, der eine Bestätigungsnummer darstellt, seinen Wert aus der Ausgabe einer Toolnutzung ableiten soll, erstellen Sie Beispiele, bei denen die Ausgabe der Toolnutzung mit dem Wert des Playbook-Ausgabeparameters übereinstimmt.

Parameter übergeben

Im Gegensatz zu Abläufen unterstützen Playbooks nicht das Einfügen von Parameterwerten mit einer bestimmten Syntax. Stattdessen basieren Playbooks auf Anweisungen und Few-Shot-Prompt-Beispielen, um zu bestimmen, wie Parameterwerte verwendet werden sollen und wie Werte beim Angeben von Parameterwerten festgelegt werden sollen.

Routine-Playbook zu Flow

So übergeben Sie Parameter von einem Routine-Playbook an einen Ablauf:

  • Definieren Sie Schreibparameter für das Routine-Playbook. Diese Parameter werden zu Sitzungsparametern.
  • In Abläufen können die Sitzungsparameter verwendet werden.
  • Fügen Sie die Parameternutzung in Anleitungen und Beispiele ein.

Ablauf zum Routine-Playbook

So übergeben Sie Parameter von einem Ablauf an ein Routine-Playbook:

  • Abläufe schreiben die Sitzungsparameter.
  • Definieren Sie Leseparameter für das Routine-Playbook mit denselben Namen.
  • Fügen Sie die Parameternutzung in Anleitungen und Beispiele ein.

Aufgaben-Playbook für Ablauf

So übergeben Sie Parameter von einem Aufgaben-Playbook an einen Ablauf:

  • Definieren Sie in den Ablauf-Einstellungen Eingabeparameter mit denselben Namen.
  • Fügen Sie die Parameternutzung in Anleitungen und Beispiele ein.

Ablauf zum Aufgaben-Playbook

So übergeben Sie Parameter von einem Ablauf an ein übergeordnetes Aufgaben-Playbook:

  • Definieren Sie in den Ablaufeinstellungen Rückgabeparameter.
  • Fügen Sie die Parameternutzung in Anleitungen und Beispiele ein.

So übergeben Sie Parameter von einem Ablauf an ein untergeordnetes Aufgaben-Playbook:

  • Definieren Sie Aufgabeneingabeparameter, die denselben Namen wie Sitzungsparameter im Ablauf haben.
  • Fügen Sie die Parameternutzung in Anleitungen und Beispiele ein.

Routine-Playbook zu Aufgaben-Playbook

So übergeben Sie Parameter von einem Routine-Playbook an ein Aufgaben-Playbook:

  • Definieren Sie Eingabeparameter für das Aufgaben-Playbook mit denselben Namen.
  • Fügen Sie die Parameternutzung in Anleitungen und Beispiele ein.

Beispiel mit Tools

Angenommen, Sie haben einen KI-Agenten für den Verkauf von Veranstaltungstickets mit den folgenden Aufgaben-Playbooks:

  1. Ein Playbook mit dem Namen Ticket ordering, das Bestellungen über ein Tool mit dem Namen Ticket sales API aufgibt.
    1. Dieses Playbook akzeptiert einen Eingabeparameter mit dem Typ number und dem Namen event_id.
    2. Das Ticket sales API-Tool erwartet eine Anfrage mit einem event_id.
  2. Ein Playbook namens Event selection, das Nutzern hilft, ein Event auszuwählen, und sie dann mit dem Parameter event_id an Ticket ordering weiterleitet, um Tickets zu kaufen.

In diesem Beispiel sind mehrere Beispiele erforderlich, damit event_id zuverlässig von Event selection an Ticket ordering und von Ticket ordering an Ticket sales API übergeben wird.

Das Playbook Ticket ordering sollte mehrere Beispiele enthalten, die:

  • Der Eingabeparameter event_id muss mit einem realistischen Wert angegeben werden, der in jedem Beispiel anders ist.
  • Fügen Sie eine Toolnutzungsaktion mit einem Anfragetext ein, der denselben realistischen event_id-Wert enthält, der im Eingabeparameter angegeben ist.

Das Playbook Event selection sollte mehrere Beispiele enthalten, die:

  • Fügen Sie eine Nutzeräußerung ein, in der der Nutzer ein Ereignis mit einem realistischen event_id auswählt, das in jedem Beispiel anders ist.
  • Fügen Sie einen Playbook-Aufruf von Ticket ordering ein, der den Parameter event_id auf denselben realistischen event_id setzt, der durch die Auswahl des Nutzers festgelegt wurde.

Zusätzlich zu Beispielen können Sie auch spezifische Anweisungen in den Anweisungen, im Ziel oder in den Tool-Details hinzufügen, um zu erklären, wie Parameter verwendet werden sollen. Das Playbook Ticket ordering enthält beispielsweise die folgende Anweisung:

- Use parameter event_id to send a buy_tickets request with ${TOOL: Ticket sales API}

Mit den beschriebenen Beispielen und Anweisungen entscheidet das Playbook Event selection korrekt über einen event_id basierend auf der Auswahl des Nutzers und übergibt ihn als Eingabeparameter mit dem Namen event_id an den Ticket ordering playbook. Anschließend übergibt Ticket ordering dieselbe event_id im Text einer Anfrage an die Ticket sales API. Playbooks sind auf Beispiele mit unterschiedlichen Parameterwerten angewiesen, um abzuleiten, wie Parameter verwendet werden sollten.

Zurück
Playbook-Beispiele
Weiter
Playbook-Tools