Skip to content

Commit

Permalink
Updating readme
Browse files Browse the repository at this point in the history
  • Loading branch information
cyfyifanchen committed Aug 6, 2024
1 parent 65563ac commit a310b72
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 17 deletions.
3 changes: 1 addition & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,8 +116,7 @@ You can open https://localhost:3001 in browser to use your graph designer. Simul

Now you have the power of the Graph Designer at your fingertips to perform the magic of agent customization yourself. 🎉

<br>
<h2>Graph designer</h2>
#### Graph designer

TEN Graph Designer (beta), a tool that requires zero coding knowledge and makes the experience of creating agentic applications smoother.

Expand Down
29 changes: 14 additions & 15 deletions docs/readmes/README-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,19 +41,19 @@
<br>
<h2>如何用搭建的 graph designer 配置 voice agent</h2>

### 1. 先决条件
#### 1.1 Keys
### 先决条件
#### Keys
- 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 Keys
- [OpenAI](https://openai.com/index/openai-api/) API Key
#### 1.2 下载安装
#### 下载安装
- [Docker](https://www.docker.com/)[Docker Compose](https://docs.docker.com/compose/install/)
- [Node.js(LTS) v18](https://nodejs.org/en)
#### 1.3 机器配置
#### 机器配置
- CPU >= 2 Core
- RAM >= 4 GB

#### 1.4 Apple Silicon 上 Docker 设置
#### Apple Silicon 上 Docker 设置
如果您使用的是 Apple Silicon Mac,您需要取消勾选 Docker 的 "Use Rosetta for x86_64/amd64 emulation on apple silicon" 选项,否则服务器将无法正常工作。

<div align="center">
Expand All @@ -62,15 +62,15 @@

</div>

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

```bash
export GOPROXY=https://goproxy.cn
```

### 2 下一步
#### 2.1 准备设置文件
### 下一步
#### 1. 准备设置文件
Clone 项目后,在根目录下跑下面的命创建 `property.json``.env`:
```bash
# 创建 property.json 文件
Expand All @@ -80,7 +80,7 @@ cp ./agents/property.json.example ./agents/property.json
cp ./.env.example ./.env
```

#### 2.2 绑定积木的 keys
#### 2. 绑定积木的 keys
打开 `.env` 文件,绑定对应的积木 keys,这里可以通过配置不同的 keys 选用不用的积木:
```
# Agora App ID and Agora App Certificate
Expand All @@ -102,14 +102,14 @@ AZURE_TTS_REGION=
OPENAI_API_KEY=
```

#### 2.3 开启 Docker 容器
#### 3. 开启 Docker 容器
在同一个目录下,通过 Docker 镜像构建 Docker 容器:
```bash
# 开启 Docker 容器:
docker compose up
```

#### 2.4 构建 Agent 并开启服务
#### 4. 构建 Agent 并开启服务
再打开一个 Terminal 窗口,通过下面的命令进入 Docker 容器,创建并开启服务:
```bash
# 进入容器创建 Agent
Expand All @@ -120,12 +120,11 @@ make build
make run-server
```

#### 2.5 体验 Graph Designer 🎉
#### 5. 验证 voice agent 和 graph designer 🎉

现在可以打开浏览器 `http://localhost:3001` 体验 Graph Designer 同时再开浏览器的一个 tab `http://localhost:3000` 定制 voice agent。
现在可以打开浏览器 `http://localhost:3000` 体验 voice agent,同时可以再开浏览器的一个窗口 `http://localhost:3001` 用 graph designer 定制 voice agent。

<br>
<h2>Graph designer</h2>
#### Graph designer

TEN Graph Designer (beta),通过简单拖拽和动态节点连接轻松实现多模型配置。

Expand Down

0 comments on commit a310b72

Please sign in to comment.