Parámetros de la guía

Las guías pueden aceptar y emitir información de contexto a través de parámetros definidos de forma explícita. Los parámetros se usan para almacenar información sobre una conversación, como las selecciones del usuario, los resultados de las acciones, etcétera. Puedes pasar los valores de estos parámetros entre los playbooks y los flujos.

Declaración de parámetros

Puedes 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 puedes especificar si un parámetro es una lista.

Parámetros de entrada (lectura)

Para cada guía, puedes definir parámetros de entrada, también llamados parámetros de lectura, que permiten que las guías usen valores que se pasan desde flujos y otras guías. Por ejemplo, un playbook podría recibir el nombre preferido de un usuario como parámetro y usarlo para agradecerle personalmente, o podría recibir un identificador de pedido como parámetro y usarlo para recuperar los detalles del pedido con una herramienta.

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

Nota: El playbook predeterminado no acepta parámetros de entrada. El playbook predeterminado sirve como punto de entrada para las conversaciones con el usuario, por lo que no tiene forma de recibir parámetros de entrada.

Crea ejemplos para controlar cómo el valor del parámetro de entrada debe afectar las acciones. Por ejemplo, si un parámetro de entrada debe afectar la forma en que el agente se refiere al usuario, crea ejemplos que definan un valor para el parámetro y, luego, usa el mismo valor en las acciones de expresión dentro del ejemplo. Consulta la sección sobre cómo pasar parámetros para obtener más detalles.

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

Para cada guía, puedes definir parámetros de salida, también llamados parámetros de escritura y parámetros de devolución, que permiten que las guías emitan información para que la usen otros flujos o guías. Por ejemplo, un playbook podría recopilar un número de pedido de un usuario y emitirlo a través de un parámetro de salida, o bien podría 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 el manual debe decidir 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 derivar 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.

Cómo pasar parámetros

Nota: Una guía de tareas no puede llamar a una guía de rutinas, por lo que no se describe el siguiente caso de transferencia de parámetros.

A diferencia de los flujos, los Playbooks no admiten la inserción de valores de parámetros con una sintaxis en particular. En cambio, los playbooks se basan en instrucciones y ejemplos de instrucciones con pocos ejemplos para determinar cómo se deben usar los valores de los parámetros y cómo se deben decidir los valores cuando se especifican los valores de los parámetros.

Guía de rutina para el flujo

Para pasar parámetros de una guía de rutina a un flujo, sigue estos pasos:

• Define los parámetros de escritura para el manual de rutinas. 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 parámetros en las instrucciones y los ejemplos.

Flujo de la guía de rutinas

Para pasar parámetros de un flujo a un manual de rutinas, sigue estos pasos:

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

Guía de tareas para el flujo

Para pasar parámetros de un playbook de tareas a un flujo, haz lo siguiente:

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

Flujo para la guía de tareas

Para pasar parámetros de un flujo a un manual de la tarea principal, haz lo siguiente:

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

Para pasar parámetros de un flujo a un manual de estrategias de tareas secundarias, haz lo siguiente:

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

De la guía de rutina a la guía de tareas

Para pasar parámetros de una guía de rutina a una guía de tareas, haz lo siguiente:

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

Muestra que involucra herramientas

Considera un agente diseñado para la venta de entradas para eventos con los siguientes manuales de tareas:

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

En este ejemplo, para garantizar que event_id se pase de forma confiable 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 cumplan con los siguientes requisitos:

• El parámetro de entrada event_id debe especificarse con algún valor realista, diferente en cada ejemplo.
• Incluye una acción de uso de herramienta con un cuerpo de solicitud que incluya el mismo valor de event_id realista que se especificó en el parámetro de entrada.

La guía Event selection debe incluir varios ejemplos que cumplan con los siguientes requisitos:

• Incluye una expresión del usuario en la que este selecciona un evento con un event_id realista y diferente en cada ejemplo.
• Incluye una invocación de la guía de Ticket ordering que establezca el parámetro event_id en el mismo event_id realista que decidió el usuario en su selección.

Además de agregar ejemplos, intenta agregar instrucciones específicas a los detalles de las instrucciones, el objetivo o la herramienta que expliquen 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 playbook Event selection decide correctamente un event_id según la selección del usuario y lo pasa como un parámetro de entrada llamado event_id al Ticket ordering playbook. Luego, Ticket ordering pasa el mismo event_id en el cuerpo de una solicitud al Ticket sales API. Los playbooks dependen de ejemplos con valores de parámetros distintos para inferir cómo se deben usar los parámetros.