Parámetros de la guía

Los playbooks pueden aceptar y emitir información de contexto mediante parámetros definidos explícitamente. Los parámetros se usan para almacenar información sobre una conversación, como las selecciones de los usuarios, los resultados de las acciones, etc. Puedes transferir los valores de estos parámetros entre los cuadernos de estrategias y los flujos.

Declaración de parámetros

Puede definir parámetros de entrada (lectura) y parámetros de salida (escritura).

Los parámetros tienen un nombre, una descripción y uno de los siguientes tipos:

• String
• Número
• Booleano
• Tipo de parámetro específico de la herramienta

También puede especificar si un parámetro es una lista.

Parámetros de entrada (lectura)

En cada manual de procedimientos, puedes definir parámetros de entrada, también llamados parámetros de lectura, que permiten que los manuales de procedimientos usen valores transferidos desde flujos y otros manuales de procedimientos. Por ejemplo, un manual podría recibir el nombre preferido de un usuario como parámetro y usarlo para darle las gracias personalmente, o podría recibir un identificador de pedido como parámetro y usarlo para obtener los detalles del pedido mediante una herramienta.

Los parámetros de entrada se definen por libro de jugadas y, de forma predeterminada, los libros de jugadas no tienen visibilidad de otros tipos de parámetros de la consola de Dialogflow CX. Cuando un flujo pasa a un manual de estrategias, los parámetros de página y de sesión se propagan al manual si este tiene un parámetro de entrada con el mismo nombre. Para comunicar información de un flujo a un manual durante una transición, define parámetros de entrada del manual con el mismo nombre que un parámetro de sesión o de página presente antes de la transición.

Nota: La guía predeterminada no acepta parámetros de entrada. El manual de respuestas predeterminado sirve como punto de entrada para las conversaciones con los usuarios, por lo que no puede recibir parámetros de entrada.

Crea ejemplos para controlar cómo debe influir el valor del parámetro de entrada en las acciones. Por ejemplo, si un parámetro de entrada debe influir en la forma en que el agente se refiere al usuario, cree ejemplos que definan un valor para el parámetro y, a continuación, use el mismo valor en las acciones de las peticiones dentro del ejemplo. Consulta más información sobre cómo transferir parámetros.

Parámetros de salida (escritura o devolución)

En cada manual de procedimientos, puedes definir parámetros de salida, también llamados parámetros de escritura y parámetros de retorno, que permiten que los manuales de procedimientos emitan información para que la usen otros flujos o manuales de procedimientos. Por ejemplo, un cuaderno de estrategias puede recoger el número de pedido de un usuario y emitirlo a través de un parámetro de salida, o bien puede usar una herramienta para reservar un vuelo y emitir el número de confirmación a través de un parámetro de salida.

Crea ejemplos para controlar cómo debe decidir el manual el valor de cada parámetro de salida. Por ejemplo, si un parámetro de salida que representa un número de confirmación debe obtener su valor de la salida de un uso de herramienta, crea ejemplos en los que la salida del uso de herramienta coincida con el valor del parámetro de salida del playbook.

Transferencia de parámetros

Nota: Un manual de procedimientos de tareas no puede llamar a un manual de procedimientos rutinario, por lo que no se describe a continuación el caso de transferencia de parámetros.

A diferencia de los flujos de trabajo, los manuales no admiten la inserción de valores de parámetros con una sintaxis concreta. En su lugar, los cuadernos de estrategias se basan en instrucciones y ejemplos de peticiones con pocos ejemplos para determinar cómo se deben usar los valores de los parámetros y cómo se deben decidir los valores al especificar los valores de los parámetros.

Guía de rutinas a flujo

Para transferir parámetros de un manual de respuestas automático a un flujo, sigue estos pasos:

• Define los parámetros de escritura de la guía de procedimientos de rutina. Estos parámetros se convertirán en parámetros de sesión.
• Los flujos pueden usar los parámetros de sesión.
• Incluye el uso de los parámetros en las instrucciones y los ejemplos.

Guía de transición a rutinas

Para transferir parámetros de un flujo a un manual de respuestas predefinidas, sigue estos pasos:

• Los flujos escriben los parámetros de sesión.
• Define parámetros de lectura para el manual de procedimientos de rutina con los mismos nombres.
• Incluye el uso de los parámetros en las instrucciones y los ejemplos.

Guía de tareas a flujo de trabajo

Para transferir parámetros de un cuaderno de estrategias de tareas a un flujo, sigue estos pasos:

• En la configuración del flujo, define parámetros de entrada con los mismos nombres.
• Incluye el uso de los parámetros en las instrucciones y los ejemplos.

Flujo de la guía de tareas

Para transferir parámetros de un flujo a un manual de respuestas de una tarea principal, sigue estos pasos:

• En la configuración del flujo, define los parámetros de retorno.
• Incluye el uso de los parámetros en las instrucciones y los ejemplos.

Para transferir parámetros de un flujo a un cuaderno de estrategias de tareas secundarias, sigue estos pasos:

• Define los parámetros de entrada de la tarea que compartan el mismo nombre que los parámetros de sesión del flujo.
• Incluye el uso de los parámetros en las instrucciones y los ejemplos.

Guía de rutinas a guía de tareas

Para transferir parámetros de una guía de procedimientos de rutina a una guía de procedimientos de tarea, sigue estos pasos:

• Define los parámetros de entrada de la guía de tareas con los mismos nombres.
• Incluye el uso de los parámetros en las instrucciones y los ejemplos.

Ejemplo con herramientas

Imagina un agente diseñado para vender entradas para eventos con los siguientes cuadernos de estrategias de tareas:

1. Un manual de estrategias llamado Ticket ordering que hace pedidos con una herramienta llamada Ticket sales API.
   1. Este cuaderno de estrategias acepta un parámetro de entrada de tipo number y nombre event_id.
   2. La herramienta Ticket sales API espera una solicitud que incluya un event_id.
2. Un manual de estrategias llamado Event selection que ayuda a los usuarios a seleccionar un evento y, a continuación, los dirige a Ticket ordering con el parámetro event_id para comprar entradas.

En este ejemplo, para asegurarse de que event_id se transfiere de forma fiable de Event selection a Ticket ordering y de Ticket ordering a Ticket sales API, se necesitan varios ejemplos.

La guía Ticket ordering debe incluir varios ejemplos que:

• El parámetro de entrada event_id debe tener un valor realista y diferente en cada ejemplo.
• Incluye una acción de uso de herramienta con un cuerpo de solicitud que incluya el mismo valor event_id realista que se haya especificado en el parámetro de entrada.

La guía Event selection debe incluir varios ejemplos que:

• Incluye una petición de usuario en la que el usuario selecciona un evento con un valor realista event_id, diferente en cada ejemplo.
• Incluya una invocación de playbook de Ticket ordering que defina el parámetro event_id en el mismo event_id realista que haya elegido el usuario.

Además de añadir ejemplos, prueba a añadir instrucciones específicas a las secciones Instrucciones, Objetivo o Detalles de la herramienta para explicar cómo se deben usar los parámetros. Por ejemplo, el manual Ticket ordering incluye la siguiente instrucción:

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

Con los ejemplos y las instrucciones descritos, el Event selection manual de procedimientos decide correctamente un event_id en función de la selección del usuario y lo transfiere como parámetro de entrada llamado event_id al Ticket ordering playbook. A continuación, Ticket ordering envía el mismo event_id en el cuerpo de una solicitud a Ticket sales API. Los playbooks dependen de ejemplos con valores de parámetros distintos para inferir cómo se deben usar los parámetros.