RestApi Retriever
RestApi Retriever envía una pregunta al buscador de documentos que tu empresa ya tiene en marcha, a través de su dirección web, y devuelve los fragmentos que este encuentra. Así puedes usar tu propio buscador dentro de un flujo sin cargar los documentos en NappAI.
Un buscador (retriever) recibe una pregunta y devuelve los fragmentos de documentos que mejor la responden, para que un agente o un modelo conteste con tu información.
Cuándo usarlo
- Tu empresa ya tiene un servicio de búsqueda sobre sus documentos y quieres aprovecharlo desde un flujo.
- Quieres combinar tu buscador propio con otros buscadores de NappAI en un Ensemble Retriever.
Configuración
| Campo | Qué hace |
|---|---|
| URL | La dirección web de tu servicio de búsqueda. Trae una dirección de ejemplo que tienes que cambiar por la de tu servicio. |
| Search Query | La pregunta o las palabras que se buscan, para la salida Search Results. |
| Number of Results | Cuántos fragmentos se piden al buscador. Por defecto: 10. |
No usa credencial y no envía claves de acceso, así que el servicio tiene que aceptar peticiones sin autenticación desde NappAI.
Qué debe hacer tu servicio de búsqueda
El componente envía la petición con el método POST y un cuerpo JSON con dos campos: text, la pregunta, y topK, el número de resultados pedido. El servicio debe responder con una lista JSON en la que cada elemento tenga:
content: el texto del fragmento.score: la puntuación de relevancia.documentId: el identificador del documento.
Si el servicio responde con un error o con otro formato, el componente da un error.
Resultado
- Retriever: el buscador, para conectarlo a componentes que piden un buscador, como Retrieval QA o Retriever Tool.
- Search Results: los fragmentos encontrados para Search Query, cada uno con su puntuación y el identificador de su documento. Puedes pasarlos a un prompt o a un agente.
Ejemplo
Seguros Atalaya tiene un buscador interno sobre sus condiciones de póliza:
- Escribe en URL la dirección del buscador, por ejemplo
https://buscador.atalaya.example/api/search/query. - Conecta la salida Retriever a Retriever de un Retrieval QA.
- Conecta la pregunta del cliente y un modelo al Retrieval QA.
Cuando un cliente pregunta “¿mi póliza cubre los daños por agua?”, el buscador de Atalaya devuelve los fragmentos de las condiciones y el modelo responde a partir de ellos.
Buenas prácticas
- Comprueba con Search Results que tu servicio devuelve fragmentos útiles antes de conectarlo a un agente.
- Ajusta Number of Results: pocos fragmentos pueden dejar fuera información; demasiados hacen que el modelo reciba mucho texto que no necesita.