Saltearse al contenido
Nappai Documentation

Couchbase

El componente Couchbase permite a los usuarios de Nappai almacenar y buscar documentos en una base de datos Couchbase usando embeddings. Con él, puedes agregar nuevos documentos, buscar los más similares a una consulta o simplemente obtener un objeto que te permita hacer búsquedas más adelante.

¿Cómo funciona?

El componente se conecta a tu clúster de Couchbase usando la credencial que hayas configurado previamente en Nappai. Cuando añades documentos, los convierte en vectores con el modelo de embeddings que elijas y los guarda en la colección especificada. Cuando buscas, envía la consulta a Couchbase y devuelve los documentos que más se parezcan al vector de la consulta. Si solo necesitas un objeto que realice búsquedas más adelante, el componente te devuelve un Retriever que puedes usar en otras partes de tu flujo.

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: Añade los documentos que ingreses al vector store.
  • Search: Busca los documentos más similares a una consulta de texto.
  • Retriever: Devuelve un objeto que permite realizar búsquedas en el futuro.

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: Modelo de embeddings que se usará para convertir los textos en vectores.

    • Visible en: Add, Search, Retriever

  • Ingest Data: Documentos que quieres agregar al vector store.

    • Visible en: Add

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

    • Visible en: Add, Search, Retriever

  • Bucket Name: Nombre del bucket de Couchbase donde se guardarán los documentos.

    • Visible en: Add, Search, Retriever

  • Collection Name: Nombre de la colección dentro del bucket.

    • Visible en: Add, Search, Retriever

  • Index Name: Nombre del índice que Couchbase usará para las búsquedas.

    • Visible en: Add, Search, Retriever

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

    • Visible en: Add, Search, Retriever

  • Scope Name: Nombre del scope dentro del bucket.

    • Visible en: Add, Search, Retriever

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

    • Visible en: Search

Nota sobre credenciales
Este componente necesita una credencial de tipo Couchbase 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 (cadena de conexión, usuario y contraseña) no aparecen en la lista de entradas porque ya están gestionados por Nappai.

Salidas

  • Retriever: Un objeto que permite hacer búsquedas en el vector store en flujos posteriores.
  • Results: Lista de documentos que coinciden con la búsqueda.
  • Vector Store: El propio vector store, útil si quieres usarlo directamente en otro componente.

Ejemplo de Uso

Operación Add

  1. Selecciona Operation = Add.
  2. En Embedding elige el modelo de embeddings que prefieras.
  3. En Ingest Data carga los documentos que quieres almacenar.
  4. Rellena Bucket Name, Scope Name, Collection Name e Index Name con los valores de tu clúster.
  5. Haz clic en Run.
    El componente guardará los documentos en Couchbase y devolverá el vector store.
  1. Selecciona Operation = Search.
  2. En Embedding elige el mismo modelo que usaste al agregar.
  3. En Search Query escribe la frase que quieres buscar.
  4. Ajusta Number of Results si quieres más o menos resultados.
  5. Rellena los campos de bucket, scope, collection e índice.
  6. Haz clic en Run.
    El componente devolverá los documentos más similares a tu consulta.

Componentes Relacionados

  • OpenAI Vector Store – Almacena embeddings generados por OpenAI.
  • FAISS Vector Store – Vector store local rápido y ligero.
  • Pinecone Vector Store – Vector store en la nube con escalabilidad automática.

Consejos y Mejores Prácticas

  • Usa un número razonable de resultados (por ejemplo, 4–10) para mantener la velocidad de respuesta.
  • Mantén tus credenciales en la sección de credenciales de Nappai y no las escribas directamente en el flujo.
  • Si vas a usar el componente en producción, revisa los límites de tu clúster de Couchbase para evitar sobrecargas.
  • Cuando añadas documentos, verifica que el modelo de embeddings sea el mismo que usarás para las búsquedas para asegurar coherencia.

Consideraciones de Seguridad

  • Almacena la credencial de Couchbase con permisos mínimos: solo lectura/escritura en los buckets necesarios.
  • Evita exponer la credencial en logs o en la interfaz de usuario.
  • Si compartes el flujo con otros usuarios, asegúrate de que tengan acceso solo a las credenciales que realmente necesitan.