tencentcloud-sdk-trtc 3.0.834 → 3.0.835

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 71e5d1e93788154c465f23b6aaf4094a84c350a7
-  data.tar.gz: 42a01e7fb8a7c9c551ce61af5b596702036cfe0c
+  metadata.gz: 0fb08e952041133123eca5f8c81e36faecfa43eb
+  data.tar.gz: 20d6bca75aee304019cee21e25fc3f942132461c
 SHA512:
-  metadata.gz: 6608a32a696e2f1b88406adbecd1fde68157211fbf5efa73ba5bbb00e4538067ab1c080dddbd9dadd48df8dce6a47591d358c7c83a883e89361ffa60159c12da
-  data.tar.gz: b2890c5aa6953b53600c964f6d91129044db50b6d8746794a8a61b8ee00ba0cb7f0993bdb573707d97872a6ff6cb2acdb6f9d0472e218a178f4edc2dce166f2f
+  metadata.gz: a985a6d065854ad51e60da3d8b81773fc9bd62da0060b7e575e250ccaabcc3491cd6600417e78fa23bfc5ed2f37295784ccb51ea476684e66397da94bb8f8b67
+  data.tar.gz: 9992b86059a26d3c271703a86eee35b9dde095513875f342dad8a91b8d7321fb0a5b6a2d46d0126f2729d647850f4c07473ed144d59fde2e88a0f840a40e1aa1

data/lib/VERSION

@@ -1 +1 @@
-3.0.834
+3.0.835

data/lib/v20190722/client.rb

@@ -136,7 +136,7 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
-        # 查询AI转录状态
+        # 查询AI转录任务状态。
 
         # @param request: Request instance for DescribeAITranscription.
         # @type request: :class:`Tencentcloud::trtc::V20190722::DescribeAITranscriptionRequest`
@@ -1007,7 +1007,50 @@ module TencentCloud
           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`
@@ -1289,7 +1332,7 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
-        # 停止AI转录
+        # 停止AI转录任务。
 
         # @param request: Request instance for StopAITranscription.
         # @type request: :class:`Tencentcloud::trtc::V20190722::StopAITranscriptionRequest`
@@ -1433,7 +1476,7 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
-        # 对转录的文本进行总结
+        # 对转录的文本进行总结。
 
         # @param request: Request instance for SummarizeTranscription.
         # @type request: :class:`Tencentcloud::trtc::V20190722::SummarizeTranscriptionRequest`

data/lib/v20190722/models.rb

@@ -484,40 +484,64 @@ module TencentCloud
 
       # DescribeAITranscription请求参数结构体
       class DescribeAITranscriptionRequest < TencentCloud::Common::AbstractModel
-        # @param TaskId: 唯一标识AI转录任务。
+        # @param TaskId: 查询任务状态，不使用时传入空字符串。
+        # 有两种查询方式：
+        # 1、只填写TaskId，这种方式使用TaskId来查询任务
+        # 2、TaskId为空字符串，填写SdkAppId和SessionId，这种方式不需要使用TaskId查询任务
         # @type TaskId: String
+        # @param SdkAppId: TRTC的SdkAppId，和SessionId配合使用。
+        # @type SdkAppId: Integer
+        # @param SessionId: 开启转录任务时传入的SessionId，和SdkAppId配合使用。
+        # @type SessionId: String
 
-        attr_accessor :TaskId
+        attr_accessor :TaskId, :SdkAppId, :SessionId
 
-        def initialize(taskid=nil)
+        def initialize(taskid=nil, sdkappid=nil, sessionid=nil)
           @TaskId = taskid
+          @SdkAppId = sdkappid
+          @SessionId = sessionid
         end
 
         def deserialize(params)
           @TaskId = params['TaskId']
+          @SdkAppId = params['SdkAppId']
+          @SessionId = params['SessionId']
         end
       end
 
       # DescribeAITranscription返回参数结构体
       class DescribeAITranscriptionResponse < TencentCloud::Common::AbstractModel
-        # @param StartTime: 起始时间。
+        # @param StartTime: 任务开始时间。
         # @type StartTime: String
         # @param Status: 转录任务状态。
+        # 有4个值：
+        # 1、Idle表示任务未开始
+        # 2、Preparing表示任务准备中
+        # 3、InProgress表示任务正在运行
+        # 4、Stopped表示任务已停止，正在清理资源中
         # @type Status: String
+        # @param TaskId: 唯一标识一次任务。
+        # @type TaskId: String
+        # @param SessionId: 开启转录任务时填写的SessionId，如果没写则不返回。
+        # @type SessionId: String
         # @param RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
         # @type RequestId: String
 
-        attr_accessor :StartTime, :Status, :RequestId
+        attr_accessor :StartTime, :Status, :TaskId, :SessionId, :RequestId
 
-        def initialize(starttime=nil, status=nil, requestid=nil)
+        def initialize(starttime=nil, status=nil, taskid=nil, sessionid=nil, requestid=nil)
           @StartTime = starttime
           @Status = status
+          @TaskId = taskid
+          @SessionId = sessionid
           @RequestId = requestid
         end
 
         def deserialize(params)
           @StartTime = params['StartTime']
           @Status = params['Status']
+          @TaskId = params['TaskId']
+          @SessionId = params['SessionId']
           @RequestId = params['RequestId']
         end
       end
@@ -3337,34 +3361,91 @@ module TencentCloud
 
       # 语音识别使用的配置
       class RecognizeConfig < TencentCloud::Common::AbstractModel
-        # @param Language: 支持的语言，目前支持语言如下：
-        #     Chinese = "zh"
-        #     Chinese_TW = "zh-TW"
-        #     English = "en"
-        #     Vietnamese = "vi"
-        #     Japanese = "ja"
-        #     Korean = "ko"
-        #     Indonesia = "id"
-        #     Thai = "th"
-        #     Portuguese = "pt"
-        #     Turkish = "tr"
-        #     Arabic = "ar"
-        #     Spanish = "es"
-        #     Hindi = "hi"
-        #     French = "fr"
+        # @param Language: 语音识别支持的语言，默认是"zh"。目前全量支持的语言如下，等号左面是语言英文名，右面是Language字段需要填写的值，该值遵循[ISO639](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes)：
+        # Chinese = "zh"
+        # Chinese_TW = "zh-TW"
+        # English = "en"
+        # Vietnamese = "vi"
+        # Japanese = "ja"
+        # Korean = "ko"
+        # Indonesia = "id"
+        # Thai = "th"
+        # Portuguese = "pt"
+        # Turkish = "tr"
+        # Arabic = "ar"
+        # Spanish = "es"
+        # Hindi = "hi"
+        # French = "fr"
+        # Malay = "ms"
+        # Filipino = "fil"
+        # German = "de"
+        # Italian = "it"
+        # Russian = "ru"
+
+        # 注意：
+        # 如果缺少满足您需求的语言，请联系我们技术人员。
+        # tencent asr不支持"it"和"ru"，google asr全都支持。
         # @type Language: String
-        # @param TranslationLanguage: 选填，如果填写，则会启用翻译，不填则忽略。支持语言同Language字段。
+        # @param Model: 使用的模型，目前支持tencent和google，默认是tencent。
+        # @type Model: String
+        # @param TranslationLanguage: 翻译功能支持的语言，如果填写，则会启用翻译，不填则只会使用语音识别。
+        # 目前全量支持的语言如下，等号左面是语言英文名，右面是Language字段需要填写的值，该值遵循[ISO639](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes)：
+        # Chinese = "zh"
+        # Chinese_TW = "zh-TW"
+        # English = "en"
+        # Vietnamese = "vi"
+        # Japanese = "ja"
+        # Korean = "ko"
+        # Indonesia = "id"
+        # Thai = "th"
+        # Portuguese = "pt"
+        # Turkish = "tr"
+        # Arabic = "ar"
+        # Spanish = "es"
+        # Hindi = "hi"
+        # French = "fr"
+        # Malay = "ms"
+        # Filipino = "fil"
+        # German = "de"
+        # Italian = "it"
+        # Russian = "ru"
+
+        # 注意：
+        # 如果缺少满足您需求的语言，请联系我们技术人员。
+        # google支持上述语言两两之间翻译，tencent只支持部分语言之间翻译。
+
+        # tencnet目标语言，各源语言的目标语言支持列表如下，冒号左侧是目标语言，右侧是源语言：
+        # - zh（简体中文）：zh-TW（繁体中文）、en（英语）、ja（日语）、ko（韩语）、fr（法语）、es（西班牙语）、it（意大利语）、de（德语）、tr（土耳其语）、ru（俄语）、pt（葡萄牙语）、vi（越南语）、id（印尼语）、th（泰语）、ms（马来语）
+        # - zh-TW（繁体中文）：zh（简体中文）、en（英语）、ja（日语）、ko（韩语）、fr（法语）、es（西班牙语）、it（意大利语）、de（德语）、tr（土耳其语）、ru（俄语）、pt（葡萄牙语）、vi（越南语）、id（印尼语）、th（泰语）、ms（马来语）
+        # - en（英语）：zh（中文）、zh-TW（繁体中文）、ja（日语）、ko（韩语）、fr（法语）、es（西班牙语）、it（意大利语）、de（德语）、tr（土耳其语）、ru（俄语）、pt（葡萄牙语）、vi（越南语）、id（印尼语）、th（泰语）、ms（马来语）、ar（阿拉伯语）、hi（印地语）
+        # - ja（日语）：zh（中文）、zh-TW（繁体中文）、en（英语）、ko（韩语）
+        # - ko（韩语）：zh（中文）、zh-TW（繁体中文）、en（英语）、ja（日语）
+        # - fr（法语）：zh（中文）、zh-TW（繁体中文）、en（英语）、es（西班牙语）、it（意大利语）、de（德语）、tr（土耳其语）、ru（俄语）、pt（葡萄牙语）
+        # - es（西班牙语）：zh（中文）、zh-TW（繁体中文）、en（英语）、fr（法语）、it（意大利语）、de（德语）、tr（土耳其语）、ru（俄语）、pt（葡萄牙语）
+        # - it（意大利语）：zh（中文）、zh-TW（繁体中文）、en（英语）、fr（法语）、es（西班牙语）、de（德语）、tr（土耳其语）、ru（俄语）、pt（葡萄牙语）
+        # - de（德语）：zh（中文）、zh-TW（繁体中文）、en（英语）、fr（法语）、es（西班牙语）、it（意大利语）、tr（土耳其语）、ru（俄语）、pt（葡萄牙语）
+        # - tr（土耳其语）：zh（中文）、zh-TW（繁体中文）、en（英语）、fr（法语）、es（西班牙语）、it（意大利语）、de（德语）、ru（俄语）、pt（葡萄牙语）
+        # - ru（俄语）：zh（中文）、zh-TW（繁体中文）、en（英语）、fr（法语）、es（西班牙语）、it（意大利语）、de（德语）、tr（土耳其语）、pt（葡萄牙语）
+        # - pt（葡萄牙语）：zh（中文）、zh-TW（繁体中文）、en（英语）、fr（法语）、es（西班牙语）、it（意大利语）、de（德语）、tr（土耳其语）、ru（俄语）
+        # - vi（越南语）：zh（中文）、zh-TW（繁体中文）、en（英语）
+        # - id（印尼语）：zh（中文）、zh-TW（繁体中文）、en（英语）
+        # - th（泰语）：zh（中文）、zh-TW（繁体中文）、en（英语）
+        # - ms（马来语）：zh（中文）、zh-TW（繁体中文）、en（英语）
+        # - ar（阿拉伯语）：en（英语）
+        # - hi（印地语）：en（英语）
         # @type TranslationLanguage: String
 
-        attr_accessor :Language, :TranslationLanguage
+        attr_accessor :Language, :Model, :TranslationLanguage
 
-        def initialize(language=nil, translationlanguage=nil)
+        def initialize(language=nil, model=nil, translationlanguage=nil)
           @Language = language
+          @Model = model
           @TranslationLanguage = translationlanguage
         end
 
         def deserialize(params)
           @Language = params['Language']
+          @Model = params['Model']
           @TranslationLanguage = params['TranslationLanguage']
         end
       end
@@ -3796,23 +3877,31 @@ module TencentCloud
 
       # StartAITranscription请求参数结构体
       class StartAITranscriptionRequest < TencentCloud::Common::AbstractModel
-        # @param SdkAppId: TRTC的[SdkAppId](https://cloud.tencent.com/document/product/647/46351#sdkappid)，使用该sdkappid开启任务。
+        # @param SdkAppId: TRTC的[SdkAppId](https://cloud.tencent.com/document/product/647/46351#sdkappid)，和开启转录任务的房间使用的SdkAppId相同。
         # @type SdkAppId: Integer
-        # @param RoomId: TRTC的[RoomId](https://cloud.tencent.com/document/product/647/46351#roomid)，使用该roomid开启任务。
+        # @param RoomId: TRTC的[RoomId](https://cloud.tencent.com/document/product/647/46351#roomid)，表示开启转录任务的房间号。
         # @type RoomId: String
-        # @param TranscriptionParams: 启动转录机器人和鉴权的参数。
+        # @param TranscriptionParams: 转录机器人的参数。
         # @type TranscriptionParams: :class:`Tencentcloud::Trtc.v20190722.models.TranscriptionParams`
+        # @param SessionId: 调用方传入的唯一Id，服务端用来去重。
+        # 注意：
+        # 如果传入该参数，服务端优先使用该参数来去重。
+        # 如果不传该参数，服务端的去重策略如下：
+        # - 如果TranscriptionMode字段是0，则一个房间只能开启一个任务
+        # - 如果TranscriptionMode字段是1，则一个TargetUserId只能开启一个任务
+        # @type SessionId: String
         # @param RoomIdType: TRTC房间号的类型，0代表数字房间号，1代表字符串房间号。不填默认是数字房间号。
         # @type RoomIdType: Integer
-        # @param RecognizeConfig: 语音识别配置
+        # @param RecognizeConfig: 语音识别配置。
         # @type RecognizeConfig: :class:`Tencentcloud::Trtc.v20190722.models.RecognizeConfig`
 
-        attr_accessor :SdkAppId, :RoomId, :TranscriptionParams, :RoomIdType, :RecognizeConfig
+        attr_accessor :SdkAppId, :RoomId, :TranscriptionParams, :SessionId, :RoomIdType, :RecognizeConfig
 
-        def initialize(sdkappid=nil, roomid=nil, transcriptionparams=nil, roomidtype=nil, recognizeconfig=nil)
+        def initialize(sdkappid=nil, roomid=nil, transcriptionparams=nil, sessionid=nil, roomidtype=nil, recognizeconfig=nil)
           @SdkAppId = sdkappid
           @RoomId = roomid
           @TranscriptionParams = transcriptionparams
+          @SessionId = sessionid
           @RoomIdType = roomidtype
           @RecognizeConfig = recognizeconfig
         end
@@ -3824,6 +3913,7 @@ module TencentCloud
             @TranscriptionParams = TranscriptionParams.new
             @TranscriptionParams.deserialize(params['TranscriptionParams'])
           end
+          @SessionId = params['SessionId']
           @RoomIdType = params['RoomIdType']
           unless params['RecognizeConfig'].nil?
             @RecognizeConfig = RecognizeConfig.new

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tencentcloud-sdk-trtc
 version: !ruby/object:Gem::Version
-  version: 3.0.834
+  version: 3.0.835
 platform: ruby
 authors:
 - Tencent Cloud
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-05-30 00:00:00.000000000 Z
+date: 2024-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tencentcloud-sdk-common