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 und Ergebnisse von Aktionen. Sie können die Werte dieser Parameter zwischen Playbooks und Flowsü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 (Leseparameter)

Für jedes Playbook können Sie Eingabeparameter definieren, die auch als Leseparameter bezeichnet werden. Mit diesen Parametern können Playbooks Werte verwenden, die von Flows 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 damit Bestelldetails mit einem Toolabrufen.

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 Informationen von einem Flow an ein Playbook übergeben möchten, definieren Sie Playbook-Eingabeparameter mit demselben Namen wie ein Sitzungs- oder Seitenparameter, der vor dem Übergang vorhanden ist.

Hinweis: Das Standard-Playbook akzeptiert keine Eingabeparameter. Das Standard-Playbook dient als Einstiegspunkt für Nutzerunterhaltungen und kann daher keine Eingabeparameter empfangen.

Erstellen Sie Beispiele, um zu steuern, wie sich der Wert des Eingabeparameters 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. Verwenden Sie dann denselben Wert in Äußerungsaktionen im Beispiel. Weitere Informationen finden Sie unter Parameter übergeben.

Ausgabeparameter (Schreib- und Rückgabeparameter)

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 Flows oder Playbooks verwendet werden können. Ein Playbook kann beispielsweise eine Bestellnummer von einem Nutzer erfassen und über einen Ausgabeparameter ausgeben. Alternativ kann ein Playbook ein Tool verwenden, um einen Flug zu buchen, und die Bestätigungsnummer über einen Ausgabeparameter ausgeben.

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

Parameter übergeben

**Hinweis**: Ein Aufgaben-Playbook kann kein Routine-Playbook aufrufen, dieses Szenario wird daher unten nicht beschrieben.

Im Gegensatz zu Flows unterstützen Playbooks nicht das Einfügen von Parameterwerten mit einer bestimmten Syntax. Stattdessen verwenden Playbooks Anleitungen und Beispiele für wenige Prompts , um zu bestimmen, wie Parameterwerte verwendet werden sollen und wie Werte festgelegt werden sollen, wenn Parameterwerte angegeben werden.

Routine-Playbook an Flow

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

• Definieren Sie Schreibparameter für das Routine-Playbook. Diese Parameter werden zu Sitzungsparametern.
• Flows können die Sitzungsparameter verwenden.
• Nehmen Sie die Parameterverwendung in Anleitungen und Beispiele auf.

Flow an Routine-Playbook

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

• Flows schreiben die Sitzungsparameter.
• Definieren Sie Leseparameter für das Routine-Playbook mit denselben Namen.
• Nehmen Sie die Parameterverwendung in Anleitungen und Beispiele auf.

Aufgaben-Playbook an Flow

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

• Definieren Sie in den Flow-Einstellungen Eingabeparameter mit denselben Namen.
• Nehmen Sie die Parameterverwendung in Anleitungen und Beispiele auf.

Flow an Aufgaben-Playbook

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

• Definieren Sie in den Flow-Einstellungen Rückgabeparameter.
• Nehmen Sie die Parameterverwendung in Anleitungen und Beispiele auf.

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

• Definieren Sie Aufgaben-Eingabeparameter mit demselben Namen wie die Sitzungsparameter im Flow.
• Nehmen Sie die Parameterverwendung in Anleitungen und Beispiele auf.

Routine-Playbook an 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.
• Nehmen Sie die Parameterverwendung in Anleitungen und Beispiele auf.

Beispiel mit Tools

Betrachten Sie einen Agenten, der für den Verkauf von Veranstaltungstickets entwickelt wurde, mit den folgenden Aufgaben-Playbooks:

1. Ein Playbook mit dem Namen Ticket ordering, das Bestellungen mit einem Tool namens Ticket sales API aufgibt.
   1. Dieses Playbook akzeptiert einen Eingabeparameter vom Typ number und mit dem Namen event_id.
   2. Das Tool Ticket sales API erwartet eine Anfrage mit einer event_id.
2. Ein Playbook mit dem Namen Event selection, mit dem Nutzer eine Veranstaltung auswählen können. Anschließend werden sie mit dem Parameter event_id zu Ticket ordering weitergeleitet, um Tickets zu kaufen.

In diesem Beispiel sind mehrere Beispiele erforderlich, um sicherzustellen, dass 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 folgende Merkmale aufweisen:

• Der Eingabeparameter event_id ist mit einem realistischen Wert angegeben, der sich in jedem Beispiel unterscheidet.
• Es ist eine Toolnutzungsaktion mit einem Anfragetext enthalten, der denselben realistischen event_id-Wert enthält, der im Eingabeparameter angegeben ist.

Das Playbook Event selection sollte mehrere Beispiele enthalten, die folgende Merkmale aufweisen:

• Es ist eine Nutzeräußerung enthalten, in der der Nutzer eine Veranstaltung mit einer realistischen event_id auswählt, die sich in jedem Beispiel unterscheidet.
• Es ist ein Playbook-Aufruf von Ticket ordering enthalten, bei dem der Parameter event_id auf denselben realistischen event_id-Wert festgelegt wird, der durch die Auswahl des Nutzers bestimmt wurde.

Fügen Sie nicht nur Beispiele hinzu, sondern auch spezifische Anleitungen zu den Anleitungen, Zielen oder Tooldetails , in denen erklärt wird, wie Parameter verwendet werden sollen. Das Playbook Ticket ordering enthält beispielsweise die folgende Anleitung:

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

Mit den beschriebenen Beispielen und Anleitungen bestimmt das Event selection Playbook anhand der Auswahl des Nutzers korrekt eine event_id und übergibt sie als Eingabeparameter mit dem Namen event_id an das 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 sollen.