From a37b345f928728b75664492d0e104b34dfb7e9c8 Mon Sep 17 00:00:00 2001 From: digitallysavvy Date: Wed, 2 Oct 2024 22:39:45 -0400 Subject: [PATCH] updated file overview --- shared/open-ai-integration/quickstart.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/shared/open-ai-integration/quickstart.mdx b/shared/open-ai-integration/quickstart.mdx index 2eeafa5bd..1f0f14a10 100644 --- a/shared/open-ai-integration/quickstart.mdx +++ b/shared/open-ai-integration/quickstart.mdx @@ -155,10 +155,10 @@ cd agora-openai-converse Overview of key files: -- `agent.py`: The main script responsible for executing the `RealtimeKitAgent`. It integrates Agora's functionality from the `rtc.py` module and OpenAI's capabilities from the `realtimeapi` package. -- `rtc.py`: Part of the `agora-realtime-ai-api` package, this file is used in `agent.py` and contains an AI-specific implementation of Agora's server-side Python Voice SDK. +- `agent.py`: The main script responsible for executing the `RealtimeKitAgent`, by integrating Agora's and OpenAI's capabilities. - `main.py`: Sets up an HTTP server that handles real-time agent processes. - `tools.py`: Classes for registering and invoking tools. +- `utils.py`: Provides utilities that facilitate passing audio data between Agor and OpenAI. - `parse_args.py`: Parses the command-line arguments used to customize the channel name and user ID when running script. - `realtimeapi/`: Contains the classes and methods that interact with OpenAI's Realtime API.