Genai Toolbox

🚀 Toolbox プロジェクトドキュメント

Toolbox は、ツールとデータソースを管理する総合的なプラットフォームです。複数のインタラクション方式をサポートし、柔軟な設定オプションを提供します。tools.yaml ファイルを使用することで、ユーザーは簡単にデータソース、ツール、およびそれらのパラメータを定義できます。

🚀 クイックスタート

Toolbox をすぐに使い始めることができます。以下の手順に従って、インストールと起動を行いましょう。

✨ 主な機能

• データソース管理：PostgreSQL や MySQL など、複数のデータベースタイプをサポートします。
• ツール定義：ユーザーが SQL クエリやその他のタイプのツール操作をカスタマイズできます。
• ツールセット管理：toolsets 機能を通じて、複数のツールをまとめて使用できます。

📦 インストール

クイックインストール

以下のコマンドを実行して、Toolbox をインストールします。

# リポジトリをクローンする
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

💻 使用例

基本的な使用法

Toolbox の基本的な使用方法をいくつかの例で説明します。

データソース設定（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 をご利用いただき、ありがとうございます。さらなる支援が必要な場合は、いつでもサポートチームにお問い合わせください。