Genai Toolbox

🚀 Toolbox 項目文檔

Toolbox 是一個綜合性平臺，用於管理工具和數據源。它支持多種交互方式，還提供靈活的配置選項。用戶通過 tools.yaml 文件，就能輕鬆定義數據源、工具及其參數。

🚀 快速開始

Toolbox 是用於管理工具和數據源的綜合性平臺，支持多種交互方式，可通過 tools.yaml 文件定義數據源、工具及其參數。以下是快速啟動步驟：

1. 克隆倉庫

git clone https://github.com/your-repository.git
cd your-repository

2. 安裝依賴

pip install -r requirements.txt

3. 啟動服務

python main.py

4. 配置環境變量（建議）

export TOOLBOX_HOME=~/toolbox-config
export DB_URL=postgresql://user:password@localhost:5432/database

✨ 主要特性

• 數據源管理：支持多種數據庫類型，如 PostgreSQL 和 MySQL。
• 工具定義：允許用戶自定義 SQL 查詢和其他類型的工具操作。
• 工具集管理：通過 toolsets 功能，用戶可以將多個工具組合在一起使用。

📦 安裝指南

快速安裝

# 克隆倉庫
git clone https://github.com/your-repository.git
cd your-repository

# 安裝依賴
pip install -r requirements.txt

# 啟動服務
python main.py

配置環境變量

在啟動 Toolbox 之前，建議配置以下環境變量：

export TOOLBOX_HOME=~/toolbox-config
export DB_URL=postgresql://user:password@localhost:5432/database

💻 使用示例

數據源配置（sources.yaml）

sources:
  my-pg-source:
    kind: postgres
    host: 127.0.0.1
    port: 5432
    database: toolbox_db
    user: toolbox_user
    password: my-password

工具配置（tools.yaml）

tools:
  search-hotels-by-name:
    kind: postgres-sql
    source: my-pg-source
    description: 搜索基於名稱的酒店。
    parameters:
      - name: name
        type: string
        description: 酒店名稱。
    statement: SELECT * FROM hotels WHERE name ILIKE '%' || $1 || '%';

工具集配置（toolsets.yaml）

toolsets:
  my_first_toolset:
    - my_first_tool
    - my_second_tool
  my_second_toolset:
    - my_second_tool
    - my_third_tool

📚 詳細文檔

數據源配置

在 sources.yaml 文件中，用戶可以定義多個數據源。每個數據源都有一個唯一標識符和相關連接參數。

示例：

sources:
  pg_source1:
    kind: postgres
    host: 127.0.0.1
    port: 5432
    database: testdb
    user: admin
    password: secret

工具配置

在 tools.yaml 文件中，用戶可以定義多個工具。每個工具都有一個唯一標識符、類型、關聯的數據源以及執行的具體操作。

示例：

tools:
  get_user_info:
    kind: postgres-sql
    source: pg_source1
    description: 獲取用戶信息。
    parameters:
      - name: user_id
        type: integer
        description: 用戶ID。
    statement: SELECT * FROM users WHERE id = $1;

工具集配置

通過 toolsets.yaml 文件，用戶可以將多個工具組合在一起，形成一個工具組。這使得在實際應用中可以更方便地管理和使用工具。

示例：

toolsets:
  user_management_toolset:
    - get_user_info
    - update_user_profile
  data_analysis_toolset:
    - fetch_data
    - analyze_results

🔖 版本控制

該項目遵循語義化版本控制（Semantic Versioning），格式為 MAJOR.MINOR.PATCH。具體含義如下：

• MAJOR：當主要功能發生變化或向下不兼容時，增加主版本號。
• MINOR：添加新功能或改進現有功能而不破壞向後兼容性時，增加次版本號。
• PATCH：修復已知問題和漏洞時，增加補丁版本號。

🤝 貢獻指南

如何貢獻代碼

1. Fork 倉庫
2. 創建功能分支
3. 提交代碼
4. 提交 Pull Request

示例提交信息格式：

feat: 新增工具配置功能
fix: 修復數據源連接問題
docs: 更新文檔說明

如何報告問題

請通過以下渠道報告任何問題或提出反饋：

• GitHub Issues: https://github.com/your-repository/issues
• 郵件: support@toolbox.com

📖 附錄

常見問題解答（FAQ）

1. 如何配置環境變量？
   • 按照文檔中的“配置環境變量”部分進行操作。
2. 支持哪些數據庫類型？
   • 當前支持 PostgreSQL 和 MySQL，未來計劃增加更多類型。
3. 如何定義新的工具？
   • 在 tools.yaml 文件中添加新的工具條目，並確保其語法正確。

聯繫方式

• 官方網站: https://www.toolbox.com
• 開發者郵件列表: dev@toolbox.com
• 中文社區: https://community.toolbox.com/c/zh-CN

感謝您使用 Toolbox！如需進一步幫助，請隨時聯繫我們的支持團隊。