Saltearse al contenido
Nappai Documentation

Redis

El componente Redis permite a los usuarios guardar y recuperar documentos de forma rápida y eficiente utilizando la base de datos en memoria Redis. Con él, puedes crear un almacén de vectores que se integra con tus modelos de embeddings y realizar búsquedas por similitud o simplemente obtener un retriever listo para usar en tus flujos de trabajo.

¿Cómo funciona?

Cuando seleccionas la operación Add, el componente toma los datos que ingresas (pueden ser textos, archivos o cualquier objeto que se pueda convertir en documento), los divide en fragmentos de hasta 1000 caracteres y los almacena en un índice de Redis junto con sus vectores de embedding.
Con la operación Search, el componente envía tu consulta a Redis y devuelve los documentos más similares, basándose en la distancia entre vectores.
La operación Retriever simplemente construye y devuelve un objeto retriever que puedes usar en otras partes de tu flujo sin realizar una búsqueda inmediata.

El componente se conecta a Redis mediante la credencial Redis API que ya debe estar configurada en Nappai. Esa credencial contiene la cadena de conexión (incluye la contraseña) necesaria para acceder al servidor Redis.

Operaciones

Este componente ofrece varias operaciones que puedes seleccionar según lo que necesites hacer. Solo puedes usar una operación a la vez:

  • Add: Ingesta de nuevos documentos en el índice de Redis.
  • Search: Busca documentos similares a una consulta dada.
  • Retriever: Crea y devuelve un retriever para usar en otras partes del flujo.

Para usar el componente, primero selecciona la operación que necesitas en el campo “Operation” (Operación).

Entradas

Campos de Entrada

Los siguientes campos están disponibles para configurar este componente. Cada campo puede estar visible en diferentes operaciones:

  • Embedding: Selecciona el modelo de embeddings que se usará para convertir los textos en vectores.

    • Visible en: Add, Search, Retriever

  • Ingest Data: Los documentos que quieres almacenar en Redis. Pueden ser textos, archivos o cualquier objeto que se pueda convertir en documento.

    • Visible en: Add

  • Operation: Elige la operación que quieres ejecutar (Add, Search o Retriever).

    • Visible en: Add, Search, Retriever

  • Number of Results: Número de resultados que quieres recibir cuando realices una búsqueda.

    • Visible en: Add, Search, Retriever

  • Redis Index: Nombre del índice dentro de Redis donde se guardarán los vectores.

    • Visible en: Add, Search, Retriever

  • Schema: Esquema opcional que define la estructura de los documentos en el índice.

    • Visible en: Add, Search, Retriever

  • Search Query: Texto de la consulta que quieres buscar. Si lo dejas vacío, se devolverán todos los documentos.

    • Visible en: Search

Nota importante: Este componente necesita una credencial de tipo Redis API.

  1. Configura la credencial en la sección de credenciales de Nappai.
  2. Selecciona esa credencial en el campo Credential del componente.
    Los datos de la credencial (como la cadena de conexión) no aparecen en la lista de entradas.

Salidas

  • Retriever: Un objeto retriever que puedes usar en otras partes del flujo para obtener documentos basados en consultas.
  • Results: Lista de documentos encontrados cuando se ejecuta la operación Search.
  • Vector Store: El objeto VectorStore completo que representa el índice en Redis.

Ejemplo de Uso

Operación Add

  1. Selecciona Add en el campo Operation.
  2. Conecta el campo Embedding con tu modelo de embeddings preferido.
  3. Arrastra tus documentos al campo Ingest Data.
  4. Especifica un nombre para el Redis Index y, opcionalmente, un Schema.
  5. Ajusta Number of Results si lo necesitas.
  6. Ejecuta el componente. Los documentos se guardarán en Redis y el flujo continuará con la salida Vector Store.
  1. Selecciona Search en el campo Operation.
  2. Conecta el campo Embedding con el mismo modelo usado al agregar los documentos.
  3. Escribe tu consulta en Search Query.
  4. Ajusta Number of Results para limitar la cantidad de resultados.
  5. Ejecuta el componente. La salida Results contendrá los documentos más similares.

Operación Retriever

  1. Selecciona Retriever en el campo Operation.
  2. Conecta el campo Embedding con tu modelo.
  3. Ejecuta el componente. La salida Retriever puede ser conectada a otros componentes que requieran un retriever.

Componentes Relacionados

  • Embeddings – Genera los vectores que el componente Redis necesita para indexar y buscar documentos.
  • Vector Store – Representa cualquier almacén de vectores; Redis es una implementación específica.
  • Retriever – Herramienta que permite obtener documentos basados en consultas; el componente Redis puede generar un retriever listo para usar.

Consejos y Mejores Prácticas

  • Usa un esquema consistente para tus documentos; esto facilita la búsqueda y el análisis posterior.
  • Ajusta el tamaño de los fragmentos (chunk_size) si tus documentos son muy largos o muy cortos.
  • Mantén la credencial Redis API segura y actualízala regularmente.
  • Si trabajas con datos sensibles, considera cifrar los documentos antes de almacenarlos.

Consideraciones de Seguridad

  • La credencial Redis API contiene la contraseña del servidor Redis; asegúrate de que solo usuarios autorizados tengan acceso a ella.
  • Evita exponer la cadena de conexión en logs o en la interfaz de usuario.
  • Si tu instancia de Redis está expuesta a Internet, habilita TLS y utiliza políticas de acceso restrictivas.