Skip to content

Commit

Permalink
Updating readmes and as well as removing unnecessary assets (#167)
Browse files Browse the repository at this point in the history
* Updating readmes and as well as removing unnecessary assets

* Swapping the order of cping .env and property.json
  • Loading branch information
cyfyifanchen authored Aug 7, 2024
1 parent 5a82338 commit f6cbaa2
Show file tree
Hide file tree
Showing 13 changed files with 71 additions and 54 deletions.
62 changes: 34 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,43 +31,42 @@

[Voice agent: Astra](https://theastra.ai)

We showcase an impressive voice agent called Astra, powered by TEN, demonstrating its ability to create intuitive and seamless conversational interactions.

[![Showcase Astra](https://github.com/rte-design/ASTRA.ai/raw/main/images/astra-voice-agent.gif)](https://theastra.ai)
Astra is a voice agent, powered by TEN, demonstrating its ability to create intuitive and seamless conversational interactions.

[![Showcase Astra](https://github.com/rte-design/docs/blob/main/assets/gifs/astra-voice-agent.gif?raw=true)](https://theastra.ai)
<br>
<h2>How to build voice agent locally</h2>

<h2>How to build voice agent locally

### Prerequisites

#### Prerequisites
#### Keys
- Agora App ID and App Certificate([read here on how](https://docs.agora.io/en/video-calling/get-started/manage-agora-account?platform=web))
- Azure's [speech-to-text](https://azure.microsoft.com/en-us/products/ai-services/speech-to-text) and [text-to-speech](https://azure.microsoft.com/en-us/products/ai-services/text-to-speech) API keys
- [OpenAI](https://openai.com/index/openai-api/) API key

- **Keys**
- Agora App ID and App Certificate([read here on how](https://docs.agora.io/en/video-calling/get-started/manage-agora-account?platform=web))
- Azure's [speech-to-text](https://azure.microsoft.com/en-us/products/ai-services/speech-to-text) and [text-to-speech](https://azure.microsoft.com/en-us/products/ai-services/text-to-speech) API keys
- [OpenAI](https://openai.com/index/openai-api/) API key
- **Downloads**
- [Docker](https://www.docker.com/) / [Docker Compose](https://docs.docker.com/compose/)
- [Node.js(LTS) v18](https://nodejs.org/en)
#### Installation
- [Docker](https://www.docker.com/) / [Docker Compose](https://docs.docker.com/compose/)
- [Node.js(LTS) v18](https://nodejs.org/en)

#### Docker setting on apple silicon
You will need to uncheck "Use Rosetta for x86_64/amd64 emulation on apple silicon" option for Docker if you are on Apple Silicon, otherwise the server is not gonna work.

<div align="center">
#### Minimum system requirements
- CPU >= 2 Core
- RAM >= 4 GB

![Docker Setting](https://github.com/rte-design/ASTRA.ai/raw/main/images/docker-setting.gif)
#### Docker setting on Apple Silicon
You will need to uncheck "Use Rosetta for x86_64/amd64 emulation on Apple Silicon" option for Docker if you are on Apple Silicon, otherwise the server is not going to work.

</div>
![Docker Setting](https://github.com/rte-design/docs/blob/main/assets/gifs/docker-setting.gif?raw=true)

### Next step

#### 1. Prepare config files
In the root of the project, create these files from the examples. They will be used to store information for Docker Compose later.
```bash
# Create property.json from the example
cp ./agents/property.json.example ./agents/property.json

# Create .env from the example
cp ./.env.example ./.env

# Create property.json from the example
cp ./agents/property.json.example ./agents/property.json
```

#### 2. Setup API keys & Environment variables in .env file
Expand Down Expand Up @@ -111,28 +110,35 @@ make build
make run-server
```

#### 5. Verify your voice agent 🎉
#### 5. Use graph designer to customize voice agent

You can open https://localhost:3001 in browser to use your graph designer. Simultaneously, open another tab at https://localhost:3000 to see the customized voice agent up and running.

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

#### Graph designer

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

You can open `localhost:3000` in your browser to test your own agent, or open `localhost:3001` in your browser to build your workflow by Graph Designer.
![TEN Graph Designer](https://github.com/rte-design/docs/blob/main/assets/gifs/graph-designer.gif?raw=true)

<br>
<h2>TEN Service</h2>
<h3>Discover More</h3>

Now that you’ve created your first AI agent, the creativity doesnt stop here. To develop more amazing agents, you’ll need an advanced understanding of how the TEN works under the hood. Please refer to the [ TEN service documentation ](./docs/astra-architecture.md).
Now that you’ve created your first AI agent, the creativity doesn't stop here. To develop more amazing agents, you’ll need an advanced understanding of how the TEN works under the hood. Please refer to the [ TEN service documentation ](./docs/astra-architecture.md).

<br>
<h2>Stay Tuned</h2>

Before we dive further, be sure to star our repository and get instant notifications for all new releases!

![TEN star us gif](https://github.com/rte-design/ASTRA.ai/raw/main/images/star-the-repo-confetti-higher-quality.gif)
![TEN star us gif](https://github.com/rte-design/docs/blob/main/assets/gifs/star-the-repo-confetti-higher-quality.gif?raw=true)

<br>
<h2>Join Community</h2>

- [Discord](https://discord.gg/VnPftUzAMJ): Ideal for sharing your applications and engaging with the community.
- [Github Discussion](https://github.com/rte-design/astra.ai/discussions): Perfect for providing feedback and asking questions.
- [GitHub Discussion](https://github.com/rte-design/astra.ai/discussions): Perfect for providing feedback and asking questions.
- [GitHub Issues](https://github.com/rte-design/astra.ai/issues): Best for reporting bugs and proposing new features. Refer to our [contribution guidelines](./docs/code-of-conduct/contributing.md) for more details.
- [X (formerly Twitter)](https://twitter.com/intent/follow?screen_name=AstraFramework): Great for sharing your agents and interacting with the community.

Expand Down
63 changes: 37 additions & 26 deletions docs/readmes/README-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,47 +30,54 @@

</div>

<br>

## Astra

[Astra](https://theastra.ai) 是通过 TEN 搭建出来的 voice agent, 展示了多模态,低延迟的能力。

[![展示ASTRA语音助手](https://github.com/rte-design/ASTRA.ai/raw/main/images/astra-voice-agent.gif)](https://theastra.ai)
[![Showcase Astra](https://github.com/rte-design/docs/blob/main/assets/gifs/astra-voice-agent.gif?raw=true)](https://theastra.ai)

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

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

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

<div align="center">

![ASTRA Docker Setting](https://github.com/rte-design/ASTRA.ai/raw/main/images/docker-setting.gif)
![Docker Setting](https://github.com/rte-design/docs/blob/main/assets/gifs/docker-setting.gif?raw=true)

</div>

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

```
$ go env -w GO111MODULE=on
$ go env -w GOPROXY=https://goproxy.cn,direct
```bash
export GOPROXY=https://goproxy.cn
```

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

# 创建 .env 文件
cp ./.env.example ./.env

# 创建 property.json 文件
cp ./agents/property.json.example ./agents/property.json
```

#### 2. 绑定积木的 keys
Expand Down Expand Up @@ -113,16 +120,23 @@ make build
make run-server
```

#### 5. 创建成功并体验 Agent 🎉
#### 5. 验证 voice agent 和 graph designer 🎉

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

现在可以打开浏览器 `localhost:3000` 体验 Astra 语音助手,同时可以打开 `localhost:3001` 体验 Graph Designer。
#### Graph designer

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

![TEN Graph Designer](https://github.com/rte-design/docs/blob/main/assets/gifs/graph-designer.gif?raw=true)

<br>
<h2>点星收藏</h2>

我们更新频繁,不想错过的话,请给我们的 repo 点星,以便获得第一时间的更新.

![ASTRA star us gif](https://github.com/rte-design/ASTRA.ai/raw/main/images/star-the-repo-confetti-higher-quality.gif)
![TEN star us gif](https://github.com/rte-design/docs/blob/main/assets/gifs/star-the-repo-confetti-higher-quality.gif?raw=true)



<br>
Expand All @@ -134,20 +148,17 @@ make run-server
- [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=AstraFramework):非常适合分享您的代理并与社区互动。

<br>
<br>
<h2>代码贡献者</h2>

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


</br>

<br>
<h2>欢迎贡献</h2>

欢迎贡献!请先阅读 [贡献指南](../code-of-conduct/contributing.md)

</br>

<br>
<h2>许可证授权</h2>

本项目使用 Apache 2.0 许可证授权 - 详细信息请参阅 [LICENSE](LICENSE)
本项目使用 Apache 2.0 许可证授权 - 详细信息请参阅 [LICENSE](LICENSE)
Binary file removed images/astra-voice-agent.gif
Binary file not shown.
Binary file removed images/banner-image-without-tagline.png
Binary file not shown.
Binary file removed images/docker-setting.gif
Binary file not shown.
Binary file removed images/image-2.png
Binary file not shown.
Binary file removed images/image.png
Binary file not shown.
Binary file removed images/logo_banner.png
Binary file not shown.
Binary file removed images/logo_banner_dark.png
Binary file not shown.
Binary file removed images/logo_banner_ref_line_light.png
Binary file not shown.
Binary file removed images/star-the-repo-confetti-higher-quality.gif
Binary file not shown.
Binary file removed images/star-the-repo-confetti.gif
Binary file not shown.
Binary file removed images/wechat-qrcode.png
Binary file not shown.

0 comments on commit f6cbaa2

Please sign in to comment.