Websearch Tools

🚀 WebSearch 検索ツールの日本語説明ドキュメント

WebSearchは、Pythonベースの高度なウェブ検索およびコンテンツ抽出ツールです。FirecrawlとOpenAIの強力な機能を組み合わせ、ユーザーに効率的でインテリジェントなウェブデータ収集と分析機能を提供します。

✨ 主な機能

• 強力なウェブクローリング：Firecrawlの高性能APIを利用してウェブページを取得します。
• インテリジェントなコンテンツ解析：OpenAIのAI技術を通じてコンテンツの理解と抽出を実現します。
• 柔軟なインターフェース設計：JSON、XMLなどの複数のデータ形式の出力をサポートします。
• 統合が容易：詳細なドキュメントとサンプルが提供され、ユーザーがすぐに使い始められます。

📦 インストール

前提条件

1. Pythonバージョン：
   • Python 3.6以上が必要です。
2. パッケージ管理ツール：
   • uv パッケージマネージャーがインストールされていることを確認してください（依存関係の管理に使用）。
3. APIキー：
   • OpenAI API Key：AI機能に使用し、OpenAI プラットフォーム から取得する必要があります。
   • Firecrawl API Key：ウェブクローリング機能に使用し、Firecrawl 公式サイト から取得する必要があります。

インストール手順

1. リポジトリをクローンする

git clone https://github.com/yourusername/WebSearch.git
cd WebSearch

2. 依存関係をインストールする

uv パッケージマネージャーを使用してすべての依存関係をインストールします。

uv install requirements.txt

3. 環境変数を設定する

.env ファイルを作成して編集します（ファイルはプロジェクトのルートディレクトリに配置する必要があります）。

OPENAI_API_KEY=your_openai_key_here
FIRECRAWL_API_KEY=your_firecrawl_key_here

💻 使用例

Claude for Desktopへの統合

1. claudius.json ファイルを開きます。
2. ルートディレクトリに以下の設定を追加します。

{
  "webSearch": {
    "apiKey": "your_firecrawl_api_key",
    "aiIntegration": true,
    "proxyEnabled": false
  }
}

3. Claudeソフトウェアを再起動して変更を適用します。

利用可能なツール

1. ウェブ検索：
   • 入力：キーワードまたはクエリ文。
   • 出力：JSON形式の検索結果リスト（タイトル、リンク、要約を含む）。
2. コンテンツ抽出：
   • 入力：ウェブページのURL。
   • 出力：構造化データ（テキスト、画像リンクなど）。
3. データ分析：
   • 入力：大量のURLリスト。
   • 出力：統計レポートまたは可視化グラフ。

📚 ドキュメント

APIリファレンス

ウェブ検索インターフェース

def search(query: str, count: int = 10) -> dict:
    """
    ウェブ検索を実行し、結果を返します。
    
    Args:
        query (str): 検索キーワード。
        count (int): 結果の数（デフォルトは10）。
        
    Returns:
        dict: JSON形式の検索結果データ。
    """

コンテンツ抽出インターフェース

def extract(url: str) -> dict:
    """
    指定されたウェブページのコンテンツを抽出します。
    
    Args:
        url (str): コンテンツを抽出するURL。
        
    Returns:
        dict: JSON形式の構造化データ結果。
    """

設定ガイド

環境変数の設定

.env ファイルを作成し、以下の内容を追加します。

# OpenAI API Key - AI機能に使用
OPENAI_API_KEY=your_openai_api_key_here

# Firecrawl API Key - ウェブクローリング機能に使用
FIRECRAWL_API_KEY=your_firecrawl_api_key_here

APIキーの取得

1. OpenAI API Key：
   • OpenAI プラットフォーム にアクセスします。
   • ログイン後、API Keys画面に移動し、新しいSecret Keyを作成します。
2. Firecrawl API Key：
   • Firecrawl 公式サイト にアクセスします。
   • 登録またはログイン後、ダッシュボードで新しいキーを生成します。

🔧 トラブルシューティング

1. エラーの種類：
   • .env ファイル内のAPIキーが正しく入力されていることを確認してください。
   • ネットワーク接続を確認し、外部サービスにアクセスできることを確認してください。
2. 一般的な問題：
   • ConnectionError が発生した場合は、プロキシ設定またはネットワーク制限が原因である可能性があります。
   • AuthenticationError が発生した場合は、キーが有効かどうかを再度確認してください。

お問い合わせ

• プロジェクトのURL：GitHub アドレス
• メールでの連絡：contact@websearchproject.com
• ディスカッショングループ：WebSearchユーザーグループ に参加してください。

WebSearchツールをご利用いただき、ありがとうございます！ご質問やご相談がある場合は、いつでもサポートチームにお問い合わせください。