Ejemplos de guías

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 tu agente controla varios idiomas, usa cada uno de ellos en tus ejemplos.

Ejemplos de resúmenes de entrada y 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 relevantes a los ejemplos para ayudar a la guía a ajustar sus acciones en función de esos resúmenes de entrada en el entorno de ejecución. Agrega resúmenes de resultados que incluyan detalles pertinentes y precisos sobre la conversación de ejemplo para mostrarle a la guía qué detalles son importantes para resumir.

Estado de ejemplo

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

  • OK: La guía logró su objetivo correctamente y el control se transfiere a la guía superior.
  • CANCELLED: El usuario decide no continuar con el objetivo asignado al playbook y el control se transfiere al playbook principal. Si la guía superior es un flujo de CX, Dialogflow CX detecta el intent de entrada del usuario antes de que se ejecute el flujo.
  • FAILED: La guía no puede continuar con el objetivo debido a un error (por ejemplo, una herramienta devuelve un error 500). La sesión finaliza con el estado de error. Se agrega un mensaje EndInteraction a la respuesta.
  • ESCALATED: La guía decide que no puede lograr el objetivo y necesita derivar la situación a un humano. La sesión finaliza con el estado Derivada. Se agrega un mensaje EndInteraction a la respuesta.
  • PENDING: La conversación continúa dentro de la guía.

Debes indicar el ejemplo de nivel superior y sus invocaciones de guía 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 enviada al LLM para la guía.

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. Puedes omitir el ejemplo 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. Puedes omitir el ejemplo si la instrucción se acerca al límite de tokens.
  • Nunca seleccionar: El ejemplo no se incluye en la instrucción. El ejemplo no tiene 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 en una guía contiene una serie de acciones. Estas acciones pueden variar en combinación, pero principalmente representan la interacción entre tú y la guía, junto con las acciones que se realizan entre ellas para cumplir con tu consulta o tus requisitos.

Puedes agregar acciones a un ejemplo de dos maneras:

  • 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. Usa estas opciones cuando crees un ejemplo nuevo haciendo clic en la opción + Ejemplo o cuando edites un ejemplo existente.
  • Para generar acciones automáticamente según las instrucciones de la guía existente, ingresa la entrada del usuario en el campo Ingresa la entrada del usuario en la parte inferior del panel derecho. Usa esta opción cuando crees o edites un ejemplo. Como alternativa, usa 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 Guía de vista previa, 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 Guía de vista previa.

Verifica 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

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

Entrada del usuario

Ingresa la consulta del usuario.

Uso de herramientas

Obtener información adicional necesaria para completar la consulta del usuario con una invocación de herramienta

Esta acción especifica los siguientes detalles:

  • Herramienta: Es el nombre de la herramienta que debes invocar.
  • Acción: Es el nombre de la operación para la herramienta de OpenAPI que debes invocar. Para las herramientas de almacén de datos y las herramientas 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. Estas entradas suelen derivarse de turnos de conversación anteriores con el usuario.

    Para las herramientas de OpenAPI, se requiere JSON de requestBody para los tipos de métodos POST, PUT y PATCH.

    Entrada de requestBody de la herramienta de OpenAPI de ejemplo para la acción createPet:

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

    Para la herramienta de almacén de datos, el requestBody de muestra indica dónde 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 a 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 ejemplo de la herramienta de almacén de datos para la consulta "¿Dónde está la tienda más cercana?":

    {
  "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, incluye ejemplos de cómo responde la guía cuando falla la invocación de la herramienta. Puedes representar la falla de invocación de la herramienta de OpenAPI 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, puedes usar la entrada fallback para especificar cómo responder si no hay una respuesta resumida.

Si quieres que tu herramienta de almacén de datos incluya un 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.

Los ejemplos que contienen acciones de uso de herramientas pueden ser bastante detallados y aumentar el consumo del límite de tokens de entrada. Para usar tokens de manera eficiente, 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 causan un alto consumo de tokens de entrada.

Invocación de la guía

Usa esta acción cuando la guía deba invocar otra guía de tareas para completar la consulta del usuario.

Especifica los siguientes detalles para esta acción:

  • 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 invocada.
  • Parámetros de entrada: Son los parámetros de entrada que se pasarán 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 que no debe ir seguida de otras acciones, lo que indica que el playbook de rutina decidió salir y hacer la transición a un playbook de rutina de destino. Debido a que 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 que no debe ir seguida de otras acciones, lo que indica que la guía de rutina decidió salir y realizar la transición a un flujo de destino. 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.

Anterior
Acciones condicionales de la guía
Siguiente
Parámetros de la guía