Skip to content

Commit

Permalink
Merge branch 'python-sdk-open-ai-integration' of github.com:/AgoraIO/…
Browse files Browse the repository at this point in the history
…Doc-Source-Private into python-sdk-open-ai-integration
  • Loading branch information
saudsami committed Sep 25, 2024
2 parents 9385c20 + e861c2b commit d666ec9
Show file tree
Hide file tree
Showing 15 changed files with 1,290 additions and 466 deletions.
463 changes: 463 additions & 0 deletions assets/code/open-ai-integration/rtc-py.mdx

Large diffs are not rendered by default.

6 changes: 6 additions & 0 deletions open-ai-integration/get-started/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"position": 2,
"label": "Get started",
"collapsible": true,
"link": null
}
14 changes: 14 additions & 0 deletions open-ai-integration/get-started/manage-agora-account.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: 'Agora account management'
sidebar_position: 2
type: docs
platform_selector: false
description: >
Create, manage and update your Agora account.
---

import ManageAccount from '@docs/shared/common/_manage-agora-account.mdx';

export const toc = [{}];

<ManageAccount PRODUCT="Real-Time STT" company="Agora" client="app" PATH="real-time-stt" />
15 changes: 15 additions & 0 deletions open-ai-integration/get-started/quickstart.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: 'Integration quickstart'
sidebar_position: 1
type: docs
platform_selector: false
description: >
Integrate Agora's real-time audio communication capabilities with OpenAI's Large Language Models (LLMs)
---

import OpenAIIntegration from '@docs/shared/open-ai-integration//quickstart.mdx';

export const toc = [{}];

<OpenAIIntegration />

6 changes: 6 additions & 0 deletions open-ai-integration/overview/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"position": 1,
"label": "Overview",
"collapsible": true,
"link": null
}
15 changes: 15 additions & 0 deletions open-ai-integration/overview/core-concepts.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: 'Core concepts'
sidebar_position: 2
type: docs
platform_selector: false
description: >
Ideas that are central to developing with Agora.
---

import CoreConcepts from '@docs/shared/common/core-concepts/real-time-stt.mdx';

export const toc = [{}];

<CoreConcepts PRODUCT="Real-Time STT" company="Agora" PATH="real-time-stt" client="app" />

50 changes: 50 additions & 0 deletions open-ai-integration/overview/product-overview.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
---
title: 'Product overview'
sidebar_position: 1
platform_selector: false
description: >
Integrate real-time audio with OpenAI LLM.
---

<ProductOverview
title="OpenAI integration"
img="/images/real-time-stt/real-time-stt.png"
quickStartLink="/open-ai-integration/get-started/quickstart"
productFeatures={[
{
title: "Real-Time audio streaming",
content: "Integrate real-time audio streaming between Agora's communication platform and OpenAI's language models to facilitate seamless voice interactions.",
link: ""
},
{
title: "Asynchronous processing",
content: "Handle audio input and model messages concurrently, ensuring responsive interactions without blocking audio streaming.",
link: ""
},
{
title: "Audio frame management",
content: "Manage audio frames effectively by capturing audio data from the Agora channel, sending it to OpenAI for processing, and routing synthesized audio back to users.",
link: ""
},
{
title: "Comprehensive message handling",
content: "Process various message types, including audio transcription deltas and completion notifications, to ensure users receive timely updates and responses.",
link: ""
},
{
title: "Dynamic session configuration",
content: "Dynamically configure session parameters, such as system messages and audio formats, to customize behavior based on application requirements.",
link: ""
},
{
title: "Flexible tool registration",
content: "Enable the registration of both local functions and pass-through tools, allowing the AI to perform specific tasks and retrieve external data.",
link: ""
},
]}

>

Integrating Agora's real-time audio communication with OpenAI's Large Language Models (LLM) opens the door to powerful, interactive voice-based applications. Create seamless voice-enabled experiences, such as voice-controlled AI assistants, or interactive dialogue systems by combining Agora's robust real-time audio streaming capabilities with the conversational intelligence of OpenAI's LLMs. This integration allows for dynamic, responsive audio interactions, enhancing user engagement across a wide range of use cases—from customer support bots to collaborative voice-driven applications.

</ProductOverview>
6 changes: 6 additions & 0 deletions open-ai-integration/reference/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"position": 4,
"label": "Reference",
"collapsible": true,
"link": null
}
14 changes: 14 additions & 0 deletions open-ai-integration/reference/firewall.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: 'Firewall requirements'
sidebar_position: 4
type: docs
platform_selector: false
description: >
use Agora products in environments with restricted network access
---

import Firewall from '@docs/shared/common/_firewall.mdx';

export const toc = [{}];

<Firewall PRODUCT="Real-Time STT" company="Agora" PATH="real-time-stt" client="app" />
14 changes: 14 additions & 0 deletions open-ai-integration/reference/glossary.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: 'Glossary'
sidebar_position: 5
type: docs
platform_selector: false
description: >
A list of terms used in Agora documentation.
---

import Glossary from '@docs/shared/common/_glossary.mdx';

export const toc = [{}];

<Glossary PRODUCT="Real-Time STT" company="Agora" PATH="real-time-stt" client="app" />
14 changes: 14 additions & 0 deletions open-ai-integration/reference/security.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: 'Security'
sidebar_position: 3
type: docs
platform_selector: false
description: >
How Agora handles security.
---

import Security from '@docs/shared/common/_security.mdx';

export const toc = [{}];

<Security PRODUCT="Real-Time STT" company="Agora" PATH="real-time-stt" client="app" />
5 changes: 2 additions & 3 deletions shared/common/prerequisites/python.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
<PlatformWrapper platform="python">

- [Python](https://www.python.org/downloads/) 3.8 or higher
- [Python](https://www.python.org/downloads/) 3.12 or higher

- A supported OS:
- A supported Linux distribution:
- Ubuntu 18.04 LTS or higher
- CentOS 7.0 or higher
- MacOS 13 or higher

</PlatformWrapper>
Loading

0 comments on commit d666ec9

Please sign in to comment.