Websearch Tools

🚀 WebSearch 搜索工具

WebSearch 是一款基於 Python 的高級網絡搜索與內容提取工具，它融合了 Firecrawl 和 OpenAI 的強大功能，能為用戶提供高效且智能的網絡數據採集與分析能力。

🚀 快速開始

WebSearch 結合了 Firecrawl 和 OpenAI 的強大功能，為用戶提供高效、智能的網絡數據採集和分析能力。以下是使用該工具的快速指南：

1. 確保滿足先決條件，包括 Python 版本、包管理器和 API 密鑰。
2. 按照安裝指南克隆倉庫、安裝依賴項並配置環境變量。
3. 根據使用說明將工具集成到 Claude for Desktop 或使用可用工具進行網絡搜索、內容提取和數據分析。

✨ 主要特性

• 強大的網絡爬取：藉助 Firecrawl 的高性能 API 進行網頁抓取。
• 智能內容解析：運用 OpenAI 的 AI 技術實現內容理解和提取。
• 靈活的接口設計：支持多種數據格式輸出（如 JSON、XML 等）。
• 易於集成：提供詳細文檔和示例，方便用戶快速上手。

📦 安裝指南

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 軟件以應用更改。

可用工具

網絡搜索

• 輸入：關鍵詞或查詢語句。
• 輸出：JSON 格式的搜索結果列表，包含標題、鏈接和摘要。

內容提取

• 輸入：網頁 URL。
• 輸出：結構化數據（如文本、圖片鏈接等）。

數據分析

• 輸入：批量 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 密鑰

• OpenAI API Key：訪問 OpenAI 平臺，登錄後進入 API Keys 界面，創建新的 Secret Key。
• Firecrawl API Key：訪問 Firecrawl 官網，註冊或登錄後，在儀表盤中生成新密鑰。

🔧 技術細節

先決條件

1. Python 版本要求：需要 Python 3.6 或更高版本。
2. 包管理工具：確保已安裝 uv 包管理器（用於依賴項管理）。
3. API 密鑰：
   • OpenAI API Key：用於 AI 功能，需從 OpenAI 平臺 獲取。
   • Firecrawl API Key：用於網絡爬取功能，需從 Firecrawl 官網 獲取。

⚠️ 故障排除

錯誤類型

• 確保 .env 文件中的 API 密鑰填寫正確。
• 檢查網絡連接，確保可以訪問外部服務。

常見問題

• 如出現 ConnectionError，可能是代理設置或網絡限制導致。
• 如出現 AuthenticationError，請重新檢查密鑰是否有效。

📞 聯繫方式

• 項目地址：GitHub 地址
• 郵件聯繫：contact@websearchproject.com
• 討論群組：加入 WebSearch 用戶群

感謝您使用 WebSearch 工具！如需幫助，請隨時聯繫我們的支持團隊。