|
 |
|
|
|
<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" 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" 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" 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" 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" src="https://img.shields.io/badge/Italiano-lightgrey"></a> |
|
|
|
[์์ํ๊ธฐ](https://doc.theten.ai/ten-agent/getting_started) |
|
<span> โข </span> |
|
[ํ์ฅ ๊ธฐ๋ฅ ๋ง๋ค๊ธฐ](https://doc.theten.ai/ten-agent/create_a_hello_world_extension) |
|
<span> โข </span> |
|
[TEN Framework ์ ์ฅ์](https://github.com/TEN-framework/ten_framework) |
|
|
|
</div> |
|
|
|
<br> |
|
<h2>๐ OpenAI ์ค์๊ฐ API์ RTC๋ฅผ ํ์ฌํ TEN Agent</h2> |
|
|
|
[agent.theten.ai](https://agent.theten.ai)์์ OpenAI ์ค์๊ฐ API, **๋ ์จ ํ์ธ**, **์น ๊ฒ์**์ ์ฒดํํด๋ณด์ธ์. |
|
|
|
OpenAI ์ค์๊ฐ API์ ์ด์ ์ง์ฐ๊ณผ RTC์ AI ๋
ธ์ด์ฆ ์ ๊ฑฐ๋ฅผ ๊ฒฐํฉํ์ฌ ๋ถ๋๋ฝ๊ณ ๊ณ ํ์ง์ ์ํธ์์ฉ์ ๋ณด์ฅํฉ๋๋ค. ์ฌ๊ธฐ์ ๋ ์จ์ ๋ด์ค ๋๊ตฌ์ ์ํํ ํตํฉ์ผ๋ก TEN Agent๋ ๋์ฑ ๋ค์ฌ๋ค๋ฅํด์ก์ต๋๋ค. |
|
|
|
 |
|
|
|
<br> |
|
<h2>TEN Agent ์ฌ์ฉ ์ฌ๋ก</h2> |
|
|
|
 |
|
|
|
<br> |
|
<h2>๋ฐ๋ก ์ฌ์ฉ ๊ฐ๋ฅํ ํ์ฅ ๊ธฐ๋ฅ</h2> |
|
|
|
 |
|
|
|
<br> |
|
<h2>๋ก์ปฌ ํ๊ฒฝ์์์ TEN Agent ํ๋ ์ด๊ทธ๋ผ์ด๋</h2> |
|
|
|
### ์ฌ์ ์๊ตฌ์ฌํญ |
|
|
|
| ์นดํ
๊ณ ๋ฆฌ | ์๊ตฌ์ฌํญ | |
|
|----------|-------------| |
|
| **ํค** | โข Agora [ ์ฑ ID ](https://docs.agora.io/en/video-calling/get-started/manage-agora-account?platform=web#create-an-agora-project) ์ [ ์ฑ ์ธ์ฆ์ ](https://docs.agora.io/en/video-calling/get-started/manage-agora-account?platform=web#create-an-agora-project)(๋งค์ ๋ฌด๋ฃ ์ฌ์ฉ ์๊ฐ ์ ๊ณต) <br>โข [OpenAI](https://openai.com/index/openai-api/) API ํค<br>โข [ Deepgram ](https://deepgram.com/) ASR (๊ฐ์
์ ๋ฌด๋ฃ ํฌ๋ ๋ง ์ ๊ณต)<br>โข [ FishAudio ](https://fish.audio/) TTS (๊ฐ์
์ ๋ฌด๋ฃ ํฌ๋ ๋ง ์ ๊ณต)| |
|
| **์ค์น** | โข [Docker](https://www.docker.com/) / [Docker Compose](https://docs.docker.com/compose/)<br>โข [Node.js(LTS) v18](https://nodejs.org/en) | |
|
| **์ต์ ์์คํ
์๊ตฌ์ฌํญ** | โข CPU >= 2์ฝ์ด<br>โข RAM >= 4 GB | |
|
|
|
<br> |
|
|
|
### macOS: Apple Silicon์์์ Docker ์ค์ |
|
|
|
Apple Silicon Mac์ ๊ฒฝ์ฐ, Docker ์ค์ ์์ "Use Rosetta for x86/amd64 emulation" ์ฒดํฌ๋ฅผ ํด์ ํ์ธ์. ์ฐธ๊ณ : ARM์์ ๋น๋ ์๊ฐ์ด ๋ ๋๋ ค์ง ์ ์์ง๋ง, x64 ์๋ฒ์ ๋ฐฐํฌํ์ ๋์ ์ฑ๋ฅ์ ์ ์์ ์
๋๋ค. |
|
|
|
 |
|
|
|
<br> |
|
|
|
### ๋ค์ ๋จ๊ณ |
|
|
|
#### 1. `.env` ํ์ผ ์์ฑ |
|
|
|
```bash |
|
cp ./.env.example ./.env |
|
``` |
|
|
|
#### 2. `.env`์์ Agora ์ฑ ID์ ์ฑ ์ธ์ฆ์ ์ค์ |
|
|
|
```bash |
|
AGORA_APP_ID= |
|
AGORA_APP_CERTIFICATE= |
|
``` |
|
|
|
#### 3. ์์ด์ ํธ ๊ฐ๋ฐ ์ปจํ
์ด๋ ์์ |
|
```bash |
|
docker compose up -d |
|
``` |
|
|
|
#### 4. ์ปจํ
์ด๋ ์ง์
|
|
```bash |
|
docker exec -it ten_agent_dev bash |
|
``` |
|
|
|
#### 5. ์์ด์ ํธ ๋น๋ |
|
```bash |
|
task use |
|
``` |
|
|
|
#### 6. ์น ์๋ฒ ์์ |
|
```bash |
|
task run |
|
``` |
|
|
|
#### 7. ํ๋ ์ด๊ทธ๋ผ์ด๋ ์ค์ ํธ์ง |
|
[localhost:3000](http://localhost:3000)์์ ํ๋ ์ด๊ทธ๋ผ์ด๋๋ฅผ ์ด์ด ์์ด์ ํธ๋ฅผ ๊ตฌ์ฑํ์ธ์. |
|
1. ๊ทธ๋ํ ์ ํ ์ ํ (์: ์์ฑ ์์ด์ ํธ, ์ค์๊ฐ ์์ด์ ํธ) |
|
2. ํด๋นํ๋ ๋ชจ๋ ์ ํ |
|
3. ํ์ฅ ๊ธฐ๋ฅ์ ์ ํํ๊ณ API ํค ์ค์ ๊ตฌ์ฑ |
|
|
|
 |
|
|
|
<br> |
|
<h2>TEN Agent ๊ตฌ์ฑ ์์</h2> |
|
|
|
 |
|
|
|
<br> |
|
<h2>์ต์ ์์ ๋ฐ์๋ณด๊ธฐ</h2> |
|
|
|
์์ํ๊ธฐ ์ ์, ์ ์ฅ์์ ์คํ๋ฅผ ๋๋ฌ ๋ชจ๋ ์๋ก์ด ๋ฆด๋ฆฌ์ค์ ์๋ฆผ์ ๋ฐ์๋ณด์ธ์! |
|
|
|
 |
|
|
|
<br> |
|
|
|
<h2>์ปค๋ฎค๋ํฐ ์ฐธ์ฌ</h2> |
|
|
|
- [Discord](https://discord.gg/VnPftUzAMJ): ์ ํ๋ฆฌ์ผ์ด์
๊ณต์ ์ ์ปค๋ฎค๋ํฐ ์ฐธ์ฌ์ ์ด์์ ์
๋๋ค. |
|
- [GitHub Discussion](https://github.com/TEN-framework/ten-agent/discussions): ํผ๋๋ฐฑ ์ ๊ณต๊ณผ ์ง๋ฌธํ๊ธฐ์ ์๋ฒฝํฉ๋๋ค. |
|
- [GitHub Issues](https://github.com/TEN-framework/ten-agent/issues): ๋ฒ๊ทธ ์ ๊ณ ์ ์๋ก์ด ๊ธฐ๋ฅ ์ ์์ ์ต์ ์
๋๋ค. ์์ธํ ๋ด์ฉ์ [๊ธฐ์ฌ ๊ฐ์ด๋๋ผ์ธ](./docs/code-of-conduct/contributing.md)์ ์ฐธ์กฐํ์ธ์. |
|
- [X](https://img.shields.io/twitter/follow/TenFramework?logo=X&color=%20%23f5f5f5): ์์ด์ ํธ ๊ณต์ ์ ์ปค๋ฎค๋ํฐ ์ํธ์์ฉ์ ์ข์ต๋๋ค. |
|
|
|
<br> |
|
<h2>์ฝ๋ ๊ธฐ์ฌ์</h2> |
|
|
|
[](https://github.com/TEN-framework/ten-agent/graphs/contributors) |
|
|
|
<br> |
|
<h2>๊ธฐ์ฌ ๊ฐ์ด๋๋ผ์ธ</h2> |
|
|
|
๊ธฐ์ฌ๋ฅผ ํ์ํฉ๋๋ค! ๋จผ์ [๊ธฐ์ฌ ๊ฐ์ด๋๋ผ์ธ](./docs/code-of-conduct/contributing.md)์ ์ฝ์ด์ฃผ์ธ์. |
|
|
|
<br> |
|
<h2>๋ผ์ด์ ์ค</h2> |
|
|
|
์ด ํ๋ก์ ํธ๋ Apache 2.0 ๋ผ์ด์ ์ค ํ์ ์ ๊ณต๋ฉ๋๋ค - ์์ธํ ๋ด์ฉ์ [LICENSE](LICENSE) ํ์ผ์ ์ฐธ์กฐํ์ธ์. |
|
|