Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README 1030: updating wording and adding docker -d mode #370

Merged
merged 3 commits into from
Nov 2, 2024
Merged

README 1030: updating wording and adding docker -d mode #370

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ae71d62
docs: updating wording
cyfyifanchen Oct 30, 2024
2758a5f
docs: updating wording
cyfyifanchen Oct 30, 2024
d1859de
docs: adding corresponding part of graph designer
cyfyifanchen Oct 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 18 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,28 +34,31 @@
<br>
<h2>🎉 TEN Agent with OpenAI Realtime API and RTC</h2>

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. Try it now at [agent.theten.ai](https://agent.theten.ai).
Try OpenAI Realtime API and RTC 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.

![TEN Agent with OpenAI Realtime API and RTC](https://github.com/TEN-framework/docs/blob/main/assets/gif/weather-and-news.gif?raw=true)

<br>
<h2>TEN Agent Features</h2>

Aside from being world's the first agent to integrate the OpenAI Realtime API and RTC, TEN Agent also offers the following features:
* **OpenAI Realtime API and RTC integration**:
TEN Agent is the world-class multimodal AI agent to integrate the OpenAI Realtime API and RTC.

1. **High-Performance Real-Time Multimodal Interactions**:
* **High-Performance Real-Time Multimodal Interactions**:
Offers high-performance, low-latency solutions for complex audio-visual AI applications.

2. **Multi-Language and Multi-Platform Support** :
* **Multi-Language and Multi-Platform Support** :
Supports extension development in C++, Go, Python, etc. Runs on Windows, Mac, Linux, and mobile devices.

3. **Edge-Cloud Integration**:
* **Edge-Cloud Integration**:
Flexibly combines edge and cloud-deployed extensions, balancing privacy, cost, and performance.

4. **Flexibility Beyond Model Limitations**:
* **Flexibility Beyond Model Limitations**:
Easily build complex AI applications through simple drag-and-drop programming, integrating audio-visual tools, databases, RAG, and more.

5. **Real-Time Agent State Management**:
* **Real-Time Agent State Management**:
Manages and adjusts agent behavior in real-time for dynamic responsiveness.

<br>
Expand Down Expand Up @@ -109,7 +112,7 @@ You will need to uncheck "Use Rosetta for x86_64/amd64 emulation on Apple Silico
### Next step

#### 1. Modify config files
In the root of the project, use `cp` command to create `.env` from the example.
In the root of the project, use `cp` command to create `.env` from the [ .env.example ](https://github.com/TEN-framework/ten-agent/blob/main/.env.example).

It will be used to store information for `docker compose` later.
```bash
Expand Down Expand Up @@ -142,6 +145,11 @@ In the same directory, run the `docker compose up` command to compose containers
docker compose up
```

Or using the `docker compose up -d` command, start the container in detached mode.([more here](https://doc.theten.ai/ten-agent/setting_up_vscode_for_development_inside_container))
```bash
docker compose up -d
```

#### 4. Enter container and build agent
Open up a separate terminal window, enter the container and build the agent:
```bash
Expand All @@ -161,13 +169,12 @@ make run-server
#### TEN Agent
Open up [localhost:3000]( http://localhost:3000 ) in browser to play the TEN Agent.

#### TEN Agent with OpenAI Realtime API
Open up [localhost:3002]( http://localhost:3002 ) in browser to play the TEN Agent with OpenAI Realtime API.

#### TEN Graph Designer

Open up another tab go to [localhost:3001]( http://localhost:3001 ), and use Graph Designer to create, connect and edit extensions on canvas.

Once you save the graph, you can return to [localhost:3000]( http://localhost:3000 ) and select the corresponding graph to view the changes.

![TEN Graph Designer](https://github.com/TEN-framework/docs/blob/main/assets/gif/hello_world_python.gif?raw=true)

<!-- <br>
Expand Down