Brave Search API の Python ラッパー。
Brave Search はあなたやあなたのクエリを追跡しません。プライバシーを保護する Google 検索の代替手段です。開発者がその上に構築できるエンドポイントを多数提供します。このモジュールは Brave Search API のラッパーです。
このリポジトリは現在開発中であるため、機能が変更される可能性があります。ご提案やご要望がございましたら、問題を開いてください。
まず、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
オブジェクトには、Brave Search API によって返されるすべてのデータが含まれます。次のようにして、Web 検索エンドポイントから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 )
pydantic モデルを通じて検証されていない生の JSON 応答を返すには、 raw
フラグを使用します。
from brave import Brave
query = "George Orwell, 1984"
num_results = 10
search_results = brave . search ( q = query , raw = True )
download_pdfs
メソッドを使用して、検索結果で見つかったすべての PDF をダウンロードします。このメソッドは、ダウンロードされた PDF へのファイル パスのリストを返します。ゴーグルを使用すると、検索結果で 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 のランキングを変更できます。誰でもゴーグルを作成、適用、拡張できます。基本的に、ゴーグルは 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 )
このパッケージに直接提供されたゴーグルを利用することもできます。
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 を確認してください。