Saltearse al contenido
Nappai Documentation

Vectara

Vectara es un componente que permite almacenar y buscar documentos en el servicio de vectores de Vectara.
Con él puedes añadir tus propios textos a un corpus de Vectara y luego recuperar los más relevantes usando embeddings.

¿Cómo funciona?

El componente se conecta al API de Vectara usando la credencial que hayas configurado previamente.
Cuando seleccionas la operación Add, el componente toma los documentos que le entregas (a través de Ingest Data), los convierte en el formato que Vectara necesita y los sube al corpus especificado.
Con la operación Search envía tu consulta de búsqueda al API de Vectara y devuelve los documentos más similares, limitados por Number of Results.
La operación Retriever crea un objeto que puede usarse en otros flujos para recuperar documentos de forma programática.

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 le entregues al corpus de Vectara.
  • Search: Busca los documentos más relevantes según una consulta de texto.
  • Retriever: Crea un objeto que permite recuperar documentos de Vectara en flujos posteriores.

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 ser visible en diferentes operaciones:

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

    • Visible en: Add, Search, Retriever

  • Ingest Data: Lista de documentos que quieres añadir al corpus.

    • Visible en: Add

  • Operation: Selecciona 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 busques.

    • 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

  • Credential: Selecciona la credencial Vectara API que configuraste en la sección de credenciales de Nappai.

    • Visible en: Add, Search, Retriever

Nota: Antes de usar el componente, debes crear una credencial de tipo Vectara API en la sección de credenciales de Nappai. Esa credencial debe incluir:

  • Vectara Customer ID
  • Vectara Corpus ID
  • Vectara API Key
    Luego, selecciona esa credencial en el campo Credential del componente.

Salidas

  • Retriever: Un objeto que permite recuperar documentos de Vectara en flujos posteriores.
  • Results: Lista de documentos encontrados cuando se usa la operación Search.
  • Vector Store: El objeto Vectara que representa el almacén de vectores.

Ejemplo de Uso

Operación Add

  1. Selecciona Add en el campo Operation.
  2. Conecta la salida de un componente que genere documentos (por ejemplo, un extractor de texto) al campo Ingest Data.
  3. Elige el modelo de embeddings que prefieras en Embedding.
  4. Selecciona la credencial Vectara API en Credential.
  5. Haz clic en Run.
    El componente subirá los documentos al corpus y mostrará un mensaje de confirmación.
  1. Selecciona Search en el campo Operation.
  2. Escribe la consulta de búsqueda en Search Query (por ejemplo, “cómo configurar la API”).
  3. Elige el modelo de embeddings en Embedding (el mismo que usaste al añadir).
  4. Selecciona la credencial Vectara API en Credential.
  5. Haz clic en Run.
    El componente devolverá los documentos más relevantes en la salida Results.

Componentes Relacionados

  • Embeddings – Genera los vectores que Vectara necesita para indexar y buscar.
  • Vector Store – Representa el almacén de vectores en Nappai.
  • Retriever – Permite usar la búsqueda en flujos más complejos.

Consejos y Mejores Prácticas

  • Usa el mismo modelo de embeddings tanto para añadir como para buscar; de lo contrario, los resultados pueden ser inconsistentes.
  • Limita Number of Results a un valor razonable (por ejemplo, 4–10) para evitar sobrecargar la respuesta.
  • Si trabajas con datos sensibles, revisa que la credencial Vectara API esté protegida y que el acceso al API esté restringido a los usuarios necesarios.

Consideraciones de Seguridad

  • La credencial Vectara API contiene tu API Key; no la compartas públicamente.
  • Asegúrate de que solo los usuarios autorizados tengan acceso a la sección de credenciales de Nappai.
  • Si necesitas revocar el acceso, actualiza o elimina la credencial en la sección de credenciales y vuelve a configurarla en el componente.