tencentcloud-sdk-python 3.0.1158__py2.py3-none-any.whl → 3.0.1160__py2.py3-none-any.whl

tencentcloud/trtc/v20190722/models.py

@@ -1051,10 +1051,19 @@ class DescribeAITranscriptionRequest(AbstractModel):
 
     def __init__(self):
         r"""
-        :param _TaskId: 唯一标识AI转录任务。
+        :param _TaskId: 查询任务状态，不使用时传入空字符串。
+有两种查询方式：
+1、只填写TaskId，这种方式使用TaskId来查询任务
+2、TaskId为空字符串，填写SdkAppId和SessionId，这种方式不需要使用TaskId查询任务
         :type TaskId: str
+        :param _SdkAppId: TRTC的SdkAppId，和SessionId配合使用。
+        :type SdkAppId: int
+        :param _SessionId: 开启转录任务时传入的SessionId，和SdkAppId配合使用。
+        :type SessionId: str
         """
         self._TaskId = None
+        self._SdkAppId = None
+        self._SessionId = None
 
     @property
     def TaskId(self):
@@ -1064,9 +1073,27 @@ class DescribeAITranscriptionRequest(AbstractModel):
     def TaskId(self, TaskId):
         self._TaskId = TaskId
 
+    @property
+    def SdkAppId(self):
+        return self._SdkAppId
+
+    @SdkAppId.setter
+    def SdkAppId(self, SdkAppId):
+        self._SdkAppId = SdkAppId
+
+    @property
+    def SessionId(self):
+        return self._SessionId
+
+    @SessionId.setter
+    def SessionId(self, SessionId):
+        self._SessionId = SessionId
+
 
     def _deserialize(self, params):
         self._TaskId = params.get("TaskId")
+        self._SdkAppId = params.get("SdkAppId")
+        self._SessionId = params.get("SessionId")
         memeber_set = set(params.keys())
         for name, value in vars(self).items():
             property_name = name[1:]
@@ -1084,15 +1111,26 @@ class DescribeAITranscriptionResponse(AbstractModel):
 
     def __init__(self):
         r"""
-        :param _StartTime: 起始时间。
+        :param _StartTime: 任务开始时间。
         :type StartTime: str
         :param _Status: 转录任务状态。
+有4个值：
+1、Idle表示任务未开始
+2、Preparing表示任务准备中
+3、InProgress表示任务正在运行
+4、Stopped表示任务已停止，正在清理资源中
         :type Status: str
+        :param _TaskId: 唯一标识一次任务。
+        :type TaskId: str
+        :param _SessionId: 开启转录任务时填写的SessionId，如果没写则不返回。
+        :type SessionId: str
         :param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
         :type RequestId: str
         """
         self._StartTime = None
         self._Status = None
+        self._TaskId = None
+        self._SessionId = None
         self._RequestId = None
 
     @property
@@ -1111,6 +1149,22 @@ class DescribeAITranscriptionResponse(AbstractModel):
     def Status(self, Status):
         self._Status = Status
 
+    @property
+    def TaskId(self):
+        return self._TaskId
+
+    @TaskId.setter
+    def TaskId(self, TaskId):
+        self._TaskId = TaskId
+
+    @property
+    def SessionId(self):
+        return self._SessionId
+
+    @SessionId.setter
+    def SessionId(self, SessionId):
+        self._SessionId = SessionId
+
     @property
     def RequestId(self):
         return self._RequestId
@@ -1123,6 +1177,8 @@ class DescribeAITranscriptionResponse(AbstractModel):
     def _deserialize(self, params):
         self._StartTime = params.get("StartTime")
         self._Status = params.get("Status")
+        self._TaskId = params.get("TaskId")
+        self._SessionId = params.get("SessionId")
         self._RequestId = params.get("RequestId")
 
 
@@ -7173,26 +7229,82 @@ class RecognizeConfig(AbstractModel):
 
     def __init__(self):
         r"""
-        :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: str
-        :param _TranslationLanguage: 选填，如果填写，则会启用翻译，不填则忽略。支持语言同Language字段。
+        :param _Model: 使用的模型，目前支持tencent和google，默认是tencent。
+        :type Model: str
+        :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: str
         """
         self._Language = None
+        self._Model = None
         self._TranslationLanguage = None
 
     @property
@@ -7203,6 +7315,14 @@ class RecognizeConfig(AbstractModel):
     def Language(self, Language):
         self._Language = Language
 
+    @property
+    def Model(self):
+        return self._Model
+
+    @Model.setter
+    def Model(self, Model):
+        self._Model = Model
+
     @property
     def TranslationLanguage(self):
         return self._TranslationLanguage
@@ -7214,6 +7334,7 @@ class RecognizeConfig(AbstractModel):
 
     def _deserialize(self, params):
         self._Language = params.get("Language")
+        self._Model = params.get("Model")
         self._TranslationLanguage = params.get("TranslationLanguage")
         memeber_set = set(params.keys())
         for name, value in vars(self).items():
@@ -8186,20 +8307,28 @@ class StartAITranscriptionRequest(AbstractModel):
 
     def __init__(self):
         r"""
-        :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: int
-        :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: str
-        :param _TranscriptionParams: 启动转录机器人和鉴权的参数。
+        :param _TranscriptionParams: 转录机器人的参数。
         :type TranscriptionParams: :class:`tencentcloud.trtc.v20190722.models.TranscriptionParams`
+        :param _SessionId: 调用方传入的唯一Id，服务端用来去重。
+注意：
+如果传入该参数，服务端优先使用该参数来去重。
+如果不传该参数，服务端的去重策略如下：
+- 如果TranscriptionMode字段是0，则一个房间只能开启一个任务
+- 如果TranscriptionMode字段是1，则一个TargetUserId只能开启一个任务
+        :type SessionId: str
         :param _RoomIdType: TRTC房间号的类型，0代表数字房间号，1代表字符串房间号。不填默认是数字房间号。
         :type RoomIdType: int
-        :param _RecognizeConfig: 语音识别配置
+        :param _RecognizeConfig: 语音识别配置。
         :type RecognizeConfig: :class:`tencentcloud.trtc.v20190722.models.RecognizeConfig`
         """
         self._SdkAppId = None
         self._RoomId = None
         self._TranscriptionParams = None
+        self._SessionId = None
         self._RoomIdType = None
         self._RecognizeConfig = None
 
@@ -8227,6 +8356,14 @@ class StartAITranscriptionRequest(AbstractModel):
     def TranscriptionParams(self, TranscriptionParams):
         self._TranscriptionParams = TranscriptionParams
 
+    @property
+    def SessionId(self):
+        return self._SessionId
+
+    @SessionId.setter
+    def SessionId(self, SessionId):
+        self._SessionId = SessionId
+
     @property
     def RoomIdType(self):
         return self._RoomIdType
@@ -8250,6 +8387,7 @@ class StartAITranscriptionRequest(AbstractModel):
         if params.get("TranscriptionParams") is not None:
             self._TranscriptionParams = TranscriptionParams()
             self._TranscriptionParams._deserialize(params.get("TranscriptionParams"))
+        self._SessionId = params.get("SessionId")
         self._RoomIdType = params.get("RoomIdType")
         if params.get("RecognizeConfig") is not None:
             self._RecognizeConfig = RecognizeConfig()

tencentcloud/trtc/v20190722/trtc_client.py

@@ -130,7 +130,7 @@ class TrtcClient(AbstractClient):
 
 
     def DescribeAITranscription(self, request):
-        """查询AI转录状态
+        """查询AI转录任务状态。
 
         :param request: Request instance for DescribeAITranscription.
         :type request: :class:`tencentcloud.trtc.v20190722.models.DescribeAITranscriptionRequest`
@@ -969,7 +969,50 @@ class TrtcClient(AbstractClient):
 
 
     def StartAITranscription(self, request):
-        """这个接口调用后，后台会启动机器人，实时进行语音识别并下发字幕和会议记录。
+        """这个接口调用后，后台会启动转录机器人，实时进行语音识别并下发字幕和转录消息。
+        转录机器人支持两种拉流方式，通过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.models.StartAITranscriptionRequest`
@@ -1245,7 +1288,7 @@ class TrtcClient(AbstractClient):
 
 
     def StopAITranscription(self, request):
-        """停止AI转录
+        """停止AI转录任务。
 
         :param request: Request instance for StopAITranscription.
         :type request: :class:`tencentcloud.trtc.v20190722.models.StopAITranscriptionRequest`
@@ -1383,7 +1426,7 @@ class TrtcClient(AbstractClient):
 
 
     def SummarizeTranscription(self, request):
-        """对转录的文本进行总结
+        """对转录的文本进行总结。
 
         :param request: Request instance for SummarizeTranscription.
         :type request: :class:`tencentcloud.trtc.v20190722.models.SummarizeTranscriptionRequest`