Playbook-Parameter

Playbooks können Kontextinformationen mithilfe von explizit definierten Parametern akzeptieren und senden. Mithilfe von Parametern werden Informationen zu einer Unterhaltung gespeichert, z. B. Nutzerauswahlen oder Ergebnisse von Aktionen. Sie können die Werte dieser Parameter zwischen Playbooks und Abläufen übergeben.

Parameterdeklaration

Sie können Eingabeparameter und Ausgabeparameter definieren.

Wenn Sie die Agent Builder-Konsole verwenden, können Sie Parameter auf der Seite „Agent-Editor“ definieren.

Wenn Sie die Dialogflow CX-Konsole verwenden, werden die Parameter pro Playbook auf dem Tab Parameter definiert, nachdem Sie ein Playbook erstellt haben.

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

  • String
  • Number
  • Boolesch
  • Toolspezifischer Parametertyp

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

Eingabeparameter

Mit Eingabeparametern können in Playbooks Werte verwendet werden, die aus Abläufen und anderen Playbooks übergeben werden. Ein Playbook kann beispielsweise den bevorzugten Namen eines Nutzers als Parameter erhalten und damit dem Nutzer persönlich danken. Es kann auch eine Bestell-ID als Parameter erhalten und damit Bestelldetails mithilfe eines Tools abrufen.

Eingabeparameter werden pro Playbook definiert. Playbooks sind standardmäßig nicht für andere Parametertypen der Dialogflow CX Console sichtbar. Wenn ein Ablauf zu einem Playbook übergeht, werden Seiten- und Sitzungsparameter an das Playbook übergeben, wenn das Ziel-Playbook einen Eingabeparameter mit demselben Namen hat. Wenn Sie Informationen während eines Übergangs von einem Fluss an ein Playbook senden möchten, definieren Sie Playbook-Eingabeparameter mit demselben Namen wie ein Sitzungs- oder Seitenparameter, der vor dem Übergang vorhanden ist.

Erstellen Sie Beispiele, um festzulegen, wie sich der Wert des Eingabeparameters auf Aktionen auswirken soll. Wenn sich ein Eingabeparameter beispielsweise darauf auswirken soll, wie sich der Kundenservicemitarbeiter an den Nutzer wendet, erstellen Sie Beispiele, in denen ein Wert für den Parameter definiert wird, und verwenden Sie dann denselben Wert in Äußerungsaktionen im Beispiel. Weitere Informationen finden Sie unter Parameter übergeben.

Ausgabeparameter

Mit Ausgabeparametern können Playbooks Informationen senden, die von anderen Abläufen oder Playbooks verwendet werden. So kann ein Playbook beispielsweise eine Bestellnummer von einem Nutzer erfassen und über einen Ausgabeparameter ausgeben. Es kann auch ein Tool verwenden, um einen Flug zu buchen und die Bestätigungsnummer über einen Ausgabeparameter auszugeben.

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

Parameter übergeben

Im Gegensatz zu Abläufen unterstützen Playbooks nicht das Einschleusen von Parameterwerten mit einer bestimmten Syntax. Stattdessen werden in Playbooks Anleitungen und Beispiele für Prompts mit wenigen Aufnahmen verwendet, um zu bestimmen, wie Parameterwerte verwendet werden sollten und wie Werte bei der Angabe von Parameterwerten festgelegt werden sollten.

Angenommen, Sie haben einen Kundenservicemitarbeiter für den Verkauf von Veranstaltungstickets mit den folgenden Playbooks erstellt:

  1. Ein Playbook mit dem Namen Ticket ordering, das Bestellungen über ein Tool namens Ticket sales API aufgibt.
    1. Dieses Playbook akzeptiert einen Eingabeparameter vom Typ number und mit dem Namen event_id.
    2. Das Ticket sales API-Tool erwartet eine Anfrage mit einem event_id.
  2. Ein Playbook mit dem Namen Event selection, das Nutzern hilft, ein Ereignis auszuwählen, und sie dann mit dem Parameter event_id zu 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 Ticket ordering-Playbook sollte mehrere Beispiele enthalten, die:

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

Das Event selection-Playbook sollte mehrere Beispiele enthalten, die:

  • Fügen Sie eine Nutzeräußerung hinzu, in der der Nutzer ein Ereignis mit einigen realistischen event_id auswählt, die in jedem Beispiel unterschiedlich sind.
  • Fügen Sie eine Playbook-Aufruf-Ticket ordering hinzu, die den event_id-Parameter auf denselben realistischen event_id festlegt, der durch die Auswahl des Nutzers festgelegt wurde.

Fügen Sie nicht nur Beispiele hinzu, sondern auch spezifische Anweisungen in den Anleitungen, Ziel oder Tool-Details, in denen erklärt wird, wie Parameter verwendet werden sollten. 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 Anleitungen entscheidet das Event selection-Playbook basierend auf der Auswahl des Nutzers korrekt über einen event_id und gibt ihn als Eingabeparameter namens event_id an die Ticket ordering playbook weiter. Anschließend gibt Ticket ordering dieselbe event_id im Anfragetext an die Ticket sales API weiter. Playbooks basieren auf Beispielen mit unterschiedlichen Parameterwerten, anhand derer abgeleitet werden kann, wie Parameter verwendet werden sollten.