brave api

API храброго поиска

Обзор

Оболочка Python для API Brave Search.

Brave Search не отслеживает вас или ваши запросы. Это альтернатива Google Search, обеспечивающая конфиденциальность. Он предлагает множество конечных точек, на которых разработчики могут работать. Этот модуль представляет собой оболочку API Brave Search.

Репозиторий находится в активной разработке, функциональность может измениться. Если у вас есть какие-либо предложения или пожелания, пожалуйста, откройте вопрос.

Установка

Для начала установите пакет с помощью pip:

pip install brave-search

Использование

Модуль поддерживает как синхронные, так и асинхронные запросы. Ваш ключ Brave API можно передать либо как переменную среды в BRAVE_API_KEY , либо как аргумент класса Brave.

 from brave import Brave

brave = Brave ()

query = "cobalt mining"
num_results = 10

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

Объект search_results будет включать все данные, возвращаемые API Brave Search. Вы можете получить доступ к результатам Web , News и Video из конечной точки веб-поиска следующим образом:

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

Модуль также поддерживает асинхронные запросы:

 from brave import AsyncBrave

brave = AsyncBrave ()

query = "cobalt mining"
num_results = 10

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

Чтобы вернуть необработанный ответ JSON, который не был проверен с помощью модели pydantic, используйте raw флаг:

 from brave import Brave

query = "George Orwell, 1984"
num_results = 10

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

Функции

Скачать PDF-файлы:

Используйте метод download_pdfs , чтобы загрузить все PDF-файлы, найденные в результатах поиска. Этот метод возвращает список путей к загруженным PDF-файлам. Вы можете использовать Goggles для повышения эффективности PDF-файлов в результатах поиска.

 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 ()

Совокупные данные о ценах

Используйте метод product_prices , чтобы получить список цен для набора результатов поиска. Этот метод возвращает список цен, найденных в результатах поиска. Если цены не найдены, возвращается пустой список. Этот метод в настоящее время не поддерживает конвертацию валют.

    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)

Совокупные данные обзора

Используйте метод average_product_review_score , чтобы получить среднюю оценку обзора для набора результатов поиска. Этот метод преобразует все оценки отзывов в 100-балльную шкалу.

 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

Очки

Brave — это мощная поисковая система, которая позволяет использовать goggles для изменения рейтинга результатов поиска в соответствии с вашими потребностями. Очки позволяют любому человеку или сообществу людей изменять рейтинг Brave Search с помощью набора инструкций (правил и фильтров). Любой может создать, применить или расширить Goggle. По сути, Goggles действуют как средство индивидуального повышения рейтинга в верхней части поискового индекса Brave.

Здесь мы используем очки, которые отдают приоритет академическим и архивным источникам.

 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 )

Вы также можете использовать очки Goggles, которые были непосредственно включены в этот пакет:

 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 )

Локальная установка

Этот пакет использует Poetry для управления зависимостями. Чтобы начать разработку здесь, вам необходимо установить Poetry

• Следуйте инструкциям в официальных документах.

После установки Poetry в вашей системе просто запустите:

make init

Разработка

Посетите CONTRIBUTING.md для получения информации о том, как развивать этот проект.