From 39c84f8300e7fde19e65b5185223115bdafa07f0 Mon Sep 17 00:00:00 2001 From: Elliott Chen Date: Tue, 8 Oct 2024 18:30:38 +0800 Subject: [PATCH 1/3] docs: updating OpenAI Realtime API part to the README.md updating OpenAI Realtime API in the README.md --- README.md | 26 +++++++++++++++++++------- 1 file changed, 19 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 2922be2c4..e37722dcf 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,6 @@
[![Follow on X](https://img.shields.io/twitter/follow/TenFramework?logo=X&color=%20%23f5f5f5)](https://twitter.com/intent/follow?screen_name=TenFramework) -![Product fee](https://img.shields.io/badge/pricing-free-blue.svg?labelColor=%20%239b8afb&color=%20%237a5af8) [![Discussion posts](https://img.shields.io/github/discussions/TEN-framework/ten-agent?labelColor=%20%23FDB062&color=%20%23f79009)](https://github.com/TEN-framework/ten-agent/discussions/) [![Commits](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) [![Issues closed](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) @@ -30,11 +29,19 @@   β€’   [TEN Framework Repository](https://github.com/TEN-framework/ten_framework) +
+
+

πŸŽ‰ TEN Agent with OpenAI Realtime API and RTC

- +OpenAI Realtime API provides ultra-low latency, and RTC offers AI noise suppression. TEN Agent has both. Feel free to try it out at [agent.theten.ai](https://agent.theten.ai). + +![TEN Agent with OpenAI Realtime API and RTC](https://github.com/TEN-framework/docs/blob/main/assets/gif/realtime-api.gif?raw=true) + +
+

TEN Features

-**TEN Agent**, powered by the world’s first real-time multimodal framework. It is open-source, with the ability to speak, see, and access a knowledge base. By taking advantage of TEN Framework, TEN Agent has the following features: +Aside from being world's the first agent to integrate the OpenAI Realtime API and RTC, TEN Agent also offers the following features: 1. **High-Performance Real-Time Multimodal Interactions**: Offers high-performance, low-latency solutions for complex audio-visual AI applications. @@ -58,14 +65,19 @@ Before we get started, be sure to star our repository and get instant notificati ![TEN star us gif](https://github.com/TEN-framework/docs/blob/main/assets/gif/star_us_2.gif?raw=true) -
+ +

How to build TEN Agent locally @@ -143,13 +155,13 @@ make run-server #### TEN Agent Open up http://localhost:3000 in browser to play and test the TEN Agent. -#### Graph Designer +#### TEN Graph Designer Open up another tab go to http://localhost:3001, and use Graph Designer to create, connect and edit extensions on canvas. ![TEN Graph Designer](https://github.com/TEN-framework/docs/blob/main/assets/gif/graph_designer.gif?raw=true) -
+
From 5e9d2582b063ed897339ddd1c7ed98e9c9c4788a Mon Sep 17 00:00:00 2001 From: Elliott Chen Date: Wed, 9 Oct 2024 15:49:53 +0800 Subject: [PATCH 2/3] docs: README.md consistency fix --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index e37722dcf..84fd10f2a 100644 --- a/README.md +++ b/README.md @@ -99,7 +99,7 @@ And, if you choose to use OpenAI Realtime API, then the Vision and RAG won't be #### Docker setting on Apple Silicon You will need to uncheck "Use Rosetta for x86_64/amd64 emulation on Apple Silicon" option for Docker if you are on Apple Silicon, otherwise the server is not going to work. -![Docker Setting](https://github.com/TEN-framework/docs/blob/main/assets/gif/docker_setting.gif?raw=true) +![Docker Setting](https://github.com/TEN-framework/docs/blob/main/assets/png/docker_setting.png?raw=true) ### Next step @@ -150,16 +150,16 @@ Once the build is done, `make run-server` on port `8080`: make run-server ``` -### Finish and verify πŸŽ‰ +### Finish and verify #### TEN Agent -Open up http://localhost:3000 in browser to play and test the TEN Agent. +Open up [localhost:3000]( http://localhost:3000 ) in browser to play and test the TEN Agent. #### TEN Graph Designer -Open up another tab go to http://localhost:3001, and use Graph Designer to create, connect and edit extensions on canvas. +Open up another tab go to [localhost:3001]( http://localhost:3001 ), and use Graph Designer to create, connect and edit extensions on canvas. -![TEN Graph Designer](https://github.com/TEN-framework/docs/blob/main/assets/gif/graph_designer.gif?raw=true) +![TEN Graph Designer](https://github.com/TEN-framework/docs/blob/main/assets/gif/hello_world_python.gif?raw=true)