Parámetros de la guía

Las guías pueden aceptar y emitir información de contexto con 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 guías y 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 pasados desde flujos y otras guías. Por ejemplo, una guía puede recibir el nombre preferido de un usuario como parámetro y usarlo para agradecerle personalmente, o puede 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 guía, y las guías no tienen visibilidad de otros tipos de parámetros de la consola de Dialogflow CX de forma predeterminada. Cuando un flujo pasa a una guía, los parámetros de página y sesión se propagan a la guía si la guía de destino tiene un parámetro de entrada con el mismo nombre. Para comunicar información de un flujo a una guía durante una transición, define los parámetros de entrada de la guía 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. La guía predeterminada sirve como punto de entrada para las conversaciones de los usuarios, 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 enunciado dentro del ejemplo. Consulta 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, una guía puede recopilar un número de pedido de un usuario y emitirlo a través de un parámetro de salida, o una guía 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 la guía 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 del resultado del uso de una herramienta, crea ejemplos en los que el resultado del uso de la herramienta coincida con el valor del parámetro de salida de la guía.

Cómo pasar parámetros

Nota: Una guía de tareas no puede llamar a una guía de rutina, por lo que esa situación de transferencia de parámetros no se describe a continuación.

A diferencia de los flujos, las guías no admiten la inserción de valores de parámetros con una sintaxis particular. En cambio, las guías se basan en instrucciones y ejemplos de instrucciones con algunos 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 a flujo

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

• Define los parámetros de escritura para la guía 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 parámetros en las instrucciones y los ejemplos.

Flujo al playbook de rutina

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

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

Guía de tarea a flujo

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

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

Flujo a la guía de tareas

Para pasar parámetros de un flujo a una guía de tareas superior, 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 una guía de tarea secundaria, haz lo siguiente:

• Define los parámetros de entrada de la tarea que comparten 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 playbook de rutina a playbook de tarea

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

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

Ejemplo que involucra herramientas

Considera un agente diseñado para la venta de entradas para eventos con las siguientes guías de tareas:

1. Una guía llamada Ticket ordering que realiza pedidos con una herramienta llamada Ticket sales API.
   1. Esta guía 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. Una guía llamada 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 de Ticket ordering debe incluir varios ejemplos que cumplan con lo siguiente:

• Especifica el parámetro de entrada event_id con un valor realista, diferente en cada ejemplo.
• Incluye una acción de uso de herramientas con un cuerpo de solicitud que incluya el mismo valor realista de event_id que se especifica en el parámetro de entrada.

La guía de Event selection debe incluir varios ejemplos que cumplan con lo siguiente:

• Incluye un enunciado del usuario en el que este seleccione un evento con un event_id realista, diferente en cada ejemplo.
• Incluye una invocación de guía de Ticket ordering que establezca el parámetro event_id en el mismo event_id realista que se decidió según la selección del usuario.

Además de agregar ejemplos, intenta agregar instrucciones específicas a las instrucciones, el objetivo o los detalles de la herramienta para explicar cómo se deben usar los parámetros. Por ejemplo, la guía 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, la guía de 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 a la Ticket ordering playbook. Luego, Ticket ordering pasa el mismo event_id en el cuerpo de una solicitud a Ticket sales API. Las guías dependen de ejemplos con valores de parámetros distintos para ayudarlas a inferir cómo se deben usar los parámetros.