File size: 9,563 Bytes
87337b1 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 |

<div align="center">
[](https://twitter.com/intent/follow?screen_name=TenFramework)
[](https://github.com/TEN-framework/ten-agent/discussions/)
[](https://github.com/TEN-framework/ten-agent/graphs/commit-activity)
[](https://github.com/TEN-framework/ten-agent/issues)
[](https://github.com/TEN-framework/ten-agent/pulls)
[](https://github.com/TEN-framework/ten-agent/blob/main/LICENSE)
[](https://discord.gg/VnPftUzAMJ)
<a href="https://trendshift.io/repositories/11978" target="_blank"><img src="https://trendshift.io/api/badge/repositories/11978" alt="TEN-framework%2FTEN-Agent | Trendshift" style="width: 250px; height: 55px;" width="250" height="55"/></a>
[](https://GitHub.com/TEN-framework/ten-agent/watchers/?WT.mc_id=academic-105485-koreyst)
[](https://GitHub.com/TEN-framework/ten-agent/network/?WT.mc_id=academic-105485-koreyst)
[](https://GitHub.com/TEN-framework/ten-agent/stargazers/?WT.mc_id=academic-105485-koreyst)
<a href="https://github.com/TEN-framework/ten-agent/blob/main/README.md"><img alt="README in English" src="https://img.shields.io/badge/English-lightgrey"></a>
<a href="https://github.com/ten-framework/ten-agent/blob/main/docs/readmes/README-CN.md"><img alt="简体中文操作指南" src="https://img.shields.io/badge/简体中文-lightgrey"></a>
<a href="https://github.com/ten-framework/ten-agent/blob/main/docs/readmes/README-JP.md"><img alt="日本語のREADME" src="https://img.shields.io/badge/日本語-lightgrey"></a>
<a href="https://github.com/ten-framework/ten-agent/blob/main/docs/readmes/README-KR.md"><img alt="README in 한국어" src="https://img.shields.io/badge/한국어-lightgrey"></a>
<a href="https://github.com/ten-framework/ten-agent/blob/main/docs/readmes/README-ES.md"><img alt="README en Español" src="https://img.shields.io/badge/Español-lightgrey"></a>
<a href="https://github.com/ten-framework/ten-agent/blob/main/docs/readmes/README-FR.md"><img alt="README en Français" src="https://img.shields.io/badge/Français-lightgrey"></a>
<a href="https://github.com/ten-framework/ten-agent/blob/main/docs/readmes/README-IT.md"><img alt="README in Italiano" src="https://img.shields.io/badge/Italiano-lightgrey"></a>
[Getting Started](https://doc.theten.ai/ten-agent/getting_started)
<span> • </span>
[Create Extensions](https://doc.theten.ai/ten-agent/create_a_hello_world_extension)
<span> • </span>
[TEN Framework Repository](https://github.com/TEN-framework/ten_framework)
</div>
<br>
<h2>🎉 TEN Agent with OpenAI Realtime API and RTC</h2>
Try OpenAI Realtime API, **Weather Check** and **Web Search** at [agent.theten.ai](https://agent.theten.ai).
Combining OpenAI Realtime API for ultra-low latency with RTC’s AI noise suppression ensures smooth, high-quality interactions. On top of that, the seamless integration of weather and news tools makes TEN Agent even more versatile.

<br>
<h2>TEN Agent Usecases</h2>

<!-- <br>
<h2>TEN Agent Features</h2>
* **OpenAI Realtime API and RTC Integration**:
TEN Agent seamlessly integrates OpenAI's Realtime API with RTC capabilities, enabling natural, responsive conversations with ultra-low latency and high-quality audio processing.
* **High-Performance Real-Time Multimodal Interactions**:
Offers high-performance, low-latency solutions for complex audio-visual AI applications.
* **Multi-Language and Multi-Platform Support** :
Supports extension development in C++, Go, Python, etc. Runs on Windows, Mac, Linux, and mobile devices.
* **Edge-Cloud Integration**:
Flexibly combines edge and cloud-deployed extensions, balancing privacy, cost, and performance.
* **Flexibility Beyond Model Limitations**:
Easily build complex AI applications through simple drag-and-drop programming, integrating audio-visual tools, databases, RAG, and more.
* **Real-Time Agent State Management**:
Manages and adjusts agent behavior in real-time for dynamic responsiveness. -->
<br>
<h2>Ready-to-use Extensions</h2>

<br>
<h2>TEN Agent Playground in Local Environment</h2>
### Prerequisites
| Category | Requirements |
|----------|-------------|
| **Keys** | • Agora [ App ID ](https://docs.agora.io/en/video-calling/get-started/manage-agora-account?platform=web#create-an-agora-project) and [ App Certificate ](https://docs.agora.io/en/video-calling/get-started/manage-agora-account?platform=web#create-an-agora-project)(free minutes every month) <br>• [OpenAI](https://openai.com/index/openai-api/) API key<br>• [ Deepgram ](https://deepgram.com/) ASR (free credits available with signup)<br>• [ FishAudio ](https://fish.audio/) TTS (free credits available with signup)|
| **Installation** | • [Docker](https://www.docker.com/) / [Docker Compose](https://docs.docker.com/compose/)<br>• [Node.js(LTS) v18](https://nodejs.org/en) |
| **Minimum System Requirements** | • CPU >= 2 Core<br>• RAM >= 4 GB |
<!-- <br>
### Windows settings(MUST READ)
On Windows, Git automatically adds a carriage return(\r) at the end of each line, which causes the `agents/bin/start: not found` error when running the server.
**If you encounter this issue**, follow these steps:
1. Completely remove the current project folder
2. Run the following command to disable Git's auto CRLF:
```bash
git config --global core.autocrlf false
``` -->
<!-- 3. Re-clone the project and start the process again -->
<br>
### macOS: Docker setting on Apple Silicon
For Apple Silicon Macs, uncheck "Use Rosetta for x86/amd64 emulation" in Docker settings. Note: This may result in slower build times on ARM, but performance will be normal when deployed to x64 servers.

<br>
### Next step
#### 1. Create `.env` file
```bash
cp ./.env.example ./.env
```
#### 2. Setup Agora App ID and App Certificate in `.env`
```bash
AGORA_APP_ID=
AGORA_APP_CERTIFICATE=
```
#### 3. Start agent development containers
```bash
docker compose up -d
```
#### 4. Enter container
```bash
docker exec -it ten_agent_dev bash
```
#### 5. Build agent
```bash
task use
```
#### 6. Start the web server
```bash
task run
```
#### 7. Edit playground settings
Open the playground at [localhost:3000](http://localhost:3000) to configure your agent.
1. Select a graph type (e.g. Voice Agent, Realtime Agent)
2. Choose a corresponding module
3. Select an extension and configure its API key settings

<br>
<h2>TEN Agent Components</h2>

<br>
<h2>Stay Tuned</h2>
Before we get started, be sure to star our repository and get instant notifications for all new releases!

<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/TEN-framework/ten-agent/discussions): Perfect for providing feedback and asking questions.
- [GitHub Issues](https://github.com/TEN-framework/ten-agent/issues): Best for reporting bugs and proposing new features. Refer to our [contribution guidelines](./docs/code-of-conduct/contributing.md) for more details.
- [X](https://img.shields.io/twitter/follow/TenFramework?logo=X&color=%20%23f5f5f5): Great for sharing your agents and interacting with the community.
<br>
<h2>Code Contributors</h2>
[](https://github.com/TEN-framework/ten-agent/graphs/contributors)
<br>
<h2>Contribution Guidelines</h2>
Contributions are welcome! Please read the [contribution guidelines](./docs/code-of-conduct/contributing.md) first.
<br>
<h2>License</h2>
This project is licensed under the Apache 2.0 License - see the [LICENSE](LICENSE) file for details.
|