Skip to content

Commit

Permalink
Readme-cn wording update (#201)
Browse files Browse the repository at this point in the history
* Update README-CN.md

* Update README-CN.md

* Update README-CN.md

* Update README-CN.md

* Update README-CN.md

* Update README-CN.md
  • Loading branch information
cyfyifanchen authored Aug 19, 2024
1 parent dabbb7a commit 9f21ace
Showing 1 changed file with 44 additions and 28 deletions.
72 changes: 44 additions & 28 deletions docs/readmes/README-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,14 +32,14 @@

<br>

## Astra 语音助手
## 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)

<br>
<h2>如何用搭建的 graph designer 配置 voice agent</h2>
<h2>如何本地搭建 Astra AI agent</h2>

### 先决条件
#### Keys
Expand All @@ -62,75 +62,91 @@

</div>

#### 设置 Go 国内代理
如果在国内,我们建议跑下列命令来全局设定国内代理以便快速下载依赖([了解详情](https://goproxy.cn/))。

#### 设置国内代理

如果在国内,我们强烈建议在 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)

# 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

# pip 代理设置, 此设置需要先安装 pip
pip config set global.index-url https://pypi.tuna.tsinghua.edu.cn/simple
```

### 下一步
#### 1. 准备设置文件
Clone 项目后,在根目录下跑下面的命创建 `property.json``.env`:
#### 1. 创建配置文件
克隆项目后,在根目录下跑下面的命创建 `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=
# 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 镜像,然后创建 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
```

# 端口 8080 开启服务
make run-server
#### 5.开启服务
```bash
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)

Expand Down

0 comments on commit 9f21ace

Please sign in to comment.