Skip to content

Commit

Permalink
fix
Browse files Browse the repository at this point in the history
  • Loading branch information
halajohn committed Aug 29, 2024
1 parent df10717 commit 918726e
Show file tree
Hide file tree
Showing 31 changed files with 44 additions and 29 deletions.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

<figure><img src=".gitbook/assets/star-the-repo-confetti.gif" alt=""><figcaption><p>Star us to stay updated</p></figcaption></figure>
<figure><img src=".gitbook/assets/star_the_repo_confetti.gif" alt=""><figcaption><p>Star us to stay updated</p></figcaption></figure>

### Jump right in

<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-cover data-type="files"></th><th data-hidden></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Getting started</strong></td><td>Quickstart to build locally </td><td><a href=".gitbook/assets/1.png">1.png</a></td><td></td><td><a href="getting-started/quickstart.md">quickstart.md</a></td></tr><tr><td><strong>Customize agent</strong></td><td>Two ways to customize</td><td><a href=".gitbook/assets/4.png">4.png</a></td><td></td><td><a href="getting-started/publish-your-docs.md">publish-your-docs.md</a></td></tr><tr><td><strong>Create hello world extension</strong></td><td>Build extensions right away</td><td><a href=".gitbook/assets/3.png">3.png</a></td><td></td><td><a href="getting-started/create-a-hello-world-extension.md">create-a-hello-world-extension.md</a></td></tr></tbody></table>
<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-cover data-type="files"></th><th data-hidden></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Getting started</strong></td><td>Quickstart to build locally </td><td><a href=".gitbook/assets/1.png">1.png</a></td><td></td><td><a href="getting_started/quickstart.md">quickstart.md</a></td></tr><tr><td><strong>Customize agent</strong></td><td>Two ways to customize</td><td><a href=".gitbook/assets/4.png">4.png</a></td><td></td><td><a href="getting_started/publish_your_docs.md">publish_your_docs.md</a></td></tr><tr><td><strong>Create hello world extension</strong></td><td>Build extensions right away</td><td><a href=".gitbook/assets/3.png">3.png</a></td><td></td><td><a href="getting_started/create_a_hello_world_extension.md">create_a_hello_world_extension.md</a></td></tr></tbody></table>
22 changes: 11 additions & 11 deletions SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Binary file added assets/gifs/astra_voice_agent.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/gifs/docker_setting.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/gifs/graph_designer.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/gifs/star_the_repo_confetti.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/imgs/astra_banner.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/imgs/banner_image_without_tagline.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/imgs/docker_setting.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/imgs/image.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/imgs/voice_agent_archietcuture.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -44,12 +46,12 @@ astra_agents_dev | cd agents &#x26;&#x26; tman dev-server
</strong>astra_graph_designer | ▲ Next.js 14.2.4
<strong>astra_graph_designer | - Local: http://localhost:3000
</strong>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
<strong>astra_playground | - Local: http://localhost:3000
</strong>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
Expand All @@ -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
Expand Down Expand Up @@ -154,18 +158,20 @@ Navigate into the `hello_world` directory and open manifest.json. Add the API ob
}
</code></pre>

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
Expand All @@ -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.

Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ There are two primary methods to customize the Astra agent locally:

## Using the power of graph designer (recommended)

<figure><img src="../.gitbook/assets/graph-designer.gif" alt=""><figcaption></figcaption></figure>
<figure><img src="../.gitbook/assets/graph_designer.gif" alt=""><figcaption></figcaption></figure>

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.

Expand Down Expand Up @@ -51,17 +51,16 @@ For those who prefer a more hands-on approach or need advanced customization, yo
</strong><strong> "agora_asr_vendor_region": "stt-region",
</strong> "agora_asr_session_control_file_path": "session_control.conf"
}
},
},
// ...
</code></pre>


{% endtab %}

{% tab title="config.go" %}
<pre class="language-go" data-title="config.go"><code class="lang-go">// ...
// Default graph name
<strong>graphNameDefault = "va.openai.azure"
<strong>graphNameDefault = "va.openai.azure"
</strong>// ...
</code></pre>
{% endtab %}
Expand Down
24 changes: 18 additions & 6 deletions getting-started/quickstart.md → getting_started/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

<figure><img src="../.gitbook/assets/astra-voice-agent.gif" alt=""><figcaption></figcaption></figure>
<figure><img src="../.gitbook/assets/astra_voice_agent.gif" alt=""><figcaption></figcaption></figure>

## 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 %}
Expand All @@ -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 %}

<figure><img src="../.gitbook/assets/docker-setting.gif" alt="" width="563"><figcaption><p>Make sure the box is unchecked</p></figcaption></figure>
<figure><img src="../.gitbook/assets/docker_setting.gif" alt="" width="563"><figcaption><p>Make sure the box is unchecked</p></figcaption></figure>

## Next step

Expand All @@ -54,21 +56,24 @@ 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**

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=
Expand All @@ -81,37 +86,44 @@ AZURE_TTS_REGION=
# OpenAI API key
OPENAI_API_KEY=
```

{% endcode %}

**3. Start agent builder toolkit containers**

In the same directory, run the `docker` command to compose containers:

{% code title=">_ Terminal" %}

```bash
docker compose up
```

{% endcode %}

**4. Build Astra agent**&#x20;

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**

Now the server is running at port: 8080.

{% code title=">_ Bash" %}

```bash
make run-server
```

{% endcode %}

## **Finish and verify your agent**
Expand All @@ -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.

<figure><img src="../.gitbook/assets/graph-designer.gif" alt=""><figcaption><p>Graph Designer</p></figcaption></figure>
<figure><img src="../.gitbook/assets/graph_designer.gif" alt=""><figcaption><p>Graph Designer</p></figcaption></figure>

## Video tutorials

{% tabs %}
{% tab title="English" %}
{% embed url="https://www.youtube.com/watch?t=1s&v=_AZ3RedzvRg" %}
{% embed url="<https://www.youtube.com/watch?t=1s&v=_AZ3RedzvRg>" %}
{% endtab %}

{% tab title="中文" %}
{% embed url="https://www.youtube.com/watch?v=MbqF4c2Myrw" %}
{% embed url="<https://www.youtube.com/watch?v=MbqF4c2Myrw>" %}
{% endtab %}
{% endtabs %}
Original file line number Diff line number Diff line change
Expand Up @@ -17,5 +17,4 @@ layout:

## Astra diagram

<figure><img src="../.gitbook/assets/voice-agent-archietcuture.png" alt=""><figcaption><p>Astra voice agent diagram</p></figcaption></figure>

<figure><img src="../.gitbook/assets/voice_agent_archietcuture.png" alt=""><figcaption><p>Astra voice agent diagram</p></figcaption></figure>
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 comments on commit 918726e

Please sign in to comment.