Playbook-Parameter

Playbooks akzeptieren und geben Kontextinformationen mithilfe explizit definierter Parameter aus. In Parametern werden Unterhaltungsinformationen wie Nutzerauswahlen und Aktionsergebnisse gespeichert. 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 damit Bestelldetails über ein Tool abrufen.

Eingabeparameter werden pro Playbook definiert. Playbooks haben standardmäßig keinen Zugriff auf andere Parametertypen der Dialogflow CX-Konsole. Wenn ein Ablauf 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.

Hinweis: Das Standard-Playbook akzeptiert keine Eingabeparameter, da es als Einstiegspunkt für Nutzerunterhaltungen dient und keine Möglichkeit hat, sie zu empfangen.

Erstellen Sie Beispiele, um zu steuern, wie sich der Parameterwert auf Aktionen auswirken soll. Wenn sich ein Eingabeparameter beispielsweise darauf auswirken 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. Ein Playbook kann auch ein Tool verwenden, um einen Flug zu buchen, und die Bestätigungsnummer über einen Ausgabeparameter ausgeben.

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

Parameter übergeben

Hinweis: Da ein Aufgaben-Playbook kein Routine-Playbook aufrufen kann, wird dieses Szenario der Parameterübergabe in den folgenden Abschnitten nicht beschrieben.

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 und entschieden 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, die nach Abschluss des Routine-Playbooks zu Sitzungsparametern werden.
• Verwenden Sie die Sitzungsparameter in Abläufen.
• 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:

• Schreiben Sie die Sitzungsparameter aus dem Ablauf.
• Definieren Sie Leseparameter für das Routine-Playbook mit denselben Namen.
• Fügen Sie die Parameternutzung in Anleitungen und Beispiele ein.

Aufgaben-Playbook zu 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 Ablauf-Einstellungen 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 im Aufgaben-Playbook Eingabeparameter für die Aufgabe, die denselben Namen wie die 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, ein KI-Agent ist für den Verkauf von Veranstaltungstickets mit den folgenden Aufgaben-Playbooks konzipiert:

• Ein Playbook mit dem Namen Ticket ordering, das Bestellungen über ein Tool mit dem Namen Ticket sales API aufgibt.
  • Dieses Playbook akzeptiert einen Eingabeparameter vom Typ number mit dem Namen event_id.
  • Das Ticket sales API-Tool erwartet eine Anfrage mit einer event_id.
• Ein Playbook mit dem Namen 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 benötigen Sie mehrere Beispiele, 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:

• Geben Sie für den Eingabeparameter event_id einen realistischen Wert an, der sich in jedem Beispiel unterscheidet.
• 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 ein Ereignis mit einer realistischen event_id ausgewählt wird, wobei in jedem Beispiel eine andere ID verwendet wird.
• 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 bestimmt wurde.

Fügen Sie neben Beispielen auch spezifische Anweisungen zu den Anweisungen, dem Ziel oder den Tool-Details hinzu, in denen erläutert wird, wie Parameter verwendet werden sollen.

Das Playbook Ticket ordering kann beispielsweise die folgende Anweisung enthalten:

- 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 das Playbook Ticket ordering. 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.