From a2ce561f1b7767c037d6f3c6215df8ee429da332 Mon Sep 17 00:00:00 2001 From: Ikko Eltociear Ashimine Date: Mon, 12 Aug 2024 04:10:58 +0900 Subject: [PATCH 1/2] docs: add Japanese README I created Japanese translated README. --- README.md | 3 +- docs/readmes/README-CN.md | 4 +- docs/readmes/README-JP.md | 166 ++++++++++++++++++++++++++++++++++++++ 3 files changed, 170 insertions(+), 3 deletions(-) create mode 100644 docs/readmes/README-JP.md diff --git a/README.md b/README.md index 8e82adc6..b7e68c4b 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,7 @@ README in English 简体中文 +日本語 [Documentation](https://astra-9.gitbook.io/ten-platform)   •   @@ -152,4 +153,4 @@ Contributions are welcome! Please read the [contribution guidelines](CONTRIBUTIN

License

-This project is licensed under the Apache 2.0 License - see the [LICENSE](LICENSE) file for details. \ No newline at end of file +This project is licensed under the Apache 2.0 License - see the [LICENSE](LICENSE) file for details. diff --git a/docs/readmes/README-CN.md b/docs/readmes/README-CN.md index 3545afc2..8bbadf32 100644 --- a/docs/readmes/README-CN.md +++ b/docs/readmes/README-CN.md @@ -1,4 +1,3 @@ -
[![Follow on X](https://img.shields.io/twitter/follow/ten_platform?logo=X&color=%20%23f5f5f5)](https://twitter.com/intent/follow?screen_name=ten_platform) @@ -17,6 +16,7 @@ README in English 简体中文 +日本語
@@ -165,4 +165,4 @@ make run-server

许可证授权

-本项目使用 Apache 2.0 许可证授权 - 详细信息请参阅 [LICENSE](LICENSE)。 \ No newline at end of file +本项目使用 Apache 2.0 许可证授权 - 详细信息请参阅 [LICENSE](LICENSE)。 diff --git a/docs/readmes/README-JP.md b/docs/readmes/README-JP.md new file mode 100644 index 00000000..debb8ef8 --- /dev/null +++ b/docs/readmes/README-JP.md @@ -0,0 +1,166 @@ +
+ +[![Follow on X](https://img.shields.io/twitter/follow/ten_platform?logo=X&color=%20%23f5f5f5)](https://twitter.com/intent/follow?screen_name=ten_platform) +[![Discussion posts](https://img.shields.io/github/discussions/rte-design/astra.ai?labelColor=%20%23FDB062&color=%20%23f79009)](https://github.com/rte-design/astra.ai/discussions/) +[![Commits](https://img.shields.io/github/commit-activity/m/rte-design/astra.ai?labelColor=%20%237d89b0&color=%20%235d6b98)](https://github.com/rte-design/astra.ai/graphs/commit-activity) +[![Issues closed](https://img.shields.io/github/issues-search?query=repo%3Arte-design%2Fastra.ai%20is%3Aclosed&label=issues%20closed&labelColor=green&color=green)](https://github.com/rte-design/ASTRA.ai/issues) +[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://github.com/rte-design/ASTRA.ai/pulls) +[![GitHub license](https://img.shields.io/badge/License-Apache_2.0-blue.svg?labelColor=%20%239b8afb&color=%20%237a5af8)](https://github.com/rte-design/ASTRA.ai/blob/main/LICENSE) +[![WeChat](https://img.shields.io/badge/WeChat-WeChat_Group-%2307C160?logo=wechat)](https://github.com/rte-design/ASTRA.ai/discussions/170) + +[![Discord](https://dcbadge.vercel.app/api/server/VnPftUzAMJ)](https://discord.gg/VnPftUzAMJ) + +[![GitHub watchers](https://img.shields.io/github/watchers/rte-design/astra.ai?style=social&label=Watch)](https://GitHub.com/rte-design/astra.ai/watchers/?WT.mc_id=academic-105485-koreyst) +[![GitHub forks](https://img.shields.io/github/forks/rte-design/astra.ai?style=social&label=Fork)](https://GitHub.com/rte-design/astra.ai/network/?WT.mc_id=academic-105485-koreyst) +[![GitHub stars](https://img.shields.io/github/stars/rte-design/astra.ai?style=social&label=Star)](https://GitHub.com/rte-design/astra.ai/stargazers/?WT.mc_id=academic-105485-koreyst) + +README in English +简体中文 +日本語 +
+ +
+ +[ドキュメント](https://astra-9.gitbook.io/ten-platform) +  •   +[クイックスタート](https://astra-9.gitbook.io/ten-platform/getting-started/quickstart) +  •   +[チュートリアル](https://app.gitbook.com/o/we7IoLK5sA6RQzhItfkW/s/4KgjqM5ChU0dSGjTLZmG/~/changes/6/tutorials/how-to-build-extension-with-go) + + +
+ +
+ +## Astra 音声エージェント + +[Astra voice agent](https://theastra.ai) は、TEN を使用して構築された音声エージェントであり、マルチモーダルで低遅延の能力を示しています。 + +[![Showcase Astra voice agent](https://github.com/rte-design/docs/blob/main/assets/gifs/astra-voice-agent.gif?raw=true)](https://theastra.ai) + +
+

グラフデザイナーを使用して音声エージェントを構成する方法

+ +### 前提条件 +#### キー +- Agora App ID と App Certificate（[詳細はこちら](https://docs.agora.io/en/video-calling/get-started/manage-agora-account?platform=web)） +- Azure の [STT](https://azure.microsoft.com/en-us/products/ai-services/speech-to-text) と [TTS](https://azure.microsoft.com/en-us/products/ai-services/text-to-speech) API キー +- [OpenAI](https://openai.com/index/openai-api/) API キー +#### インストール +- [Docker](https://www.docker.com/) と [Docker Compose](https://docs.docker.com/compose/install/) +- [Node.js(LTS) v18](https://nodejs.org/en) +#### システム要件 +- CPU >= 2 コア +- RAM >= 4 GB + +#### Apple Silicon 上の Docker 設定 +Apple Silicon Mac を使用している場合は、Docker の "Use Rosetta for x86_64/amd64 emulation on Apple Silicon" オプションのチェックを外す必要があります。そうしないと、サーバーが正常に動作しません。 + +
+ +![Docker Setting](https://github.com/rte-design/docs/blob/main/assets/gifs/docker-setting.gif?raw=true) + +
+ +#### Go 国内プロキシの設定 +国内で使用する場合、依存関係を迅速にダウンロードするために、以下のコマンドを実行してグローバルに国内プロキシを設定することをお勧めします（[詳細はこちら](https://goproxy.cn/)）。 + +```bash + export GOPROXY=https://goproxy.cn +``` + +### 次のステップ +#### 1. 設定ファイルの準備 +プロジェクトをクローンした後、ルートディレクトリで以下のコマンドを実行して `property.json` と `.env` を作成します： +```bash +# .env ファイルの作成 +cp ./.env.example ./.env + +# property.json ファイルの作成 +cp ./agents/property.json.example ./agents/property.json +``` + +#### 2. キーのバインド +`.env` ファイルを開き、対応するキーをバインドします。ここで異なるキーを設定することで、異なるエージェントを選択できます： +``` +# Agora App ID と Agora App Certificate +AGORA_APP_ID= +AGORA_APP_CERTIFICATE= + +# Extension: agora_rtc +# Azure STT キーとリージョン +AZURE_STT_KEY= +AZURE_STT_REGION= + +# Extension: azure_tts +# Azure TTS キーとリージョン +AZURE_TTS_KEY= +AZURE_TTS_REGION= + +# Extension: openai_chatgpt +# OpenAI API キー +OPENAI_API_KEY= +``` + +#### 3. Docker コンテナの起動 +同じディレクトリで、Docker イメージを使用して Docker コンテナを構築します： +```bash +# Docker コンテナの起動： +docker compose up +``` + +#### 4. エージェントのビルドとサーバーの起動 +別のターミナルウィンドウを開き、以下のコマンドを実行して Docker コンテナに入り、エージェントをビルドしてサーバーを起動します： +```bash +# コンテナに入り、エージェントをビルド +docker exec -it astra_agents_dev bash +make build + +# ポート 8080 でサーバーを起動 +make run-server +``` + +### 完了 🎉 + +ここまででローカルでの構築が完了しました。簡単な 4 ステップで、エージェントの体験が最大化されます！ + +#### Astra 音声エージェントの検証 + +ブラウザで `localhost:3000` を開いて音声エージェントを体験できます。 + +#### グラフデザイナーの検証 + +別のタブを開いて `localhost:3001` にアクセスし、TEN グラフデザイナー (ベータ版) を体験できます。簡単なドラッグアンドドロップと動的なノード接続で、Astra 音声エージェントを簡単にカスタマイズできます。 + +![TEN Graph Designer](https://github.com/rte-design/docs/blob/main/assets/gifs/graph-designer.gif?raw=true) + +
+

スターを付ける

+ +頻繁に更新されるため、最新情報を見逃さないように、リポジトリにスターを付けてください。 + +![TEN star us gif](https://github.com/rte-design/docs/blob/main/assets/gifs/star-the-repo-confetti-higher-quality.gif?raw=true) + +
+

コミュニティに参加する

+ +- [Discord](https://discord.gg/VnPftUzAMJ)：アプリケーションを共有し、コミュニティと交流するのに最適です。 +- [WeChat Group](https://github.com/rte-design/ASTRA.ai/discussions/170): WeChat グループのコミュニティが好きな方は、ぜひご参加ください。 +- [Github Discussion](https://github.com/rte-design/astra.ai/discussions)：フィードバックを提供し、質問するのに最適です。 +- [GitHub Issues](https://github.com/rte-design/astra.ai/issues)：バグを報告し、新機能を提案するのに最適です。詳細については、[貢献ガイドライン](./docs/code-of-conduct/contributing.md)をご覧ください。 +- [X（以前のTwitter）](https://twitter.com/intent/follow?screen_name=ten_platform)：エージェントを共有し、コミュニティと交流するのに最適です。 + +
+

コード貢献者

+ +[![ASTRA](https://contrib.rocks/image?repo=rte-design/astra.ai)](https://github.com/rte-design/astra.ai/graphs/contributors) + +
+

貢献を歓迎します

+ +貢献を歓迎します！まずは [貢献ガイドライン](../code-of-conduct/contributing.md) をお読みください。 + +
+

ライセンス

+ +このプロジェクトは Apache 2.0 ライセンスの下でライセンスされています。詳細については [LICENSE](LICENSE) をご覧ください。 From eaf50fbe6080de2150721c57fe8f1ddb0fbd42f5 Mon Sep 17 00:00:00 2001 From: Ikko Eltociear Ashimine Date: Tue, 13 Aug 2024 20:45:10 +0900 Subject: [PATCH 2/2] docs: update README-JP.md --- docs/readmes/README-JP.md | 7 ------- 1 file changed, 7 deletions(-) diff --git a/docs/readmes/README-JP.md b/docs/readmes/README-JP.md index debb8ef8..b191e41f 100644 --- a/docs/readmes/README-JP.md +++ b/docs/readmes/README-JP.md @@ -62,13 +62,6 @@ Apple Silicon Mac を使用している場合は、Docker の "Use Rosetta for x
-#### Go 国内プロキシの設定 -国内で使用する場合、依存関係を迅速にダウンロードするために、以下のコマンドを実行してグローバルに国内プロキシを設定することをお勧めします（[詳細はこちら](https://goproxy.cn/)）。 - -```bash - export GOPROXY=https://goproxy.cn -``` - ### 次のステップ #### 1. 設定ファイルの準備 プロジェクトをクローンした後、ルートディレクトリで以下のコマンドを実行して `property.json` と `.env` を作成します：