tencentcloud-sdk-nodejs 4.0.842 → 4.0.844

package/src/services/hunyuan/v20230901/hunyuan_models.ts

@@ -15,6 +15,69 @@
  * under the License.
  */
 
+/**
+ * ChatCompletions请求参数结构体
+ */
+export interface ChatCompletionsRequest {
+  /**
+   * 模型名称，可选值包括 hunyuan-lite、hunyuan-standard、hunyuan-pro。
+各模型介绍请阅读 [产品概述](https://cloud.tencent.com/document/product/1729/104753) 中的说明。
+
+注意：
+不同的模型计费不同，请根据 [购买指南](https://cloud.tencent.com/document/product/1729/97731) 按需调用。
+   */
+  Model: string
+  /**
+   * 聊天上下文信息。
+说明：
+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) 文档），超过则会截断最前面的内容，只保留尾部内容。
+   */
+  Messages: Array<Message>
+  /**
+   * 流式调用开关。
+说明：
+1. 未传值时默认为非流式调用（false）。
+2. 流式调用时以 SSE 协议增量返回结果（返回值取 Choices[n].Delta 中的值，需要拼接增量数据才能获得完整结果）。
+3. 非流式调用时：
+调用方式与普通 HTTP 请求无异。
+接口响应耗时较长，**如需更低时延建议设置为 true**。
+只返回一次最终结果（返回值取 Choices[n].Message 中的值）。
+
+注意：
+通过 SDK 调用时，流式和非流式调用需用**不同的方式**获取返回值，具体参考 SDK 中的注释或示例（在各语言 SDK 代码仓库的 examples/hunyuan/v20230901/ 目录中）。
+   */
+  Stream?: boolean
+  /**
+   * 流式输出审核开关。
+说明：
+1. 当使用流式输出（Stream 字段值为 true）时，该字段生效。
+2. 输出审核有流式和同步两种模式，**流式模式首包响应更快**。未传值时默认为流式模式（true）。
+3. 如果值为 true，将对输出内容进行分段审核，审核通过的内容流式输出返回。如果出现审核不过，响应中的 FinishReason 值为 sensitive。
+4. 如果值为 false，则不使用流式输出审核，需要审核完所有输出内容后再返回结果。
+
+注意：
+当选择流式输出审核时，可能会出现部分内容已输出，但中间某一段响应中的 FinishReason 值为 sensitive，此时说明安全审核未通过。如果业务场景有实时文字上屏的需求，需要自行撤回已上屏的内容，并建议自定义替换为一条提示语，如 “这个问题我不方便回答，不如我们换个话题试试”，以保障终端体验。
+   */
+  StreamModeration?: boolean
+  /**
+   * 说明：
+1. 影响输出文本的多样性，取值越大，生成文本的多样性越强。
+2. 默认 1.0，取值区间为 [0.0, 1.0]。
+3. 非必要不建议使用，不合理的取值会影响效果。
+   */
+  TopP?: number
+  /**
+   * 说明：
+1. 较高的数值会使输出更加随机，而较低的数值会使其更加集中和确定。
+2. 默认 1.0，取值区间为 [0.0, 2.0]。
+3. 非必要不建议使用，不合理的取值会影响效果。
+   */
+  Temperature?: number
+}
+
 /**
  * GetTokenCount返回参数结构体
  */
@@ -42,11 +105,11 @@ export interface GetTokenCountResponse {
  */
 export interface GetEmbeddingResponse {
   /**
-   * 返回的 embedding 信息。
+   * 返回的 Embedding 信息。当前不支持批量，所以数组元素数目为 1。
    */
   Data?: Array<EmbeddingData>
   /**
-   * token 使用计数，按照总token数量收费。
+   * Token 使用计数，按照总 Token 数量收费。
    */
   Usage?: EmbeddingUsage
   /**
@@ -114,7 +177,7 @@ export interface ChatStdResponse {
  */
 export interface GetEmbeddingRequest {
   /**
-   * 输入文本。总长度不超过1024 个token, 超过则会截断最后面的内容。
+   * 输入文本。总长度不超过 1024 个 Token，超过则会截断最后面的内容。
    */
   Input: string
 }
@@ -161,7 +224,8 @@ export interface ChatProResponse {
  */
 export interface Choice {
   /**
-   * 结束标志位，为 stop 则表示尾包。
+   * 结束标志位，可能为 stop 或 sensitive。
+stop 表示输出正常结束，sensitive 只在开启流式输出审核时会出现，表示安全审核未通过。
    */
   FinishReason?: string
   /**
@@ -184,8 +248,9 @@ export interface ChatProRequest {
    * 聊天上下文信息。
 说明：
 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) 文档），超过则会截断最前面的内容，只保留尾部内容。
    */
   Messages: Array<Message>
   /**
@@ -198,7 +263,7 @@ export interface ChatProRequest {
   /**
    * 说明：
 1. 较高的数值会使输出更加随机，而较低的数值会使其更加集中和确定。
-2. 默认 1.0，取值区间为 [0.0，2.0]。
+2. 默认 1.0，取值区间为 [0.0, 2.0]。
 3. 非必要不建议使用，不合理的取值会影响效果。
    */
   Temperature?: number
@@ -209,24 +274,27 @@ export interface ChatProRequest {
 2. 流式调用时以 SSE 协议增量返回结果。
 3. 非流式调用时接口响应耗时较长，非必要不建议使用。
 4. 非流式调用时只返回一次最终结果，调用方式与普通 HTTP 请求无异。
+
+注意：
+通过 SDK 调用时，流式和非流式调用需要用**不同的方式**获取返回值，具体参考 SDK 中的注释或示例（在各语言 SDK 代码仓库的 examples/hunyuan/v20230901/ 目录中）。
    */
   Stream?: boolean
   /**
    * 流式输出审核开关。
 说明：
-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，此时说明安全审核未通过。如果业务场景有实时文字上屏的需求，需要自行撤回已上屏的内容，并建议自定义替换为一条提示语，如 “这个问题我不方便回答，不如我们换个话题试试”，以保障终端体验。
    */
   StreamModeration?: boolean
 }
 
 /**
- * embedding 信息，当前不支持批量，所以数组元素数目为1。
+ * Embedding 信息。
  */
 export interface EmbeddingData {
   /**
@@ -301,7 +369,7 @@ export interface Message {
    */
   Role: string
   /**
-   * 消息内容
+   * 文本内容
    */
   Content: string
 }
@@ -316,6 +384,43 @@ export interface GetTokenCountRequest {
   Prompt: string
 }
 
+/**
+ * ChatCompletions返回参数结构体
+ */
+export interface ChatCompletionsResponse {
+  /**
+   * Unix 时间戳，单位为秒。
+   */
+  Created?: number
+  /**
+   * Token 统计信息。
+按照总 Token 数量计费。
+   */
+  Usage?: Usage
+  /**
+   * 免责声明。
+   */
+  Note?: string
+  /**
+   * 本轮对话的 ID。
+   */
+  Id?: string
+  /**
+   * 回复内容。
+   */
+  Choices?: Array<Choice>
+  /**
+   * 错误信息。
+如果流式返回中服务处理异常，返回该错误信息。
+注意：此字段可能返回 null，表示取不到有效值。
+   */
+  ErrorMsg?: ErrorMsg
+  /**
+   * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。本接口为流式响应接口，当请求成功时，RequestId 会被放在 HTTP 响应的 Header "X-TC-RequestId" 中。
+   */
+  RequestId?: string
+}
+
 /**
  * ChatStd请求参数结构体
  */
@@ -324,9 +429,9 @@ export interface ChatStdRequest {
    * 聊天上下文信息。
 说明：
 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) 文档），超过则会截断最前面的内容，只保留尾部内容。
    */
   Messages: Array<Message>
   /**
@@ -339,7 +444,7 @@ export interface ChatStdRequest {
   /**
    * 说明：
 1. 较高的数值会使输出更加随机，而较低的数值会使其更加集中和确定。
-2. 默认 1.0，取值区间为 [0.0，2.0]。
+2. 默认 1.0，取值区间为 [0.0, 2.0]。
 3. 非必要不建议使用，不合理的取值会影响效果。
    */
   Temperature?: number
@@ -350,18 +455,21 @@ export interface ChatStdRequest {
 2. 流式调用时以 SSE 协议增量返回结果。
 3. 非流式调用时接口响应耗时较长，非必要不建议使用。
 4. 非流式调用时只返回一次最终结果，调用方式与普通 HTTP 请求无异。
+
+注意：
+通过 SDK 调用时，流式和非流式调用需要用**不同的方式**获取返回值，具体参考 SDK 中的注释或示例（在各语言 SDK 代码仓库的 examples/hunyuan/v20230901/ 目录中）。
    */
   Stream?: boolean
   /**
    * 流式输出审核开关。
 说明：
-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，此时说明安全审核未通过。如果业务场景有实时文字上屏的需求，需要自行撤回已上屏的内容，并建议自定义替换为一条提示语，如 “这个问题我不方便回答，不如我们换个话题试试”，以保障终端体验。
    */
   StreamModeration?: boolean
 }

package/src/services/iotvideo/v20211125/iotvideo_models.ts

@@ -3453,6 +3453,11 @@ export interface CloudStorageEvent {
    * 事件ID
    */
   EventId: string
+  /**
+   * 事件录像上传状态，Finished: 全部上传成功 Partial: 部分上传成功 Failed: 上传失败
+注意：此字段可能返回 null，表示取不到有效值。
+   */
+  UploadStatus?: string
 }
 
 /**

package/src/services/lcic/v20220817/lcic_models.ts

@@ -2950,7 +2950,7 @@ video 纯视频
    */
   EndDelayTime?: number
   /**
-   * 直播方式：0 常规模式（默认）1 回放直播模式（伪直播）
+   * 直播方式：0 常规模式（默认）1 回放直播模式（伪直播）。 目前支持从回放直播模式（伪直播）改为常规模式，不支持从常规模式改为回放直播模式（伪直播）
    */
   LiveType?: number
   /**

package/src/services/lke/v20231130/lke_client.ts

@@ -42,6 +42,7 @@ import {
   GetMsgRecordResponse,
   AttrLabelRefer,
   DescribeUnsatisfiedReplyContextRequest,
+  Procedure,
   QAQuery,
   ListAppRequest,
   AttrLabel,
@@ -55,6 +56,7 @@ import {
   ReferDetail,
   ListUnsatisfiedReplyRequest,
   DeleteQARequest,
+  ParseDocRequest,
   ListReleaseRequest,
   ListModelRequest,
   SummaryOutput,
@@ -88,6 +90,7 @@ import {
   ResetSessionRequest,
   GetAppSecretRequest,
   DeleteQACateResponse,
+  QueryParseDocResultResponse,
   ListReleaseDocPreviewResponse,
   SummaryConfig,
   GenerateQAResponse,
@@ -143,6 +146,7 @@ import {
   CreateAttributeLabelRequest,
   ListAppResponse,
   AppInfo,
+  QueryParseDocResultRequest,
   KnowledgeQaConfig,
   RejectedQuestion,
   MsgRecordReference,
@@ -174,13 +178,14 @@ import {
   CreateAttributeLabelResponse,
   CreateQAResponse,
   StopDocParseResponse,
+  ParseDocResponse,
   ListQACateRequest,
   ListReleaseQAPreviewRequest,
   DescribeReleaseInfoResponse,
   IsTransferIntentRequest,
   DescribeReferRequest,
   DeleteAppRequest,
-  VerifyQAResponse,
+  TokenStat,
   ListAppCategoryRspOption,
   DescribeStorageCredentialRequest,
   QAList,
@@ -202,6 +207,7 @@ import {
   DescribeRobotBizIDByAppKeyRequest,
   CreateRejectedQuestionRequest,
   ListRejectedQuestionRequest,
+  VerifyQAResponse,
   ReleaseConfigs,
   Filters,
   ModifyRejectedQuestionRequest,
@@ -681,6 +687,16 @@ export class Client extends AbstractClient {
     return this.request("CreateQA", req, cb)
   }
 
+  /**
+   * 查询文档解析结果。该接口需开通文档解析原子能力后调用。文档解析原子能力内测中，如有需要请联系架构师或[联系客服](https://cloud.tencent.com/act/event/Online_service) 。
+   */
+  async QueryParseDocResult(
+    req: QueryParseDocResultRequest,
+    cb?: (error: string, rep: QueryParseDocResultResponse) => void
+  ): Promise<QueryParseDocResultResponse> {
+    return this.request("QueryParseDocResult", req, cb)
+  }
+
   /**
    * 查询属性标签列表
    */
@@ -791,6 +807,16 @@ export class Client extends AbstractClient {
     return this.request("ModifyDoc", req, cb)
   }
 
+  /**
+   * 解析拆分文档。该接口需开通文档解析原子能力后调用。文档解析原子能力内测中，如有需要请联系架构师或 [联系客服](https://cloud.tencent.com/act/event/Online_service)  。
+   */
+  async ParseDoc(
+    req: ParseDocRequest,
+    cb?: (error: string, rep: ParseDocResponse) => void
+  ): Promise<ParseDocResponse> {
+    return this.request("ParseDoc", req, cb)
+  }
+
   /**
    * 获取ws token
    */