Parametri del playbook

I playbook accettano ed emettono informazioni di contesto utilizzando parametri definiti in modo esplicito. I parametri memorizzano le informazioni sulla conversazione, come le selezioni degli utenti e i risultati delle azioni. Puoi passare i valori di questi parametri tra playbook e flussi.

Dichiarazione dei parametri

Puoi definire parametri di input (lettura) e parametri di output (scrittura).

I parametri hanno un nome, una descrizione e uno dei seguenti tipi:

• Stringa
• Numero
• Booleano
• Tipo di parametro specifico dello strumento

Puoi anche specificare se un parametro è un elenco.

Parametri di input (lettura)

Per ogni playbook, puoi definire parametri di input, chiamati anche parametri di lettura, che consentono ai playbook di utilizzare i valori passati dai flussi e da altri playbook. Ad esempio, un playbook potrebbe ricevere il nome preferito di un utente come parametro e utilizzarlo per ringraziare l'utente personalmente oppure potrebbe ricevere un identificatore dell'ordine come parametro e utilizzarlo per recuperare i dettagli dell'ordine utilizzando uno strumento.

I parametri di input sono definiti per playbook e i playbook non hanno accesso ad altri tipi di parametri della console Dialogflow CX per impostazione predefinita. Quando un flusso passa a un playbook, i parametri di pagina e sessione vengono propagati al playbook se il playbook di destinazione ha un parametro di input con lo stesso nome. Per comunicare informazioni da un flusso a un playbook durante una transizione, definisci i parametri di input del playbook con lo stesso nome di un parametro di sessione o di pagina presente prima della transizione.

Nota: il playbook predefinito non accetta parametri di input perché funge da punto di accesso per le conversazioni degli utenti e non ha modo di riceverli.

Crea esempi per controllare in che modo il valore parametro di input deve influire sulle azioni. Ad esempio, se un parametro di input deve influire sul modo in cui l'agente si riferisce all'utente, crea esempi che definiscono un valore per il parametro e poi utilizza lo stesso valore nelle azioni di espressione all'interno dell'esempio. Per saperne di più, consulta la sezione sul passaggio dei parametri.

Parametri di output (scrittura, ritorno)

Per ogni playbook, puoi definire parametri di output, chiamati anche parametri di scrittura e parametri di ritorno, che consentono ai playbook di emettere informazioni che possono essere utilizzate da altri flussi o playbook. Ad esempio, un playbook potrebbe raccogliere un numero d'ordine da un utente ed emetterlo tramite un parametro di output oppure un playbook potrebbe utilizzare uno strumento per prenotare un volo ed emettere il numero di conferma tramite un parametro di output.

Crea esempi per controllare il modo in cui i playbook determinano il valore di ogni parametro di output. Ad esempio, se un parametro di output che rappresenta un numero di conferma deriva il suo valore dall'output di utilizzo di uno strumento, crea esempi in cui l'output dello strumento corrisponde al valore del parametro di output del playbook.

Passaggio di parametri

Nota: poiché un playbook di attività non può chiamare un playbook della routine, questo scenario di passaggio dei parametri non è descritto nelle sezioni seguenti.

A differenza dei flussi, i playbook non supportano l'inserimento di valori parametro con una sintassi particolare. Al contrario, i playbook si basano su istruzioni ed esempi di prompt few-shot per determinare come utilizzare e decidere i valori dei parametri.

Playbook della routine per il flusso

Per passare i parametri da un playbook della routine a un flusso:

• Definisci i parametri di scrittura per il playbook della routine, che diventano parametri di sessione al termine del playbook della routine.
• Utilizza i parametri di sessione nei flussi.
• Includi l'utilizzo dei parametri nelle istruzioni e negli esempi.

Flusso al playbook della routine

Per passare i parametri da un flusso a un playbook della routine:

• Scrivi i parametri di sessione dal flusso.
• Definisci i parametri di lettura per il playbook della routine con gli stessi nomi.
• Includi l'utilizzo dei parametri nelle istruzioni e negli esempi.

Playbook delle attività per il flusso

Per passare i parametri da un playbook di attività a un flusso:

• Nelle impostazioni del flusso, definisci i parametri di input con gli stessi nomi.
• Includi l'utilizzo dei parametri nelle istruzioni e negli esempi.

Playbook per il flusso verso l'attività

Per passare i parametri da un flusso a un playbook di attività principale:

• Nelle impostazioni del flusso, definisci i parametri di ritorno.
• Includi l'utilizzo dei parametri nelle istruzioni e negli esempi.

Per passare i parametri da un flusso a un playbook di attività secondaria:

• Definisci i parametri di input dell'attività nel playbook dell'attività con lo stesso nome dei parametri di sessione nel flusso.
• Includi l'utilizzo dei parametri nelle istruzioni e negli esempi.

Playbook della routine per il playbook delle attività

Per passare i parametri da un playbook della routine a un playbook dell'attività:

• Definisci i parametri di input per il playbook delle attività utilizzando gli stessi nomi.
• Includi l'utilizzo dei parametri nelle istruzioni e negli esempi.

Esempio che coinvolge gli strumenti

Supponiamo che un agente sia progettato per la vendita di biglietti per un evento con i seguenti playbook delle attività:

• Un playbook denominato Ticket ordering che effettua ordini utilizzando uno strumento denominato Ticket sales API.
  • Questo playbook accetta un parametro di input di tipo number denominato event_id.
  • Lo strumento Ticket sales API prevede una richiesta che includa un event_id.
• Un playbook denominato Event selection che aiuta gli utenti a selezionare un evento e poi li indirizza a Ticket ordering con il parametro event_id per acquistare i biglietti.

In questo esempio, per assicurarti che event_id venga trasmesso in modo affidabile da Event selection a Ticket ordering e da Ticket ordering a Ticket sales API, hai bisogno di diversi esempi.

Il playbook Ticket ordering deve includere più esempi che:

• Specifica il parametro di input event_id con un valore realistico diverso in ogni esempio.
• Includi un'azione di utilizzo dello strumento con un corpo della richiesta che includa lo stesso valore event_id realistico specificato nel parametro di input.

Il playbook Event selection deve includere più esempi che:

• Includi un'espressione dell'utente in cui viene selezionato un evento con un event_id realistico, con un ID diverso in ogni esempio.
• Includi una chiamata del playbook di Ticket ordering che imposta il parametro event_id sullo stesso event_id realistico determinato dalla selezione.

Oltre ad aggiungere esempi, aggiungi istruzioni specifiche alle istruzioni, all'obiettivo o ai dettagli dello strumento che spiegano come utilizzare i parametri.

Ad esempio, il playbook Ticket ordering può includere la seguente istruzione:

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

Con gli esempi e le istruzioni descritti, il playbook Event selection decide correttamente un event_id in base alla selezione dell'utente e lo passa come parametro di input denominato event_id al playbook Ticket ordering. Quindi, Ticket ordering passa lo stesso event_id nel corpo di una richiesta a Ticket sales API. I playbook si basano su esempi con valori parametro distinti per aiutarli a dedurre come vengono utilizzati i parametri.