From e52c8ed4dcf320bb982d32da872c5e477fb65220 Mon Sep 17 00:00:00 2001 From: Ikko Eltociear Ashimine Date: Sun, 6 Oct 2024 01:31:35 +0900 Subject: [PATCH] docs: add Japanese README I created Japanese translated README. --- README.md | 1 + README_cn.md | 1 + README_ja.md | 185 +++++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 187 insertions(+) create mode 100644 README_ja.md diff --git a/README.md b/README.md index b323ba3..d218f79 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,7 @@

简体中文 | English | + 日本語 | Getting Started

diff --git a/README_cn.md b/README_cn.md index 7fe89fb..8a0217b 100644 --- a/README_cn.md +++ b/README_cn.md @@ -3,6 +3,7 @@

简体中文 | English | + 日本語 | 快速开始

diff --git a/README_ja.md b/README_ja.md new file mode 100644 index 0000000..fc0f195 --- /dev/null +++ b/README_ja.md @@ -0,0 +1,185 @@ +## 📃 NextAGIFuture + +

+ 简体中文 | + English | + 日本語 | + 始め方 +

+ +LangChain、LangGraph、およびその他のフレームワークに基づいたチャットボット、RAG、エージェント、およびマルチエージェントアプリケーションプロジェクトで、オープンソースであり、オフライン展開が可能です。 + + +### 🤖️ 概要 + +![image](https://github.com/user-attachments/assets/22583a25-4cee-43af-9d8e-38a491377875) + +#### ワークフロー + +![image](https://github.com/user-attachments/assets/a4e33565-7acf-45d9-8e82-5a740cd88344) +![image](https://github.com/user-attachments/assets/4d5874f1-aeb0-47c5-b907-21878a2fa4d9) + +#### 画像 + +![image](https://github.com/user-attachments/assets/4097b087-0309-4aab-8be9-a06fdc9d4964) + +#### ヒューマン・イン・ザ・ループ（人間の承認またはLLMの再考または人間への助けを求める） + +

+ image + image +

+ +NextAGIFutureは、大規模言語モデル（LLM）アプリケーションを開発するためのオープンソースプラットフォームを目指しています。これは、LangChainとLangGraphの概念を利用したLLMベースのアプリケーションです。チャットボット、RAGアプリケーション、エージェント、およびマルチエージェントシステムをサポートするLLMOpsソリューションのスイートを作成し、オフライン操作の機能を備えることを目指しています。 + +[StreetLamb](https://github.com/StreetLamb)プロジェクトおよびその[tribe](https://github.com/StreetLamb/tribe)プロジェクトに触発され、NextAGIFutureは多くのアプローチとコードを採用しています。この基盤の上に、新しい機能と方向性を導入しています。 + +このプロジェクトのレイアウトの一部は、[Lobe-chat](https://github.com/lobehub/lobe-chat)、[Dify](https://github.com/langgenius/dify)、および[fastgpt](https://github.com/labring/FastGPT)を参考にしています。これらはすべて優れたオープンソースプロジェクトであり、感謝しています🙇‍。 + +### 👨‍💻 開発 + +プロジェクトの技術スタック：LangChain + LangGraph + React + Next.js + Chakra UI + PostgreSQL + +### 💡ロードマップ + +1 アプリ + +- [x] チャットボット +- [x] シンプルRAG +- [x] 階層エージェント +- [x] シーケンシャルエージェント +- [ ] ワークフロー ---進行中 +- [ ] さらに多くのマルチエージェント + +2 モデル + +- [x] OpenAI +- [x] ZhipuAI +- [x] Siliconflow +- [x] Ollama +- [ ] Qwen +- [ ] Xinference + +3 その他 + +- [x] ツール呼び出し +- [x] I18n +- [ ] Langchainテンプレート + +### 🏘️ハイライト + +- 永続的な会話：チャット履歴を保存および維持し、会話を続けることができます。 +- 可観測性：LangSmithを使用してエージェントのパフォーマンスと出力をリアルタイムで監視および追跡し、効率的に動作するようにします。 +- ツール呼び出し：エージェントが外部ツールやAPIを利用できるようにします。 +- 検索強化生成：エージェントが内部知識ベースを利用して推論できるようにします。 +- ヒューマン・イン・ザ・ループ：ツール呼び出し前に人間の承認を有効にします。 +- オープンソースモデル：llama、Qwen、GlmなどのオープンソースLLMモデルを使用します。 +- マルチテナンシー：複数のユーザーとチームを管理およびサポートします。 + +### 始め方 + +#### 1. 準備 + +##### 1.1 コードをクローン + +git clone https://github.com/Onelevenvy/NextAGIFuture.git + +##### 1.2 環境設定ファイルをコピー + +```bash +cp .env.example .env +``` + +##### 1.3 秘密鍵を生成 + +.envファイルのいくつかの環境変数には、デフォルト値としてchangethisが設定されています。 +これらを秘密鍵に変更する必要があります。秘密鍵を生成するには、次のコマンドを実行します： + +```bash +python -c "import secrets; print(secrets.token_urlsafe(32))" +``` + +内容をコピーしてパスワード/秘密鍵として使用します。もう一度実行して別の安全な鍵を生成します。 + +##### 1.3 postgres、qdrant、redisをインストール + +```bash +cd nextagi +docker compose up -d +``` + +#### 2. バックエンドを実行 + +##### 2.1 基本環境のインストール + +サーバーの起動にはPython 3.10.xが必要です。Python環境を迅速にインストールするには、pyenvを使用することをお勧めします。 + +追加のPythonバージョンをインストールするには、pyenv installを使用します。 + +```bash +pyenv install 3.10 +``` + +"3.10" Python環境に切り替えるには、次のコマンドを使用します： + +```bash +pyenv global 3.10 +``` + +次の手順に従います： +"backend"ディレクトリに移動します： + +```bash +cd backend +``` + +環境をアクティブにします。 + +```bash +poetry env use 3.10 +poetry install +``` + +##### 2.2 初期データの設定 + +```bash +# DBを起動させる +python /app/app/backend_pre_start.py + +# マイグレーションを実行 +alembic upgrade head + +# DBに初期データを作成 +python /app/app/initial_data.py +``` + +##### 2.3 unicornを実行 + +```bash + uvicorn app.main:app --reload --log-level debug +``` + +##### 2.4 celeryを実行（rag機能を使用する場合のみ） + +```bash +poetry run celery -A app.core.celery_app.celery_app worker --loglevel=debug +``` + +#### 3. フロントエンドを実行 + +##### 3.1 webディレクトリに移動して依存関係をインストール + +```bash +cd web +pnpm install +``` + +##### 3.2 webサービスを起動 + +```bash +cd web +pnpm dev + +# または pnpm build してから pnpm start +```