Saltar a contenido

Añadir Middleware API

Para añadir un nuevo middleware API, sigue estos pasos:

Paso 1: Acceder a la configuración

  1. Ve a la sección de Middlewares API
  2. Haz clic en el botón "Añadir"

Paso 2: Configuración básica

Nombre del middleware

Asigna un nombre descriptivo que identifique claramente la función de este middleware.

Método HTTP

Selecciona el método HTTP apropiado:

  • GET: Para obtener datos
  • POST: Para crear o enviar datos
  • PUT: Para actualizar datos completos
  • PATCH: Para actualizaciones parciales
  • DELETE: Para eliminar datos

URL del endpoint

Introduce la URL completa del endpoint de la API que deseas consumir:

https://api.ejemplo.com/v1/endpoint

Paso 3: Tipo de middleware

Tipo de middleware

Selecciona el tipo de middleware a utilizar:

  • Inicializador: El middleware se ejecutará antes del LLM
  • Finalizador: El middleware se ejecutará después del LLM

Nota: Cambiar el tipo de middleware puede afectar a las mutaciones configuradas.

Paso 4: Configuración de body

Define el body que será enviado en la petición en formato JSON. El apartado tiene un botón para comprobar si el formato es correcto.

Paso 5: Configuración de headers

Headers personalizados

Añade headers adicionales si son necesarios: - Content-Type: application/json - Accept: application/json - User-Agent: Tu aplicación - Headers personalizados: Según los requerimientos de la API

Paso 6: Mutaciones

En esta pestaña se puede modificar diversos valores del flujo de la conversación. Dependiendo del tipo de ejecución, los valores a editar serán diferentes

  • Inicializador

    • Input: Permite cambiar el input que recibirá el LLM con un apartado del body recibido. En este campo se escribe el "camino" hacia el valor con este formato: {{clave1.clave2}}
    • Mensajes multimodal: Permite eliminar archivos enviados antes de pasar al LLM, existe la opción de eliminar un archivo "blob" o especificar el formato si se selecciona Fichero. En caso de seleccionar Fichero se podrán elegir formatos especificos de archivos que no se deben eliminar.
    • Cabeceras a modificar: Permite modificar headers con un valor del body recibido, similar a Input. Se debe especificar el header a modificar y el "camino" hacia el valor como se mostró en el apartado de Input

  • Finalizador

    • Output: Igual que el input en Inicializador, pero modificando el output salido del LLM.
    • Cabeceras a modificar: Igual que en Inicializador.

Paso 7: Acciones

Las acciones permiten Cancelar o Redirigir el flujo de la aplicación cuando se cumplan diversas condiciones. En el caso de los middlewares de API las condiciones son las siguientes:

  • Stage: Permite ejecutar la acción en base al momento de ejecuccion en el que se encuentre el flujo de la conversación.
  • Body: Permite ejecutar la acción en base a lo obtenido en el body. Se puede comprobar si un valor específico del body tiene un valor.
  • HTTP_STATUS: Permite ejecutar la acción en base al estado de la respuesta(200, 403, etc...)
  • Headers: Permite ejecutar la acción en base a un valor en un header específico.
  • Input/Output(Si es inicializador/finalizador): Permite ejecutar la acción si el input/output tiene un valor específico.