tencentcloud-sdk-python 3.0.1136__py2.py3-none-any.whl → 3.0.1138__py2.py3-none-any.whl

tencentcloud/hunyuan/v20230901/models.py

@@ -18,6 +18,246 @@ import warnings
 from tencentcloud.common.abstract_model import AbstractModel
 
 
+class ChatCompletionsRequest(AbstractModel):
+    """ChatCompletions请求参数结构体
+
+    """
+
+    def __init__(self):
+        r"""
+        :param _Model: 模型名称，可选值包括 hunyuan-lite、hunyuan-standard、hunyuan-pro。
+各模型介绍请阅读 [产品概述](https://cloud.tencent.com/document/product/1729/104753) 中的说明。
+
+注意：
+不同的模型计费不同，请根据 [购买指南](https://cloud.tencent.com/document/product/1729/97731) 按需调用。
+        :type Model: str
+        :param _Messages: 聊天上下文信息。
+说明：
+1. 长度最多为 40，按对话时间从旧到新在数组中排列。
+2. Message.Role 可选值：system、user、assistant。
+其中，system 角色可选，如存在则必须位于列表的最开始。user 和 assistant 需交替出现（一问一答），以 user 提问开始和结束，且 Content 不能为空。Role 的顺序示例：[system（可选） user assistant user assistant user ...]。
+3. Messages 中 Content 总长度不能超过模型输入长度上限（可参考 [产品概述](https://cloud.tencent.com/document/product/1729/104753) 文档），超过则会截断最前面的内容，只保留尾部内容。
+        :type Messages: list of Message
+        :param _Stream: 流式调用开关。
+说明：
+1. 未传值时默认为非流式调用（false）。
+2. 流式调用时以 SSE 协议增量返回结果（返回值取 Choices[n].Delta 中的值，需要拼接增量数据才能获得完整结果）。
+3. 非流式调用时：
+调用方式与普通 HTTP 请求无异。
+接口响应耗时较长，**如需更低时延建议设置为 true**。
+只返回一次最终结果（返回值取 Choices[n].Message 中的值）。
+
+注意：
+通过 SDK 调用时，流式和非流式调用需用**不同的方式**获取返回值，具体参考 SDK 中的注释或示例（在各语言 SDK 代码仓库的 examples/hunyuan/v20230901/ 目录中）。
+        :type Stream: bool
+        :param _StreamModeration: 流式输出审核开关。
+说明：
+1. 当使用流式输出（Stream 字段值为 true）时，该字段生效。
+2. 输出审核有流式和同步两种模式，**流式模式首包响应更快**。未传值时默认为流式模式（true）。
+3. 如果值为 true，将对输出内容进行分段审核，审核通过的内容流式输出返回。如果出现审核不过，响应中的 FinishReason 值为 sensitive。
+4. 如果值为 false，则不使用流式输出审核，需要审核完所有输出内容后再返回结果。
+
+注意：
+当选择流式输出审核时，可能会出现部分内容已输出，但中间某一段响应中的 FinishReason 值为 sensitive，此时说明安全审核未通过。如果业务场景有实时文字上屏的需求，需要自行撤回已上屏的内容，并建议自定义替换为一条提示语，如 “这个问题我不方便回答，不如我们换个话题试试”，以保障终端体验。
+        :type StreamModeration: bool
+        :param _TopP: 说明：
+1. 影响输出文本的多样性，取值越大，生成文本的多样性越强。
+2. 默认 1.0，取值区间为 [0.0, 1.0]。
+3. 非必要不建议使用，不合理的取值会影响效果。
+        :type TopP: float
+        :param _Temperature: 说明：
+1. 较高的数值会使输出更加随机，而较低的数值会使其更加集中和确定。
+2. 默认 1.0，取值区间为 [0.0, 2.0]。
+3. 非必要不建议使用，不合理的取值会影响效果。
+        :type Temperature: float
+        """
+        self._Model = None
+        self._Messages = None
+        self._Stream = None
+        self._StreamModeration = None
+        self._TopP = None
+        self._Temperature = None
+
+    @property
+    def Model(self):
+        return self._Model
+
+    @Model.setter
+    def Model(self, Model):
+        self._Model = Model
+
+    @property
+    def Messages(self):
+        return self._Messages
+
+    @Messages.setter
+    def Messages(self, Messages):
+        self._Messages = Messages
+
+    @property
+    def Stream(self):
+        return self._Stream
+
+    @Stream.setter
+    def Stream(self, Stream):
+        self._Stream = Stream
+
+    @property
+    def StreamModeration(self):
+        return self._StreamModeration
+
+    @StreamModeration.setter
+    def StreamModeration(self, StreamModeration):
+        self._StreamModeration = StreamModeration
+
+    @property
+    def TopP(self):
+        return self._TopP
+
+    @TopP.setter
+    def TopP(self, TopP):
+        self._TopP = TopP
+
+    @property
+    def Temperature(self):
+        return self._Temperature
+
+    @Temperature.setter
+    def Temperature(self, Temperature):
+        self._Temperature = Temperature
+
+
+    def _deserialize(self, params):
+        self._Model = params.get("Model")
+        if params.get("Messages") is not None:
+            self._Messages = []
+            for item in params.get("Messages"):
+                obj = Message()
+                obj._deserialize(item)
+                self._Messages.append(obj)
+        self._Stream = params.get("Stream")
+        self._StreamModeration = params.get("StreamModeration")
+        self._TopP = params.get("TopP")
+        self._Temperature = params.get("Temperature")
+        memeber_set = set(params.keys())
+        for name, value in vars(self).items():
+            property_name = name[1:]
+            if property_name in memeber_set:
+                memeber_set.remove(property_name)
+        if len(memeber_set) > 0:
+            warnings.warn("%s fileds are useless." % ",".join(memeber_set))
+        
+
+
+class ChatCompletionsResponse(AbstractModel):
+    """ChatCompletions返回参数结构体
+
+    """
+
+    def __init__(self):
+        r"""
+        :param _Created: Unix 时间戳，单位为秒。
+        :type Created: int
+        :param _Usage: Token 统计信息。
+按照总 Token 数量计费。
+        :type Usage: :class:`tencentcloud.hunyuan.v20230901.models.Usage`
+        :param _Note: 免责声明。
+        :type Note: str
+        :param _Id: 本轮对话的 ID。
+        :type Id: str
+        :param _Choices: 回复内容。
+        :type Choices: list of Choice
+        :param _ErrorMsg: 错误信息。
+如果流式返回中服务处理异常，返回该错误信息。
+注意：此字段可能返回 null，表示取不到有效值。
+        :type ErrorMsg: :class:`tencentcloud.hunyuan.v20230901.models.ErrorMsg`
+        :param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。本接口为流式响应接口，当请求成功时，RequestId 会被放在 HTTP 响应的 Header "X-TC-RequestId" 中。
+        :type RequestId: str
+        """
+        self._Created = None
+        self._Usage = None
+        self._Note = None
+        self._Id = None
+        self._Choices = None
+        self._ErrorMsg = None
+        self._RequestId = None
+
+    @property
+    def Created(self):
+        return self._Created
+
+    @Created.setter
+    def Created(self, Created):
+        self._Created = Created
+
+    @property
+    def Usage(self):
+        return self._Usage
+
+    @Usage.setter
+    def Usage(self, Usage):
+        self._Usage = Usage
+
+    @property
+    def Note(self):
+        return self._Note
+
+    @Note.setter
+    def Note(self, Note):
+        self._Note = Note
+
+    @property
+    def Id(self):
+        return self._Id
+
+    @Id.setter
+    def Id(self, Id):
+        self._Id = Id
+
+    @property
+    def Choices(self):
+        return self._Choices
+
+    @Choices.setter
+    def Choices(self, Choices):
+        self._Choices = Choices
+
+    @property
+    def ErrorMsg(self):
+        return self._ErrorMsg
+
+    @ErrorMsg.setter
+    def ErrorMsg(self, ErrorMsg):
+        self._ErrorMsg = ErrorMsg
+
+    @property
+    def RequestId(self):
+        return self._RequestId
+
+    @RequestId.setter
+    def RequestId(self, RequestId):
+        self._RequestId = RequestId
+
+
+    def _deserialize(self, params):
+        self._Created = params.get("Created")
+        if params.get("Usage") is not None:
+            self._Usage = Usage()
+            self._Usage._deserialize(params.get("Usage"))
+        self._Note = params.get("Note")
+        self._Id = params.get("Id")
+        if params.get("Choices") is not None:
+            self._Choices = []
+            for item in params.get("Choices"):
+                obj = Choice()
+                obj._deserialize(item)
+                self._Choices.append(obj)
+        if params.get("ErrorMsg") is not None:
+            self._ErrorMsg = ErrorMsg()
+            self._ErrorMsg._deserialize(params.get("ErrorMsg"))
+        self._RequestId = params.get("RequestId")
+
+
 class ChatProRequest(AbstractModel):
     """ChatPro请求参数结构体
 
@@ -28,8 +268,9 @@ class ChatProRequest(AbstractModel):
         :param _Messages: 聊天上下文信息。
 说明：
 1. 长度最多为 40，按对话时间从旧到新在数组中排列。
-2. Message 的 Role 当前可选值：system、user、assistant。其中，system 角色是可选的，如果存在，必须位于列表的最开始。此外，user 和 assistant 需交替出现（一问一答），以 user 提问开始和结束，且 Content 不能为空。Role 的顺序示例：[system（可选） user assistant user assistant user ...]。
-3. Messages 中 Content 总长度不超过 16000 Token，超过则会截断最前面的内容，只保留尾部内容。建议不超过 4000 Token。
+2. Message.Role 可选值：system、user、assistant。
+其中，system 角色可选，如存在则必须位于列表的最开始。user 和 assistant 需交替出现（一问一答），以 user 提问开始和结束，且 Content 不能为空。Role 的顺序示例：[system（可选） user assistant user assistant user ...]。
+3. Messages 中 Content 总长度不能超过 hunyuan-pro 模型输入长度上限（可参考 [产品概述](https://cloud.tencent.com/document/product/1729/104753) 文档），超过则会截断最前面的内容，只保留尾部内容。
         :type Messages: list of Message
         :param _TopP: 说明：
 1. 影响输出文本的多样性，取值越大，生成文本的多样性越强。
@@ -38,7 +279,7 @@ class ChatProRequest(AbstractModel):
         :type TopP: float
         :param _Temperature: 说明：
 1. 较高的数值会使输出更加随机，而较低的数值会使其更加集中和确定。
-2. 默认 1.0，取值区间为 [0.0，2.0]。
+2. 默认 1.0，取值区间为 [0.0, 2.0]。
 3. 非必要不建议使用，不合理的取值会影响效果。
         :type Temperature: float
         :param _Stream: 流式调用开关。
@@ -47,16 +288,19 @@ class ChatProRequest(AbstractModel):
 2. 流式调用时以 SSE 协议增量返回结果。
 3. 非流式调用时接口响应耗时较长，非必要不建议使用。
 4. 非流式调用时只返回一次最终结果，调用方式与普通 HTTP 请求无异。
+
+注意：
+通过 SDK 调用时，流式和非流式调用需要用**不同的方式**获取返回值，具体参考 SDK 中的注释或示例（在各语言 SDK 代码仓库的 examples/hunyuan/v20230901/ 目录中）。
         :type Stream: bool
         :param _StreamModeration: 流式输出审核开关。
 说明：
-1. 当 Stream 字段值为 true 时，该字段有效。
-2. 未传值时默认不使用流式输出审核。
-3. 如果值为 true，将对输出内容进行分段审核，审核通过的内容流式输出返回。如果出现审核不过，响应中的 finish_reason 值为 sensitive。
-4. 如果值为 false，则需要审核完所有输出内容后再返回结果。
+1. 输出审核有流式和同步两种模式，**流式模式首包响应更快**。
+2. 当使用流式输出（Stream 字段值为 true）时，该字段生效。
+3. 如果值为 true，将对输出内容进行分段审核，审核通过的内容流式输出返回。如果出现审核不过，响应中的 FinishReason 值为 sensitive。
+4. 如果未传值或值为 false，则不使用流式输出审核，需要审核完所有输出内容后再返回结果。
 
 注意：
-当选择流式输出审核时，可能会出现部分内容已输出，但中间某一段响应中的 finish_reason 值为 sensitive，此时说明安全审核未通过。如果业务场景有实时文字上屏的需求，需要自行撤回已上屏的内容，并建议自定义替换为一条提示语，如 “这个问题我不方便回答，不如我们换个话题试试”，以保障终端体验。
+当选择流式输出审核时，可能会出现部分内容已输出，但中间某一段响应中的 FinishReason 值为 sensitive，此时说明安全审核未通过。如果业务场景有实时文字上屏的需求，需要自行撤回已上屏的内容，并建议自定义替换为一条提示语，如 “这个问题我不方便回答，不如我们换个话题试试”，以保障终端体验。
         :type StreamModeration: bool
         """
         self._Messages = None
@@ -246,9 +490,9 @@ class ChatStdRequest(AbstractModel):
         :param _Messages: 聊天上下文信息。
 说明：
 1. 长度最多为 40，按对话时间从旧到新在数组中排列。
-2. Message 的 Role 当前可选值：user、assistant。其中，user 和 assistant 需交替出现（一问一答），以 user 提问开始和结束，且 Content 不能为空。Role 的顺序示例：[user assistant user assistant user ...]。
-3. Messages 中 Content 总长度不超过 16000 Token，超过则会截断最前面的内容，只保留尾部内容。建议不超过 4000 Token。
-
+2. Message 的 Role 当前可选值：user、assistant。
+其中，user 和 assistant 需交替出现（一问一答），以 user 提问开始和结束，且 Content 不能为空。Role 的顺序示例：[user assistant user assistant user ...]。
+3. Messages 中 Content 总长度不能超过 hunyuan-standard 模型输入长度上限（可参考 [产品概述](https://cloud.tencent.com/document/product/1729/104753) 文档），超过则会截断最前面的内容，只保留尾部内容。
         :type Messages: list of Message
         :param _TopP: 说明：
 1. 影响输出文本的多样性，取值越大，生成文本的多样性越强。
@@ -257,7 +501,7 @@ class ChatStdRequest(AbstractModel):
         :type TopP: float
         :param _Temperature: 说明：
 1. 较高的数值会使输出更加随机，而较低的数值会使其更加集中和确定。
-2. 默认 1.0，取值区间为 [0.0，2.0]。
+2. 默认 1.0，取值区间为 [0.0, 2.0]。
 3. 非必要不建议使用，不合理的取值会影响效果。
         :type Temperature: float
         :param _Stream: 流式调用开关。
@@ -266,16 +510,19 @@ class ChatStdRequest(AbstractModel):
 2. 流式调用时以 SSE 协议增量返回结果。
 3. 非流式调用时接口响应耗时较长，非必要不建议使用。
 4. 非流式调用时只返回一次最终结果，调用方式与普通 HTTP 请求无异。
+
+注意：
+通过 SDK 调用时，流式和非流式调用需要用**不同的方式**获取返回值，具体参考 SDK 中的注释或示例（在各语言 SDK 代码仓库的 examples/hunyuan/v20230901/ 目录中）。
         :type Stream: bool
         :param _StreamModeration: 流式输出审核开关。
 说明：
-1. 当 Stream 字段值为 true 时，该字段有效。
-2. 未传值时默认不使用流式输出审核。
-3. 如果值为 true，将对输出内容进行分段审核，审核通过的内容流式输出返回。如果出现审核不过，响应中的 finish_reason 值为 sensitive。
-4. 如果值为 false，则需要审核完所有输出内容后再返回结果。
+1. 输出审核有流式和同步两种模式，**流式模式首包响应更快**。
+2. 当使用流式输出（Stream 字段值为 true）时，该字段生效。
+3. 如果值为 true，将对输出内容进行分段审核，审核通过的内容流式输出返回。如果出现审核不过，响应中的 FinishReason 值为 sensitive。
+4. 如果未传值或值为 false，则不使用流式输出审核，需要审核完所有输出内容后再返回结果。
 
 注意：
-当选择流式输出审核时，可能会出现部分内容已输出，但中间某一段响应中的 finish_reason 值为 sensitive，此时说明安全审核未通过。如果业务场景有实时文字上屏的需求，需要自行撤回已上屏的内容，并建议自定义替换为一条提示语，如 “这个问题我不方便回答，不如我们换个话题试试”，以保障终端体验。
+当选择流式输出审核时，可能会出现部分内容已输出，但中间某一段响应中的 FinishReason 值为 sensitive，此时说明安全审核未通过。如果业务场景有实时文字上屏的需求，需要自行撤回已上屏的内容，并建议自定义替换为一条提示语，如 “这个问题我不方便回答，不如我们换个话题试试”，以保障终端体验。
         :type StreamModeration: bool
         """
         self._Messages = None
@@ -462,7 +709,8 @@ class Choice(AbstractModel):
 
     def __init__(self):
         r"""
-        :param _FinishReason: 结束标志位，为 stop 则表示尾包。
+        :param _FinishReason: 结束标志位，可能为 stop 或 sensitive。
+stop 表示输出正常结束，sensitive 只在开启流式输出审核时会出现，表示安全审核未通过。
         :type FinishReason: str
         :param _Delta: 增量返回值，流式调用时使用该字段。
 注意：此字段可能返回 null，表示取不到有效值。
@@ -564,7 +812,7 @@ class Delta(AbstractModel):
 
 
 class EmbeddingData(AbstractModel):
-    """embedding 信息，当前不支持批量，所以数组元素数目为1。
+    """Embedding 信息。
 
     """
 
@@ -723,7 +971,7 @@ class GetEmbeddingRequest(AbstractModel):
 
     def __init__(self):
         r"""
-        :param _Input: 输入文本。总长度不超过1024 个token, 超过则会截断最后面的内容。
+        :param _Input: 输入文本。总长度不超过 1024 个 Token，超过则会截断最后面的内容。
         :type Input: str
         """
         self._Input = None
@@ -756,9 +1004,9 @@ class GetEmbeddingResponse(AbstractModel):
 
     def __init__(self):
         r"""
-        :param _Data: 返回的 embedding 信息。
+        :param _Data: 返回的 Embedding 信息。当前不支持批量，所以数组元素数目为 1。
         :type Data: list of EmbeddingData
-        :param _Usage: token 使用计数，按照总token数量收费。
+        :param _Usage: Token 使用计数，按照总 Token 数量收费。
         :type Usage: :class:`tencentcloud.hunyuan.v20230901.models.EmbeddingUsage`
         :param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
         :type RequestId: str
@@ -908,7 +1156,7 @@ class Message(AbstractModel):
         r"""
         :param _Role: 角色
         :type Role: str
-        :param _Content: 消息内容
+        :param _Content: 文本内容
         :type Content: str
         """
         self._Role = None

tencentcloud/ims/v20200713/errorcodes.py

@@ -98,6 +98,9 @@ RESOURCEUNAVAILABLE_IMAGEDOWNLOADERROR = 'ResourceUnavailable.ImageDownloadError
 # 图片资源错误。
 RESOURCEUNAVAILABLE_INVALIDIMAGECONTENT = 'ResourceUnavailable.InvalidImageContent'
 
+# 模型调用失败，请重试。
+RESOURCEUNAVAILABLE_MODELCALLFAILED = 'ResourceUnavailable.ModelCallFailed'
+
 # 资源售罄。
 RESOURCESSOLDOUT = 'ResourcesSoldOut'
 

tencentcloud/iotvideo/v20211125/models.py

@@ -1555,11 +1555,15 @@ class CloudStorageEvent(AbstractModel):
         :type Thumbnail: str
         :param _EventId: 事件ID
         :type EventId: str
+        :param _UploadStatus: 事件录像上传状态，Finished: 全部上传成功 Partial: 部分上传成功 Failed: 上传失败
+注意：此字段可能返回 null，表示取不到有效值。
+        :type UploadStatus: str
         """
         self._StartTime = None
         self._EndTime = None
         self._Thumbnail = None
         self._EventId = None
+        self._UploadStatus = None
 
     @property
     def StartTime(self):
@@ -1593,12 +1597,21 @@ class CloudStorageEvent(AbstractModel):
     def EventId(self, EventId):
         self._EventId = EventId
 
+    @property
+    def UploadStatus(self):
+        return self._UploadStatus
+
+    @UploadStatus.setter
+    def UploadStatus(self, UploadStatus):
+        self._UploadStatus = UploadStatus
+
 
     def _deserialize(self, params):
         self._StartTime = params.get("StartTime")
         self._EndTime = params.get("EndTime")
         self._Thumbnail = params.get("Thumbnail")
         self._EventId = params.get("EventId")
+        self._UploadStatus = params.get("UploadStatus")
         memeber_set = set(params.keys())
         for name, value in vars(self).items():
             property_name = name[1:]

tencentcloud/lcic/v20220817/models.py

@@ -8055,7 +8055,7 @@ video 纯视频
         :type RecordLayout: int
         :param _EndDelayTime: 拖堂时间：单位分钟，0为不限制(默认值), -1为不能拖堂，大于0为拖堂的时间，最大值120分钟
         :type EndDelayTime: int
-        :param _LiveType: 直播方式：0 常规模式（默认）1 回放直播模式（伪直播）
+        :param _LiveType: 直播方式：0 常规模式（默认）1 回放直播模式（伪直播）。 目前支持从回放直播模式（伪直播）改为常规模式，不支持从常规模式改为回放直播模式（伪直播）
         :type LiveType: int
         :param _RecordLiveUrl: 伪直播链接
         :type RecordLiveUrl: str

tencentcloud/lke/v20231130/errorcodes.py

@@ -16,3 +16,15 @@
 
 # 操作失败。
 FAILEDOPERATION = 'FailedOperation'
+
+# 内部错误。
+INTERNALERROR = 'InternalError'
+
+# 参数错误。
+INVALIDPARAMETER = 'InvalidParameter'
+
+# 超过配额限制。
+LIMITEXCEEDED = 'LimitExceeded'
+
+# 请求的次数超过了频率限制。
+REQUESTLIMITEXCEEDED = 'RequestLimitExceeded'

tencentcloud/lke/v20231130/lke_client.py

@@ -1476,6 +1476,52 @@ class LkeClient(AbstractClient):
                 raise TencentCloudSDKException(type(e).__name__, str(e))
 
 
+    def ParseDoc(self, request):
+        """解析拆分文档。该接口需开通文档解析原子能力后调用。文档解析原子能力内测中，如有需要请联系架构师或 [联系客服](https://cloud.tencent.com/act/event/Online_service)  。
+
+        :param request: Request instance for ParseDoc.
+        :type request: :class:`tencentcloud.lke.v20231130.models.ParseDocRequest`
+        :rtype: :class:`tencentcloud.lke.v20231130.models.ParseDocResponse`
+
+        """
+        try:
+            params = request._serialize()
+            headers = request.headers
+            body = self.call("ParseDoc", params, headers=headers)
+            response = json.loads(body)
+            model = models.ParseDocResponse()
+            model._deserialize(response["Response"])
+            return model
+        except Exception as e:
+            if isinstance(e, TencentCloudSDKException):
+                raise
+            else:
+                raise TencentCloudSDKException(type(e).__name__, str(e))
+
+
+    def QueryParseDocResult(self, request):
+        """查询文档解析结果。该接口需开通文档解析原子能力后调用。文档解析原子能力内测中，如有需要请联系架构师或[联系客服](https://cloud.tencent.com/act/event/Online_service) 。
+
+        :param request: Request instance for QueryParseDocResult.
+        :type request: :class:`tencentcloud.lke.v20231130.models.QueryParseDocResultRequest`
+        :rtype: :class:`tencentcloud.lke.v20231130.models.QueryParseDocResultResponse`
+
+        """
+        try:
+            params = request._serialize()
+            headers = request.headers
+            body = self.call("QueryParseDocResult", params, headers=headers)
+            response = json.loads(body)
+            model = models.QueryParseDocResultResponse()
+            model._deserialize(response["Response"])
+            return model
+        except Exception as e:
+            if isinstance(e, TencentCloudSDKException):
+                raise
+            else:
+                raise TencentCloudSDKException(type(e).__name__, str(e))
+
+
     def QueryRewrite(self, request):
         """多轮改写
         本接口有单账号调用上限控制，如您有提高并发限制的需求请 [联系我们](https://cloud.tencent.com/act/event/Online_service) 。