brave api

API de búsqueda valiente

Descripción general

Envoltorio de Python para la API Brave Search.

Brave Search no lo rastrea a usted ni a sus consultas, es una alternativa a la Búsqueda de Google que preserva la privacidad. Ofrece muchos puntos finales para que los desarrolladores puedan construir sobre ellos. Este módulo es un contenedor para la API Brave Search.

Este repositorio está en desarrollo activo, la funcionalidad puede cambiar. Si tiene alguna sugerencia o solicitud, abra un problema.

Instalación

Para comenzar, instale el paquete usando pip:

pip install brave-search

Uso

El módulo admite solicitudes tanto sincrónicas como asincrónicas. Su clave Brave API se puede pasar como una variable de entorno en BRAVE_API_KEY o como un argumento para la clase Brave.

 from brave import Brave

brave = Brave ()

query = "cobalt mining"
num_results = 10

search_results = brave . search ( q = query , count = num_results )

El objeto search_results incluirá todos los datos devueltos por Brave Search API. Puede acceder a resultados Web , News y Video desde el punto final de búsqueda web de la siguiente manera:

 web_results = search_results . web_results
news_results = search_results . news_results
video_results = search_results . video_results

El módulo también admite solicitudes asincrónicas:

 from brave import AsyncBrave

brave = AsyncBrave ()

query = "cobalt mining"
num_results = 10

search_results = await brave . search ( q = query , count = num_results )

Para devolver la respuesta JSON sin formato que no ha sido validada a través del modelo pydantic, utilice la bandera raw :

 from brave import Brave

query = "George Orwell, 1984"
num_results = 10

search_results = brave . search ( q = query , raw = True )

Características

Descargar archivos PDF:

Utilice el método download_pdfs para descargar todos los archivos PDF que se encuentran en los resultados de la búsqueda. Este método devuelve una lista de rutas de archivos a los archivos PDF descargados. Puede utilizar Goggles para aumentar los archivos PDF en sus resultados de búsqueda.

 from brave import Brave

brave = Brave ()

query = "cobalt mining"
num_results = 10

search_results = brave . search ( q = query , count = num_results )

search_results . download_pdfs ()

Datos de precios agregados

Utilice el método product_prices para obtener una lista de precios para un conjunto de resultados de búsqueda. Este método devuelve una lista de precios encontrados en los resultados de la búsqueda. Si no se encuentran precios, se devuelve una lista vacía. Actualmente, este método no admite la conversión de monedas.

    from brave import Brave

    brave = Brave ()

    query = "Blue Tack"
    num_results = 10
    country = "US"
    search_results = brave . search ( q = query , count = num_results , country = country )
    print ( search_results . product_prices ())
    # >> [6.28, 5.98, 4.99, 13.18, 6.59, 7.8, 5.56, 10.79, 5.02, 10.56, 16.95, 9.99, 23.59, 16.31, 11.96]
    print ( search_results . product_price_ranges ())
    # >> (4.99, 23.59)

Datos agregados de revisión

Utilice el método average_product_review_score para obtener la puntuación de revisión promedio para un conjunto de resultados de búsqueda. Este método convierte todas las puntuaciones de las revisiones a una escala de 100 puntos.

 from brave import Brave

brave = Brave ()

query = "Blue Tack"
num_results = 10
search_results = brave . search ( q = query , count = num_results )
print ( search_results . average_product_review_score ())
# >> 88.13333333333333

Gafas de protección

Brave es un potente motor de búsqueda que permite el uso de goggles para reclasificar los resultados de búsqueda para satisfacer su caso de uso. Las gafas permiten a cualquier individuo (o comunidad de personas) alterar la clasificación de Brave Search mediante el uso de un conjunto de instrucciones (reglas y filtros). Cualquiera puede crear, aplicar o ampliar Goggle. Básicamente, Goggles actúa como una reclasificación personalizada además del índice de búsqueda de Brave.

Aquí utilizamos unas gafas que priorizan las fuentes académicas y de archivo.

 from brave import Brave

query = "cobalt mining"
goggle_url = "https://raw.githubusercontent.com/CSamuelAnderson/Brave-goggles/main/academic-and-archival.goggle"
num_results = 10
result_filter = "web" # must be comma separated string

search_results = brave . search ( q = query , goggles_id = goggle_url , count = num_results , result_filter = result_filter )

También puede utilizar las Goggles que se han contribuido directamente a este paquete:

 from brave import Brave
from brave . goggles import thought_leadership

query = "cobalt mining"
num_results = 10

search_results = brave . search ( q = query , goggles_id = thought_leadership , count = num_results )

Instalación local

Este paquete utiliza Poetry para la gestión de dependencias. Para comenzar a desarrollar aquí, necesitas instalar Poetry.

• Siga las instrucciones en los documentos oficiales.

Una vez que haya instalado Poetry en su sistema, simplemente ejecute:

make init

Desarrollo

Consulte CONTRIBUTING.md para obtener información sobre cómo desarrollar este proyecto.