Merge pull request #1007 from AgoraIO/ENDOC-107-rtt-vendor-region-id

added third-party config
AgoraIO · Mar 12, 2024 · 2fc3648 · 2fc3648
2 parents eb07961 + aa99616
commit 2fc3648
Show file tree

Hide file tree

Showing 2 changed files with 157 additions and 18 deletions.
diff --git a/shared/variables/global.js b/shared/variables/global.js
@@ -162,6 +162,8 @@ export const ACC = 'Acceleration';
 export const ACCM = 'Media Accelerator';
 export const ACCG = 'Global Accelerator';
 
+export const RTT = 'Real-Time Transcription';
+
 export const TEMPL = 'Templates';
 
 export const RTEE = 'Extensions';

diff --git a/shared/video-sdk/develop/_real-time-transcription.mdx b/shared/video-sdk/develop/_real-time-transcription.mdx
@@ -14,8 +14,8 @@ display the text in your <Vpl k="CLIENT" />.
 To start transcribing the audio in a channel in real time, you send an `HTTP` request to the <Vg k="AGORA_BACKEND" />
 through your business server. <Vg k="RTT" /> provides the following modes:
 
-* Transcribe speech in real-time, then stream this data to the channel.
-* Transcribe speech in real-time, store the text in the `WebVTT` format, and upload the file to third-party cloud
+* Transcribe speech in real time, then stream this data to the channel.
+* Transcribe speech in real time, store the text in the `WebVTT` format, and upload the file to third-party cloud
 storage.
 
 <Vg k="RTT" /> transcribes at most three speakers in a channel. When there are more than three speakers, the top three are selected based on volume, and their audio is transcribed.
@@ -26,7 +26,7 @@ The following figure shows the workflow to start, query, and stop a <Vg k="RTT"
 
 In order to use the RESTful API to transcribe speech, make the following calls:
 
-1. `acquire`: Request a `builderToken` that authenticates the user and gives permission to start <Vg k="RTT" /> . You must call
+1. `acquire`: Request a `builderToken` that authenticates the user and gives permission to start transcription. You must call
 `start` using this `builderToken` within five minutes.
 1. `start`: Begin the transcription task. Once you start a task, `builderToken` remains valid for the entire
 session. Use the same `builderToken` to query and stop the task.
@@ -37,10 +37,8 @@ session. Use the same `builderToken` to query and stop the task.
 
 In order to set up <Vg k="RTT" /> in your <Vpl k="CLIENT" />, you must have:
 
-* Enabled <Vg k="RTT" /> for your project:
-
-    Contact [email protected].
-* Activated a [supported cloud storage service](#supported-third-party-cloud-storage-services) to record and store <Vg k="RTT" /> videos and texts
+* Enabled <Vg k="RTT" /> for your project. Contact [email protected].
+* Activated a [supported cloud storage service](#cloud-storage-configuration) to record and store <Vg k="RTT" /> videos and texts
 * Installed the [Protobuf package](https://protobuf.dev/downloads) to generate code classes for displaying transcription text.
 * To run the post-processing script, install:
   * Python 3.0
@@ -205,16 +203,155 @@ Use the following language codes in the `recognizeConfig.language` parameter of
 | Turkish (Turkey)                 | tr-TR |
 | Vietnamese (Vietnam)             | vi-VN |
 
-### Supported third-party cloud storage services
+### Cloud storage configuration
+
+Set the following fields to configure third-party storage:
+
+- `vendor`: Number. The third-party cloud storage vendor. The following are supported:
+
+  - `1`: [Amazon S3](https://aws.amazon.com/s3/?nc1=h_ls)
+  - `2`: [Alibaba Cloud](https://www.alibabacloud.com/product/object-storage-service)
+  - `3`: [Tencent Cloud](https://intl.cloud.tencent.com/product/cos)
+  - `4`: [Kingsoft Cloud](https://en.ksyun.com/nv/product/KS3)
+  - `5`: [Microsoft Azure](https://azure.microsoft.com/en-us/services/storage/blobs/)
+  - `6`: [Google Cloud](https://cloud.google.com/storage)
+  - `7`: [Huawei Cloud](https://www.huaweicloud.com/intl/en-us/product/obs)
+  - `8`: [Baidu AI Cloud](https://intl.cloud.baidu.com/product/bos.html)
+
+- `region`: Number. The region information specified for the third-party cloud storage. The service only supports regions in the following lists:
+
+  - Third-party cloud storage is Amazon S3 (`vendor` = 1):
+    - `0`: US_EAST_1
+    - `1`: US_EAST_2
+    - `2`: US_WEST_1
+    - `3`: US_WEST_2
+    - `4`: EU_WEST_1
+    - `5`: EU_WEST_2
+    - `6`: EU_WEST_3
+    - `7`: EU_CENTRAL_1
+    - `8`: AP_SOUTHEAST_1
+    - `9`: AP_SOUTHEAST_2
+    - `10`: AP_NORTHEAST_1
+    - `11`: AP_NORTHEAST_2
+    - `12`: SA_EAST_1
+    - `13`: CA_CENTRAL_1
+    - `14`: AP_SOUTH_1
+    - `15`: CN_NORTH_1
+    - `16`: CN_NORTHWEST_1
+    - `17`: US_GOV_WEST_1
+    - `20`：AP_NORTHEAST_3
+    - `21`：EU_NORTH_1
+    - `22`：ME_SOUTH_1
+    - `23`：US_GOV_EAST_1
+    - `24`: AP_SOUTHEAST_3
+    - `25`: EU_SOUTH_1
+    - `28`: IL_CENTRAL_1
+  - Third-party cloud storage is Alibaba Cloud (`vendor` = 2):
+    - `0`: CN_Hangzhou
+    - `1`: CN_Shanghai
+    - `2`: CN_Qingdao
+    - `3`: CN_Beijing
+    - `4`: CN_Zhangjiakou
+    - `5`: CN_Huhehaote
+    - `6`: CN_Shenzhen
+    - `7`: CN_Hongkong
+    - `8`: US_West_1
+    - `9`: US_East_1
+    - `10`: AP_Southeast_1
+    - `11`: AP_Southeast_2
+    - `12`: AP_Southeast_3
+    - `13`: AP_Southeast_5
+    - `14`: AP_Northeast_1
+    - `15`: AP_South_1
+    - `16`: EU_Central_1
+    - `17`: EU_West_1
+    - `18`: EU_East_1
+    - `19`：AP_Southeast_6
+    - `20`：CN_Heyuan
+    - `21`：CN_Guangzhou
+    - `22`：CN_Chengdu
+    - `23`: CN_Nanjing
+    - `24`: CN_Fuzhou
+    - `25`: CN_Wulanchabu
+    - `26`: CN_Northeast_2
+    - `27`: CN_Southeast_7
+    For details, see [Alibaba Cloud Documentation](https://www.alibabacloud.com/help/doc-detail/31837.html).
+  - Third-party cloud storage is Tencent Cloud (`vendor` = 3):
+    - `0`：AP_Beijing_1
+    - `1`：AP_Beijing
+    - `2`：AP_Shanghai
+    - `3`：AP_Guangzhou
+    - `4`：AP_Chengdu
+    - `5`：AP_Chongqing
+    - `6`：AP_Shenzhen_FSI
+    - `7`：AP_Shanghai_FSI
+    - `8`：AP_Beijing_FSI
+    - `9`：AP_Hongkong
+    - `10`：AP_Singapore
+    - `11`：AP_Mumbai
+    - `12`：AP_Seoul
+    - `13`：AP_Bangkok
+    - `14`：AP_Tokyo
+    - `15`：NA_Siliconvalley
+    - `16`：NA_Ashburn
+    - `17`：NA_Toronto
+    - `18`：EU_Frankfurt
+    - `19`：EU_Moscow
+  - Third-party cloud storage is Kingsoft Cloud (`vendor` = 4):
+    - `0`：CN_Hangzhou
+    - `1`：CN_Shanghai
+    - `2`：CN_Qingdao
+    - `3`：CN_Beijing
+    - `4`：CN_Guangzhou
+    - `5`：CN_Hongkong
+    - `6`：JR_Beijing
+    - `7`：JR_Shanghai
+    - `8`：NA_Russia_1
+    - `9`：NA_Singapore_1
+  - Third-party cloud storage is Microsoft Azure (`vendor` = 5), the `region` parameter has no effect, whether set or not.
+  - Third-party cloud storage is Google Cloud (`vendor` = 6), the `region` parameter has no effect, whether set or not.
+  - Third-party cloud storage is Huawei Cloud (`vendor` = 7):
+    - `0`：CN_North_1
+    - `1`：CN_North_4
+    - `2`：CN_East_2
+    - `3`：CN_East_3
+    - `4`：CN_South_1
+    - `5`：CN_Southwest_2
+    - `6`：AP_Southeast_1
+    - `7`：AP_Southeast_2
+    - `8`：AP_Southeast_3
+    - `9`：AF_South_1
+    - `10`：SA_Argentina_1
+    - `11`：SA_Peru_1
+    - `12`：NA_Mexico_1
+    - `13`：SA_Brazil_1
+    - `14`：LA_South_2
+    - `15`：SA_Chile_1
+  - Third-party cloud storage is Huawei Cloud (`vendor` = 7):
+    - `0`：CN_North_1
+    - `1`：CN_North_4
+    - `2`：CN_East_2
+    - `3`：CN_East_3
+    - `4`：CN_South_1
+    - `5`：CN_Southwest_2
+    - `6`：AP_Southeast_1
+    - `7`：AP_Southeast_2
+    - `8`：AP_Southeast_3
+    - `9`：AF_South_1
+    - `10`：SA_Argentina_1
+    - `11`：SA_Peru_1
+    - `12`：NA_Mexico_1
+    - `13`：SA_Brazil_1
+    - `14`：LA_South_2
+    - `15`：SA_Chile_1
+  - Third-party cloud storage is Baidu AI Cloud (`vendor` = 8):
+    - `0`：Beijing
+    - `1`：Baoding
+    - `2`：Suzhou
+    - `3`：Guangzhou
+    - `4`：Hongkong
+    - `5`：Singapore
+    - `6`：Wuhan
+    - `7`：Shanghai
 
-The following third-party cloud storage service providers are supported:
 
-* [Alibaba Cloud](https://www.alibabacloud.com/product/oss)
-* [Amazon S3](https://aws.amazon.com/s3/?nc1=h_ls)
-* [Baidu AI Cloud](https://intl.cloud.baidu.com/product/bos.html)
-* [Google Cloud](https://cloud.google.com/storage)
-* [Huawei Cloud](https://www.huaweicloud.com/intl/en-us/product/obs.html)
-* [Kingsoft Cloud](https://en.ksyun.com/nv/product/KS3.html)
-* [Microsoft Azure](https://azure.microsoft.com/en-us/services/storage/blobs/)
-* [Qiniu Cloud](https://www.qiniu.com/en/products/kodo)
-* [Tencent Cloud](https://intl.cloud.tencent.com/product/cos)