Playbook-Parameter

Playbooks können Kontextinformationen über explizit definierte Parameter annehmen 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 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
• Number
• Boolesch
• Toolspezifischer Parametertyp

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

Eingabeparameter (Lesen)

Für jedes Playbook können Sie Eingabeparameter definieren, auch Leseparameter genannt. Damit können Playbooks Werte verwenden, 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 dem Nutzer persönlich zu danken. Es kann auch eine Bestell-ID als Parameter erhalten und sie verwenden, um mit einem Tool Bestelldetails abzurufen.

Eingabeparameter werden pro Playbook definiert. Playbooks haben standardmäßig keinen Zugriff auf andere Dialogflow CX Console-Parametertypen. Wenn ein Ablauf zu einem Playbook wechselt, werden Seiten- und Sitzungsparameter an das Playbook weitergegeben, sofern das Ziel-Playbook einen Eingabeparameter mit demselben Namen hat. Wenn Sie Informationen aus einem Ablauf während eines Übergangs an ein Playbook übermitteln 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 den Äußerungsaktionen im Beispiel. Weitere Informationen finden Sie unter Parameter übergeben.

Ausgabeparameter (schreiben, zurückgeben)

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 ausgeben.

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

Parameter übergeben

Hinweis :Ein Aufgaben-Playbook kann kein Routine-Playbook aufrufen. Das Szenario für die Parameterübergabe wird daher unten nicht beschrieben.

Im Gegensatz zu Abläufen wird in Playbooks keine bestimmte Syntax zum Einfügen von Parameterwerten unterstützt. Stattdessen wird in Playbooks auf Anleitungen und Beispiele für Few-Shot-Prompts zurückgegriffen, um zu bestimmen, wie Parameterwerte verwendet und wie Werte festgelegt werden sollen, wenn Parameterwerte angegeben werden.

Playbook für Abläufe

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

• Schreibparameter für das Routine-Playbook definieren Diese Parameter werden zu Sitzungsparametern.
• In Abläufen können Sitzungsparameter verwendet werden.
• Nehmen Sie die Verwendung von Parametern in Anleitungen und Beispielen auf.

Ablauf zum Playbook für Abläufe

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

• In Abläufen werden die Sitzungsparameter geschrieben.
• Definieren Sie Leseparameter für das Routine-Playbook mit denselben Namen.
• Nehmen Sie die Verwendung von Parametern in Anleitungen und Beispielen auf.

Task-Playbook für Flow

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

• Definieren Sie in den Flusseinstellungen Eingabeparameter mit denselben Namen.
• Nehmen Sie die Verwendung von Parametern in Anleitungen und Beispielen auf.

Ablauf zum Aufgaben-Playbook

So übergeben Sie Parameter aus einem Ablauf an ein Playbook für eine übergeordnete Aufgabe:

• Definieren Sie in den Flusseinstellungen Rückgabeparameter.
• Nehmen Sie die Verwendung von Parametern in Anleitungen und Beispielen auf.

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

• Definieren Sie Aufgaben-Eingabeparameter, die denselben Namen wie Sitzungsparameter im Ablauf haben.
• Nehmen Sie die Verwendung von Parametern in Anleitungen und Beispielen auf.

Vom Routine-Playbook zum 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 Verwendung von Parametern in Anleitungen und Beispielen auf.

Beispiel mit Tools

Betrachten Sie einen Agent, der für den Verkauf von Veranstaltungstickets entwickelt wurde und die folgenden Task-Playbooks enthält:

1. Ein Playbook mit dem Namen Ticket ordering, das Bestellungen mit einem Tool mit dem Namen Ticket sales API aufgibt.
   1. Für dieses Playbook ist ein Eingabeparameter mit dem Typ number und dem Namen event_id erforderlich.
   2. Das Tool Ticket sales API erwartet eine Anfrage mit einem event_id.
2. Ein Playbook mit dem Namen Event selection, das Nutzern hilft, ein Event 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 in jedem Beispiel mit einem realistischen Wert angegeben werden.
• Fügen Sie eine Tool-Nutzungsaktion mit einem Anfragetext ein, der denselben realistischen event_id-Wert wie im Eingabeparameter angegeben enthält.

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

• Fügen Sie eine Nutzeräußerung ein, in der der Nutzer ein Ereignis mit realistischen event_id auswählt, die sich in den Beispielen unterscheiden.
• Fügen Sie einen Playbook-Aufruf von Ticket ordering ein, der den Parameter event_id auf denselben realistischen event_id festlegt, der durch die Auswahl des Nutzers bestimmt wird.

Fügen Sie nicht nur Beispiele hinzu, sondern auch spezifische Anweisungen in die Anleitung, das Ziel oder die Tool-Details ein, 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}

Anhand der beschriebenen Beispiele und Anleitungen wird im Event selection-Playbook basierend auf der Auswahl des Nutzers korrekt ein event_id festgelegt und als Eingabeparameter mit dem Namen event_id an den Ticket ordering playbook übergeben. 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.