tencentcloud-sdk-nodejs 4.0.873 → 4.0.875

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 (100) hide show
  1. package/CHANGELOG.md +524 -0
  2. package/SERVICE_CHANGELOG.md +735 -44
  3. package/package.json +1 -1
  4. package/products.md +32 -32
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/asr/v20190614/asr_client.ts +8 -7
  7. package/src/services/asr/v20190614/asr_models.ts +10 -4
  8. package/src/services/billing/v20180709/billing_models.ts +2 -2
  9. package/src/services/ccc/v20200210/ccc_models.ts +1 -1
  10. package/src/services/cdwdoris/v20211228/cdwdoris_models.ts +10 -0
  11. package/src/services/cls/v20201016/cls_models.ts +4 -0
  12. package/src/services/cynosdb/v20190107/cynosdb_models.ts +3 -3
  13. package/src/services/dc/v20180410/dc_client.ts +1 -1
  14. package/src/services/dc/v20180410/dc_models.ts +86 -78
  15. package/src/services/domain/v20180808/domain_client.ts +2 -3
  16. package/src/services/domain/v20180808/domain_models.ts +8 -8
  17. package/src/services/dsgc/v20190723/dsgc_models.ts +5 -1
  18. package/src/services/dts/v20180330/dts_client.ts +4 -2
  19. package/src/services/emr/v20190103/emr_client.ts +20 -4
  20. package/src/services/emr/v20190103/emr_models.ts +274 -78
  21. package/src/services/es/v20180416/es_models.ts +5 -0
  22. package/src/services/ess/v20201111/ess_client.ts +3 -4
  23. package/src/services/ess/v20201111/ess_models.ts +19 -4
  24. package/src/services/essbasic/v20210526/essbasic_client.ts +7 -4
  25. package/src/services/essbasic/v20210526/essbasic_models.ts +51 -5
  26. package/src/services/hunyuan/v20230901/hunyuan_client.ts +20 -56
  27. package/src/services/hunyuan/v20230901/hunyuan_models.ts +46 -226
  28. package/src/services/iotexplorer/v20190423/iotexplorer_models.ts +4 -0
  29. package/src/services/monitor/v20180724/monitor_client.ts +10 -6
  30. package/src/services/monitor/v20180724/monitor_models.ts +14 -14
  31. package/src/services/mps/v20190612/mps_client.ts +7 -4
  32. package/src/services/mps/v20190612/mps_models.ts +129 -67
  33. package/src/services/mrs/v20200910/mrs_models.ts +142 -17
  34. package/src/services/ocr/v20181119/ocr_models.ts +1 -0
  35. package/src/services/organization/v20210331/organization_models.ts +13 -0
  36. package/src/services/rce/v20201103/rce_models.ts +21 -13
  37. package/src/services/redis/v20180412/redis_client.ts +1 -1
  38. package/src/services/redis/v20180412/redis_models.ts +27 -15
  39. package/src/services/tdmq/v20200217/tdmq_models.ts +8 -8
  40. package/src/services/tke/v20180525/tke_models.ts +16 -9
  41. package/src/services/tse/v20201207/tse_models.ts +2 -2
  42. package/src/services/waf/v20180125/waf_client.ts +24 -0
  43. package/src/services/waf/v20180125/waf_models.ts +51 -0
  44. package/src/services/wedata/v20210820/wedata_client.ts +2 -0
  45. package/src/services/wedata/v20210820/wedata_models.ts +56 -1
  46. package/tencentcloud/common/sdk_version.d.ts +1 -1
  47. package/tencentcloud/common/sdk_version.js +1 -1
  48. package/tencentcloud/services/asr/v20190614/asr_client.d.ts +8 -7
  49. package/tencentcloud/services/asr/v20190614/asr_client.js +8 -7
  50. package/tencentcloud/services/asr/v20190614/asr_models.d.ts +10 -4
  51. package/tencentcloud/services/billing/v20180709/billing_models.d.ts +2 -2
  52. package/tencentcloud/services/ccc/v20200210/ccc_models.d.ts +1 -1
  53. package/tencentcloud/services/cdwdoris/v20211228/cdwdoris_models.d.ts +10 -0
  54. package/tencentcloud/services/cls/v20201016/cls_models.d.ts +4 -0
  55. package/tencentcloud/services/cynosdb/v20190107/cynosdb_models.d.ts +3 -3
  56. package/tencentcloud/services/dc/v20180410/dc_client.d.ts +1 -1
  57. package/tencentcloud/services/dc/v20180410/dc_client.js +1 -1
  58. package/tencentcloud/services/dc/v20180410/dc_models.d.ts +86 -78
  59. package/tencentcloud/services/domain/v20180808/domain_client.d.ts +0 -1
  60. package/tencentcloud/services/domain/v20180808/domain_client.js +0 -1
  61. package/tencentcloud/services/domain/v20180808/domain_models.d.ts +8 -8
  62. package/tencentcloud/services/dsgc/v20190723/dsgc_models.d.ts +5 -1
  63. package/tencentcloud/services/dts/v20180330/dts_client.d.ts +3 -1
  64. package/tencentcloud/services/dts/v20180330/dts_client.js +3 -1
  65. package/tencentcloud/services/emr/v20190103/emr_client.d.ts +5 -1
  66. package/tencentcloud/services/emr/v20190103/emr_client.js +6 -0
  67. package/tencentcloud/services/emr/v20190103/emr_models.d.ts +268 -78
  68. package/tencentcloud/services/es/v20180416/es_models.d.ts +5 -0
  69. package/tencentcloud/services/ess/v20201111/ess_client.d.ts +3 -4
  70. package/tencentcloud/services/ess/v20201111/ess_client.js +3 -4
  71. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +19 -4
  72. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +6 -4
  73. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +6 -4
  74. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +50 -5
  75. package/tencentcloud/services/hunyuan/v20230901/hunyuan_client.d.ts +10 -30
  76. package/tencentcloud/services/hunyuan/v20230901/hunyuan_client.js +11 -35
  77. package/tencentcloud/services/hunyuan/v20230901/hunyuan_models.d.ts +46 -222
  78. package/tencentcloud/services/iotexplorer/v20190423/iotexplorer_models.d.ts +4 -0
  79. package/tencentcloud/services/monitor/v20180724/monitor_client.d.ts +8 -4
  80. package/tencentcloud/services/monitor/v20180724/monitor_client.js +8 -4
  81. package/tencentcloud/services/monitor/v20180724/monitor_models.d.ts +14 -14
  82. package/tencentcloud/services/mps/v20190612/mps_client.d.ts +1 -1
  83. package/tencentcloud/services/mps/v20190612/mps_models.d.ts +125 -66
  84. package/tencentcloud/services/mrs/v20200910/mrs_models.d.ts +142 -17
  85. package/tencentcloud/services/ocr/v20181119/ocr_models.d.ts +1 -0
  86. package/tencentcloud/services/organization/v20210331/organization_models.d.ts +13 -0
  87. package/tencentcloud/services/rce/v20201103/rce_models.d.ts +21 -13
  88. package/tencentcloud/services/redis/v20180412/redis_client.d.ts +1 -1
  89. package/tencentcloud/services/redis/v20180412/redis_client.js +1 -1
  90. package/tencentcloud/services/redis/v20180412/redis_models.d.ts +27 -15
  91. package/tencentcloud/services/tdmq/v20200217/tdmq_models.d.ts +8 -8
  92. package/tencentcloud/services/tke/v20180525/tke_models.d.ts +16 -9
  93. package/tencentcloud/services/tse/v20201207/tse_models.d.ts +2 -2
  94. package/tencentcloud/services/waf/v20180125/waf_client.d.ts +9 -1
  95. package/tencentcloud/services/waf/v20180125/waf_client.js +12 -0
  96. package/tencentcloud/services/waf/v20180125/waf_models.d.ts +47 -0
  97. package/tencentcloud/services/wedata/v20210820/wedata_models.d.ts +54 -1
  98. package/test/emr.v20190103.test.js +10 -0
  99. package/test/hunyuan.v20230901.test.js +4 -24
  100. package/test/waf.v20180125.test.js +20 -0
@@ -209,7 +209,13 @@ export interface Component {
209
209
  <li> <b>IMG_ESIGN</b> : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)</li></ul>
210
210
  <b>参考样例</b>:`{"ComponentTypeLimit": ["SYSTEM_ESIGN"]}`
211
211
  印章的对应关系参考下图
212
- ![image](https://qcloudimg.tencent-cloud.cn/raw/ee0498856c060c065628a0c5ba780d6b.jpg)
212
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/ee0498856c060c065628a0c5ba780d6b.jpg)<br><br>
213
+ <font color="red">ComponentType为SIGN_SEAL 或者 SIGN_PAGING_SEAL类型时</font>,可以通过**ComponentTypeLimit**参数控制签署方签署时要使用的印章类型,支持指定以下印章类型
214
+ <ul><li> <b>OFFICIAL</b> : 企业公章</li>
215
+ <li> <b>CONTRACT</b> : 合同专用章</li>
216
+ <li> <b>FINANCE</b> : 财务专用章</li>
217
+ <li> <b>PERSONNEL</b> : 人事专用章</li></ul>
218
+ <b>参考样例</b>:`{\"ComponentTypeLimit\":[\"PERSONNEL\",\"FINANCE\"]}` 表示改印章签署区,客户需使用人事专用章或财务专用章盖章签署。<br><br>
213
219
 
214
220
  <font color="red">ComponentType为SIGN_DATE时</font>,支持以下参数:
215
221
  <ul><li> <b>Font</b> :字符串类型目前只支持"黑体"、"宋体",如果不填默认为"黑体"</li>
@@ -2496,7 +2502,12 @@ export interface ChannelCreateOrganizationBatchSignUrlRequest {
2496
2502
  */
2497
2503
  FlowIds?: Array<string>
2498
2504
  /**
2499
- * 第三方应用平台的用户openid。 您可登录腾讯电子签控制台,在 "更多能力"->"组织管理" 中查阅某位员工的OpenId。 OpenId必须是传入合同(FlowId)中的签署人。 - 1. 若OpenId为空,Name和Mobile 必须提供。 - 2. 若OpenId 与 Name,Mobile均存在,将优先采用OpenId对应的员工。
2505
+ * 第三方应用平台的用户openid。 您可登录腾讯电子签控制台,在 "更多能力"->"组织管理" 中查阅某位员工的OpenId。 OpenId必须是传入合同(FlowId)中的签署人。
2506
+
2507
+ <ul>
2508
+ <li>1. 若OpenId为空,Name和Mobile 必须提供。</li>
2509
+ <li>2. 若OpenId 与 Name,Mobile均存在,将优先采用OpenId对应的员工。 </li>
2510
+ </ul>
2500
2511
  */
2501
2512
  OpenId?: string
2502
2513
  /**
@@ -3095,7 +3106,14 @@ export interface ComponentLimit {
3095
3106
  /**
3096
3107
  * 签署控件类型的值(可选),用与限制签署时印章或者签名的选择范围
3097
3108
 
3098
- 1.当ComponentType 是 SIGN_SEAL 或者 SIGN_PAGING_SEAL 时可传入企业印章Id(支持多个)
3109
+ 1.当ComponentType 是 SIGN_SEAL 或者 SIGN_PAGING_SEAL 时可传入企业印章Id(支持多个)或者以下印章类型
3110
+
3111
+ <ul><li> <b>OFFICIAL</b> : 企业公章</li>
3112
+ <li> <b>CONTRACT</b> : 合同专用章</li>
3113
+ <li> <b>FINANCE</b> : 财务专用章</li>
3114
+ <li> <b>PERSONNEL</b> : 人事专用章</li></ul>
3115
+
3116
+ 注:`限制印章控件或骑缝章控件情况下,仅本企业签署方可以指定具体印章(通过传递ComponentValue,支持多个),他方企业签署人只能限制类型.若同时指定了印章类型和印章Id,以印章Id为主,印章类型会被忽略`
3099
3117
 
3100
3118
  2.当ComponentType 是 SIGN_SIGNATURE 时可传入以下类型(支持多个)
3101
3119
 
@@ -3843,6 +3861,10 @@ export interface ChannelDescribeOrganizationSealsRequest {
3843
3861
  注: `为空时查询所有类型的印章。`
3844
3862
  */
3845
3863
  SealTypes?: Array<string>
3864
+ /**
3865
+ * 查询的印章状态列表。 <ul> <li>空,只查询启用状态的印章;</li> <li>ALL,查询所有状态的印章;</li> <li>CHECKING,查询待审核的印章;</li> <li>SUCCESS,查询启用状态的印章;</li> <li>FAIL,查询印章审核拒绝的印章;</li> <li>DISABLE,查询已停用的印章;</li> <li>STOPPED,查询已终止的印章;</li> <li>VOID,查询已作废的印章;</li> <li>INVALID,查询已失效的印章;</li> </ul>
3866
+ */
3867
+ SealStatuses?: Array<string>
3846
3868
  }
3847
3869
 
3848
3870
  /**
@@ -4816,7 +4838,7 @@ export interface SignQrCode {
4816
4838
 
4817
4839
  **各种场景传参说明**:
4818
4840
 
4819
- <table> <thead> <tr> <th>场景编号</th> <th>发起方类型</th> <th>签署方类型</th> <th>签署方传参说明</th> </tr> </thead> <tbody> <tr> <td>场景一</td> <td>第三方子企业A员工</td> <td>第三方子企业A员工</td> <td> <ul> <li>(选填)IdCardNumber和IdCardType:证件类型和证件号</li> <li>(必传)Name:签署方的名字</li> <li>(必传)Mobile:签署方的手机号</li> <li>(必传)OpenId:企业员工标识</li> <li>(必传)OrganizationName:子企业名称</li> <li>(必传)OrganizationOpenId:子企业的标识</li> <li>(固定)ApproverType:需设置为ORGANIZATION</li> </ul> </td> </tr> <tr> <td>场景二</td> <td>第三方子企业A员工</td> <td>第三方子企业B(不指定经办人走领取方式)</td> <td> <ul> <li>(必传)OrganizationName:子企业名称</li> <li>(必传)OrganizationOpenId:子企业的标识</li> <li>(固定)ApproverType:需设置为ORGANIZATION</li> <li>(固定)ApproverOption.FillType:需设置为1</li> </ul> </td> </tr> <tr> <td>场景三</td> <td>第三方子企业A员工</td> <td>第三方子企业B员工</td> <td> <ul> <li>(选填)IdCardNumber和IdCardType:证件类型和证件号</li> <li>(必传)Name:签署方的名字</li> <li>(必传)Mobile:签署方的手机号</li> <li>(必传)OpenId:企业员工标识</li> <li>(必传)OrganizationName:子企业名称</li> <li>(必传)OrganizationOpenId:子企业的标识</li> <li>(固定)ApproverType:需设置为ORGANIZATION</li> </ul></td> </tr> <tr> <td>场景四</td> <td>第三方子企业A员工</td> <td>个人/自然人</td> <td> <ul> <li>(选填)IdCardNumber和IdCardType:证件类型和证件号</li> <li>(必传)Name:签署方的名字</li> <li>(必传)Mobile:签署方的手机号</li> <li>(固定)ApproverType:需设置为PERSON</li> </ul> </td> </tr> <tr> <td>场景五</td> <td>第三方子企业A员工</td> <td>SaaS平台企业员工</td> <td> <ul> <li>(选填)IdCardNumber和IdCardType:证件类型和证件号</li> <li>(必传)OrganizationName:SaaS企业的名字</li> <li>(必传)Name:签署方的名字</li> <li>(必传)Mobile:签署方的手机号</li> <li>(必传)OrganizationOpenId:子企业的标识</li> <li>(固定)ApproverType:需设置为ORGANIZATION</li> <li>(固定)NotChannelOrganization:需设置为True</li> </ul> </td> </tr> </tbody> </table>
4841
+ <table> <thead> <tr> <th>场景编号</th> <th>发起方类型</th> <th>签署方类型</th> <th>签署方传参说明</th> </tr> </thead> <tbody> <tr> <td>场景一</td> <td>第三方子企业A员工</td> <td>第三方子企业A员工</td> <td> <ul> <li>(选填)IdCardNumber和IdCardType:证件类型和证件号</li> <li>(必传)Name:签署方的名字</li> <li>(必传)Mobile:签署方的手机号</li> <li>(必传)OpenId:企业员工标识</li> <li>(必传)OrganizationName:子企业名称</li> <li>(必传)OrganizationOpenId:子企业的标识</li> <li>(固定)ApproverType:需设置为ORGANIZATION</li> </ul> </td> </tr> <tr> <td>场景二</td> <td>第三方子企业A员工</td> <td>第三方子企业B(不指定经办人走领取方式)</td> <td> <ul> <li>(必传)OrganizationName:子企业名称</li> <li>(必传)OrganizationOpenId:子企业的标识</li> <li>(固定)ApproverType:需设置为ORGANIZATION</li> <li>(固定)ApproverOption.FillType:需设置为1</li> </ul> </td> </tr> <tr> <td>场景三</td> <td>第三方子企业A员工</td> <td>第三方子企业B员工</td> <td> <ul> <li>(选填)IdCardNumber和IdCardType:证件类型和证件号</li> <li>(必传)Name:签署方的名字</li> <li>(必传)Mobile:签署方的手机号</li> <li>(必传)OpenId:企业员工标识</li> <li>(必传)OrganizationName:子企业名称</li> <li>(必传)OrganizationOpenId:子企业的标识</li> <li>(固定)ApproverType:需设置为ORGANIZATION</li> </ul></td> </tr> <tr> <td>场景四</td> <td>第三方子企业A员工</td> <td>个人/自然人</td> <td> <ul> <li>(选填)IdCardNumber和IdCardType:证件类型和证件号</li> <li>(必传)Name:签署方的名字</li> <li>(必传)Mobile:签署方的手机号</li> <li>(固定)ApproverType:需设置为PERSON</li> </ul> </td> </tr> <tr> <td>场景五</td> <td>第三方子企业A员工</td> <td>SaaS平台企业员工</td> <td> <ul> <li>(选填)IdCardNumber和IdCardType:证件类型和证件号</li> <li>(必传)OrganizationName:SaaS企业的名字</li> <li>(必传)Name:签署方的名字</li> <li>(必传)Mobile:签署方的手机号</li> <li>(不传)OrganizationOpenId:子企业的标识</li> <li>(不传)OpenId:企业员工标识</li> <li>(固定)ApproverType:需设置为ORGANIZATION</li> <li>(固定)NotChannelOrganization:需设置为True</li> </ul> </td> </tr> </tbody> </table>
4820
4842
 
4821
4843
 
4822
4844
  **注1**: `使用模板发起合同时,RecipientId(模板发起合同时)必传`
@@ -4999,7 +5021,7 @@ export interface FlowApproverInfo {
4999
5021
  */
5000
5022
  NotifyType?: string
5001
5023
  /**
5002
- * [通过文件创建签署流程](https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowByFiles)时,如果设置了外层参数SignBeanTag=1(允许签署过程中添加签署控件),则可通过此参数明确规定合同所使用的签署控件类型(骑缝章、普通章法人章等)和具体的印章(印章ID)或签名方式。
5024
+ * [通过文件创建签署流程](https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowByFiles)时,如果设置了外层参数SignBeanTag=1(允许签署过程中添加签署控件),则可通过此参数明确规定合同所使用的签署控件类型(骑缝章、普通章法人章等)和具体的印章(印章ID,或者印章类型)或签名方式。
5003
5025
 
5004
5026
  注:`限制印章控件或骑缝章控件情况下,仅本企业签署方可以指定具体印章(通过传递ComponentValue,支持多个),他方企业或个人只支持限制控件类型。`
5005
5027
  */
@@ -7563,6 +7585,26 @@ export interface ChannelCreateOrganizationBatchSignUrlResponse {
7563
7585
  RequestId?: string
7564
7586
  }
7565
7587
 
7588
+ /**
7589
+ * 创建嵌入式页面url个性化参数
7590
+ */
7591
+ export interface EmbedUrlOption {
7592
+ /**
7593
+ * 合同详情页面是否展示合同控件信息
7594
+ <br/>true:允许在合同详情页展示控件
7595
+ <br/>false:不允许在合同详情页展示控件
7596
+ <br/>默认false,在合同详情页不展示控件
7597
+ */
7598
+ ShowFlowDetailComponent?: boolean
7599
+ /**
7600
+ * 模版预览页面是否展示空间信息
7601
+ <br/>true:允许在模版预览页展示控件
7602
+ <br/>false:不允许在模版预览页展示控件
7603
+ <br/>默认false,在模版预览页不展示控件
7604
+ */
7605
+ ShowTemplateComponent?: boolean
7606
+ }
7607
+
7566
7608
  /**
7567
7609
  * 用量明细
7568
7610
  */
@@ -8107,6 +8149,10 @@ export interface ChannelCreateEmbedWebUrlRequest {
8107
8149
  </ul>
8108
8150
  */
8109
8151
  UserData?: string
8152
+ /**
8153
+ * 个性化参数,用于控制页面展示内容
8154
+ */
8155
+ Option?: EmbedUrlOption
8110
8156
  }
8111
8157
 
8112
8158
  /**
@@ -19,26 +19,22 @@ import { AbstractClient } from "../../../common/abstract_client"
19
19
  import { ClientConfig } from "../../../common/interface"
20
20
  import {
21
21
  ChatCompletionsRequest,
22
- GetTokenCountResponse,
23
22
  GetEmbeddingResponse,
24
23
  QueryHunyuanImageJobRequest,
25
24
  ErrorMsg,
26
- ChatStdResponse,
27
25
  GetEmbeddingRequest,
28
- ChatProResponse,
29
26
  SubmitHunyuanImageJobResponse,
30
27
  Choice,
31
- ChatProRequest,
28
+ GetTokenCountResponse,
32
29
  EmbeddingData,
33
30
  QueryHunyuanImageJobResponse,
34
- EmbeddingUsage,
31
+ SubmitHunyuanImageJobRequest,
35
32
  Delta,
36
33
  Usage,
37
34
  Message,
38
35
  GetTokenCountRequest,
39
36
  ChatCompletionsResponse,
40
- ChatStdRequest,
41
- SubmitHunyuanImageJobRequest,
37
+ EmbeddingUsage,
42
38
  } from "./hunyuan_models"
43
39
 
44
40
  /**
@@ -51,32 +47,18 @@ export class Client extends AbstractClient {
51
47
  }
52
48
 
53
49
  /**
54
- * 混元生图接口基于混元大模型,将根据输入的文本描述,智能生成与之相关的结果图。分为提交任务和查询任务2个接口。
55
- 提交任务:输入文本等,提交一个混元生图异步任务,获得任务 ID。
56
- 查询任务:根据任务 ID 查询任务的处理状态、处理结果,任务处理完成后可获得生成图像结果。
57
- 并发任务数(并发)说明:并发任务数指能同时处理的任务数量。混元生图默认提供1个并发任务数,代表最多能同时处理1个已提交的任务,上一个任务处理完毕后才能开始处理下一个任务。
58
- */
59
- async SubmitHunyuanImageJob(
60
- req: SubmitHunyuanImageJobRequest,
61
- cb?: (error: string, rep: SubmitHunyuanImageJobResponse) => void
62
- ): Promise<SubmitHunyuanImageJobResponse> {
63
- return this.request("SubmitHunyuanImageJob", req, cb)
64
- }
65
-
66
- /**
67
- * <span style="font-size:1.5em;">注意:本接口将于 5 月 15 日下线;下线后将不再提供文档指引,接口本身可继续调用,建议使用 [hunyuan](https://cloud.tencent.com/document/api/1729/105701) 接入。</span>
68
-
69
- 腾讯混元大模型(hunyuan-pro)是由腾讯研发的大语言模型,具备强大的中文创作能力,复杂语境下的逻辑推理能力,以及可靠的任务执行能力。本接口支持流式或非流式调用,当使用流式调用时为 SSE 协议。
50
+ * 腾讯混元大模型是由腾讯研发的大语言模型,具备强大的中文创作能力,复杂语境下的逻辑推理能力,以及可靠的任务执行能力。本接口支持流式或非流式调用,当使用流式调用时为 SSE 协议。
70
51
 
71
52
  1. 本接口暂不支持返回图片内容。
72
- 2. 默认单账号限制并发数为 5 路,如您有提高并发限制的需求请 [联系我们](https://cloud.tencent.com/act/event/Online_service) 。
53
+ 2. 默认每种模型单账号限制并发数为 5 路,如您有提高并发限制的需求请 [联系我们](https://cloud.tencent.com/act/event/Online_service) 。
73
54
  3. 请使用 SDK 调用本接口,每种开发语言的 SDK Git 仓库 examples/hunyuan/v20230901/ 目录下有提供示例供参考。SDK 链接在文档下方 “**开发者资源 - SDK**” 部分提供。
55
+ 4. 我们推荐您使用 API Explorer,方便快速地在线调试接口和下载各语言的示例代码,[点击打开](https://console.cloud.tencent.com/api/explorer?Product=hunyuan&Version=2023-09-01&Action=ChatCompletions)。
74
56
  */
75
- async ChatPro(
76
- req: ChatProRequest,
77
- cb?: (error: string, rep: ChatProResponse) => void
78
- ): Promise<ChatProResponse> {
79
- return this.request("ChatPro", req, cb)
57
+ async ChatCompletions(
58
+ req: ChatCompletionsRequest,
59
+ cb?: (error: string, rep: ChatCompletionsResponse) => void
60
+ ): Promise<ChatCompletionsResponse> {
61
+ return this.request("ChatCompletions", req, cb)
80
62
  }
81
63
 
82
64
  /**
@@ -93,34 +75,16 @@ export class Client extends AbstractClient {
93
75
  }
94
76
 
95
77
  /**
96
- * <span style="font-size:1.5em;">注意:本接口将于 5 月 15 日下线;下线后将不再提供文档指引,接口本身可继续调用,建议使用 [hunyuan](https://cloud.tencent.com/document/api/1729/105701) 接入。</span>
97
-
98
- 腾讯混元大模型(hunyuan-standard)是由腾讯研发的大语言模型,具备强大的中文创作能力,复杂语境下的逻辑推理能力,以及可靠的任务执行能力。本接口支持流式或非流式调用,当使用流式调用时为 SSE 协议。
99
-
100
- 1. 本接口暂不支持返回图片内容。
101
- 2. 默认单账号限制并发数为 5 路,如您有提高并发限制的需求请 [联系我们](https://cloud.tencent.com/act/event/Online_service) 。
102
- 3. 请使用 SDK 调用本接口,每种开发语言的 SDK Git 仓库 examples/hunyuan/v20230901/ 目录下有提供示例供参考。SDK 链接在文档下方 “**开发者资源 - SDK**” 部分提供。
103
- */
104
- async ChatStd(
105
- req: ChatStdRequest,
106
- cb?: (error: string, rep: ChatStdResponse) => void
107
- ): Promise<ChatStdResponse> {
108
- return this.request("ChatStd", req, cb)
109
- }
110
-
111
- /**
112
- * 腾讯混元大模型是由腾讯研发的大语言模型,具备强大的中文创作能力,复杂语境下的逻辑推理能力,以及可靠的任务执行能力。本接口支持流式或非流式调用,当使用流式调用时为 SSE 协议。
113
-
114
- 1. 本接口暂不支持返回图片内容。
115
- 2. 默认每种模型单账号限制并发数为 5 路,如您有提高并发限制的需求请 [联系我们](https://cloud.tencent.com/act/event/Online_service) 。
116
- 3. 请使用 SDK 调用本接口,每种开发语言的 SDK Git 仓库 examples/hunyuan/v20230901/ 目录下有提供示例供参考。SDK 链接在文档下方 “**开发者资源 - SDK**” 部分提供。
117
- 4. 我们推荐您使用 API Explorer,方便快速地在线调试接口和下载各语言的示例代码,[点击打开](https://console.cloud.tencent.com/api/explorer?Product=hunyuan&Version=2023-09-01&Action=ChatCompletions)。
78
+ * 混元生图接口基于混元大模型,将根据输入的文本描述,智能生成与之相关的结果图。分为提交任务和查询任务2个接口。
79
+ 提交任务:输入文本等,提交一个混元生图异步任务,获得任务 ID。
80
+ 查询任务:根据任务 ID 查询任务的处理状态、处理结果,任务处理完成后可获得生成图像结果。
81
+ 并发任务数(并发)说明:并发任务数指能同时处理的任务数量。混元生图默认提供1个并发任务数,代表最多能同时处理1个已提交的任务,上一个任务处理完毕后才能开始处理下一个任务。
118
82
  */
119
- async ChatCompletions(
120
- req: ChatCompletionsRequest,
121
- cb?: (error: string, rep: ChatCompletionsResponse) => void
122
- ): Promise<ChatCompletionsResponse> {
123
- return this.request("ChatCompletions", req, cb)
83
+ async SubmitHunyuanImageJob(
84
+ req: SubmitHunyuanImageJobRequest,
85
+ cb?: (error: string, rep: SubmitHunyuanImageJobResponse) => void
86
+ ): Promise<SubmitHunyuanImageJobResponse> {
87
+ return this.request("SubmitHunyuanImageJob", req, cb)
124
88
  }
125
89
 
126
90
  /**
@@ -65,14 +65,14 @@ export interface ChatCompletionsRequest {
65
65
  /**
66
66
  * 说明:
67
67
  1. 影响输出文本的多样性,取值越大,生成文本的多样性越强。
68
- 2. 默认 1.0,取值区间为 [0.0, 1.0]
68
+ 2. 取值区间为 [0.0, 1.0],未传值时使用各模型推荐值。
69
69
  3. 非必要不建议使用,不合理的取值会影响效果。
70
70
  */
71
71
  TopP?: number
72
72
  /**
73
73
  * 说明:
74
74
  1. 较高的数值会使输出更加随机,而较低的数值会使其更加集中和确定。
75
- 2. 默认 1.0,取值区间为 [0.0, 2.0]
75
+ 2. 取值区间为 [0.0, 2.0],未传值时使用各模型推荐值。
76
76
  3. 非必要不建议使用,不合理的取值会影响效果。
77
77
  */
78
78
  Temperature?: number
@@ -87,28 +87,6 @@ export interface ChatCompletionsRequest {
87
87
  EnableEnhancement?: boolean
88
88
  }
89
89
 
90
- /**
91
- * GetTokenCount返回参数结构体
92
- */
93
- export interface GetTokenCountResponse {
94
- /**
95
- * token计数
96
- */
97
- TokenCount?: number
98
- /**
99
- * 字符计数
100
- */
101
- CharacterCount?: number
102
- /**
103
- * 切分后的列表
104
- */
105
- Tokens?: Array<string>
106
- /**
107
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
108
- */
109
- RequestId?: string
110
- }
111
-
112
90
  /**
113
91
  * GetEmbedding返回参数结构体
114
92
  */
@@ -154,43 +132,6 @@ export interface ErrorMsg {
154
132
  Code?: number
155
133
  }
156
134
 
157
- /**
158
- * ChatStd返回参数结构体
159
- */
160
- export interface ChatStdResponse {
161
- /**
162
- * Unix 时间戳,单位为秒。
163
- */
164
- Created?: number
165
- /**
166
- * Token 统计信息。
167
- 按照总 Token 数量计费。
168
- */
169
- Usage?: Usage
170
- /**
171
- * 免责声明。
172
- */
173
- Note?: string
174
- /**
175
- * 本轮对话的 ID。
176
- */
177
- Id?: string
178
- /**
179
- * 回复内容。
180
- */
181
- Choices?: Array<Choice>
182
- /**
183
- * 错误信息。
184
- 如果流式返回中服务处理异常,返回该错误信息。
185
- 注意:此字段可能返回 null,表示取不到有效值。
186
- */
187
- ErrorMsg?: ErrorMsg
188
- /**
189
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。本接口为流式响应接口,当请求成功时,RequestId 会被放在 HTTP 响应的 Header "X-TC-RequestId" 中。
190
- */
191
- RequestId?: string
192
- }
193
-
194
135
  /**
195
136
  * GetEmbedding请求参数结构体
196
137
  */
@@ -201,43 +142,6 @@ export interface GetEmbeddingRequest {
201
142
  Input: string
202
143
  }
203
144
 
204
- /**
205
- * ChatPro返回参数结构体
206
- */
207
- export interface ChatProResponse {
208
- /**
209
- * Unix 时间戳,单位为秒。
210
- */
211
- Created?: number
212
- /**
213
- * Token 统计信息。
214
- 按照总 Token 数量计费。
215
- */
216
- Usage?: Usage
217
- /**
218
- * 免责声明。
219
- */
220
- Note?: string
221
- /**
222
- * 本轮对话的 ID。
223
- */
224
- Id?: string
225
- /**
226
- * 回复内容。
227
- */
228
- Choices?: Array<Choice>
229
- /**
230
- * 错误信息。
231
- 如果流式返回中服务处理异常,返回该错误信息。
232
- 注意:此字段可能返回 null,表示取不到有效值。
233
- */
234
- ErrorMsg?: ErrorMsg
235
- /**
236
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。本接口为流式响应接口,当请求成功时,RequestId 会被放在 HTTP 响应的 Header "X-TC-RequestId" 中。
237
- */
238
- RequestId?: string
239
- }
240
-
241
145
  /**
242
146
  * SubmitHunyuanImageJob返回参数结构体
243
147
  */
@@ -274,56 +178,25 @@ stop 表示输出正常结束,sensitive 只在开启流式输出审核时会
274
178
  }
275
179
 
276
180
  /**
277
- * ChatPro请求参数结构体
181
+ * GetTokenCount返回参数结构体
278
182
  */
279
- export interface ChatProRequest {
280
- /**
281
- * 聊天上下文信息。
282
- 说明:
283
- 1. 长度最多为 40,按对话时间从旧到新在数组中排列。
284
- 2. Message.Role 可选值:system、user、assistant。
285
- 其中,system 角色可选,如存在则必须位于列表的最开始。user 和 assistant 需交替出现(一问一答),以 user 提问开始和结束,且 Content 不能为空。Role 的顺序示例:[system(可选) user assistant user assistant user ...]。
286
- 3. Messages 中 Content 总长度不能超过 hunyuan-pro 模型输入长度上限(可参考 [产品概述](https://cloud.tencent.com/document/product/1729/104753) 文档),超过则会截断最前面的内容,只保留尾部内容。
287
- */
288
- Messages: Array<Message>
183
+ export interface GetTokenCountResponse {
289
184
  /**
290
- * 说明:
291
- 1. 影响输出文本的多样性,取值越大,生成文本的多样性越强。
292
- 2. 默认 1.0,取值区间为 [0.0, 1.0]。
293
- 3. 非必要不建议使用,不合理的取值会影响效果。
185
+ * token计数
294
186
  */
295
- TopP?: number
187
+ TokenCount?: number
296
188
  /**
297
- * 说明:
298
- 1. 较高的数值会使输出更加随机,而较低的数值会使其更加集中和确定。
299
- 2. 默认 1.0,取值区间为 [0.0, 2.0]。
300
- 3. 非必要不建议使用,不合理的取值会影响效果。
189
+ * 字符计数
301
190
  */
302
- Temperature?: number
191
+ CharacterCount?: number
303
192
  /**
304
- * 流式调用开关。
305
- 说明:
306
- 1. 未传值时默认为流式调用。
307
- 2. 流式调用时以 SSE 协议增量返回结果。
308
- 3. 非流式调用时接口响应耗时较长,非必要不建议使用。
309
- 4. 非流式调用时只返回一次最终结果,调用方式与普通 HTTP 请求无异。
310
-
311
- 注意:
312
- 通过 SDK 调用时,流式和非流式调用需要用**不同的方式**获取返回值,具体参考 SDK 中的注释或示例(在各语言 SDK 代码仓库的 examples/hunyuan/v20230901/ 目录中)。
193
+ * 切分后的列表
313
194
  */
314
- Stream?: boolean
195
+ Tokens?: Array<string>
315
196
  /**
316
- * 流式输出审核开关。
317
- 说明:
318
- 1. 输出审核有流式和同步两种模式,**流式模式首包响应更快**。
319
- 2. 当使用流式输出(Stream 字段值为 true)时,该字段生效。
320
- 3. 如果值为 true,将对输出内容进行分段审核,审核通过的内容流式输出返回。如果出现审核不过,响应中的 FinishReason 值为 sensitive。
321
- 4. 如果未传值或值为 false,则不使用流式输出审核,需要审核完所有输出内容后再返回结果。
322
-
323
- 注意:
324
- 当选择流式输出审核时,可能会出现部分内容已输出,但中间某一段响应中的 FinishReason 值为 sensitive,此时说明安全审核未通过。如果业务场景有实时文字上屏的需求,需要自行撤回已上屏的内容,并建议自定义替换为一条提示语,如 “这个问题我不方便回答,不如我们换个话题试试”,以保障终端体验。
197
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
325
198
  */
326
- StreamModeration?: boolean
199
+ RequestId?: string
327
200
  }
328
201
 
329
202
  /**
@@ -392,17 +265,39 @@ export interface QueryHunyuanImageJobResponse {
392
265
  }
393
266
 
394
267
  /**
395
- * Token 使用计数。
268
+ * SubmitHunyuanImageJob请求参数结构体
396
269
  */
397
- export interface EmbeddingUsage {
270
+ export interface SubmitHunyuanImageJobRequest {
398
271
  /**
399
- * 输入 Token 数。
272
+ * 文本描述。 算法将根据输入的文本智能生成与之相关的图像。 不能为空,推荐使用中文。最多可传100个 utf-8 字符。
400
273
  */
401
- PromptTokens?: number
274
+ Prompt: string
402
275
  /**
403
- * 总 Token 数。
276
+ * 绘画风格。
277
+ 请在 [混元生图风格列表](https://cloud.tencent.com/document/product/1729/105846) 中选择期望的风格,传入风格编号。
278
+ 不传默认不指定风格。
404
279
  */
405
- TotalTokens?: number
280
+ Style?: string
281
+ /**
282
+ * 生成图分辨率。
283
+ 支持生成以下分辨率的图片:768:768(1:1)、768:1024(3:4)、1024:768(4:3)、1024:1024(1:1)、720:1280(9:16)、1280:720(16:9)、768:1280(3:5)、1280:768(5:3),不传默认使用1024:1024。
284
+ */
285
+ Resolution?: string
286
+ /**
287
+ * 为生成结果图添加显式水印标识的开关,默认为1。
288
+ 1:添加。
289
+ 0:不添加。
290
+ 其他数值:默认按1处理。
291
+ 建议您使用显著标识来提示结果图使用了 AI 绘画技术,是 AI 生成的图片。
292
+ */
293
+ LogoAdd?: number
294
+ /**
295
+ * prompt 扩写开关。1为开启,0为关闭,不传默认开启。
296
+ 开启扩写后,将自动扩写原始输入的 prompt 并使用扩写后的 prompt 生成图片,返回生成图片结果时将一并返回扩写后的 prompt 文本。
297
+ 如果关闭扩写,将直接使用原始输入的 prompt 生成图片。
298
+ 建议开启,在多数场景下可提升生成图片效果、丰富生成图片细节。
299
+ */
300
+ Revise?: number
406
301
  }
407
302
 
408
303
  /**
@@ -499,90 +394,15 @@ export interface ChatCompletionsResponse {
499
394
  }
500
395
 
501
396
  /**
502
- * ChatStd请求参数结构体
503
- */
504
- export interface ChatStdRequest {
505
- /**
506
- * 聊天上下文信息。
507
- 说明:
508
- 1. 长度最多为 40,按对话时间从旧到新在数组中排列。
509
- 2. Message 的 Role 当前可选值:user、assistant。
510
- 其中,user 和 assistant 需交替出现(一问一答),以 user 提问开始和结束,且 Content 不能为空。Role 的顺序示例:[user assistant user assistant user ...]。
511
- 3. Messages 中 Content 总长度不能超过 hunyuan-standard 模型输入长度上限(可参考 [产品概述](https://cloud.tencent.com/document/product/1729/104753) 文档),超过则会截断最前面的内容,只保留尾部内容。
512
- */
513
- Messages: Array<Message>
514
- /**
515
- * 说明:
516
- 1. 影响输出文本的多样性,取值越大,生成文本的多样性越强。
517
- 2. 默认 1.0,取值区间为 [0.0, 1.0]。
518
- 3. 非必要不建议使用,不合理的取值会影响效果。
519
- */
520
- TopP?: number
521
- /**
522
- * 说明:
523
- 1. 较高的数值会使输出更加随机,而较低的数值会使其更加集中和确定。
524
- 2. 默认 1.0,取值区间为 [0.0, 2.0]。
525
- 3. 非必要不建议使用,不合理的取值会影响效果。
526
- */
527
- Temperature?: number
528
- /**
529
- * 流式调用开关。
530
- 说明:
531
- 1. 未传值时默认为流式调用。
532
- 2. 流式调用时以 SSE 协议增量返回结果。
533
- 3. 非流式调用时接口响应耗时较长,非必要不建议使用。
534
- 4. 非流式调用时只返回一次最终结果,调用方式与普通 HTTP 请求无异。
535
-
536
- 注意:
537
- 通过 SDK 调用时,流式和非流式调用需要用**不同的方式**获取返回值,具体参考 SDK 中的注释或示例(在各语言 SDK 代码仓库的 examples/hunyuan/v20230901/ 目录中)。
538
- */
539
- Stream?: boolean
540
- /**
541
- * 流式输出审核开关。
542
- 说明:
543
- 1. 输出审核有流式和同步两种模式,**流式模式首包响应更快**。
544
- 2. 当使用流式输出(Stream 字段值为 true)时,该字段生效。
545
- 3. 如果值为 true,将对输出内容进行分段审核,审核通过的内容流式输出返回。如果出现审核不过,响应中的 FinishReason 值为 sensitive。
546
- 4. 如果未传值或值为 false,则不使用流式输出审核,需要审核完所有输出内容后再返回结果。
547
-
548
- 注意:
549
- 当选择流式输出审核时,可能会出现部分内容已输出,但中间某一段响应中的 FinishReason 值为 sensitive,此时说明安全审核未通过。如果业务场景有实时文字上屏的需求,需要自行撤回已上屏的内容,并建议自定义替换为一条提示语,如 “这个问题我不方便回答,不如我们换个话题试试”,以保障终端体验。
550
- */
551
- StreamModeration?: boolean
552
- }
553
-
554
- /**
555
- * SubmitHunyuanImageJob请求参数结构体
397
+ * Token 使用计数。
556
398
  */
557
- export interface SubmitHunyuanImageJobRequest {
558
- /**
559
- * 文本描述。 算法将根据输入的文本智能生成与之相关的图像。 不能为空,推荐使用中文。最多可传100个 utf-8 字符。
560
- */
561
- Prompt: string
562
- /**
563
- * 绘画风格。
564
- 请在 [混元生图风格列表](https://cloud.tencent.com/document/product/1729/105846) 中选择期望的风格,传入风格编号。
565
- 不传默认不指定风格。
566
- */
567
- Style?: string
568
- /**
569
- * 生成图分辨率。
570
- 支持生成以下分辨率的图片:768:768(1:1)、768:1024(3:4)、1024:768(4:3)、1024:1024(1:1)、720:1280(9:16)、1280:720(16:9)、768:1280(3:5)、1280:768(5:3),不传默认使用1024:1024。
571
- */
572
- Resolution?: string
399
+ export interface EmbeddingUsage {
573
400
  /**
574
- * 为生成结果图添加显式水印标识的开关,默认为1。
575
- 1:添加。
576
- 0:不添加。
577
- 其他数值:默认按1处理。
578
- 建议您使用显著标识来提示结果图使用了 AI 绘画技术,是 AI 生成的图片。
401
+ * 输入 Token 数。
579
402
  */
580
- LogoAdd?: number
403
+ PromptTokens?: number
581
404
  /**
582
- * prompt 扩写开关。1为开启,0为关闭,不传默认开启。
583
- 开启扩写后,将自动扩写原始输入的 prompt 并使用扩写后的 prompt 生成图片,返回生成图片结果时将一并返回扩写后的 prompt 文本。
584
- 如果关闭扩写,将直接使用原始输入的 prompt 生成图片。
585
- 建议开启,在多数场景下可提升生成图片效果、丰富生成图片细节。
405
+ * Token 数。
586
406
  */
587
- Revise?: number
407
+ TotalTokens?: number
588
408
  }
@@ -1311,6 +1311,10 @@ export interface GetWechatDeviceTicketRequest {
1311
1311
  * 模板ID
1312
1312
  */
1313
1313
  ModelId?: string
1314
+ /**
1315
+ * 小程序APPID
1316
+ */
1317
+ MiniProgramAppId?: string
1314
1318
  }
1315
1319
 
1316
1320
  /**
@@ -670,8 +670,10 @@ export class Client extends AbstractClient {
670
670
  }
671
671
 
672
672
  /**
673
- * 判断用户是否为云原生监控新用户,即在任何地域下均未创建过监控实例的用户
674
- */
673
+ * 接口功能是检查是否为prometheus新用户,已有其他功能更加全面的接口替代
674
+
675
+ 判断用户是否为云原生监控新用户,即在任何地域下均未创建过监控实例的用户
676
+ */
675
677
  async CheckIsPrometheusNewUser(
676
678
  req?: CheckIsPrometheusNewUserRequest,
677
679
  cb?: (error: string, rep: CheckIsPrometheusNewUserResponse) => void
@@ -1604,7 +1606,7 @@ export class Client extends AbstractClient {
1604
1606
  }
1605
1607
 
1606
1608
  /**
1607
- * 列出 Prometheus 服务可用区
1609
+ * 列出 Prometheus 服务可用区。
1608
1610
  */
1609
1611
  async DescribePrometheusZones(
1610
1612
  req: DescribePrometheusZonesRequest,
@@ -1885,8 +1887,10 @@ export class Client extends AbstractClient {
1885
1887
  }
1886
1888
 
1887
1889
  /**
1888
- * 拉取Prometheus聚合规则yaml列表
1889
- */
1890
+ * DescribePrometheusRecordRules 接口可完全代替该接口。近30天仅有3次调用,且都是报错请求
1891
+
1892
+ 拉取Prometheus聚合规则yaml列表
1893
+ */
1890
1894
  async DescribePrometheusRecordRuleYaml(
1891
1895
  req: DescribePrometheusRecordRuleYamlRequest,
1892
1896
  cb?: (error: string, rep: DescribePrometheusRecordRuleYamlResponse) => void
@@ -2027,7 +2031,7 @@ export class Client extends AbstractClient {
2027
2031
  }
2028
2032
 
2029
2033
  /**
2030
- * 列出可安装的所有 Grafana 插件
2034
+ * 列出可安装的所有 Grafana 插件。
2031
2035
  */
2032
2036
  async DescribePluginOverviews(
2033
2037
  req?: DescribePluginOverviewsRequest,