From d8479d3ab8222f79862e517aba2760db42ef9508 Mon Sep 17 00:00:00 2001 From: Elliott Chen Date: Tue, 13 Aug 2024 18:06:17 +0800 Subject: [PATCH 1/6] Update README-CN.md --- docs/readmes/README-CN.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/readmes/README-CN.md b/docs/readmes/README-CN.md index 3545afc2..a3438fc1 100644 --- a/docs/readmes/README-CN.md +++ b/docs/readmes/README-CN.md @@ -32,14 +32,14 @@
-## Astra 语音助手 +## Astra voice agent [Astra voice agent](https://theastra.ai) 是通过 TEN 搭建出来的 voice agent, 展示了多模态，低延迟的能力。 [![Showcase Astra voice agent](https://github.com/rte-design/docs/blob/main/assets/gifs/astra-voice-agent.gif?raw=true)](https://theastra.ai)
-

如何用搭建的 graph designer 配置 voice agent

+

如何本地搭建 Astra voice agent

### 先决条件 #### Keys @@ -81,7 +81,7 @@ cp ./agents/property.json.example ./agents/property.json ``` #### 2. 绑定积木的 keys -打开 `.env` 文件，绑定对应的积木 keys，这里可以通过配置不同的 keys 选用不用的积木： +打开 `.env` 文件，绑定对应的积木 keys，这里也可以通过配置不同的 keys 选用不用的积木： ``` # Agora App ID and Agora App Certificate AGORA_APP_ID= From b3871c5d21a48ee1b4b559772d799323e0e34169 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E8=B4=9D=E5=90=89=E5=A1=94=E5=A4=A7=E7=8E=8B?= Date: Wed, 14 Aug 2024 06:25:39 +0800 Subject: [PATCH 2/6] Update README-CN.md --- docs/readmes/README-CN.md | 27 ++++++++++++++------------- 1 file changed, 14 insertions(+), 13 deletions(-) diff --git a/docs/readmes/README-CN.md b/docs/readmes/README-CN.md index a3438fc1..af960693 100644 --- a/docs/readmes/README-CN.md +++ b/docs/readmes/README-CN.md @@ -70,7 +70,7 @@ ``` ### 下一步 -#### 1. 准备设置文件 +#### 1. 创建配置文件 Clone 项目后，在根目录下跑下面的命创建 `property.json` 和 `.env`: ```bash # 创建 .env 文件 @@ -87,50 +87,51 @@ cp ./agents/property.json.example ./agents/property.json AGORA_APP_ID= AGORA_APP_CERTIFICATE= -# Extension: agora_rtc # Azure STT key and region AZURE_STT_KEY= AZURE_STT_REGION= -# Extension: azure_tts # Azure TTS key and region AZURE_TTS_KEY= AZURE_TTS_REGION= -# Extension: openai_chatgpt # OpenAI API key OPENAI_API_KEY= ``` -#### 3. 开启 Docker 容器 -在同一个目录下，通过 Docker 镜像构建 Docker 容器： +#### 3. 创建 Docker 容器 +在根目录下，通过 `docker compose up` 创建 docker 容器： ```bash # 开启 Docker 容器： docker compose up ``` -#### 4. 构建 Agent 并开启服务 -再打开一个 Terminal 窗口，通过下面的命令进入 Docker 容器，创建并开启服务： +#### 4. 在容器内创建 agent 服务 +再打开一个 Terminal 窗口，通过下面的命令进入 Docker 容器，创建 agent 服务： ```bash -# 进入容器创建 Agent +# 进入容器创建 agent docker exec -it astra_agents_dev bash + make build +``` +#### 5.开启服务 +```bash # 端口 8080 开启服务 -make run-server +make run-sever ``` ### 构建完成 🎉 -走到这里就本地构建完成了，简单 4 步，上手体验拉满！ +走到这里就本地构建完成了，简单 5 步，上手体验拉满！ #### 验证 Astra voice agent -现在可以打开浏览器 `localhost:3000` 体验 voice agent。 +现在可以打开浏览器 http://localhost:3000 体验 Astra voice agent。 #### 验证 Graph designer -同时可以再开一个 tab 在 `localhost:3001` 体验 TEN Graph Designer (beta)，通过简单拖拽和动态节点连接轻松定制 Astra voice agent。 +同时可以再开一个 tab 在 http://localhost:3001 体验 Graph Designer (beta)，通过简单拖拽和动态节点连接轻松定制 Astra voice agent。 ![TEN Graph Designer](https://github.com/rte-design/docs/blob/main/assets/gifs/graph-designer.gif?raw=true) From 2294e7f88615e0c38cb0e31007582307ae2e3896 Mon Sep 17 00:00:00 2001 From: Elliott Chen Date: Mon, 19 Aug 2024 14:03:51 +0800 Subject: [PATCH 3/6] Update README-CN.md --- docs/readmes/README-CN.md | 42 ++++++++++++++++++++++++--------------- 1 file changed, 26 insertions(+), 16 deletions(-) diff --git a/docs/readmes/README-CN.md b/docs/readmes/README-CN.md index af960693..00d46064 100644 --- a/docs/readmes/README-CN.md +++ b/docs/readmes/README-CN.md @@ -32,14 +32,14 @@
-## Astra voice agent +## Astra AI agent -[Astra voice agent](https://theastra.ai) 是通过 TEN 搭建出来的 voice agent, 展示了多模态，低延迟的能力。 +[Astra AI agent](https://theastra.ai) 是通过 TEN 搭建出来的 multimodal AI agent, 展示了其多模态，低延迟的能力。 [![Showcase Astra voice agent](https://github.com/rte-design/docs/blob/main/assets/gifs/astra-voice-agent.gif?raw=true)](https://theastra.ai)
-

如何本地搭建 Astra voice agent

+

如何本地搭建 Astra AI agent

### 先决条件 #### Keys @@ -62,29 +62,41 @@ -#### 设置 Go 国内代理 -如果在国内，我们建议跑下列命令来全局设定国内代理以便快速下载依赖([了解详情](https://goproxy.cn/))。 +#### 设置国内代理 + +> [!Note] +> 注意， 如果在国内，我们强烈建议在 SSH 中把代理打开，下载和安装的依赖的时候会更加丝滑。 + ```bash - export GOPROXY=https://goproxy.cn +# 如果用的代理软件没有增强模式的话， 建议手动把所有代理协议都打开， +# export 的有效期为一个 session。 +export https_proxy=http://127.0.0.1:（端口例如 7890） +export http_proxy=http://127.0.0.1:（端口例如 7890） +export all_proxy=socks5://127.0.0.1:（端口例如 7890） + +# GO 代理设置 +export GOPROXY=https://goproxy.cn,direct + +# pip 代理设置, 此设置需要先安装 pip + pip config set global.index-url https://pypi.tuna.tsinghua.edu.cn/simple ``` ### 下一步 #### 1. 创建配置文件 -Clone 项目后，在根目录下跑下面的命创建 `property.json` 和 `.env`: +克隆项目后，在根目录下跑下面的命创建 `property.json` 和 `.env`: ```bash -# 创建 .env 文件 cp ./.env.example ./.env - -# 创建 property.json 文件 cp ./agents/property.json.example ./agents/property.json ``` -#### 2. 绑定积木的 keys -打开 `.env` 文件，绑定对应的积木 keys，这里也可以通过配置不同的 keys 选用不用的积木： +#### 2. 绑定 extension 的 keys +打开 `.env` 文件，绑定对应的 `keys`，这里也可以通过配置不同的 `keys` 选用不用的 extensions： ``` -# Agora App ID and Agora App Certificate +# Agora app ID AGORA_APP_ID= +# Certificate 非必须，只有在申请 Agora app ID 的时候申请了才需要填 +# 如果不知道 certificate 是什么, 请留空 AGORA_APP_CERTIFICATE= # Azure STT key and region @@ -100,9 +112,8 @@ OPENAI_API_KEY= ``` #### 3. 创建 Docker 容器 -在根目录下，通过 `docker compose up` 创建 docker 容器： +在根目录下，拉取 Docker 镜像，然后创建 Docker 容器。 ```bash -# 开启 Docker 容器： docker compose up ``` @@ -117,7 +128,6 @@ make build #### 5.开启服务 ```bash -# 端口 8080 开启服务 make run-sever ``` From 2c28a67fe6389ecbd232df90cca199c87495825b Mon Sep 17 00:00:00 2001 From: Elliott Chen Date: Mon, 19 Aug 2024 14:09:17 +0800 Subject: [PATCH 4/6] Update README-CN.md --- docs/readmes/README-CN.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/readmes/README-CN.md b/docs/readmes/README-CN.md index 00d46064..a8ea3746 100644 --- a/docs/readmes/README-CN.md +++ b/docs/readmes/README-CN.md @@ -62,15 +62,15 @@ -#### 设置国内代理 > [!Note] +> 设置国内代理 > 注意， 如果在国内，我们强烈建议在 SSH 中把代理打开，下载和安装的依赖的时候会更加丝滑。 ```bash -# 如果用的代理软件没有增强模式的话， 建议手动把所有代理协议都打开， -# export 的有效期为一个 session。 +# 如果用的代理软件没有增强模式的话， 建议手动把所有代理协议都打开 +# export 的有效期为一个 session export https_proxy=http://127.0.0.1:（端口例如 7890） export http_proxy=http://127.0.0.1:（端口例如 7890） export all_proxy=socks5://127.0.0.1:（端口例如 7890） @@ -79,7 +79,7 @@ export all_proxy=socks5://127.0.0.1:（端口例如 7890） export GOPROXY=https://goproxy.cn,direct # pip 代理设置, 此设置需要先安装 pip - pip config set global.index-url https://pypi.tuna.tsinghua.edu.cn/simple +pip config set global.index-url https://pypi.tuna.tsinghua.edu.cn/simple ``` ### 下一步 @@ -91,7 +91,7 @@ cp ./agents/property.json.example ./agents/property.json ``` #### 2. 绑定 extension 的 keys -打开 `.env` 文件，绑定对应的 `keys`，这里也可以通过配置不同的 `keys` 选用不用的 extensions： +打开 `.env` 文件，绑定对应的 `keys`，这里也可以通过配置不同的 `keys` 选用不用的 `extensions`： ``` # Agora app ID AGORA_APP_ID= @@ -112,7 +112,7 @@ OPENAI_API_KEY= ``` #### 3. 创建 Docker 容器 -在根目录下，拉取 Docker 镜像，然后创建 Docker 容器。 +在根目录下，拉取 Docker 镜像，然后创建 Docker 容器: ```bash docker compose up ``` @@ -137,7 +137,7 @@ make run-sever #### 验证 Astra voice agent -现在可以打开浏览器 http://localhost:3000 体验 Astra voice agent。 +现在可以打开浏览器 http://localhost:3000 体验 Astra voice agent #### 验证 Graph designer From d6166981dc025e233c721d6e217ae2f2de0c02ff Mon Sep 17 00:00:00 2001 From: Elliott Chen Date: Mon, 19 Aug 2024 14:17:05 +0800 Subject: [PATCH 5/6] Update README-CN.md --- docs/readmes/README-CN.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/readmes/README-CN.md b/docs/readmes/README-CN.md index a8ea3746..96308683 100644 --- a/docs/readmes/README-CN.md +++ b/docs/readmes/README-CN.md @@ -63,9 +63,9 @@ -> [!Note] -> 设置国内代理 -> 注意， 如果在国内，我们强烈建议在 SSH 中把代理打开，下载和安装的依赖的时候会更加丝滑。 +#### 设置国内代理 + +如果在国内，我们强烈建议在 SSH 中把代理打开，下载和安装的依赖的时候会更加丝滑。 ```bash From ab0e388b1a88606c965735d70d615c0cf39a8d2e Mon Sep 17 00:00:00 2001 From: Elliott Chen Date: Mon, 19 Aug 2024 15:02:41 +0800 Subject: [PATCH 6/6] Update README-CN.md --- docs/readmes/README-CN.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/readmes/README-CN.md b/docs/readmes/README-CN.md index 96308683..d5cdc45b 100644 --- a/docs/readmes/README-CN.md +++ b/docs/readmes/README-CN.md @@ -75,6 +75,11 @@ export https_proxy=http://127.0.0.1:（端口例如 7890） export http_proxy=http://127.0.0.1:（端口例如 7890） export all_proxy=socks5://127.0.0.1:（端口例如 7890） +# Docker +export https_proxy=http://host.docker.internal:（端口例如 7890） +export http_proxy=http://host.docker.internal:（端口例如 7890） +export all_proxy=http://host.docker.internal:（端口例如 7890） + # GO 代理设置 export GOPROXY=https://goproxy.cn,direct