Skip to content

Latest commit

 

History

History
185 lines (134 loc) · 9.26 KB

README_JA.md

File metadata and controls

185 lines (134 loc) · 9.26 KB

PySpur

PySpurはPython製のAIエージェントビルダーです。AIエンジニアはこれを利用してエージェントを構築し、ステップバイステップで実行し、過去の実行結果を検証します。

英語版README 简体中文版自述文件 日本語のREADME 韓国語版README ドイツ語版README フランス語版README スペイン語版README

ドキュメント お会いしましょう クラウド Discordに参加する

hero.mp4

🕸️ なぜ PySpur なのか？

  • 🖐️ ドラッグ＆ドロップ: 数秒で構築、テスト、反復できます。
  • 🔄 ループ: メモリを活用した反復的なツール呼び出し。
  • 📤 ファイルアップロード: ファイルのアップロードやURLの貼り付けによりドキュメントを処理します。
  • 📋 構造化された出力: JSONスキーマ用のUIエディタ。
  • 🗃️ RAG: データを解析、分割、埋め込み、そしてVector DBにアップサートします。
  • 🖼️ マルチモーダル: ビデオ、画像、オーディオ、テキスト、コードに対応。
  • 🧰 ツール: Slack、Firecrawl.dev、Google Sheets、GitHubなど多数。
  • 🧪 評価: 実際のデータセットでエージェントを評価します。
  • 🚀 ワンクリックデプロイ: APIとして公開し、どこにでも統合可能。
  • 🐍 Pythonベース: 単一のPythonファイルを作成するだけで新しいノードを追加できます。
  • 🎛️ どのベンダーにも対応: 100以上のLLMプロバイダー、エンベッダー、Vector DBに対応。

⚡ クイックスタート

オプション A: pyspur Pythonパッケージの使用

これは最も迅速なスタート方法です。Python 3.12以上が必要です。

  1. PySpurのインストール:

    pip install pyspur

  2. 新しいプロジェクトの初期化:

    pyspur init my-project
cd my-project

    これにより、.envファイルを含む新しいディレクトリが作成されます。

  3. サーバーの起動:

    pyspur serve --sqlite

    デフォルトでは、SQLiteデータベースを使用して http://localhost:6080 でPySpurアプリが起動します。より安定した動作を求める場合は、.envファイルにPostgresのインスタンスURLを設定することを推奨します。

  4. [オプション] デプロイのカスタマイズ: PySpurのデプロイは以下の2通りの方法でカスタマイズできます：

    a. アプリ内から (推奨): - アプリ内の「APIキー」タブに移動する - 各種プロバイダー（OpenAI、Anthropicなど）のAPIキーを追加する - 変更は即座に反映される

    b. 手動設定: - プロジェクトディレクトリ内の .env ファイルを編集する - より信頼性を高めるために、.envでPostgresデータベースを設定することを推奨 - pyspur serve でアプリを再起動する。Postgresを使用していない場合は --sqlite を追加する

オプション B: Dockerの利用（スケーラブルな本番システム向けに推奨）

本番環境でのデプロイにはこちらの方法を推奨します：

  1. Dockerのインストール: まず、お使いのOSに合わせた公式インストールガイドに従い、Dockerをインストールしてください：

  2. PySpurプロジェクトの作成: Dockerをインストールしたら、以下のコマンドで新しいPySpurプロジェクトを作成します：

    curl -fsSL https://raw.githubusercontent.com/PySpur-com/pyspur/main/start_pyspur_docker.sh | bash -s pyspur-project

    このコマンドは以下の処理を行います：

    • pyspur-project という新しいディレクトリ内にPySpurプロジェクトを作成
    • 必要な設定ファイルを構成
    • ローカルのPostgres Dockerインスタンスをバックエンドに、PySpurアプリを自動で起動

  3. PySpurへのアクセス: ブラウザで http://localhost:6080 にアクセスしてください。

  4. [オプション] デプロイのカスタマイズ: a. アプリ内から (推奨): - アプリ内の「APIキー」タブに移動する - 各種プロバイダー（OpenAI、Anthropicなど）のAPIキーを追加する - 変更は即座に反映される

    b. 手動設定: - プロジェクトディレクトリ内の .env ファイルを編集する - 以下のコマンドでサービスを再起動する： sh docker compose up -d

以上です！「New Spur」をクリックしてワークフローを作成するか、標準テンプレートから開始してください。

✨ 主な利点

ノードレベルでのデバッグ:

visualization.mp4

マルチモーダル（ファイルアップロードまたはURL貼り付け）

PDF、ビデオ、オーディオ、画像、…

multimodal.mp4

ループ

Loops

RAG

ステップ 1) ドキュメントコレクションの作成（チャンク分割＋解析）

RAG_1.mp4

ステップ 2) ベクターインデックスの作成（埋め込み＋Vector DBアップサート）

RAG_2.mp4

モジュール式ビルディングブロック

blocks.mp4

最終パフォーマンスの評価

evals.mp4

近日公開予定：自己改善

optimization.mp4

🛠️ PySpur 開発環境セットアップ

[ Unix系システムでの開発向けの手順です。Windows/PCでの開発はサポートされていません ]

開発のためには、以下の手順に従ってください：

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

    git clone https://github.com/PySpur-com/pyspur.git
cd pyspur

  2. docker-compose.dev.ymlを使用して起動:

    docker compose -f docker-compose.dev.yml up --build -d

    これにより、開発用にホットリロードが有効なPySpurのローカルインスタンスが起動します。

  3. セットアップのカスタマイズ: 環境設定のために .env ファイルを編集してください。デフォルトでは、PySpurはローカルのPostgreSQLデータベースを使用しています。外部データベースを使用する場合は、.env 内の POSTGRES_* 変数を変更してください.

⭐ サポート

スターを押していただくことで、私たちの活動をサポートしていただけます。ありがとうございます！

star

皆様のフィードバックを大変ありがたく思います。 次にどの機能を見たいか、または全く新しい機能のリクエストがあれば、ぜひお知らせください.