Saltearse al contenido
Nappai Documentation

Brave Search API Tool

Brave Search API Tool permite a los usuarios buscar información en la web directamente desde el dashboard de Nappai. Al ingresar una consulta, el componente se comunica con la API de Brave Search y devuelve los resultados más relevantes en un formato listo para usar en el flujo de trabajo.

¿Cómo funciona?

El componente envía la consulta introducida en el campo Input a la API de Brave Search, utilizando la clave API que el usuario ha configurado previamente en la sección de credenciales de Nappai. La API devuelve un conjunto de resultados que el componente procesa y convierte en objetos Data. Cada objeto contiene un fragmento de texto (el snippet) que representa la respuesta de la búsqueda. Además, el componente expone el objeto BaseTool que puede ser reutilizado en otras partes del flujo si se necesita una referencia directa al motor de búsqueda.

Entradas

Campos de Entrada

  • Input: Escribe la consulta de búsqueda que deseas enviar a Brave Search. Por ejemplo, “tutoriales de aprendizaje automático”.
  • Number of Results: Define cuántos resultados quieres recibir. El valor predeterminado es 10, pero puedes ajustarlo según tus necesidades.

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

  1. Ve a la sección de credenciales de Nappai y crea una nueva credencial llamada “Brave Search API”, ingresando tu API Key.
  2. En el componente, selecciona esa credencial en el campo Credential. La clave no se mostrará en la interfaz de usuario, lo que garantiza que permanezca segura.

Salidas

  • Data: Una lista de objetos Data que contienen los fragmentos de los resultados de búsqueda. Cada objeto incluye la propiedad snippet, que puedes usar directamente en tu flujo de trabajo.
  • Tool: El objeto BaseTool que representa la herramienta de búsqueda configurada. Puede ser útil si quieres pasar la herramienta a otro componente que requiera un objeto de tipo BaseTool.

Ejemplo de Uso

  1. Configuración

    • Crea la credencial “Brave Search API” con tu API Key.
    • Selecciona la credencial en el componente.

  2. Definir la consulta

    • En el campo Input, escribe: machine learning tutorials.
    • En Number of Results, deja el valor predeterminado (10) o cambia a 5 si prefieres menos resultados.

  3. Ejecutar

    • Conecta la salida Data a un componente de visualización (por ejemplo, un cuadro de texto o una tabla).
    • Los resultados aparecerán como una lista de fragmentos que puedes mostrar al usuario final.

Componentes Relacionados

  • CustomBraveSearchTool – La herramienta interna que se crea a partir de la API de Brave Search.
  • Data – Componente que representa los datos devueltos por el buscador y que se puede usar en otras partes del flujo.

Consejos y Mejores Prácticas

  • Usa consultas claras: Cuanto más específica sea la búsqueda, más relevantes serán los resultados.
  • Ajusta el número de resultados: Si solo necesitas los mejores 3 o 5 resultados, reduce el valor para ahorrar llamadas a la API y mejorar la velocidad.
  • Revisa la política de uso de la API: Asegúrate de no exceder los límites de tu plan de Brave Search.

Consideraciones de Seguridad

  • La API Key se almacena en la sección de credenciales de Nappai y no se muestra en la interfaz del componente.
  • Evita compartir la credencial con usuarios que no necesiten acceso a la búsqueda.
  • Si sospechas que la clave ha sido comprometida, revísala y genera una nueva inmediatamente.