Ejemplos de guías

Nota: En la consola Aplicaciones de IA, los playbooks siguen denominándose agentes. Pronto se actualizará a guía en la consola.

Cada guía debe tener uno o varios ejemplos. Estos ejemplos son conversaciones de muestra entre un usuario final y el cuaderno de estrategias, que incluyen el diálogo y las acciones realizadas por el agente. Estos son, en esencia, ejemplos de peticiones con pocos ejemplos para el LLM.

La consola proporciona una interfaz para que introduzcas acciones.

Agentes multilingües

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

Ejemplo de resumen de entrada y de resumen de salida

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

Añade resúmenes de entrada relevantes a los ejemplos para condicionar el cuaderno de estrategias de forma que ajuste sus acciones en función de los resúmenes de entrada en el tiempo de ejecución. Añade resúmenes de la salida que incluyan detalles relevantes y precisos sobre la conversación de ejemplo para mostrarle al manual qué detalles son importantes para resumir.

Nota: Es posible que los ejemplos de la guía predeterminada no definan parámetros de entrada ni un resumen 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.

Ejemplo de estado

En un momento dado de la conversación, un manual de respuestas tendrá uno de los siguientes estados:

• OK: la guía ha alcanzado su objetivo y ahora el control se transferirá a la guía principal.
• CANCELLED: El usuario ha decidido no continuar con el objetivo asignado al manual de estrategias. Ahora, el control se transferirá al manual para padres. Si el manual de respuestas principal es un flujo de experiencia de cliente, se detectará la intención de la entrada del usuario antes de que se ejecute el flujo.
• FAILED: El manual no puede continuar con el objetivo debido a un error (por ejemplo, la herramienta devuelve un error 500). La sesión finalizará con el estado de error. Se añadirá un mensaje EndInteraction a la respuesta.
• ESCALATED: la guía ha determinado que no puede alcanzar el objetivo y necesita derivar la situación a un agente humano. La sesión finalizará con el estado "Derivado". Se añadirá un mensaje EndInteraction a la respuesta.
• PENDING: La conversación sigue en la guía.

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

Estrategia de selección

El ajuste de la estrategia de selección controla si se incluye un ejemplo en la petición del libro de jugadas que se envía al LLM. Se encuentran disponibles las siguientes opciones:

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

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

• Nunca seleccionar: el ejemplo nunca se incluye en la petición. El ejemplo no afectará al rendimiento del manual de estrategias. Este ajuste es útil para excluir temporalmente un ejemplo con fines de prueba.

Añadir 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 realizadas entre ellas para cumplir la consulta o los requisitos del usuario.

Hay dos formas de añadir acciones a un ejemplo:

• Para añadir una acción manualmente, haz clic en el botón + situado en la parte inferior del panel de la derecha o en el botón Añadir acción cuando coloques el puntero sobre las acciones que ya tengas. Puede usar estas opciones cuando cree un ejemplo haciendo clic en + Ejemplo o cuando edite uno que ya tenga.
• Para generar acciones automáticamente a partir de las instrucciones de la guía, introduce una petición en el campo Introduce una petición, situado en la parte inferior del panel de la derecha. Puede usar esta opción al crear o editar un ejemplo. También puedes usar esta opción cuando pruebes tu manual de respuestas en tiempo de ejecución en el panel Vista previa del manual de respuestas de la derecha. Para guardar acciones en un ejemplo del 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 de la izquierda del panel Vista previa de la guía.

Comprueba que las acciones generadas automáticamente sean correctas y edítalas si es necesario. Esto es especialmente importante en el caso de las guías que tienen pocos ejemplos o ninguno.

El manual admite los siguientes tipos de acciones:

Respuesta de la guía

La respuesta de la guía a la consulta del usuario.

Entrada del usuario

La consulta del usuario.

Uso de herramientas

Se trata de una invocación de herramienta para obtener información adicional necesaria para responder a la consulta del usuario. Esta acción debe especificar los siguientes detalles:

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

• Acción: nombre de la operación de la herramienta OpenAPI que se debe invocar. En el caso de las herramientas de almacenamiento de datos y las herramientas de funciones, el nombre de la acción es el mismo que el de la herramienta.

• Entrada de la herramienta: entradas que se incluirán en la llamada a la herramienta. Normalmente, se derivan de las conversaciones anteriores con el usuario.

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

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

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

  En el caso de la herramienta de almacén de datos, el ejemplo requestBody donde la consulta es obligatoria 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."
  }
  

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

  Ejemplo de salida de herramienta de API abierta para la acción listPets:

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

  Ejemplo de salida de la herramienta de almacenamiento 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 asegurarte de que la guía sea infalible, incluye ejemplos de cómo debe responder la guía cuando falle la invocación de la herramienta. Un error al invocar la herramienta de APIs abiertas se puede representar como una cadena de error ("404 not found") en el resultado de la herramienta. En el caso de las herramientas de almacenamiento 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 almacenamiento de datos incluya URIs en la respuesta del playbook, añade ejemplos que contengan el URI con el que quieres que responda el playbook. Si este URI procede de la herramienta de almacenamiento de datos, la salida de la herramienta de almacenamiento de datos debe contener un URI que coincida con el URI de la respuesta del cuaderno de estrategias. La nota fallback no se puede usar en este caso, ya que inhabilitará la capacidad del cuaderno de estrategias LLM para reformular la respuesta de la herramienta de almacén de datos e incluir URIs en la respuesta del cuaderno de estrategias.

Los ejemplos que contienen acciones de uso de herramientas pueden ser bastante extensos y contribuir a aumentar el consumo del límite de tokens de entrada. Para asegurarte de que los tokens se usen de forma eficiente, comprueba que los resultados de las herramientas sean concisos y contengan información relevante para los objetivos del cuaderno de estrategias. En el caso de las herramientas de almacenamiento de datos, considera la posibilidad de eliminar 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 a la consulta del usuario. Esta acción debe especificar los siguientes detalles:

• Guía: nombre de la guía que se va a invocar.
• Resumen de la entrada de invocación de la guía: un resumen de las partes relevantes de la conversación anterior útil para la guía que se está invocando.
• Parámetros de entrada: Parámetros de entrada que se pasarán a la guía.
• Resumen de la salida de invocación de la guía: un resumen de lo que debe generar la guía cuando se complete su objetivo.
• Parámetros de salida: Parámetros de salida generados por la guía al completar su objetivo.

Transición de la guía

Una acción de transición de una guía es una acción terminal (no debe ir seguida de otras acciones) que indica que la guía de rutinas ha decidido salir y pasar a una guía de rutinas de destino. Ten en cuenta que, como esta acción indica que la guía se cierra, añade los parámetros de salida de la guía al ejemplo de salida de la guía.

Invocación de flujo

Esta acción se usa cuando el manual de tareas debe invocar un flujo. Esta acción debe especificar los siguientes detalles:

• Flujo: nombre del flujo que se va a invocar.
• Parámetros de entrada del flujo: parámetros de entrada que se van a transferir al flujo.
• Parámetros de retorno del flujo: parámetros de salida devueltos por el 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 manual de procedimientos de la rutina ha decidido salir y pasar a un flujo de destino. Ten en cuenta que, como esta acción indica que la guía se cierra, añade los parámetros de salida de la guía al ejemplo de salida de la guía.