File size: 8,803 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
![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)
[![PRs 歓迎](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 Playground</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. Webサーバーの起動
```bash
task run
```

#### 7. Playground設定の編集
[localhost:3000](http://localhost:3000)でPlaygroundを開き、エージェントを設定します。
 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)ファイルをご覧ください。