Skip to content

Personal collection of sample code and experiments using the Swarm multi-agent framework.

License

Notifications You must be signed in to change notification settings

Sunwood-ai-labs/swarm-sample-box

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🌟 swarm-sample-box 🌟

GitHub Repo License GitHub stars GitHub release GitHub commit activity PRs Welcome

~ Experimental Playground for AI Agent Orchestration ~

JA doc EN doc

Important

swarm-sample-boxは、cline (旧:Claude Dev), SourceSage, claude.aiを活用して開発されたテンプレートリポジトリです。リリースノート、README、コミットメッセージの大部分は、最新のAI技術を用いて生成されています。

🚀 プロジェクト概要

Swarm Sample Boxは、OpenAIが開発した実験的なマルチエージェントオーケストレーションフレームワーク「Swarm」を活用したAIエージェント実験リポジトリです。このリポジトリは、複数のAIエージェントを効率的に連携させ、複雑なタスクを実行するための軽量で柔軟なソリューションを提供し、開発者の研究と実験を支援します。バージョン: v1.7.0

✨ 主な機能

  1. 多様なエージェントサンプル: 基本的な対話から複雑なタスク処理まで、様々なAIエージェントの実装例を提供
  2. 柔軟なカスタマイズ: 各サンプルは容易に拡張・修正可能で、独自のユースケースに適応可能
  3. 統合実験環境: Docker環境やベクトルデータベース(Qdrant)との連携など、実践的な実験環境を提供
  4. 自動評価機能: 一部のサンプルには自動評価スクリプトが含まれ、エージェントのパフォーマンス測定が可能
  5. Swarmフレームワーク要件定義プロンプト: docs/SWARM_REQUIREMENTS_DEFINITION_PROMPT_V1.md に、AIエージェントシステム構築を支援するプロンプトを提供

🔧 使用方法

  1. リポジトリのクローン:

    git clone https://github.com/Sunwood-ai-labs/swarm-sample-box.git
    cd swarm-sample-box
  2. 仮想環境の作成と有効化:

    python -m venv .venv
    source .venv/bin/activate  # Linux/macOS
    .venv\Scripts\activate  # Windows
  3. 依存関係のインストール:

    pip install -r requirements.txt
  4. OpenAI APIキーの設定:

    export OPENAI_API_KEY="your-api-key"
  5. 特定のサンプルの実行:

    cd examples/<サンプル名>
    python main.py # もしくは run.py

📦 インストール手順

swarm-sample-boxを使用するためのインストール手順は「使用方法」セクションを参照ください。

🆕 最新情報

  • Swarmフレームワークを用いたAIエージェントシステム構築を支援する構造化された要件定義プロンプトが追加されました。 (docs/SWARM_REQUIREMENTS_DEFINITION_PROMPT_V1.md)
  • 既存のサンプルコードとREADMEの改善が行われています。

📚 サンプル一覧

公式サンプル(日本語化)

(🔥の数は、各サンプルの相対的な複雑さと学習曲線を表しています。)

  1. Basic 🔥: 基本的なSwarmの機能を紹介する最小限の実装例です。

  2. Weather Agent 🔥🔥: 天気情報の取得と関連タスクを行うシンプルなエージェントの実装例です。

  3. Triage Agent 🔥🔥: ユーザーリクエストを適切なエージェントに振り分けるトリアージエージェントの実装例です。

  4. Personal Shopper 🔥🔥🔥: 個人向けショッピングアシスタントエージェントの実装例です。

  5. Airline 🔥🔥🔥🔥: 航空会社の顧客サービスを模したマルチエージェントセットアップです。

  6. Support Bot 🔥🔥🔥🔥🔥: カスタマーサポート向けボットの実装例で、Qdrantを使用した文書検索機能を含みます。

  7. 実験段階??: Customer Service Streaming 🔥🔥🔥🔥🔥: ストリーミング形式でのカスタマーサービスを模したサンプルです。

オリジナルサンプル

このセクションでは、独自に開発したサンプルを紹介する予定です。現在準備中ですので、今後のアップデートをお待ちください。

  • [準備中] 新しいオリジナルサンプル1: 詳細は近日公開予定
  • [準備中] 新しいオリジナルサンプル2: 詳細は近日公開予定

🚀 Swarm 公式サンプル チュートリアル

🧪 評価方法

一部のサンプルには自動評価スクリプトが含まれています。評価を実行するには、サンプルディレクトリ内で以下のコマンドを実行します:

pytest evals.py

📄 ライセンス

Swarm Sample Boxは、MITライセンスの下で公開されています。

🙏 謝辞

このプロジェクトは、OpenAIが開発したSwarmフレームワークを基盤としています。Swarmの開発者の皆様に深く感謝申し上げます。このリリースへの貢献者: Maki, iris-s-coon


Swarm Sample Boxを使って、革新的なAIエージェントシステムの開発と実験を始めましょう!詳細な使用方法や各サンプルの説明は、対応するディレクトリ内のREADMEファイルをご覧ください。

About

Personal collection of sample code and experiments using the Swarm multi-agent framework.

Resources

License

Stars

Watchers

Forks

Packages

No packages published