client.rb in tencentcloud-sdk-trtc-3.0.835

- old
+ new

@@ -134,11 +134,11 @@
           raise e
         rescue StandardError => e
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
-        # 查询AI转录状态
+        # 查询AI转录任务状态。
 
         # @param request: Request instance for DescribeAITranscription.
         # @type request: :class:`Tencentcloud::trtc::V20190722::DescribeAITranscriptionRequest`
         # @rtype: :class:`Tencentcloud::trtc::V20190722::DescribeAITranscriptionResponse`
         def DescribeAITranscription(request)
@@ -1005,12 +1005,55 @@
           raise e
         rescue StandardError => e
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
-        # 这个接口调用后，后台会启动机器人，实时进行语音识别并下发字幕和会议记录。
+        # 这个接口调用后，后台会启动转录机器人，实时进行语音识别并下发字幕和转录消息。
+        # 转录机器人支持两种拉流方式，通过TranscriptionMode字段控制：
+        # - 拉取全房间的流。
+        # - 拉取特定用户的流。
 
+        # 服务端实时下发字幕和会议记录有两种方式，通过IMAdminUserId和IMAdminUserSig字段控制：
+        # - 如果填写IMAdminUserId和IMAdminUserSig，服务端会调用IM的[发送群组消息](https://cloud.tencent.com/document/product/269/1629)API来向端上实时下发消息。客户端只需监听群组消息的回调即可，比如[web端回调](https://cloud.tencent.com/document/product/269/75319)。
+        # - 如果不填写IMAdminUserId和IMAdminUserSig，服务端使用TRTC自定义消息通道下发消息，CmdId固定是1。客户端只需监听自定义消息的回调即可，比如[c++回调](https://cloud.tencent.com/document/product/647/79637#4cd82f4edb24992a15a25187089e1565)。
+
+        # 服务端实时下发的消息是JSON字符串，实时字幕具体格式如下：
+        # `{
+        #     "type": "subtitle",
+        #     "userid": "xxx",
+        #     "text": "xxx",
+        #     "translation_text": "xxx",
+        #     "start_time": "00:00:02",
+        #     "end_time": "00:00:05"
+        # }`
+        # 字段作用如下：
+        # - type是subtitle，表示这是实时字幕消息。
+        # - userid表示是哪个用户说的话。
+        # - text是语音识别出的文本。
+        # - translation_text是text翻译后的文本，如果不启用翻译，则是空字符串。
+        # - start_time和end_time表示该字幕消息从任务开启后的开始和结束时间。
+
+        # 转录消息具体格式如下：
+        # `{
+        #     "type": "transcription",
+        #     "userid": "xxx",
+        #     "text": "xxx",
+        #     "translation_text": "xx",
+        #     "start_time": "00:00:02",
+        #     "end_time": "00:00:05"
+        # }`
+        # 字段作用如下：
+        # - type是transcription，表示这是转录消息。
+        # - 其余字段同实时字幕消息。
+
+        # 转录消息和实时字幕消息的区别是，转录消息是完整的一句话，实时字幕消息则是这一句话的中间阶段。
+        # 假如有一句完整的话，“今天天气怎么样？”，那么服务的下发消息的顺序可能是这样：
+        # - 字幕消息，“今天”
+        # - 字幕消息，“今天天气”
+        # - 字幕消息，“今天天气怎么样”
+        # - 转录消息，“今天天气怎么样？”
+
         # @param request: Request instance for StartAITranscription.
         # @type request: :class:`Tencentcloud::trtc::V20190722::StartAITranscriptionRequest`
         # @rtype: :class:`Tencentcloud::trtc::V20190722::StartAITranscriptionResponse`
         def StartAITranscription(request)
           body = send_request('StartAITranscription', request.serialize)
@@ -1287,11 +1330,11 @@
           raise e
         rescue StandardError => e
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
-        # 停止AI转录
+        # 停止AI转录任务。
 
         # @param request: Request instance for StopAITranscription.
         # @type request: :class:`Tencentcloud::trtc::V20190722::StopAITranscriptionRequest`
         # @rtype: :class:`Tencentcloud::trtc::V20190722::StopAITranscriptionResponse`
         def StopAITranscription(request)
@@ -1431,10 +1474,10 @@
           raise e
         rescue StandardError => e
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
-        # 对转录的文本进行总结
+        # 对转录的文本进行总结。
 
         # @param request: Request instance for SummarizeTranscription.
         # @type request: :class:`Tencentcloud::trtc::V20190722::SummarizeTranscriptionRequest`
         # @rtype: :class:`Tencentcloud::trtc::V20190722::SummarizeTranscriptionResponse`
         def SummarizeTranscription(request)
\ No newline at end of file