Ejemplos de guías

Nota: La consola de AI Applications aún se refiere a los playbooks como agentes. Pronto se actualizará a manual en la consola.

Cada guía debe tener uno o más ejemplos. Estos ejemplos son conversaciones de muestra entre un usuario final y el manual, que incluyen el diálogo y las acciones que realiza el agente. Estos son, en efecto, ejemplos de instrucciones con pocos ejemplos para el LLM.

La consola proporciona una interfaz para que ingreses acciones.

Agentes multilingües

Si quieres que tu agente controle varios idiomas, tus ejemplos deben usar cada uno de ellos.

Ejemplo de resumen de entrada y resumen de salida

Además de los parámetros de entrada y salida, los playbooks admiten la recepción de un resumen de entrada y la emisión de un resumen de salida para intercambiar información con otros playbooks. Los resúmenes son útiles para pasar información contextual abstracta entre los playbooks, mientras que los parámetros son más útiles para pasar campos estructurados y bien definidos entre los playbooks. Los parámetros son la única forma de intercambiar datos entre flujos y guiones.

Agrega resúmenes de entrada pertinentes a los ejemplos para condicionar la guía y ajustar sus acciones según los resúmenes de entrada en el tiempo de ejecución. Agrega resúmenes de la salida, incluidos detalles relevantes y precisos sobre la conversación de ejemplo, para mostrarle a la guía qué detalles son importantes para resumir.

Nota: Es posible que los ejemplos del manual predeterminado no definan parámetros de entrada ni un resumen de entrada. El playbook predeterminado sirve como punto de entrada para las conversaciones con los usuarios, por lo que no tiene forma de recibir parámetros de entrada.

Ejemplo de estado

En un momento determinado de la conversación, un manual estará en uno de los siguientes estados:

• OK: La guía logró su objetivo, y el control ahora se transferirá a la guía principal.
• CANCELLED: El usuario decidió no continuar con el objetivo asignado a la guía. Ahora el control se transferirá al manual de estrategias para madres y padres. Si el manual principal es un flujo de CX, se detectará la intención de la entrada del usuario antes de que se ejecute el flujo.
• FAILED: El playbook no puede continuar con el objetivo debido a algún error (p.ej., la herramienta devuelve un error 500). La sesión finalizará con el estado de falla. Se agregará un mensaje EndInteraction a la respuesta.
• ESCALATED: La guía decidió que no puede alcanzar el objetivo y necesita derivar la situación a un humano. La sesión finalizará con el estado de derivación. Se agregará un mensaje EndInteraction a la respuesta.
• PENDING: La conversación continúa dentro de la guía.

El ejemplo de nivel superior y sus invocaciones de playbook deben denotarse con un estado que corresponda al playbook al que hacen referencia.

Estrategia de selección

El parámetro de configuración de la estrategia de selección controla si se incluye un ejemplo en la instrucción del manual que se envía al LLM. Las siguientes opciones están disponibles:

• Selección dinámica: El ejemplo se incluye de forma condicional, según su relevancia para el contexto de la conversación actual. El ejemplo se puede omitir si la instrucción se acerca al límite de tokens.

• Siempre seleccionado: El ejemplo siempre se incluye, independientemente del contexto de la conversación. El ejemplo se puede omitir si la instrucción se acerca al límite de tokens.

• Nunca seleccionar: El ejemplo nunca se incluye en la instrucción. El ejemplo no afectará el rendimiento del manual. Este parámetro de configuración es útil para excluir temporalmente un ejemplo para realizar pruebas.

Agregar acción

Un ejemplo proporcionado en una guía consta de una serie de acciones. Estas acciones pueden variar en sus combinaciones, pero principalmente describen la interacción entre el usuario y el manual, junto con las acciones que se realizan en el medio para satisfacer la búsqueda o los requisitos del usuario.

Existen dos formas de agregar acciones a un ejemplo:

• Para agregar una acción de forma manual, haz clic en el botón + en la parte inferior del panel derecho o en el botón Agregar acción cuando mantengas el puntero sobre las acciones existentes. Puedes usar estas opciones cuando creas un ejemplo nuevo haciendo clic en la opción + Ejemplo o cuando editas un ejemplo existente.
• Para generar acciones automáticamente según las instrucciones existentes del manual, ingresa una entrada del usuario en el campo Enter user input ubicado en la parte inferior del panel derecho. Puedes usar esta opción cuando crees o edites un ejemplo. Como alternativa, puedes usar esta opción cuando pruebes tu guía en el tiempo de ejecución en el panel Vista previa de la guía a la derecha. Para guardar acciones en un ejemplo desde el panel Vista previa de la guía, haz clic en Guardar ejemplo después de seleccionar la invocación de la guía en la lista de invocaciones a la izquierda del panel Vista previa de la guía.

Asegúrate de verificar la exactitud de las acciones generadas automáticamente y editarlas si es necesario. Esto es especialmente importante para los manuales con pocos ejemplos o sin ejemplos.

El manual admite los siguientes tipos de acciones:

Respuesta de la guía

Es la respuesta del playbook a la búsqueda del usuario.

Entrada del usuario

Es la consulta del usuario.

Uso de herramientas

Esta es una invocación de herramienta para obtener información adicional necesaria para satisfacer la búsqueda del usuario. En esta acción, se deben especificar los siguientes detalles:

• Herramienta: Nombre de la herramienta que se debe invocar.

• Action: Nombre de la operación para la herramienta de OpenAPI que se debe invocar. En el caso de las herramientas de almacén de datos y la herramienta de función, el nombre de la acción es el mismo que el de la herramienta.

• Entrada de la herramienta: Son las entradas que se incluirán en la llamada a la herramienta. Por lo general, se derivan de los turnos de conversación anteriores con el usuario.

  En el caso de las herramientas de la API abierta, se requiere requestBody JSON para los tipos de métodos POST, PUT y PATCH.

  Ejemplo de entrada de la herramienta de Open API para la acción createPet:requestBody

  {
    "id": 1,
    "name": "Luna"
  }
  

  Para la herramienta de almacén de datos, el ejemplo requestBody en el que se requiere la consulta y otros campos son opcionales.

  {
    "query": "Where is my nearest store?",
    "filter": "country: ANY(\"United States\")",
    "userMetadata": {
      "userCity": "San Francisco",
    },
    "fallback": "We don't have any stores in your area."
  }
  

• Resultado de la herramienta: Es la respuesta de la invocación de la herramienta. Esta es una respuesta JSON válida de la herramienta para la entrada proporcionada. En el caso de las herramientas de API abierta, también puede ser un error de cadena (por ejemplo, "404 No encontrado").

  Ejemplo de salida de la herramienta de OpenAPI para la acción listPets:

  {
    "pets": [
      {
        "id": 1,
        "name": "Luna"
      },
      {
        "id": 2,
        "name": "Charlie"
      }]
  }
  

  Ejemplo de resultado de la herramienta Sample Data store:

  {
    "answer": "Here's the address to your nearest store ...",
    "snippets": [
      {
        "title": "San Francisco Downtown",
        "uri": "https://www.example.com/San_Francisco_Downtown",
        "text": "Address for San Francisco Downtown .."
      }
    ]
  }
  

Para garantizar que la guía sea a prueba de fallas, también incluye ejemplos de cómo debe responder la guía cuando falla la invocación de la herramienta. La falla en la invocación de la herramienta de la API abierta se puede representar como una cadena de error ("404 not found") en el resultado de la herramienta. En el caso de las herramientas de almacén de datos, la entrada fallback se puede usar para especificar cómo responder si no hay una respuesta resumida.

Si deseas que tu herramienta de almacén de datos incluya el URI en la respuesta de la guía, agrega ejemplos que contengan el URI con el que deseas que responda la guía. Si este URI proviene de la herramienta de almacenamiento de datos, el resultado de la herramienta de almacenamiento de datos debe contener un URI que coincida con el URI de la respuesta del manual. La nota fallback no se puede usar en este caso porque inhabilitará la capacidad de la guía de LLM para reformular la respuesta de la herramienta de almacén de datos y, así, incluir URIs en la respuesta de la guía.

Los ejemplos que contienen acciones de uso de herramientas pueden ser bastante detallados y contribuir a un mayor consumo del límite de tokens de entrada. Para garantizar el uso eficiente de los tokens, asegúrate de que los resultados de las herramientas sean concisos y contengan información pertinente para los objetivos del playbook. En el caso de las herramientas de almacén de datos, considera quitar fragmentos de los ejemplos, ya que pueden contribuir a un alto consumo de tokens de entrada.

Invocación de la guía

Esta acción se usa cuando el playbook debe invocar otro playbook de tareas para satisfacer la búsqueda del usuario. En esta acción, se deben especificar los siguientes detalles:

• Playbook: Es el nombre de la guía que se invocará.
• Resumen de la entrada de invocación de la guía: Un resumen de las partes pertinentes de la conversación anterior que son útiles para la guía que se invoca.
• Parámetros de entrada: Parámetros de entrada que se pasarán al manual.
• Resumen del resultado de la invocación de la guía: Un resumen de lo que debería generar la guía cuando se complete su objetivo.
• Parámetros de salida: Parámetros de salida que genera el playbook cuando se completa su objetivo.

Transición de la guía

Una acción de transición de la guía es una acción terminal (no debe seguirla ninguna otra acción) que indica que la guía de rutina decidió salir y realizar la transición a una guía de rutina de destino. Ten en cuenta que, dado que esta acción indica que se sale de la guía, agrega los parámetros de salida de la guía a la salida de la guía del ejemplo.

Invocación de flujo

Esta acción se usa cuando el manual de estrategias de la tarea debe invocar un flujo. En esta acción, se deben especificar los siguientes detalles:

• Flujo: Es el nombre del flujo que se invocará.
• Parámetros de entrada del flujo: Son los parámetros de entrada que se pasarán al flujo.
• Parámetros de devolución del flujo: Son los parámetros de salida que se devuelven desde el flujo.

Transición de flujo

Una acción de transición de flujo es una acción terminal (no debe seguirla ninguna otra acción) que indica que la guía de rutinas decidió salir y realizar la transición a un flujo de destino. Ten en cuenta que, dado que esta acción indica que se sale de la guía, agrega los parámetros de salida de la guía a la salida de la guía del ejemplo.