Skip to content

Commit

Permalink
feedback updates
Browse files Browse the repository at this point in the history
  • Loading branch information
saudsami committed Sep 26, 2024
1 parent 550a1de commit 85f2427
Show file tree
Hide file tree
Showing 16 changed files with 123 additions and 140 deletions.
5 changes: 2 additions & 3 deletions open-ai-integration/overview/product-overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -47,10 +47,9 @@ description: >
link: '',
},
]}
/>
>

Integrating Agora’s real-time audio communication with OpenAI’s Large Language Models (LLMs) unlocks the potential for powerful, interactive voice-based applications. By combining Agora’s robust real-time audio streaming capabilities with the conversational intelligence of OpenAI’s LLMs, you can create seamless voice-enabled experiences, such as voice-powered AI assistants or interactive dialogue systems. This integration enables dynamic, responsive audio interactions, enhancing user engagement across a broad range of use cases—from customer support bots to collaborative voice-driven applications.

Most importantly, By combining Agora’s and OpenAI’s strengths this integration finally enables the most natural form of language interaction, lowering the barrier for users to leverage the power of AI and making advanced technologies more accessible than ever before.

Most importantly, by combining the strengths of Agora and OpenAI, this integration enables the most natural form of language interaction, lowering the barrier for users to harness the power of AI and making advanced technologies more accessible than ever before.
</ProductOverview>
15 changes: 3 additions & 12 deletions shared/common/core-concepts/agora-console.mdx
Original file line number Diff line number Diff line change
@@ -1,26 +1,17 @@
<ProductWrapper notAllowed={['interactive-whiteboard', 'cloud-recording', 'agora-analytics', 'extensions-marketplace']}>
<Link to="{{Global.AGORA_CONSOLE_URL}}">
<Vg k="CONSOLE" />
</Link>{' '}
is the main dashboard where you manage your <Vg k="COMPANY" /> projects and services. Before you can use <Vg k="COMPANY" />
's SDKs, you must first create a project in the <Vg k="CONSOLE" />. See [Agora account management](../get-started/manage-agora-account) for
<Link to="{{Global.AGORA_CONSOLE_URL}}"><Vg k="CONSOLE" /></Link> is the main dashboard where you manage your <Vg k="COMPANY" /> projects and services. Before you can use <Vg k="COMPANY" />'s SDKs, you must first create a project in the <Vg k="CONSOLE" />. See [Agora account management](../get-started/manage-agora-account) for
details.
</ProductWrapper>

<ProductWrapper product={['interactive-whiteboard', 'cloud-recording', 'agora-analytics', 'extensions-marketplace']}>
To use <Vg k="COMPANY" /> <Vpd k="NAME" />, create a project in the <Vg k="CONSOLE" /> first.
To use <Vg k="COMPANY" /> <Vpd k="NAME" />, create a project in the <Vg k="CONSOLE" /> first.
</ProductWrapper>

<ProductWrapper notAllowed="interactive-whiteboard">![Create project in Agora Console](/images/common/create-project.svg)</ProductWrapper>

#### <Vg k="CONSOLE" />

<Link to="{{Global.AGORA_CONSOLE_URL}}">
<Vg k="CONSOLE" />
</Link> provides an intuitive interface for developers to query and manage their <Vg k="COMPANY" /> account. After registering an <Link to="{{Global.AGORA_CONSOLE_URL}}">
Agora Account
</Link>
, you use the <Vg k="CONSOLE" /> to perform the following tasks:
<Link to="{{Global.AGORA_CONSOLE_URL}}"><Vg k="CONSOLE" /></Link> provides an intuitive interface for developers to query and manage their <Vg k="COMPANY" /> account. After registering an <Link to="{{Global.AGORA_CONSOLE_URL}}">Agora Account</Link>, you use the <Vg k="CONSOLE" /> to perform the following tasks:

- Manage the account
- Create and configure <Vg k="COMPANY" /> projects and services
Expand Down
2 changes: 1 addition & 1 deletion shared/common/core-concepts/app-certificate.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

An App Certificate is a unique key generated by the <Vg k="CONSOLE" /> to secure projects through token authentication. It is required, along with the App ID, to generate a token that proves authorization between your systems and <Vg k="COMPANY" />'s network. App Certificates are used to generate <Vg k="VSDK" /> or <Vg k="MESS" /> authentication tokens.

App Certificates should be stored securely in your backend systems. In the event that your App Certificate is no longer secure or to enable compliance with security requirements, certificates can be invalidated and new ones can be created through <Vg k="CONSOLE" />.
App Certificates should be stored securely in your backend systems. If your App Certificate is compromised or to meet security compliance requirements, you can invalidate certificates and create new ones through the <Vg k='CONSOLE' />.
4 changes: 2 additions & 2 deletions shared/common/core-concepts/app-id.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@ The App ID is a unique key generated by <Vg k="COMPANY" />'s platform to identif
App IDs are stored on the front-end client and do not provide access control. Projects using only an App ID allow any user with the App ID to join voice and video streams.

<ProductWrapper notAllowed={["extensions-marketplace","agora-analytics","video-calling", "voice-calling",
"interactive-live-streaming", "broadcast-streaming","signaling"]}>
"interactive-live-streaming", "broadcast-streaming","signaling","open-ai-integration"]}>

For applications requiring access controls, such as those in production environments, choose an **App ID + Token** mechanism for [user authentication](../get-started/authentication-workflow) when creating a new project. Without an authentication token, your environment is open to anyone with access to your App ID.

</ProductWrapper>

<ProductWrapper product="agora-analytics">
<ProductWrapper product="agora-analytics, open-ai-integration">

For applications requiring access controls, such as those in production environments, choose an **App ID + Token** mechanism for user authentication when creating a new project. Without an authentication token, your environment is open to anyone with your App ID.

Expand Down
8 changes: 4 additions & 4 deletions shared/common/core-concepts/channel.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ In <Vg k="MESS" />, channels serve as a data transfer management mechanism for p

<Vg k="MESS" /> supports the following channel types:

| Channel Type | Main Features | Applicable Scenarios |
| ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Message | Follows the industry-standard pub/sub model. Channels do not need to be created in advance, and there is no upper limit on the number of publishers and subscribers in a channel. | Multi-device management and command exchange in the IoT industry, location tracking in smart devices, etc. |
| Channel Type | Main Features | Applicable Scenarios |
| ------------ | ------------------- | --------------------------------- |
| Message | Follows the industry-standard pub/sub model. Channels do not need to be created in advance, and there is no upper limit on the number of publishers and subscribers in a channel. | Multi-device management and command exchange in the IoT industry, location tracking in smart devices, etc. |
| Stream | Follows the chat room model. Users need to join the channel to send and receive event notifications. Messages are managed and delivered through topics, and a single channel allows up to 1,000 users to join simultaneously. Supports channel sharing and synchronous transmission of audio and video data. | High-frequency and large concurrent data transmission or co-channel and synchronous transmission with audio and video data, such as in metaverse and cloud gaming applications. |

</ProductWrapper>
Expand All @@ -24,6 +24,6 @@ Channels are created by calling the methods for transmitting real-time data. <Vg

These channels are independent of each other.

Additional services provided by <Vg k="COMPANY" />, such as Cloud Recording and Real-Time Transcription, join the <Vg k="VSDK" /> channel to provide real-time recording, transmission acceleration, media playback, and content moderation.
Additional services provided by <Vg k="COMPANY" />, such as Cloud Recording and Real-Time Speech-To-Text, join the <Vg k="VSDK" /> channel to provide real-time recording, transmission acceleration, media playback, and content moderation.

</ProductWrapper>
8 changes: 3 additions & 5 deletions shared/common/core-concepts/open-ai-intro.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,9 @@ import Channel from './channel.mdx';
import UserId from './user-id.mdx';
import SD_RTN from './sd-rtn.mdx';

<Vg k="COMPANY" />
's platform enables you to transcribe audio streams from users in real-time, providing live transcription to power features such as live closed
captions (CC) for improved accessibility.
Combining Agora’s real-time audio communication with OpenAI’s Large Language Models (LLMs) opens up new possibilities for creating powerful, interactive voice-driven applications.

This article introduces the key processes and concepts you need to know to use <Vg k="COMPANY" />'s platform effectively.
This guide introduces the key processes and concepts you need to know to use <Vg k="COMPANY" />'s platform effectively.

## Using the <Vg k="CONSOLE" />

Expand All @@ -27,4 +25,4 @@ This article introduces the key processes and concepts you need to know to use <

## RESTful APIs

<Vg k="COMPANY" /> offers RESTful APIs across many of its products. For the full list, see [Agora API reference](../../../api-reference?platform=rest&product=all).
<Vg k="COMPANY" /> offers RESTful APIs across many of its products. For details, see [RESTful API](/video-calling/channel-management-api/overview).
5 changes: 2 additions & 3 deletions shared/common/core-concepts/real-time-stt.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,9 @@ import Channel from './channel.mdx';
import UserId from './user-id.mdx';
import SD_RTN from './sd-rtn.mdx';

<Vg k="COMPANY" />
's <Vpd k="NAME" /> enables you to transcribe audio of each host to provide live closed captions (CC) and transcription for improved accessibility.
<Vg k="COMPANY" />'s <Vpd k="NAME" /> enables you to transcribe audio of each host to provide live closed captions (CC) and transcription for improved accessibility.

This article introduces the key processes and concepts you need to know to use <Vpd k="NAME" />.
This guide introduces the key processes and concepts you need to know to use <Vpd k="NAME" />.

## Using the <Vg k="CONSOLE" />

Expand Down
7 changes: 1 addition & 6 deletions shared/common/core-concepts/sd-rtn.mdx
Original file line number Diff line number Diff line change
@@ -1,12 +1,7 @@
<a name="agora-sd-rtn"></a>
#### <Vg k="AGORA_BACKEND" />

<Vg k="COMPANY" />
's core engagement services are powered by its Software-Defined Real-time Network (SD-RTN™), which is accessible and available anytime, anywhere
around the world. Unlike traditional networks, the software-defined network is not confined by device, phone numbers, or a telecommunication
provider's coverage area. <Vg k="AGORA_BACKEND" /> has data centers globally, covering over 200 countries and regions. The network delivers sub-second
latency and high availability of real-time video and audio anywhere on the globe. With <Vg k="AGORA_BACKEND" />, <Vg k="COMPANY" /> can
deliver live user engagement experiences in the form of real-time communication (RTC) with the following advantages:
<Vg k="COMPANY" />'s core engagement services are powered by its Software-Defined Real-time Network (SD-RTN™), which is accessible and available anytime, anywhere around the world. Unlike traditional networks, the software-defined network is not confined by device, phone numbers, or a telecommunication provider's coverage area. <Vg k="AGORA_BACKEND" /> has data centers globally, covering over 200 countries and regions. The network delivers sub-second latency and high availability of real-time video and audio anywhere on the globe. With <Vg k="AGORA_BACKEND" />, <Vg k="COMPANY" /> can deliver live user engagement experiences in the form of real-time communication (RTC) with the following advantages:

- Unmatched quality of service
- High availability and accessibility
Expand Down
6 changes: 2 additions & 4 deletions shared/common/core-concepts/token.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,15 @@ Tokens are generated on your server and passed to the client for use in the <Vg

For testing and during development, use the <Vg k="CONSOLE" /> to generate temporary tokens. For production environments, implement a token server as part of your security infrastructure to control access to your channels.

For more information, see [Secure authentication with tokens](../get-started/authentication-workflow).

<ProductWrapper notAllowed={["extensions-marketplace","agora-analytics","video-calling", "voice-calling",
"interactive-live-streaming", "broadcast-streaming","signaling"]}>

For information on setting up a token server for generating and managing tokens, refer to the guide on [creating and running a token server](../get-started/authentication-workflow).
For information on setting up a token server for generating and managing tokens, refer to the guide on [Secure authentication with tokens](/video-calling/get-started/authentication-workflow).

</ProductWrapper>

<ProductWrapper product={["video-calling", "voice-calling", "interactive-live-streaming", "broadcast-streaming","signaling"]}>

For information on setting up a token server for generating and managing tokens, refer to the guide on [creating and running a token server](../get-started/authentication-workflow).
For information on setting up a token server for generating and managing tokens, refer to the guide on [Secure authentication with tokens](../get-started/authentication-workflow).

</ProductWrapper>
4 changes: 2 additions & 2 deletions shared/common/core-concepts/user-id.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

<ProductWrapper notAllowed="signaling">

In <Vg k="COMPANY" />'s platform, the UID is an integer value that is a unique identifier assigned to each user within the context of a specific channel. When joining a channel, you have the choice to either assign a specific UID to the user or pass null and allow <Vg k="COMPANY" />'s platform to automatically generate and assign a UID for the user. If two users attempt to join the same channel with the same UID, it can lead to unexpected behavior.
In <Vg k="COMPANY" />'s platform, the UID is an integer value that is a unique identifier assigned to each user within the context of a specific channel. When joining a channel, you have the choice to either assign a specific UID to the user or pass `0` or `null` and allow <Vg k="COMPANY" />'s platform to automatically generate and assign a UID for the user. If two users attempt to join the same channel with the same UID, it can lead to unexpected behavior.

The UID is used by <Vg k="COMPANY" />'s services and components to identify and manage users within a channel. Developers should ensure that UIDs are properly assigned to prevent conflicts.

Expand All @@ -12,7 +12,7 @@ The UID is used by <Vg k="COMPANY" />'s services and components to identify and

In <Vg k="MESS" />, the UID is a string that is a unique identifier and required along with an App ID to initialize the SDK. It is used to identify the user when logging in to <Vg k="MESS" /> and throughout their session. Users can join channels by providing just the channel name, as the UID is already associated with the user during initialization.

The same UID cannot log in to <Vg k="AGORA_BACKEND" /> from multiple devices at the same time. If <Vpl k="CLIENT"/>s with the same UID logs in to <Vg k="AGORA_BACKEND" />, the <Vplk="CLIENT" /> previously logged in client is disconnected and sent an event notification.
The same UID cannot log in to <Vg k="AGORA_BACKEND" /> from multiple devices at the same time. If <Vpl k="CLIENT" />s with the same UID logs in to <Vg k="AGORA_BACKEND" />, the <Vpl k="CLIENT" /> previously logged in client is disconnected and sent an event notification.

The UID is used for billing and online status notifications.

Expand Down
2 changes: 1 addition & 1 deletion shared/common/core-concepts/video-sdk.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ RTC (Real-Time Communication) refers to real-time communication technology, whic

<Vg k="COMPANY" /> SDKs provide real-time audio and video interaction services, with multi-platform and multi-device support. This includes high-definition video calls, voice-only calls, interactive live streaming, as well as one-on-one and multi-group chats.

This article introduces the key processes and concepts you need to know to use <Vg k="COMPANY" /> SDKs.
This guide introduces the key processes and concepts you need to know to use <Vg k="COMPANY" /> SDKs.

## Using the <Vg k="CONSOLE" />

Expand Down
2 changes: 0 additions & 2 deletions shared/common/prerequisites/index.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
import Android from './android.mdx';
import Ios from './ios.mdx';
import MacOS from './macos.mdx';
import Python from './python.mdx';
import Web from './web.mdx';
import ReactNative from './react-native.mdx';
import ReactJS from './react-js.mdx';
Expand All @@ -15,7 +14,6 @@ import Unreal from './unreal.mdx';
<Android />
<Ios />
<MacOS />
<Python />
<Web />
<ReactNative />
<ReactJS />
Expand Down
Loading

0 comments on commit 85f2427

Please sign in to comment.