ten / docs /readmes /README-KR.md
3v324v23's picture
ะ—ะฐั„ะธะบัะธั€ะพะฒะฐะฝะฐ ั€ะฐะฑะพั‡ะฐั ะฒะตั€ัะธั TEN-Agent ะดะปั HuggingFace Space
87337b1
![TEN Agent ๋ฐฐ๋„ˆ](https://github.com/TEN-framework/docs/blob/main/assets/jpg/banner.jpg?raw=true)
<div align="center">
[![X์—์„œ ํŒ”๋กœ์šฐ](https://img.shields.io/twitter/follow/TenFramework?logo=X&color=%20%23f5f5f5)](https://twitter.com/intent/follow?screen_name=TenFramework)
[![ํ† ๋ก  ๊ฒŒ์‹œ๋ฌผ](https://img.shields.io/github/discussions/TEN-framework/ten-agent?labelColor=%20%23FDB062&color=%20%23f79009)](https://github.com/TEN-framework/ten-agent/discussions/)
[![์ปค๋ฐ‹](https://img.shields.io/github/commit-activity/m/TEN-framework/ten-agent?labelColor=%20%237d89b0&color=%20%235d6b98)](https://github.com/TEN-framework/ten-agent/graphs/commit-activity)
[![ํ•ด๊ฒฐ๋œ ์ด์Šˆ](https://img.shields.io/github/issues-search?query=repo%3ATEN-framework%2Ften-agent%20is%3Aclosed&label=issues%20closed&labelColor=green&color=green)](https://github.com/TEN-framework/ten-agent/issues)
[![PR ํ™˜์˜](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://github.com/TEN-framework/ten-agent/pulls)
[![GitHub ๋ผ์ด์„ ์Šค](https://img.shields.io/badge/License-Apache_2.0-blue.svg?labelColor=%20%23155EEF&color=%20%23528bff)](https://github.com/TEN-framework/ten-agent/blob/main/LICENSE)
[![Discord TEN ์ปค๋ฎค๋‹ˆํ‹ฐ](https://dcbadge.vercel.app/api/server/VnPftUzAMJ)](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>
[![GitHub ์›Œ์ฒ˜](https://img.shields.io/github/watchers/TEN-framework/ten-agent?style=social&label=Watch)](https://GitHub.com/TEN-framework/ten-agent/watchers/?WT.mc_id=academic-105485-koreyst)
[![GitHub ํฌํฌ](https://img.shields.io/github/forks/TEN-framework/ten-agent?style=social&label=Fork)](https://GitHub.com/TEN-framework/ten-agent/network/?WT.mc_id=academic-105485-koreyst)
[![GitHub ์Šคํƒ€](https://img.shields.io/github/stars/TEN-framework/ten-agent?style=social&label=Star)](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>&nbsp;&nbsp;โ€ข&nbsp;&nbsp;</span>
[ํ™•์žฅ ๊ธฐ๋Šฅ ๋งŒ๋“ค๊ธฐ](https://doc.theten.ai/ten-agent/create_a_hello_world_extension)
<span>&nbsp;&nbsp;โ€ข&nbsp;&nbsp;</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๋Š” ๋”์šฑ ๋‹ค์žฌ๋‹ค๋Šฅํ•ด์กŒ์Šต๋‹ˆ๋‹ค.
![OpenAI ์‹ค์‹œ๊ฐ„ API์™€ RTC๋ฅผ ํƒ‘์žฌํ•œ TEN Agent](https://github.com/TEN-framework/docs/blob/main/assets/gif/weather-and-news.gif?raw=true)
<br>
<h2>TEN Agent ์‚ฌ์šฉ ์‚ฌ๋ก€</h2>
![์‚ฌ์šฉ ์‚ฌ๋ก€](https://github.com/TEN-framework/docs/blob/main/assets/jpg/usecases.jpg?raw=true)
<br>
<h2>๋ฐ”๋กœ ์‚ฌ์šฉ ๊ฐ€๋Šฅํ•œ ํ™•์žฅ ๊ธฐ๋Šฅ</h2>
![๋ฐ”๋กœ ์‚ฌ์šฉ ๊ฐ€๋Šฅํ•œ ํ™•์žฅ ๊ธฐ๋Šฅ](https://github.com/TEN-framework/docs/blob/main/assets/jpg/extensions.jpg?raw=true)
<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 ์„œ๋ฒ„์— ๋ฐฐํฌํ–ˆ์„ ๋•Œ์˜ ์„ฑ๋Šฅ์€ ์ •์ƒ์ ์ž…๋‹ˆ๋‹ค.
![Docker ์„ค์ •](https://github.com/TEN-framework/docs/blob/main/assets/gif/docker_setting.gif?raw=true)
<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 ํ‚ค ์„ค์ • ๊ตฌ์„ฑ
![๋ชจ๋“ˆ ์˜ˆ์‹œ](https://github.com/TEN-framework/docs/blob/main/assets/gif/module-example.gif?raw=true)
<br>
<h2>TEN Agent ๊ตฌ์„ฑ ์š”์†Œ</h2>
![๊ตฌ์„ฑ ์š”์†Œ ๋‹ค์ด์–ด๊ทธ๋žจ](https://github.com/TEN-framework/docs/blob/main/assets/jpg/diagram.jpg?raw=true)
<br>
<h2>์ตœ์‹  ์†Œ์‹ ๋ฐ›์•„๋ณด๊ธฐ</h2>
์‹œ์ž‘ํ•˜๊ธฐ ์ „์—, ์ €์žฅ์†Œ์— ์Šคํƒ€๋ฅผ ๋ˆŒ๋Ÿฌ ๋ชจ๋“  ์ƒˆ๋กœ์šด ๋ฆด๋ฆฌ์Šค์˜ ์•Œ๋ฆผ์„ ๋ฐ›์•„๋ณด์„ธ์š”!
![TEN ์Šคํƒ€ ๋ˆ„๋ฅด๊ธฐ GIF](https://github.com/TEN-framework/docs/blob/main/assets/gif/star_us_2.gif?raw=true)
<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>
[![TEN](https://contrib.rocks/image?repo=TEN-framework/ten-agent)](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) ํŒŒ์ผ์„ ์ฐธ์กฐํ•˜์„ธ์š”.