Ejemplos de guías

Nota: El Generative AI App Builder todavía se refiere a las guías como agentes. Pronto se actualizará a guía en la consola.

Cada guía debe tener uno o más ejemplos. Estos ejemplos son conversaciones de muestra entre un usuario final y la guía, incluido el diálogo y las acciones realizadas por el agente. Estos son, en efecto, ejemplos de instrucciones con varios ejemplos para el LLM.

La interfaz de la consola te permite ingresar acciones.

Agentes multilingües

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

Ejemplo de resumen de entrada y resumen de salida

Además de los parámetros de entrada y salida, las guías admiten recibir un resumen de entrada y emitir un resumen de salida para intercambiar información con otras guías. Los resúmenes son útiles para pasar información contextual abstracta entre guías, mientras que los parámetros son más útiles para pasar campos estructurados y bien definidos entre guías. Los parámetros son la única forma de intercambiar datos entre flujos y guías.

Agrega resúmenes de entrada pertinentes a los ejemplos para condicionar la guía y ajustar sus acciones en función de los resúmenes de entrada en el entorno de ejecución. Agrega resúmenes de resultados que incluyan detalles relevantes y precisos sobre la conversación de ejemplo para mostrarle a la guía qué detalles son importantes para resumir.

Nota: Los ejemplos de la guía predeterminada no pueden definir parámetros de entrada ni un resumen de entrada. La guía predeterminada sirve como un punto de entrada para las conversaciones de los usuarios, por lo que no tiene forma de recibir parámetros de entrada.

Estado de ejemplo

En un punto determinado de la conversación, una guía se encontrará en uno de los siguientes estados:

• OK: La guía logró su objetivo correctamente y el control ahora se transferirá a la guía superior.
• CANCELLED: El usuario decidió no continuar con el objetivo asignado a la guía. El control ahora se transferirá a la guía de tácticas principal. Si la guía superior es un flujo de CX, se detectará la intención de la entrada del usuario antes de que se ejecute el flujo.
• FAILED: La guía 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 error. Se agregará un mensaje EndInteraction a la respuesta.
• ESCALATED: La guía decidió que no puede lograr el objetivo y necesita derivar la situación a un humano. La sesión finalizará con el estado derivado. Se agregará un mensaje EndInteraction a la respuesta.
• PENDING: La conversación aún continúa dentro de la guía.

El ejemplo de nivel superior y sus invocaciones de guía deben indicarse con un estado que corresponda a la guía a la 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 de la guía enviada 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 puede omitirse si la instrucción se acerca al límite de tokens.

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

• No seleccionar nunca: El ejemplo nunca se incluye en la instrucción. El ejemplo no tendrá ningún efecto en el rendimiento de la guía. Este parámetro de configuración es útil para excluir temporalmente un ejemplo para realizar pruebas.

Agregar acción

Un ejemplo proporcionado dentro de una guía consiste en una serie de acciones. Estas acciones pueden variar en sus combinaciones, pero principalmente representan la interacción entre el usuario y la guía, junto con las acciones que se realizan entre ellas para cumplir con la consulta o los requisitos del usuario.

Existen dos maneras de agregar acciones a un ejemplo:

• Para agregar una acción de forma manual, haz clic en el botón + que se encuentra en la parte inferior del panel derecho o en el botón Add action cuando mantengas el puntero sobre las acciones existentes. Puedes usar estas opciones cuando crees un ejemplo nuevo haciendo clic en la opción + Example o cuando edites un ejemplo existente.
• Para generar acciones automáticamente según las instrucciones de la guía existente, ingresa una entrada de usuario en el campo Ingresa la entrada del usuario en la parte inferior del panel derecho. Puedes usar esta opción cuando creas o editas un ejemplo. Como alternativa, puedes usar esta opción cuando pruebes tu guía durante el tiempo de ejecución en el panel Vista previa de la guía de 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 que se encuentra a la izquierda del panel Vista previa de la guía.

Asegúrate de verificar que las acciones generadas automáticamente sean correctas y edítalas si es necesario. Esto es especialmente importante para las guías con pocos o ningún ejemplo.

La guía admite los siguientes tipos de acciones:

Respuesta de la guía

Es la respuesta de la guía a la consulta 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 completar la consulta del usuario. Esta acción debe especificar los siguientes detalles:

• Herramienta: Es el nombre de la herramienta que se debe invocar.

• Acción: Es el nombre de la operación para la herramienta de OpenAPI que se debe invocar. Para 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 OpenAPI, se requiere JSON de requestBody para los tipos de métodos POST, PUT y PATCH.

  Entrada requestBody de la herramienta de API abierta de muestra para la acción createPet:

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

  Para la herramienta de almacén de datos, el requestBody de muestra 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 OpenAPI, también puede ser un error de cadena (por ejemplo, "404 No encontrado").

  Resultado de ejemplo de la herramienta de OpenAPI para la acción listPets:

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

  Resultado de muestra de la herramienta de almacén de datos:

  {
    "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 debería responder cuando falla la invocación de la herramienta. Abrir la herramienta de API La falla de invocación se puede representar como una cadena de error ("404 no encontrado") 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 quieres 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 quieres que responda la guía. Si este URI proviene de la herramienta de almacén de datos, entonces el resultado de la herramienta de almacén de datos debe contener un URI que coincida con el URI de la respuesta de la guía. Ten en cuenta que fallback no se puede usar en esta situación, ya que inhabilitará la capacidad de la guía del LLM de reformular la respuesta de la herramienta de almacén de datos para incluir los URI 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 un uso eficiente de los tokens, asegúrate de que los resultados de las herramientas sean concisos y contengan información relevante para los objetivos de la guía. 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 la guía debe invocar otra guía de tareas para responder la consulta del usuario. Esta acción debe especificar los siguientes detalles:

• Guía: Es el nombre de la guía que se invocará.
• Resumen de entrada de invocación de la guía: Es 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 para pasar a la guía.
• Resumen del resultado de la invocación de la guía: Es un resumen de lo que debería generar la guía cuando se complete su objetivo.
• Parámetros de salida: Son los parámetros de salida que genera la guía cuando se completa su objetivo.

Transición de la guía

Una acción de transición de playbook es una acción terminal (no debe ir seguida de otras acciones) 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, como esta acción indica que la guía sale, agrega los parámetros de salida de la guía al resultado de la guía del ejemplo.

Invocación del flujo

Esta acción se usa cuando la guía de tareas debe invocar un flujo. Esta acción debe 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 del flujo.

Transición de flujo

Una acción de transición de flujo es una acción terminal (no debe ir seguida de otras acciones) que indica que el playbook de rutina decidió salir y realizar la transición a un flujo de destino. Ten en cuenta que, como esta acción indica que la guía sale, agrega los parámetros de salida de la guía al resultado de la guía del ejemplo.