tencentcloud-sdk-nodejs 4.0.841 → 4.0.843

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (106) hide show
  1. package/CHANGELOG.md +334 -0
  2. package/README.md +7 -0
  3. package/SERVICE_CHANGELOG.md +340 -59
  4. package/examples/common/common_client.js +47 -0
  5. package/examples/common/common_client.ts +47 -0
  6. package/package.json +1 -1
  7. package/products.md +29 -29
  8. package/src/common/index.ts +3 -0
  9. package/src/common/sdk_version.ts +1 -1
  10. package/src/services/aiart/v20221229/aiart_models.ts +38 -34
  11. package/src/services/apm/v20210622/apm_client.ts +46 -8
  12. package/src/services/apm/v20210622/apm_models.ts +233 -24
  13. package/src/services/ccc/v20200210/ccc_models.ts +1 -1
  14. package/src/services/cfs/v20190719/cfs_models.ts +36 -22
  15. package/src/services/cfw/v20190904/cfw_client.ts +1 -1
  16. package/src/services/cfw/v20190904/cfw_models.ts +3 -3
  17. package/src/services/cloudstudio/v20230508/cloudstudio_models.ts +9 -5
  18. package/src/services/cls/v20201016/cls_models.ts +72 -36
  19. package/src/services/cynosdb/v20190107/cynosdb_client.ts +16 -3
  20. package/src/services/cynosdb/v20190107/cynosdb_models.ts +109 -43
  21. package/src/services/dcdb/v20180411/dcdb_client.ts +1 -1
  22. package/src/services/dcdb/v20180411/dcdb_models.ts +1 -1
  23. package/src/services/ess/v20201111/ess_client.ts +2 -0
  24. package/src/services/ess/v20201111/ess_models.ts +31 -3
  25. package/src/services/essbasic/v20210526/essbasic_client.ts +2 -0
  26. package/src/services/essbasic/v20210526/essbasic_models.ts +30 -2
  27. package/src/services/faceid/v20180301/faceid_models.ts +40 -7
  28. package/src/services/hunyuan/v20230901/hunyuan_client.ts +20 -4
  29. package/src/services/hunyuan/v20230901/hunyuan_models.ts +123 -17
  30. package/src/services/ims/v20201229/ims_client.ts +2 -3
  31. package/src/services/ims/v20201229/ims_models.ts +54 -54
  32. package/src/services/iotexplorer/v20190423/iotexplorer_client.ts +13 -0
  33. package/src/services/iotexplorer/v20190423/iotexplorer_models.ts +47 -0
  34. package/src/services/iss/v20230517/iss_models.ts +16 -0
  35. package/src/services/lcic/v20220817/lcic_models.ts +1 -1
  36. package/src/services/lke/v20231130/lke_client.ts +0 -24
  37. package/src/services/lke/v20231130/lke_models.ts +0 -81
  38. package/src/services/mariadb/v20170312/mariadb_client.ts +1 -1
  39. package/src/services/mariadb/v20170312/mariadb_models.ts +1 -1
  40. package/src/services/monitor/v20180724/monitor_client.ts +1 -1
  41. package/src/services/mps/v20190612/mps_client.ts +2 -1
  42. package/src/services/mps/v20190612/mps_models.ts +66 -42
  43. package/src/services/rum/v20210622/rum_models.ts +2 -2
  44. package/src/services/tdid/v20210519/tdid_client.ts +1 -1
  45. package/src/services/teo/v20220901/teo_client.ts +1 -0
  46. package/src/services/teo/v20220901/teo_models.ts +83 -21
  47. package/src/services/tione/v20211111/tione_client.ts +1 -0
  48. package/src/services/tione/v20211111/tione_models.ts +16 -0
  49. package/src/services/tmt/v20180321/tmt_models.ts +1 -1
  50. package/src/services/waf/v20180125/waf_models.ts +1 -1
  51. package/tencentcloud/common/index.d.ts +3 -0
  52. package/tencentcloud/common/index.js +6 -0
  53. package/tencentcloud/common/sdk_version.d.ts +1 -1
  54. package/tencentcloud/common/sdk_version.js +1 -1
  55. package/tencentcloud/services/aiart/v20221229/aiart_models.d.ts +38 -34
  56. package/tencentcloud/services/apm/v20210622/apm_client.d.ts +15 -3
  57. package/tencentcloud/services/apm/v20210622/apm_client.js +21 -3
  58. package/tencentcloud/services/apm/v20210622/apm_models.d.ts +225 -24
  59. package/tencentcloud/services/ccc/v20200210/ccc_models.d.ts +1 -1
  60. package/tencentcloud/services/cfs/v20190719/cfs_models.d.ts +36 -22
  61. package/tencentcloud/services/cfw/v20190904/cfw_client.d.ts +1 -1
  62. package/tencentcloud/services/cfw/v20190904/cfw_client.js +1 -1
  63. package/tencentcloud/services/cfw/v20190904/cfw_models.d.ts +3 -3
  64. package/tencentcloud/services/cloudstudio/v20230508/cloudstudio_models.d.ts +9 -5
  65. package/tencentcloud/services/cls/v20201016/cls_models.d.ts +72 -36
  66. package/tencentcloud/services/cynosdb/v20190107/cynosdb_client.d.ts +5 -1
  67. package/tencentcloud/services/cynosdb/v20190107/cynosdb_client.js +6 -0
  68. package/tencentcloud/services/cynosdb/v20190107/cynosdb_models.d.ts +105 -42
  69. package/tencentcloud/services/dcdb/v20180411/dcdb_client.d.ts +1 -1
  70. package/tencentcloud/services/dcdb/v20180411/dcdb_client.js +1 -1
  71. package/tencentcloud/services/dcdb/v20180411/dcdb_models.d.ts +1 -1
  72. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +29 -3
  73. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +28 -2
  74. package/tencentcloud/services/faceid/v20180301/faceid_models.d.ts +40 -7
  75. package/tencentcloud/services/hunyuan/v20230901/hunyuan_client.d.ts +13 -5
  76. package/tencentcloud/services/hunyuan/v20230901/hunyuan_client.js +14 -4
  77. package/tencentcloud/services/hunyuan/v20230901/hunyuan_models.d.ts +121 -17
  78. package/tencentcloud/services/ims/v20201229/ims_client.d.ts +2 -3
  79. package/tencentcloud/services/ims/v20201229/ims_client.js +2 -3
  80. package/tencentcloud/services/ims/v20201229/ims_models.d.ts +54 -54
  81. package/tencentcloud/services/iotexplorer/v20190423/iotexplorer_client.d.ts +5 -1
  82. package/tencentcloud/services/iotexplorer/v20190423/iotexplorer_client.js +6 -0
  83. package/tencentcloud/services/iotexplorer/v20190423/iotexplorer_models.d.ts +44 -0
  84. package/tencentcloud/services/iss/v20230517/iss_models.d.ts +16 -0
  85. package/tencentcloud/services/lcic/v20220817/lcic_models.d.ts +1 -1
  86. package/tencentcloud/services/lke/v20231130/lke_client.d.ts +1 -9
  87. package/tencentcloud/services/lke/v20231130/lke_client.js +0 -12
  88. package/tencentcloud/services/lke/v20231130/lke_models.d.ts +0 -77
  89. package/tencentcloud/services/mariadb/v20170312/mariadb_client.d.ts +1 -1
  90. package/tencentcloud/services/mariadb/v20170312/mariadb_client.js +1 -1
  91. package/tencentcloud/services/mariadb/v20170312/mariadb_models.d.ts +1 -1
  92. package/tencentcloud/services/monitor/v20180724/monitor_client.d.ts +1 -1
  93. package/tencentcloud/services/monitor/v20180724/monitor_client.js +1 -1
  94. package/tencentcloud/services/mps/v20190612/mps_models.d.ts +65 -42
  95. package/tencentcloud/services/rum/v20210622/rum_models.d.ts +2 -2
  96. package/tencentcloud/services/tdid/v20210519/tdid_client.d.ts +1 -1
  97. package/tencentcloud/services/tdid/v20210519/tdid_client.js +1 -1
  98. package/tencentcloud/services/teo/v20220901/teo_models.d.ts +82 -21
  99. package/tencentcloud/services/tione/v20211111/tione_models.d.ts +15 -0
  100. package/tencentcloud/services/tmt/v20180321/tmt_models.d.ts +1 -1
  101. package/tencentcloud/services/waf/v20180125/waf_models.d.ts +1 -1
  102. package/test/apm.v20210622.test.js +32 -2
  103. package/test/cynosdb.v20190107.test.js +10 -0
  104. package/test/hunyuan.v20230901.test.js +10 -0
  105. package/test/iotexplorer.v20190423.test.js +10 -0
  106. package/test/lke.v20231130.test.js +0 -20
@@ -25,6 +25,16 @@ export interface SyncProxyOrganizationResponse {
25
25
  RequestId?: string
26
26
  }
27
27
 
28
+ /**
29
+ * 批量签署合同相关信息,指定批量签署合同和签署方的信息,用于补充动态签署人。
30
+ */
31
+ export interface FlowBatchUrlInfo {
32
+ /**
33
+ * 批量签署合同和签署方的信息,用于补充动态签署人。
34
+ */
35
+ FlowBatchApproverInfos?: Array<FlowBatchApproverInfo>
36
+ }
37
+
28
38
  /**
29
39
  * ChannelCreateConvertTaskApi返回参数结构体
30
40
  */
@@ -2987,6 +2997,20 @@ export interface OrganizationAuthUrl {
2987
2997
  ErrorMessage?: string
2988
2998
  }
2989
2999
 
3000
+ /**
3001
+ * 批量签署合同相关信息,指定批量签署合同和签署方的信息,用于补充动态签署人。
3002
+ */
3003
+ export interface FlowBatchApproverInfo {
3004
+ /**
3005
+ * 合同流程ID。
3006
+ */
3007
+ FlowId?: string
3008
+ /**
3009
+ * 签署节点ID,用于生成动态签署人链接完成领取。注:`生成动态签署人补充链接时必传。`
3010
+ */
3011
+ RecipientId?: string
3012
+ }
3013
+
2990
3014
  /**
2991
3015
  * 企业员工信息
2992
3016
  */
@@ -6437,14 +6461,14 @@ export interface ChannelCreateBatchSignUrlRequest {
6437
6461
 
6438
6462
  注:`请确保和合同中填入的一致`
6439
6463
  */
6440
- Name: string
6464
+ Name?: string
6441
6465
  /**
6442
6466
  * 手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。
6443
6467
  请确认手机号所有方为此业务通知方。
6444
6468
 
6445
6469
  注:`请确保和合同中填入的一致, 若无法保持一致,请确保在发起和生成批量签署链接时传入相同的参与方证件信息`
6446
6470
  */
6447
- Mobile: string
6471
+ Mobile?: string
6448
6472
  /**
6449
6473
  * 执行本接口操作的员工信息。
6450
6474
  注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
@@ -6501,6 +6525,10 @@ export interface ChannelCreateBatchSignUrlRequest {
6501
6525
  </ul>
6502
6526
  */
6503
6527
  JumpToDetail?: boolean
6528
+ /**
6529
+ * 批量签署合同相关信息,指定合同和签署方的信息,用于补充动态签署人。
6530
+ */
6531
+ FlowBatchUrlInfo?: FlowBatchUrlInfo
6504
6532
  }
6505
6533
 
6506
6534
  /**
@@ -1041,13 +1041,15 @@ export interface GetFaceIdResultResponse {
1041
1041
  */
1042
1042
  Extra?: string
1043
1043
  /**
1044
- * 设备风险标签,仅错误码返回1007(设备疑似被劫持)时返回风险标签。标签说明:
1045
- 202、5001:设备疑似被Root
1046
- 203、5004:设备疑似被注入
1047
- 205:设备疑似被Hook
1048
- 206:设备疑似虚拟运行环境
1049
- 5007、1005:设备疑似摄像头被劫持
1050
- 8000:设备疑似存在异常篡改行为
1044
+ * plus版:描述当前请求所在设备的风险标签,详情如下:
1045
+ 01-设备疑似被Root/设备疑似越狱
1046
+ 02-设备疑似被注入
1047
+ 03-设备疑似为模拟器
1048
+ 04-设备疑似存在风险操作
1049
+ 05-摄像头疑似被劫持
1050
+ 06-疑似黑产设备
1051
+ null-无设备风险
1052
+ 增强版:此字段不生效,默认为null
1051
1053
  注意:此字段可能返回 null,表示取不到有效值。
1052
1054
  */
1053
1055
  DeviceInfoTag?: string
@@ -1057,6 +1059,37 @@ export interface GetFaceIdResultResponse {
1057
1059
  注意:此字段可能返回 null,表示取不到有效值。
1058
1060
  */
1059
1061
  RiskInfoTag?: string
1062
+ /**
1063
+ * plus版:描述当前请求活体阶段被拒绝的详细原因,详情如下:
1064
+ 01-用户全程闭眼
1065
+ 02-用户未完成指定动作
1066
+ 03-疑似翻拍攻击
1067
+ 04-疑似合成图片
1068
+ 05-疑似合成视频
1069
+ 06-疑似合成动作
1070
+ 07-疑似黑产模版
1071
+ 08-疑似存在水印
1072
+ 09-反光校验未通过
1073
+ 10-最佳帧校验未通过
1074
+ 11-人脸质量过差
1075
+ 12-人脸距离不匹配
1076
+ 13-疑似对抗样本攻击
1077
+ null-无
1078
+ 增强版:此字段不生效,默认为null
1079
+ 注意:此字段可能返回 null,表示取不到有效值。
1080
+ */
1081
+ LivenessInfoTag?: string
1082
+ /**
1083
+ * plus版:描述当前请求所在设备的风险等级,共4级,详情如下:
1084
+ 1 - 安全
1085
+ 2 - 低风险
1086
+ 3 - 中风险
1087
+ 4 - 高危
1088
+ null - 未获取到风险等级
1089
+ 增强版:此字段不生效,默认为null
1090
+ 注意:此字段可能返回 null,表示取不到有效值。
1091
+ */
1092
+ DeviceInfoLevel?: string
1060
1093
  /**
1061
1094
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1062
1095
  */
@@ -18,6 +18,7 @@
18
18
  import { AbstractClient } from "../../../common/abstract_client"
19
19
  import { ClientConfig } from "../../../common/interface"
20
20
  import {
21
+ ChatCompletionsRequest,
21
22
  GetTokenCountResponse,
22
23
  GetEmbeddingResponse,
23
24
  ErrorMsg,
@@ -32,6 +33,7 @@ import {
32
33
  Usage,
33
34
  Message,
34
35
  GetTokenCountRequest,
36
+ ChatCompletionsResponse,
35
37
  ChatStdRequest,
36
38
  } from "./hunyuan_models"
37
39
 
@@ -45,11 +47,25 @@ export class Client extends AbstractClient {
45
47
  }
46
48
 
47
49
  /**
48
- * 腾讯混元大模型高级版是由腾讯研发的大语言模型,具备强大的中文创作能力,复杂语境下的逻辑推理能力,以及可靠的任务执行能力。本接口支持流式或非流式调用,当使用流式调用时为 SSE 协议。
50
+ * 腾讯混元大模型是由腾讯研发的大语言模型,具备强大的中文创作能力,复杂语境下的逻辑推理能力,以及可靠的任务执行能力。本接口支持流式或非流式调用,当使用流式调用时为 SSE 协议。
51
+
52
+ 1. 本接口暂不支持返回图片内容。
53
+ 2. 默认每种模型单账号限制并发数为 5 路,如您有提高并发限制的需求请 [联系我们](https://cloud.tencent.com/act/event/Online_service) 。
54
+ 3. 请使用 SDK 调用本接口,每种开发语言的 SDK Git 仓库 examples/hunyuan/v20230901/ 目录下有提供示例供参考。SDK 链接在文档下方 “**开发者资源 - SDK**” 部分提供。
55
+ */
56
+ async ChatCompletions(
57
+ req: ChatCompletionsRequest,
58
+ cb?: (error: string, rep: ChatCompletionsResponse) => void
59
+ ): Promise<ChatCompletionsResponse> {
60
+ return this.request("ChatCompletions", req, cb)
61
+ }
62
+
63
+ /**
64
+ * 腾讯混元大模型(hunyuan-pro)是由腾讯研发的大语言模型,具备强大的中文创作能力,复杂语境下的逻辑推理能力,以及可靠的任务执行能力。本接口支持流式或非流式调用,当使用流式调用时为 SSE 协议。
49
65
 
50
66
  1. 本接口暂不支持返回图片内容。
51
67
  2. 默认单账号限制并发数为 5 路,如您有提高并发限制的需求请 [联系我们](https://cloud.tencent.com/act/event/Online_service) 。
52
- 3. 请使用 SDK 调用本接口,每种开发语言的 SDK Git 仓库 examples/hunyuan/v20230901/ 目录下有提供示例供参考。
68
+ 3. 请使用 SDK 调用本接口,每种开发语言的 SDK Git 仓库 examples/hunyuan/v20230901/ 目录下有提供示例供参考。SDK 链接在文档下方 “**开发者资源 - SDK**” 部分提供。
53
69
  */
54
70
  async ChatPro(
55
71
  req: ChatProRequest,
@@ -63,7 +79,7 @@ export class Client extends AbstractClient {
63
79
 
64
80
  1. 本接口暂不支持返回图片内容。
65
81
  2. 默认单账号限制并发数为 5 路,如您有提高并发限制的需求请 [联系我们](https://cloud.tencent.com/act/event/Online_service) 。
66
- 3. 请使用 SDK 调用本接口,每种开发语言的 SDK Git 仓库 examples/hunyuan/v20230901/ 目录下有提供示例供参考。
82
+ 3. 请使用 SDK 调用本接口,每种开发语言的 SDK Git 仓库 examples/hunyuan/v20230901/ 目录下有提供示例供参考。SDK 链接在文档下方 “**开发者资源 - SDK**” 部分提供。
67
83
  */
68
84
  async ChatStd(
69
85
  req: ChatStdRequest,
@@ -83,7 +99,7 @@ export class Client extends AbstractClient {
83
99
  }
84
100
 
85
101
  /**
86
- * 腾讯混元-Embedding接口,可以将文本转化为高质量的向量数据。
102
+ * 腾讯混元 Embedding 接口,可以将文本转化为高质量的向量数据。
87
103
  */
88
104
  async GetEmbedding(
89
105
  req: GetEmbeddingRequest,
@@ -15,6 +15,69 @@
15
15
  * under the License.
16
16
  */
17
17
 
18
+ /**
19
+ * ChatCompletions请求参数结构体
20
+ */
21
+ export interface ChatCompletionsRequest {
22
+ /**
23
+ * 模型名称,可选值包括 hunyuan-lite、hunyuan-standard、hunyuan-pro。
24
+ 各模型介绍请阅读 [产品概述](https://cloud.tencent.com/document/product/1729/104753) 中的说明。
25
+
26
+ 注意:
27
+ 不同的模型计费不同,请根据 [购买指南](https://cloud.tencent.com/document/product/1729/97731) 按需调用。
28
+ */
29
+ Model: string
30
+ /**
31
+ * 聊天上下文信息。
32
+ 说明:
33
+ 1. 长度最多为 40,按对话时间从旧到新在数组中排列。
34
+ 2. Message.Role 可选值:system、user、assistant。
35
+ 其中,system 角色可选,如存在则必须位于列表的最开始。user 和 assistant 需交替出现(一问一答),以 user 提问开始和结束,且 Content 不能为空。Role 的顺序示例:[system(可选) user assistant user assistant user ...]。
36
+ 3. Messages 中 Content 总长度不超过 16000 Token,超过则会截断最前面的内容,只保留尾部内容。建议不超过 4000 Token。
37
+ */
38
+ Messages: Array<Message>
39
+ /**
40
+ * 流式调用开关。
41
+ 说明:
42
+ 1. 未传值时默认为非流式调用(false)。
43
+ 2. 流式调用时以 SSE 协议增量返回结果(返回值取 Choices[n].Delta 中的值,需要拼接增量数据才能获得完整结果)。
44
+ 3. 非流式调用时:
45
+ 调用方式与普通 HTTP 请求无异。
46
+ 接口响应耗时较长,**如需更低时延建议设置为 true**。
47
+ 只返回一次最终结果(返回值取 Choices[n].Message 中的值)。
48
+
49
+ 注意:
50
+ 通过 SDK 调用时,流式和非流式调用需用**不同的方式**获取返回值,具体参考 SDK 中的注释或示例(在各语言 SDK 代码仓库的 examples/hunyuan/v20230901/ 目录中)。
51
+ */
52
+ Stream?: boolean
53
+ /**
54
+ * 流式输出审核开关。
55
+ 说明:
56
+ 1. 输出审核有流式和同步两种模式,**流式模式首包响应更快**。
57
+ 2. 当使用流式输出(Stream 字段值为 true)时,该字段生效。
58
+ 3. 如果值为 true,将对输出内容进行分段审核,审核通过的内容流式输出返回。如果出现审核不过,响应中的 FinishReason 值为 sensitive。
59
+ 4. 如果未传值或值为 false,则不使用流式输出审核,需要审核完所有输出内容后再返回结果。
60
+
61
+ 注意:
62
+ 当选择流式输出审核时,可能会出现部分内容已输出,但中间某一段响应中的 FinishReason 值为 sensitive,此时说明安全审核未通过。如果业务场景有实时文字上屏的需求,需要自行撤回已上屏的内容,并建议自定义替换为一条提示语,如 “这个问题我不方便回答,不如我们换个话题试试”,以保障终端体验。
63
+ */
64
+ StreamModeration?: boolean
65
+ /**
66
+ * 说明:
67
+ 1. 影响输出文本的多样性,取值越大,生成文本的多样性越强。
68
+ 2. 默认 1.0,取值区间为 [0.0, 1.0]。
69
+ 3. 非必要不建议使用,不合理的取值会影响效果。
70
+ */
71
+ TopP?: number
72
+ /**
73
+ * 说明:
74
+ 1. 较高的数值会使输出更加随机,而较低的数值会使其更加集中和确定。
75
+ 2. 默认 1.0,取值区间为 [0.0, 2.0]。
76
+ 3. 非必要不建议使用,不合理的取值会影响效果。
77
+ */
78
+ Temperature?: number
79
+ }
80
+
18
81
  /**
19
82
  * GetTokenCount返回参数结构体
20
83
  */
@@ -42,11 +105,11 @@ export interface GetTokenCountResponse {
42
105
  */
43
106
  export interface GetEmbeddingResponse {
44
107
  /**
45
- * 返回的 embedding 信息。
108
+ * 返回的 Embedding 信息。当前不支持批量,所以数组元素数目为 1。
46
109
  */
47
110
  Data?: Array<EmbeddingData>
48
111
  /**
49
- * token 使用计数,按照总token数量收费。
112
+ * Token 使用计数,按照总 Token 数量收费。
50
113
  */
51
114
  Usage?: EmbeddingUsage
52
115
  /**
@@ -114,7 +177,7 @@ export interface ChatStdResponse {
114
177
  */
115
178
  export interface GetEmbeddingRequest {
116
179
  /**
117
- * 输入文本。总长度不超过1024 个token, 超过则会截断最后面的内容。
180
+ * 输入文本。总长度不超过 1024 个 Token,超过则会截断最后面的内容。
118
181
  */
119
182
  Input: string
120
183
  }
@@ -198,7 +261,7 @@ export interface ChatProRequest {
198
261
  /**
199
262
  * 说明:
200
263
  1. 较高的数值会使输出更加随机,而较低的数值会使其更加集中和确定。
201
- 2. 默认 1.0,取值区间为 [0.02.0]。
264
+ 2. 默认 1.0,取值区间为 [0.0, 2.0]。
202
265
  3. 非必要不建议使用,不合理的取值会影响效果。
203
266
  */
204
267
  Temperature?: number
@@ -209,24 +272,27 @@ export interface ChatProRequest {
209
272
  2. 流式调用时以 SSE 协议增量返回结果。
210
273
  3. 非流式调用时接口响应耗时较长,非必要不建议使用。
211
274
  4. 非流式调用时只返回一次最终结果,调用方式与普通 HTTP 请求无异。
275
+
276
+ 注意:
277
+ 通过 SDK 调用时,流式和非流式调用需要用**不同的方式**获取返回值,具体参考 SDK 中的注释或示例(在各语言 SDK 代码仓库的 examples/hunyuan/v20230901/ 目录中)。
212
278
  */
213
279
  Stream?: boolean
214
280
  /**
215
281
  * 流式输出审核开关。
216
282
  说明:
217
- 1. 当 Stream 字段值为 true 时,该字段有效。
218
- 2. 未传值时默认不使用流式输出审核。
219
- 3. 如果值为 true,将对输出内容进行分段审核,审核通过的内容流式输出返回。如果出现审核不过,响应中的 finish_reason 值为 sensitive。
220
- 4. 如果值为 false,则需要审核完所有输出内容后再返回结果。
283
+ 1. 输出审核有流式和同步两种模式,**流式模式首包响应更快**。
284
+ 2. 当使用流式输出(Stream 字段值为 true)时,该字段生效。
285
+ 3. 如果值为 true,将对输出内容进行分段审核,审核通过的内容流式输出返回。如果出现审核不过,响应中的 FinishReason 值为 sensitive。
286
+ 4. 如果未传值或值为 false,则不使用流式输出审核,需要审核完所有输出内容后再返回结果。
221
287
 
222
288
  注意:
223
- 当选择流式输出审核时,可能会出现部分内容已输出,但中间某一段响应中的 finish_reason 值为 sensitive,此时说明安全审核未通过。如果业务场景有实时文字上屏的需求,需要自行撤回已上屏的内容,并建议自定义替换为一条提示语,如 “这个问题我不方便回答,不如我们换个话题试试”,以保障终端体验。
289
+ 当选择流式输出审核时,可能会出现部分内容已输出,但中间某一段响应中的 FinishReason 值为 sensitive,此时说明安全审核未通过。如果业务场景有实时文字上屏的需求,需要自行撤回已上屏的内容,并建议自定义替换为一条提示语,如 “这个问题我不方便回答,不如我们换个话题试试”,以保障终端体验。
224
290
  */
225
291
  StreamModeration?: boolean
226
292
  }
227
293
 
228
294
  /**
229
- * embedding 信息,当前不支持批量,所以数组元素数目为1。
295
+ * Embedding 信息。
230
296
  */
231
297
  export interface EmbeddingData {
232
298
  /**
@@ -301,7 +367,7 @@ export interface Message {
301
367
  */
302
368
  Role: string
303
369
  /**
304
- * 消息内容
370
+ * 文本内容
305
371
  */
306
372
  Content: string
307
373
  }
@@ -316,6 +382,43 @@ export interface GetTokenCountRequest {
316
382
  Prompt: string
317
383
  }
318
384
 
385
+ /**
386
+ * ChatCompletions返回参数结构体
387
+ */
388
+ export interface ChatCompletionsResponse {
389
+ /**
390
+ * Unix 时间戳,单位为秒。
391
+ */
392
+ Created?: number
393
+ /**
394
+ * Token 统计信息。
395
+ 按照总 Token 数量计费。
396
+ */
397
+ Usage?: Usage
398
+ /**
399
+ * 免责声明。
400
+ */
401
+ Note?: string
402
+ /**
403
+ * 本轮对话的 ID。
404
+ */
405
+ Id?: string
406
+ /**
407
+ * 回复内容。
408
+ */
409
+ Choices?: Array<Choice>
410
+ /**
411
+ * 错误信息。
412
+ 如果流式返回中服务处理异常,返回该错误信息。
413
+ 注意:此字段可能返回 null,表示取不到有效值。
414
+ */
415
+ ErrorMsg?: ErrorMsg
416
+ /**
417
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。本接口为流式响应接口,当请求成功时,RequestId 会被放在 HTTP 响应的 Header "X-TC-RequestId" 中。
418
+ */
419
+ RequestId?: string
420
+ }
421
+
319
422
  /**
320
423
  * ChatStd请求参数结构体
321
424
  */
@@ -339,7 +442,7 @@ export interface ChatStdRequest {
339
442
  /**
340
443
  * 说明:
341
444
  1. 较高的数值会使输出更加随机,而较低的数值会使其更加集中和确定。
342
- 2. 默认 1.0,取值区间为 [0.02.0]。
445
+ 2. 默认 1.0,取值区间为 [0.0, 2.0]。
343
446
  3. 非必要不建议使用,不合理的取值会影响效果。
344
447
  */
345
448
  Temperature?: number
@@ -350,18 +453,21 @@ export interface ChatStdRequest {
350
453
  2. 流式调用时以 SSE 协议增量返回结果。
351
454
  3. 非流式调用时接口响应耗时较长,非必要不建议使用。
352
455
  4. 非流式调用时只返回一次最终结果,调用方式与普通 HTTP 请求无异。
456
+
457
+ 注意:
458
+ 通过 SDK 调用时,流式和非流式调用需要用**不同的方式**获取返回值,具体参考 SDK 中的注释或示例(在各语言 SDK 代码仓库的 examples/hunyuan/v20230901/ 目录中)。
353
459
  */
354
460
  Stream?: boolean
355
461
  /**
356
462
  * 流式输出审核开关。
357
463
  说明:
358
- 1. 当 Stream 字段值为 true 时,该字段有效。
359
- 2. 未传值时默认不使用流式输出审核。
360
- 3. 如果值为 true,将对输出内容进行分段审核,审核通过的内容流式输出返回。如果出现审核不过,响应中的 finish_reason 值为 sensitive。
361
- 4. 如果值为 false,则需要审核完所有输出内容后再返回结果。
464
+ 1. 输出审核有流式和同步两种模式,**流式模式首包响应更快**。
465
+ 2. 当使用流式输出(Stream 字段值为 true)时,该字段生效。
466
+ 3. 如果值为 true,将对输出内容进行分段审核,审核通过的内容流式输出返回。如果出现审核不过,响应中的 FinishReason 值为 sensitive。
467
+ 4. 如果未传值或值为 false,则不使用流式输出审核,需要审核完所有输出内容后再返回结果。
362
468
 
363
469
  注意:
364
- 当选择流式输出审核时,可能会出现部分内容已输出,但中间某一段响应中的 finish_reason 值为 sensitive,此时说明安全审核未通过。如果业务场景有实时文字上屏的需求,需要自行撤回已上屏的内容,并建议自定义替换为一条提示语,如 “这个问题我不方便回答,不如我们换个话题试试”,以保障终端体验。
470
+ 当选择流式输出审核时,可能会出现部分内容已输出,但中间某一段响应中的 FinishReason 值为 sensitive,此时说明安全审核未通过。如果业务场景有实时文字上屏的需求,需要自行撤回已上屏的内容,并建议自定义替换为一条提示语,如 “这个问题我不方便回答,不如我们换个话题试试”,以保障终端体验。
365
471
  */
366
472
  StreamModeration?: boolean
367
473
  }
@@ -92,13 +92,12 @@ export class Client extends AbstractClient {
92
92
 
93
93
  ### 接口调用说明:
94
94
  - 图片文件大小支持:**文件 < 5M**
95
- - 图片尺寸支持:**长或者宽 >50分辨率**和**长或者宽<10000分辨率**
95
+ - 图片默认尺寸支持:**长或者宽 >50分辨率**和**长或者宽<10000分辨率**
96
96
  - 图片文件分辨率支持:建议**分辨率大于256x256**,否则可能会影响识别效果;
97
97
  - 图片文件支持格式:PNG、JPG、JPEG、BMP、GIF、WEBP格式;
98
98
  - 图片文件链接支持的传输协议:HTTP、HTTPS;
99
99
  - 若传入图片文件的访问链接,则需要注意**图片下载时间限制为3秒**,为保障被检测图片的稳定性和可靠性,建议您使用腾讯云COS存储或者CDN缓存等;
100
- - 默认接口请求频率限制:**100次/秒**,超过此调用频率则会报错。
101
- -审核列表中,排序是按照用户通过API接口上传调用的时间进行排序;
100
+
102
101
 
103
102
  <div class="rno-api-explorer" style="margin-bottom:20px">
104
103
  <div class="rno-api-explorer-inner">