Saltearse al contenido
Nappai Documentation

Upstash

El componente Upstash permite a los usuarios de Nappai almacenar documentos en una base de datos vectorial de Upstash y realizar búsquedas por similitud. También puede generar un retriever para que otros componentes de la automatización consulten la base de datos de forma eficiente.

¿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) y los envía a la base de datos Upstash. Si no proporcionas un modelo de embeddings propio, el propio Upstash generará los vectores a partir del texto que indiques con el campo Text Key.

Para la operación Search, el componente envía la consulta que escribas en Search Query a Upstash y devuelve los documentos más similares, limitados por el número que especifiques en Number of Results.

La operación Retriever crea un objeto retriever que puede ser usado por otros componentes de Nappai para recuperar documentos de forma programática, sin necesidad de escribir código adicional.

En todas las operaciones el componente necesita una credencial Upstash API que ya debe estar configurada en la sección de credenciales de Nappai. Esa credencial contiene el Index URL y el Index Token que el componente usa para autenticarse con la API de Upstash.

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: Inserta nuevos documentos en la base de datos Upstash. Si no proporcionas un modelo de embeddings, el propio Upstash generará los vectores.
  • Search: Busca los documentos más similares a una consulta de texto y devuelve los resultados.
  • Retriever: Crea un objeto retriever que puede ser usado por otros componentes para obtener documentos de forma programática.

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

Entradas

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

  • Credential: Selecciona la credencial Upstash API previamente configurada en Nappai.

    • Visible en: Add, Search, Retriever

  • Embedding: To use Upstash’s embeddings, don’t provide an embedding.

    • Visible en: Add, Search, Retriever

  • Ingest Data: Los datos que quieres almacenar en la base de datos.

    • Visible en: Add

  • Operation: Elige la operación que quieres ejecutar.

    • Visible en: Add, Search, Retriever

  • Number of Results: Number of results to return.

    • Visible en: Add, Search, Retriever

  • Search Query: Enter a search query. Leave empty to retrieve all documents.

    • Visible en: Search

  • Text Key: The key in the record to use as text.

    • Visible en: Add, Search, Retriever

Nota: Antes de usar el componente, asegúrate de haber configurado la credencial Upstash API en la sección de credenciales de Nappai. Luego, selecciona esa credencial en el campo Credential del componente.

Salidas

  • Retriever: Tipo de datos: Retriever (método: build_base_retriever). Se puede usar en otros componentes que requieran un retriever.
  • Results: Tipo de datos: Data (método: search_documents). Contiene los documentos devueltos por una búsqueda.
  • Vector Store: Tipo de datos: VectorStore (método: cast_vector_store). Representa la base de datos vectorial creada o utilizada.

Ejemplo de Uso

Operación Add

  1. Selecciona la operación Add.
  2. En Credential, elige la credencial Upstash API que ya configuraste.
  3. En Ingest Data, arrastra y suelta los documentos que quieres almacenar (por ejemplo, archivos PDF o textos).
  4. Deja el campo Embedding vacío para que Upstash genere los vectores automáticamente.
  5. Haz clic en Run.
    El componente guardará los documentos en la base de datos Upstash y mostrará un mensaje de éxito.
  1. Selecciona la operación Search.
  2. En Credential, elige la credencial Upstash API.
  3. En Search Query, escribe una frase o palabra clave (por ejemplo, “manual de usuario”).
  4. Ajusta Number of Results si quieres más o menos documentos.
  5. Haz clic en Run.
    El componente devolverá los documentos más similares en la salida Results, que puedes usar en pasos posteriores del flujo.

Componentes Relacionados

  • Embeddings – Genera vectores a partir de texto si decides usar un modelo propio.
  • Vector Store – Representa la base de datos vectorial que se crea o se consulta.
  • Retriever – Permite recuperar documentos de forma programática en otros componentes.

Consejos y Mejores Prácticas

  • Usa credenciales seguras: Nunca compartas el Index Token en el flujo de trabajo; confía en la gestión de credenciales de Nappai.
  • Limita el número de resultados: Un valor alto puede ralentizar la búsqueda y consumir más recursos.
  • Revisa el formato de los documentos: Asegúrate de que el campo indicado en Text Key contenga el texto que quieres indexar.
  • Prueba con un subconjunto de datos: Antes de cargar grandes volúmenes, prueba la operación Add con pocos documentos para verificar que la configuración es correcta.
  • Combina con otros componentes: Usa el retriever generado para alimentar modelos de lenguaje que necesiten contexto de documentos.

Consideraciones de Seguridad

  • La credencial Upstash API debe almacenarse con permisos mínimos; solo los usuarios que necesiten acceder a la base de datos deben tenerla.
  • Evita exponer la salida Results en flujos públicos si contiene información sensible.
  • Si el componente se usa en un entorno multiusuario, revisa que cada usuario utilice su propia credencial para evitar accesos no autorizados.