Skip to content

Commit 7d6a824

Browse files
committed
Update README.md
1 parent 05b7d8f commit 7d6a824

File tree

1 file changed

+24
-18
lines changed

1 file changed

+24
-18
lines changed

README.md

Lines changed: 24 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -6,20 +6,28 @@
66

77
<div align="center">
88

9-
[![](https://dcbadge.limes.pink/api/server/9VDGJ9F7)](https://discord.gg/9VDGJ9F7)
9+
<a href="https://discord.gg/9VDGJ9F7"><img src="https://img.shields.io/badge/Discord-@Astra AI%20-blue.svg?logo=discord"></a>
10+
<a href="">
11+
<img src="https://img.shields.io/static/v1?label=RTE&message=Real-Time Engagement&color=yellow" alt="Agora RTE" /></a>
12+
<a href="">
13+
<img src="https://img.shields.io/static/v1?label=RTC&message=Video Call SDK&color=orange" alt="Agora RTC" /></a>
14+
<a href="">
15+
<img src="https://img.shields.io/static/v1?label=RTM&message=IM Chat&color=success" alt="Agora Chat"/></a>
1016

1117
</div>
1218

1319
<div align="center">
1420

15-
🎉 Creation of real-time multi-modal AI Agents 🎉
21+
<span>Low Latency</span>
22+
<span>&nbsp;&nbsp;&nbsp;&nbsp;</span>
23+
<span>LLM Capabilities</span>
24+
<span>&nbsp;&nbsp;&nbsp;&nbsp;</span>
25+
<span>Real-time Multi-model Interactions</span>
1626

17-
Enables the rapid orchestration and reuses of the latest large model capabilities, achieves low-latency, real-time multi-modal interactions with AI Agents.
27+
🎉 Creation of real-time multi-modal AI Agents 🎉
1828

1929
</div>
2030

21-
</br>
22-
2331
## Quick Start
2432

2533
### Playground
@@ -30,9 +38,9 @@ Enables the rapid orchestration and reuses of the latest large model capabilitie
3038

3139
We provide a [live playground](https://astra-agents.agora.io/) where you can experiment and interact with the Astra powered voice agent.
3240

33-
### Local Agent
41+
### Run Local Agent
3442

35-
And of course, you are more than welcome to run our voice agent locally. We have a Docker image ready for you to build and run the agent on both macOS and Windows.
43+
Of course, you are more than welcome to run our voice agent locally. We have a Docker image ready for you to build and run the agent on both macOS and Windows.
3644

3745
To start, make sure you have:
3846

@@ -58,11 +66,11 @@ docker run --restart=always -itd -p 8080:8080 \
5866

5967
This should start an agent server running on port 8080.
6068

61-
### Use Astra.ai playground to connect to your agent
69+
### Use the playground to connect to your agent
6270

6371
You can use the playground project to test with the server you just started.
6472

65-
The playground project is built on NextJS 14, hence it needs Node 18+.
73+
The Playground project is built on NextJS 14, hence it needs Node 18+.
6674

6775
```shell
6876
# set up an .env file
@@ -79,9 +87,7 @@ npm i && npm run dev
7987

8088
# Agent Customization
8189

82-
### Example
83-
84-
Our voice agent is a great place for you to get started with, it uses following Extensions:
90+
Our voice agent is a great place for you to start with, it uses following Extensions:
8591

8692
- _agora_rtc_ / [Agora](https://docs.agora.io/en) for RTC transport + VAD + Azure speech-to-text (STT)
8793
- _azure_tts_ / [Azure](https://azure.microsoft.com/en-us/products/ai-services/text-to-speech) for text-to-speech (TTS)
@@ -134,13 +140,13 @@ export AZURE_TTS_REGION=<your_azure_tts_region>
134140
make run-server
135141
```
136142

137-
🎉 Congratulations! You have created your first personalized voice agent. We appreciate your effort and look forward to seeing it in the extension store. We’d love it if you could share it within the community.
143+
🎉 Congratulations! You have created your first personalized voice agent. We appreciate your effort and look forward to seeing it in the Astra Cloud Store. We’d love it if you could share it within the community.
138144

139145
<br />
140146

141147
# Astra Service
142148

143-
Now let's discuss what's under the hood. The Astra Service is composed of various Astra extensions, developed in different programming languages. These extensions are interconnected using the concept of a graph, which describes their relationships and illustrates the flow of data. Furthermore, sharing and downloading extensions are simplified through the Astra cloud store and the Astra package manager.
149+
Now let's discuss what's under the hood. The Astra Service is composed of various Astra extensions, developed in different programming languages. These extensions are interconnected using Graph, which describes their relationships and illustrates the flow of data. Furthermore, sharing and downloading extensions are simplified through the Astra Cloud Store and the Astra Package Manager.
144150

145151
<div align="center">
146152

@@ -164,7 +170,7 @@ As of June 2024, we support extensions written in the following languages:
164170

165171
### Graph
166172

167-
A graph in Astra describes the data flow between extensions, orchestrating their interactions. For example, the text output from a speech-to-text (STT) extension might be directed to a large language model (LLM) extension. Essentially, a graph defines which extensions are involved and the direction of data flow between them. Developers can customize this flow, directing outputs from one extension, such as an STT, into another, like an LLM.
173+
A Graph in Astra describes the data flow between extensions, orchestrating their interactions. For example, the text output from a speech-to-text (STT) extension might be directed to a large language model (LLM) extension. Essentially, a Graph defines which extensions are involved and the direction of data flow between them. Developers can customize this flow, directing outputs from one extension, such as an STT, into another, like an LLM.
168174

169175
In Astra, there are four main types of data flow between extensions:
170176

@@ -173,19 +179,19 @@ In Astra, there are four main types of data flow between extensions:
173179
- Image frame
174180
- PCM frame
175181

176-
By specifying the direction of these data types in the graph, developers can enable mutual invocation and unidirectional data flow between plugins. This is especially useful for PCM and image data types, simplifying audio and video processing.
182+
By specifying the direction of these data types in the Graph, developers can enable mutual invocation and unidirectional data flow between plugins. This is especially useful for PCM and image data types, simplifying audio and video processing.
177183

178184
### Astra Agent App
179185

180186
An Astra Agent App is a runnable server-side application that combines multiple Extensions following Graph rules to accomplish more sophisticated operations.
181187

182-
### Astra Store
188+
### Astra Cloud Store
183189

184190
The Astra Store is a centralized platform where developers can share their extensions and access those created by others.
185191

186192
### Astra Package Manager
187193

188-
The Astra Package Manager simplifies the process of uploading, sharing, downloading, and installing Astra extensions. Extensions can specify dependencies on other extensions and the environment, and the package manager automatically manages these dependencies, making the installation and release of extensions extremely convenient.
194+
The Astra Package Manager simplifies the process of uploading, sharing, downloading, and installing Astra extensions. Extensions can specify dependencies on other extensions and the environment, and the Astra Package Manager automatically manages these dependencies, making the installation and release of extensions extremely convenient and intuitive.
189195

190196
</br>
191197

0 commit comments

Comments
 (0)