diff --git a/.gitbook/assets/astra-voice-agent.gif b/.gitbook/assets/astra_voice_agent.gif similarity index 100% rename from .gitbook/assets/astra-voice-agent.gif rename to .gitbook/assets/astra_voice_agent.gif diff --git a/.gitbook/assets/docker-restart-server.gif b/.gitbook/assets/docker_restart_server.gif similarity index 100% rename from .gitbook/assets/docker-restart-server.gif rename to .gitbook/assets/docker_restart_server.gif diff --git a/.gitbook/assets/docker-setting.gif b/.gitbook/assets/docker_setting.gif similarity index 100% rename from .gitbook/assets/docker-setting.gif rename to .gitbook/assets/docker_setting.gif diff --git a/.gitbook/assets/graph-designer.gif b/.gitbook/assets/graph_designer.gif similarity index 100% rename from .gitbook/assets/graph-designer.gif rename to .gitbook/assets/graph_designer.gif diff --git a/.gitbook/assets/hello-world-python.gif b/.gitbook/assets/hello_world_python.gif similarity index 100% rename from .gitbook/assets/hello-world-python.gif rename to .gitbook/assets/hello_world_python.gif diff --git a/.gitbook/assets/star-the-repo-confetti.gif b/.gitbook/assets/star_the_repo_confetti.gif similarity index 100% rename from .gitbook/assets/star-the-repo-confetti.gif rename to .gitbook/assets/star_the_repo_confetti.gif diff --git a/.gitbook/assets/star-the-repo-confetti-higher-quality.gif b/.gitbook/assets/star_the_repo_confetti_higher_quality.gif similarity index 100% rename from .gitbook/assets/star-the-repo-confetti-higher-quality.gif rename to .gitbook/assets/star_the_repo_confetti_higher_quality.gif diff --git a/.gitbook/assets/voice-agent-archietcuture.png b/.gitbook/assets/voice_agent_archietcuture.png similarity index 100% rename from .gitbook/assets/voice-agent-archietcuture.png rename to .gitbook/assets/voice_agent_archietcuture.png diff --git a/README.md b/README.md index f46fb1b..f2ff829 100644 --- a/README.md +++ b/README.md @@ -20,8 +20,8 @@ Here, you’ll get an overview of all the incredible features TEN offers to help Before we get started, please click the [**star button on our GitHub repo**](https://github.com/rte-design/astra.ai) to stay updated with one of the AI agents powered by TEN. -

Star us to stay updated

+

Star us to stay updated

### Jump right in -
Getting startedQuickstart to build locally 1.pngquickstart.md
Customize agentTwo ways to customize4.pngpublish-your-docs.md
Create hello world extensionBuild extensions right away3.pngcreate-a-hello-world-extension.md
+
Getting startedQuickstart to build locally 1.pngquickstart.md
Customize agentTwo ways to customize4.pngpublish_your_docs.md
Create hello world extensionBuild extensions right away3.pngcreate_a_hello_world_extension.md
diff --git a/SUMMARY.md b/SUMMARY.md index 2e8863d..4f76f1e 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -4,20 +4,20 @@ ## 🎉 Getting Started -* [Quickstart](getting-started/quickstart.md) -* [Customize your agent](getting-started/publish-your-docs.md) -* [Create a hello world extension](getting-started/create-a-hello-world-extension.md) +* [Quickstart](getting_started/quickstart.md) +* [Customize your agent](getting_started/publish_your_docs.md) +* [Create a hello world extension](getting_started/create_a_hello_world_extension.md) ## TEN Service -* [🚧 TEN architecture(beta)](ten-service/ten-architecture-beta.md) -* [🚧 TEN schema(beta)](ten-service/ten-schema-beta.md) -* [TEN API(beta)](ten-service/ten-api-beta.md) -* [🚧 TEN Message type and name(beta)](ten-service/ten-message-type-and-name-beta.md) -* [🚧 Astra AI agent architecture(beta)](ten-service/astra-ai-agent-architecture-beta.md) +* [🚧 TEN architecture(beta)](ten-service/ten_architecture_beta.md) +* [🚧 TEN schema(beta)](ten-service/ten_schema_beta.md) +* [TEN API(beta)](ten-service/ten_api_beta.md) +* [🚧 TEN Message type and name(beta)](ten-service/ten_message_type_and_name_beta.md) +* [🚧 Astra AI agent architecture(beta)](ten-service/astra_ai_agent_architecture_beta.md) ## Tutorials -* [How to debug with logs](tutorials/how-to-debug-with-logs.md) -* [🚧 How to build extension with Go(beta)](tutorials/how-to-build-extension-with-go-beta.md) -* [🚧 How to build extension with C++(beta)](tutorials/how-to-build-extension-with-c++-beta.md) +* [How to debug with logs](tutorials/how_to_debug_with_logs.md) +* [🚧 How to build extension with Go(beta)](tutorials/how_to_build_extension_with_go_beta.md) +* [🚧 How to build extension with C++(beta)](tutorials/how_to_build_extension_with_c++_beta.md) diff --git a/assets/gifs/astra_voice_agent.gif b/assets/gifs/astra_voice_agent.gif new file mode 100644 index 0000000..e9e182b Binary files /dev/null and b/assets/gifs/astra_voice_agent.gif differ diff --git a/assets/gifs/docker_setting.gif b/assets/gifs/docker_setting.gif new file mode 100644 index 0000000..edc0611 Binary files /dev/null and b/assets/gifs/docker_setting.gif differ diff --git a/assets/gifs/graph_designer.gif b/assets/gifs/graph_designer.gif new file mode 100644 index 0000000..955fafa Binary files /dev/null and b/assets/gifs/graph_designer.gif differ diff --git a/assets/gifs/star_the_repo_confetti.gif b/assets/gifs/star_the_repo_confetti.gif new file mode 100644 index 0000000..d41e7d4 Binary files /dev/null and b/assets/gifs/star_the_repo_confetti.gif differ diff --git a/assets/gifs/star_the_repo_confetti_higher_quality.gif b/assets/gifs/star_the_repo_confetti_higher_quality.gif new file mode 100644 index 0000000..1055515 Binary files /dev/null and b/assets/gifs/star_the_repo_confetti_higher_quality.gif differ diff --git a/assets/imgs/astra_banner.jpg b/assets/imgs/astra_banner.jpg new file mode 100644 index 0000000..bcf20d1 Binary files /dev/null and b/assets/imgs/astra_banner.jpg differ diff --git a/assets/imgs/banner_image_without_tagline.png b/assets/imgs/banner_image_without_tagline.png new file mode 100644 index 0000000..e571a29 Binary files /dev/null and b/assets/imgs/banner_image_without_tagline.png differ diff --git a/assets/imgs/docker_setting.png b/assets/imgs/docker_setting.png new file mode 100644 index 0000000..415b412 Binary files /dev/null and b/assets/imgs/docker_setting.png differ diff --git a/assets/imgs/image.png b/assets/imgs/image.png new file mode 100644 index 0000000..28dcfa1 Binary files /dev/null and b/assets/imgs/image.png differ diff --git a/assets/imgs/voice_agent_archietcuture.png b/assets/imgs/voice_agent_archietcuture.png new file mode 100644 index 0000000..d7b5543 Binary files /dev/null and b/assets/imgs/voice_agent_archietcuture.png differ diff --git a/getting-started/create-a-hello-world-extension.md b/getting_started/create_a_hello_world_extension.md similarity index 97% rename from getting-started/create-a-hello-world-extension.md rename to getting_started/create_a_hello_world_extension.md index 2e39ab1..07e06fc 100644 --- a/getting-started/create-a-hello-world-extension.md +++ b/getting_started/create_a_hello_world_extension.md @@ -29,9 +29,11 @@ If the caption says `Terminal`, it means you are running the command locally. If {% endhint %} {% code title=">_ Terminal" %} + ```bash docker compose up ``` + {% endcode %} Once the command is entered, you should see output similar to this: @@ -44,12 +46,12 @@ astra_agents_dev | cd agents && tman dev-server astra_graph_designer | ▲ Next.js 14.2.4 astra_graph_designer | - Local: http://localhost:3000 astra_graph_designer | - Network: http://0.0.0.0:3000 -astra_graph_designer | +astra_graph_designer | astra_graph_designer | ✓ Starting... astra_playground | ▲ Next.js 14.2.4 astra_playground | - Local: http://localhost:3000 astra_playground | - Network: http://0.0.0.0:3000 -astra_playground | +astra_playground | astra_playground | ✓ Starting... astra_graph_designer | ✓ Ready in 293ms astra_playground | ✓ Ready in 293ms @@ -69,9 +71,11 @@ Now, we’ve got the following services running: To work within the isolated environment, run the following command: {% code title=">_ Terminal" %} + ```bash docker exec -it astra_agents_dev bash ``` + {% endcode %} ## 3. Create the hello world extension @@ -154,18 +158,20 @@ Navigate into the `hello_world` directory and open manifest.json. Add the API ob } -For detailed information on the API and schema, please refer to [ten-api-beta.md](../ten-service/ten-api-beta.md "mention") and [ten-schema-beta.md](../ten-service/ten-schema-beta.md "mention"). +For detailed information on the API and schema, please refer to [ten_api_beta.md](../ten-service/ten_api_beta.md "mention") and [ten_schema_beta.md](../ten-service/ten_schema_beta.md "mention"). ## 5. Build the extension Let's use `cd /app` command to go back to the root of the project, and run `make build` to build the extension. {% code title=">_ Bash" %} + ```bash cd /app make build ``` + {% endcode %} ## 6. Restart the server @@ -187,4 +193,3 @@ Congratulations! You’ve successfully created your first `hello_world` extensio ## 8. Check the network requests Open Chrome DevTools, navigate to the Network panel, and monitor the requests. You should see the status codes returning as 200, indicating that the changes have been successfully processed. - diff --git a/getting-started/publish-your-docs.md b/getting_started/publish_your_docs.md similarity index 95% rename from getting-started/publish-your-docs.md rename to getting_started/publish_your_docs.md index 3bf5370..4afadaf 100644 --- a/getting-started/publish-your-docs.md +++ b/getting_started/publish_your_docs.md @@ -18,7 +18,7 @@ There are two primary methods to customize the Astra agent locally: ## Using the power of graph designer (recommended) -
+
The Graph Designer is a user-friendly, visual tool that allows you to create and modify the behavior and responses of the Astra agent without needing to write code. This approach is highly recommended for its ease of use and efficiency. By leveraging the Graph Designer, you can quickly design complex interactions and workflows through a graphical interface, making it accessible even for those with limited programming experience. @@ -51,17 +51,16 @@ For those who prefer a more hands-on approach or need advanced customization, yo "agora_asr_vendor_region": "stt-region", "agora_asr_session_control_file_path": "session_control.conf" } - }, + }, // ... - {% endtab %} {% tab title="config.go" %} 
// ...
 // Default graph name
-graphNameDefault = "va.openai.azure" 
+graphNameDefault = "va.openai.azure"
 // ...
{% endtab %} diff --git a/getting-started/quickstart.md b/getting_started/quickstart.md similarity index 90% rename from getting-started/quickstart.md rename to getting_started/quickstart.md index c25e69d..bba0563 100644 --- a/getting-started/quickstart.md +++ b/getting_started/quickstart.md @@ -16,18 +16,20 @@ layout: In this chapter, we’ll build the Astra agent together. For additional help, check out the YouTube video tutorial at the end. -
+
## Prerequisites {% tabs %} {% tab title="API Keys" %} + * Agora App ID and App Certificate([read here on how](https://docs.agora.io/en/video-calling/get-started/manage-agora-account?platform=web)) * Azure [speech-to-text](https://azure.microsoft.com/en-us/products/ai-services/speech-to-text) and [text-to-speech](https://azure.microsoft.com/en-us/products/ai-services/text-to-speech) API keys * [OpenAI](https://openai.com/index/openai-api/) API key {% endtab %} {% tab title="Installations" %} + * [Docker](https://www.docker.com/) / [Docker Compose](https://docs.docker.com/compose/) * [Node.js(LTS) v18](https://nodejs.org/en) {% endtab %} @@ -45,7 +47,7 @@ In this chapter, we’ll build the Astra agent together. For additional help, ch 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. {% endhint %} -

Make sure the box is unchecked

+

Make sure the box is unchecked

## Next step @@ -54,9 +56,11 @@ You will need to uncheck "Use Rosetta for x86\_64/amd64 emulation on Apple Silic In the root of the project, use `cd` command to create \`.env\` file from example . It will be used to store information for \`docker compose\` later. {% code title=">_ Terminal" %} + ```sh cp ./.env.example ./.env ``` + {% endcode %} **2. Setup API keys & Environment variables in .env file** @@ -64,11 +68,12 @@ cp ./.env.example ./.env Open the `.env` file and fill in the keys and regions. This is also where you can choose to use any different extensions: {% code title=".env" %} + ```bash # Agora App ID and App Certificate AGORA_APP_ID= # Certificate is only required when enabled within Agora.io account -AGORA_APP_CERTIFICATE= +AGORA_APP_CERTIFICATE= # Azure STT key and region AZURE_STT_KEY= @@ -81,6 +86,7 @@ AZURE_TTS_REGION= # OpenAI API key OPENAI_API_KEY= ``` + {% endcode %} **3. Start agent builder toolkit containers** @@ -88,9 +94,11 @@ OPENAI_API_KEY= In the same directory, run the `docker` command to compose containers: {% code title=">_ Terminal" %} + ```bash docker compose up ``` + {% endcode %} **4. Build Astra agent** @@ -98,10 +106,12 @@ docker compose up Open up a separate terminal window, build the agent and start the server: {% code title=">_ Bash" %} + ```bash docker exec -it astra_agents_dev bash make build ``` + {% endcode %} **5. Start the server** @@ -109,9 +119,11 @@ make build Now the server is running at port: 8080. {% code title=">_ Bash" %} + ```bash make run-server ``` + {% endcode %} ## **Finish and verify your agent** @@ -124,16 +136,16 @@ Now you have the power of the Graph Designer at your fingertips to perform the m TEN Graph Designer (beta), a tool that requires zero coding knowledge and makes the experience of creating agentic applications smoother. -

Graph Designer

+

Graph Designer

## Video tutorials {% tabs %} {% tab title="English" %} -{% embed url="https://www.youtube.com/watch?t=1s&v=_AZ3RedzvRg" %} +{% embed url="" %} {% endtab %} {% tab title="中文" %} -{% embed url="https://www.youtube.com/watch?v=MbqF4c2Myrw" %} +{% embed url="" %} {% endtab %} {% endtabs %} diff --git a/ten-service/astra-ai-agent-architecture-beta.md b/ten_service/astra_ai_agent_architecture_beta.md similarity index 83% rename from ten-service/astra-ai-agent-architecture-beta.md rename to ten_service/astra_ai_agent_architecture_beta.md index de42c6c..ac0db78 100644 --- a/ten-service/astra-ai-agent-architecture-beta.md +++ b/ten_service/astra_ai_agent_architecture_beta.md @@ -17,5 +17,4 @@ layout: ## Astra diagram -

Astra voice agent diagram

- +

Astra voice agent diagram

diff --git a/ten-service/ten-api-beta.md b/ten_service/ten_api_beta.md similarity index 100% rename from ten-service/ten-api-beta.md rename to ten_service/ten_api_beta.md diff --git a/ten-service/ten-architecture-beta.md b/ten_service/ten_architecture_beta.md similarity index 100% rename from ten-service/ten-architecture-beta.md rename to ten_service/ten_architecture_beta.md diff --git a/ten-service/ten-message-type-and-name-beta.md b/ten_service/ten_message_type_and_name_beta.md similarity index 100% rename from ten-service/ten-message-type-and-name-beta.md rename to ten_service/ten_message_type_and_name_beta.md diff --git a/ten-service/ten-schema-beta.md b/ten_service/ten_schema_beta.md similarity index 100% rename from ten-service/ten-schema-beta.md rename to ten_service/ten_schema_beta.md diff --git a/tutorials/how-to-build-extension-with-c++-beta.md b/tutorials/how_to_build_extension_with_c++_beta.md similarity index 100% rename from tutorials/how-to-build-extension-with-c++-beta.md rename to tutorials/how_to_build_extension_with_c++_beta.md diff --git a/tutorials/how-to-build-extension-with-go-beta.md b/tutorials/how_to_build_extension_with_go_beta.md similarity index 100% rename from tutorials/how-to-build-extension-with-go-beta.md rename to tutorials/how_to_build_extension_with_go_beta.md diff --git a/tutorials/how-to-debug-with-logs.md b/tutorials/how_to_debug_with_logs.md similarity index 100% rename from tutorials/how-to-debug-with-logs.md rename to tutorials/how_to_debug_with_logs.md