tencentcloud-sdk-nodejs 4.1.122 → 4.1.123

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.
package/README.md CHANGED
@@ -62,6 +62,8 @@ npm install tencentcloud-sdk-slim-nodejs --save
62
62
 
63
63
  1. clone 代码到本地:
64
64
  ```
65
+ git clone https://cnb.cool/tencent/cloud/api/sdk/tencentcloud-sdk-nodejs
66
+ # 或者
65
67
  git clone https://github.com/tencentcloud/tencentcloud-sdk-nodejs
66
68
  # 或者
67
69
  git clone https://gitee.com/tencentcloud/tencentcloud-sdk-nodejs
@@ -135,7 +137,7 @@ const CvmClient = tencentcloud.cvm.v20170312.Client
135
137
  // ...
136
138
  ```
137
139
 
138
- 实例化 `Client` 的入参支持 `clientConfig`,数据结构和说明详见 [ClientConfig](https://github.com/TencentCloud/tencentcloud-sdk-nodejs/blob/master/src/common/interface.ts)。
140
+ 实例化 `Client` 的入参支持 `clientConfig`,数据结构和说明详见 [ClientConfig](src/common/interface.ts)。
139
141
 
140
142
  ## Common Client
141
143
 
@@ -143,17 +145,17 @@ const CvmClient = tencentcloud.cvm.v20170312.Client
143
145
 
144
146
  **注意,您必须明确知道您调用的接口所需参数,否则可能会调用失败。**
145
147
 
146
- 详细使用请参阅示例:[使用 Common Client 进行调用](https://github.com/TencentCloud/tencentcloud-sdk-nodejs/tree/master/examples/common)
148
+ 详细使用请参阅示例:[使用 Common Client 进行调用](examples/common)
147
149
 
148
150
  ## 更多示例
149
151
 
150
- 请参考 [examples](https://github.com/TencentCloud/tencentcloud-sdk-nodejs/tree/master/examples) 目录。
152
+ 请参考 [examples](examples) 目录。
151
153
 
152
154
  # 相关配置
153
155
 
154
156
  ## 代理
155
157
 
156
- 如果是有代理的环境下,需要配置代理,请在创建 Client 时传入 [profile.httpProfile.proxy](https://github.com/TencentCloud/tencentcloud-sdk-nodejs/blob/master/src/common/interface.ts#L78) 参数,或设置系统环境变量 `http_proxy` ,否则可能无法正常调用,抛出连接超时的异常。
158
+ 如果是有代理的环境下,需要配置代理,请在创建 Client 时传入 [profile.httpProfile.proxy](src/common/interface.ts#L78) 参数,或设置系统环境变量 `http_proxy` ,否则可能无法正常调用,抛出连接超时的异常。
157
159
 
158
160
  # 凭证管理
159
161
 
@@ -1 +1 @@
1
- export const sdkVersion = "4.1.122";
1
+ export const sdkVersion = "4.1.123";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "tencentcloud-sdk-nodejs",
3
- "version": "4.1.122",
3
+ "version": "4.1.123",
4
4
  "description": "腾讯云 API NODEJS SDK",
5
5
  "main": "./tencentcloud/index.js",
6
6
  "module": "./es/index.js",
@@ -1 +1 @@
1
- export declare const sdkVersion = "4.1.122";
1
+ export declare const sdkVersion = "4.1.123";
@@ -1,4 +1,4 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.sdkVersion = void 0;
4
- exports.sdkVersion = "4.1.122";
4
+ exports.sdkVersion = "4.1.123";
@@ -6768,11 +6768,11 @@ export interface RuleInfo {
6768
6768
  */
6769
6769
  export interface MonitorNoticeRule {
6770
6770
  /**
6771
- * 云监控通知模版ID
6771
+ * 腾讯云可观测平台通知模板 ID
6772
6772
  */
6773
6773
  NoticeId?: string;
6774
6774
  /**
6775
- * 云监控内容模版ID,不传默认内容模版
6775
+ * 腾讯云可观测平台内容模板ID,不传默认内容模板
6776
6776
  注意:此字段可能返回 null,表示取不到有效值。
6777
6777
  */
6778
6778
  ContentTmplId?: string;
@@ -6904,7 +6904,7 @@ export interface ModifyConfigResponse {
6904
6904
  */
6905
6905
  export interface ModifyNoticeContentRequest {
6906
6906
  /**
6907
- * 通知内容模板ID。-通过[获取通知内容模板](https://cloud.tencent.com/document/api/614/111714)获取通知内容模版ID
6907
+ * 通知内容模板ID。-通过[获取通知内容模板](https://cloud.tencent.com/document/api/614/111714)获取通知内容模板ID
6908
6908
  */
6909
6909
  NoticeContentId: string;
6910
6910
  /**
@@ -7332,12 +7332,12 @@ export interface SearchCosRechargeInfoResponse {
7332
7332
  - 0:成功
7333
7333
  - 10000:参数错误,请确认参数
7334
7334
  - 10001:授权失败,请确认授权
7335
- - 10002:获取文件列表失败,请稍后再试。若无法解决,请联系智能客服或提交工单
7335
+ - 10002:获取文件列表失败,请稍后再试。若无法解决,请咨询 [在线支持](https://cloud.tencent.com/online-service) 或 [提交工单](https://console.cloud.tencent.com/workorder/category?level1_id=83&level2_id=469&source=14&data_title=%E6%97%A5%E5%BF%97%E6%9C%8D%E5%8A%A1&step=1) 处理。
7336
7336
  - 10003:桶内无相应前缀文件,请使用正确的桶、文件前缀和压缩方式
7337
- - 10004:文件下载失败,请稍后再试。若无法解决,请联系智能客服或提交工单
7337
+ - 10004:文件下载失败,请稍后再试。若无法解决,请咨询 [在线支持](https://cloud.tencent.com/online-service) 或 [提交工单](https://console.cloud.tencent.com/workorder/category?level1_id=83&level2_id=469&source=14&data_title=%E6%97%A5%E5%BF%97%E6%9C%8D%E5%8A%A1&step=1) 处理。
7338
7338
  - 10005:文件解压缩失败,请选择正确的压缩方式然后再试
7339
7339
  - 10006:读取文件内容失败,请确认文件可读
7340
- - 10007:文件预览失败,请稍后再试。若无法解决,请联系智能客服或提交工单
7340
+ - 10007:文件预览失败,请稍后再试。若无法解决,请咨询 [在线支持](https://cloud.tencent.com/online-service) 或 [提交工单](https://console.cloud.tencent.com/workorder/category?level1_id=83&level2_id=469&source=14&data_title=%E6%97%A5%E5%BF%97%E6%9C%8D%E5%8A%A1&step=1) 处理。
7341
7341
  */
7342
7342
  Status?: number;
7343
7343
  /**
@@ -505,7 +505,7 @@ export interface NeedReviewApproverInfo {
505
505
  */
506
506
  ApproverName: string;
507
507
  /**
508
- * 签署方经办人手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。 请确认手机号所有方为此合同签署方。
508
+ * 签署方经办人手机号码, 支持中国大陆手机号11位数字(无需加+86前缀或其他字符)。 请确认手机号所有方为此合同签署方。
509
509
  */
510
510
  ApproverMobile?: string;
511
511
  /**
@@ -1789,7 +1789,7 @@ export interface FormField {
1789
1789
 
1790
1790
 
1791
1791
  <b>控件值约束说明</b>:
1792
- <table> <thead> <tr> <th>特殊控件</th> <th>填写约束</th> </tr> </thead> <tbody> <tr> <td>企业全称控件</td> <td>企业名称中文字符中文括号</td> </tr> <tr> <td>统一社会信用代码控件</td> <td>企业注册的统一社会信用代码</td> </tr> <tr> <td>法人名称控件</td> <td>最大50个字符,2到25个汉字或者1到50个字母</td> </tr> <tr> <td>签署意见控件</td> <td>签署意见最大长度为50字符</td> </tr> <tr> <td>签署人手机号控件</td> <td>国内手机号 13,14,15,16,17,18,19号段长度11位</td> </tr> <tr> <td>签署人身份证控件</td> <td>合法的身份证号码检查</td> </tr> <tr> <td>控件名称</td> <td>控件名称最大长度为20字符,不支持表情</td> </tr> <tr> <td>单行文本控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>多行文本控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>勾选框控件</td> <td>选择填字符串true,不选填字符串false</td> </tr> <tr> <td>选择器控件</td> <td>同单行文本控件约束,填写选择值中的字符串</td> </tr> <tr> <td>数字控件</td> <td>请输入有效的数字(可带小数点)</td> </tr> <tr> <td>日期控件</td> <td>格式:yyyy年mm月dd日</td> </tr> <tr> <td>附件控件</td> <td>JPG或PNG图片,上传数量限制,1到6个,最大6个附件,填写上传的资源ID</td> </tr> <tr> <td>图片控件</td> <td>JPG或PNG图片,填写上传的图片资源ID</td> </tr> <tr> <td>邮箱控件</td> <td>有效的邮箱地址, w3c标准</td> </tr> <tr> <td>地址控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>省市区控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>性别控件</td> <td>选择值中的字符串</td> </tr> <tr> <td>学历控件</td> <td>选择值中的字符串</td> </tr> </tbody> </table>
1792
+ <table> <thead> <tr> <th>特殊控件</th> <th>填写约束</th> </tr> </thead> <tbody> <tr> <td>企业全称控件</td> <td>企业名称中文字符中文括号</td> </tr> <tr> <td>统一社会信用代码控件</td> <td>企业注册的统一社会信用代码</td> </tr> <tr> <td>法人名称控件</td> <td>最大50个字符,2到25个汉字或者1到50个字母</td> </tr> <tr> <td>签署意见控件</td> <td>签署意见最大长度为50字符</td> </tr> <tr> <td>签署人手机号控件</td> <td>中国大陆手机号 13,14,15,16,17,18,19号段长度11位</td> </tr> <tr> <td>签署人身份证控件</td> <td>合法的身份证号码检查</td> </tr> <tr> <td>控件名称</td> <td>控件名称最大长度为20字符,不支持表情</td> </tr> <tr> <td>单行文本控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>多行文本控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>勾选框控件</td> <td>选择填字符串true,不选填字符串false</td> </tr> <tr> <td>选择器控件</td> <td>同单行文本控件约束,填写选择值中的字符串</td> </tr> <tr> <td>数字控件</td> <td>请输入有效的数字(可带小数点)</td> </tr> <tr> <td>日期控件</td> <td>格式:yyyy年mm月dd日</td> </tr> <tr> <td>附件控件</td> <td>JPG或PNG图片,上传数量限制,1到6个,最大6个附件,填写上传的资源ID</td> </tr> <tr> <td>图片控件</td> <td>JPG或PNG图片,填写上传的图片资源ID</td> </tr> <tr> <td>邮箱控件</td> <td>有效的邮箱地址, w3c标准</td> </tr> <tr> <td>地址控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>省市区控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>性别控件</td> <td>选择值中的字符串</td> </tr> <tr> <td>学历控件</td> <td>选择值中的字符串</td> </tr> </tbody> </table>
1793
1793
 
1794
1794
  */
1795
1795
  ComponentValue: string;
@@ -1843,7 +1843,7 @@ export interface Staff {
1843
1843
  */
1844
1844
  DisplayName?: string;
1845
1845
  /**
1846
- * 用户手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。
1846
+ * 用户手机号码, 支持中国大陆手机号11位数字(无需加+86前缀或其他字符)。
1847
1847
  */
1848
1848
  Mobile?: string;
1849
1849
  /**
@@ -2757,7 +2757,7 @@ export interface CreateOrganizationInfoChangeUrlRequest {
2757
2757
  */
2758
2758
  export interface CcInfo {
2759
2759
  /**
2760
- * 被抄送方手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。
2760
+ * 被抄送方手机号码, 支持中国大陆手机号11位数字(无需加+86前缀或其他字符)。
2761
2761
  请确认手机号所有方为此业务通知方。
2762
2762
  */
2763
2763
  Mobile?: string;
@@ -2889,9 +2889,7 @@ export interface CreateSchemeUrlRequest {
2889
2889
  */
2890
2890
  Name?: string;
2891
2891
  /**
2892
- * 合同流程里边签署方经办人手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符)
2893
-
2894
- `注:在动态签署人补充链接场景中,可以通过传入此值,对补充的个人参与方信息进行限制。仅匹配传入手机号的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。`
2892
+ * 合同流程里边签署方经办人手机号码, 支持中国大陆手机号11位数字(无需加+86前缀或其他字符)。`注:在动态签署人补充链接场景中,可以通过传入此值,对补充的个人参与方信息进行限制。仅匹配传入手机号的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。`
2895
2893
  */
2896
2894
  Mobile?: string;
2897
2895
  /**
@@ -3345,7 +3343,7 @@ export interface FlowCreateApprover {
3345
3343
  */
3346
3344
  ApproverName?: string;
3347
3345
  /**
3348
- * 签署方经办人手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。 此手机号用于通知和用户的实名认证等环境,请确认手机号所有方为此合同签署方。
3346
+ * 签署方经办人手机号码, 支持中国大陆手机号11位数字(无需加+86前缀或其他字符)。 此手机号用于通知和用户的实名认证等环境,请确认手机号所有方为此合同签署方。
3349
3347
 
3350
3348
  注:`在未指定签署人电子签UserId情况下,为必填参数`
3351
3349
 
@@ -3618,8 +3616,7 @@ export interface DescribeFlowTemplatesRequest {
3618
3616
  */
3619
3617
  ContentType?: number;
3620
3618
  /**
3621
- * 搜索过滤的条件,本字段允许您通过指定模板 ID 或模板名称来进行查询。
3622
- <ul><li><strong>模板 ID</strong>:<strong>Key</strong>设置为 <code>template-id</code> ,<strong>Values</strong>为您想要查询的 <a href="https://qcloudimg.tencent-cloud.cn/raw/5c27b917b2bbe8c341566c78ca6f8782.png" target="_blank">模板 ID </a>列表。</li> <li><strong>主企业模板 ID</strong>:<strong>Key</strong>设置为 <code>share-template-id</code> ,<strong>Values</strong>为您想要查询的 <a href="https://qcloudimg.tencent-cloud.cn/raw/5c27b917b2bbe8c341566c78ca6f8782.png" target="_blank">主企业模板 ID </a>列表。用来查询主企业分享模板到子企业场景下,子企业的模板信息,在此情境下,参数 <strong>Agent.ProxyOrganizationId</strong>(子企业的组织ID)为必填项。</li> <li><strong>模板名称</strong>:<strong>Key</strong>设置为 <code>template-name</code> ,<strong>Values</strong>为您想要查询的<a href="https://qcloudimg.tencent-cloud.cn/raw/03a924ee0a53d86575f8067d1c97876d.png" target="_blank">模板名称</a>列表。</li><li><strong>模板的用户合同类型</strong>:<strong>Key</strong>设置为 <code>user-flow-type-id</code> ,<strong>Values</strong>为您想要查询的用户模版类型id列表。</li></ul>
3619
+ * 搜索过滤的条件,本字段允许您通过指定模板 ID 或模板名称来进行查询。<ul><li><strong>模板 ID</strong>:<strong>Key</strong>设置为 <code>template-id</code> ,<strong>Values</strong>为您想要查询的 <a href="https://qcloudimg.tencent-cloud.cn/raw/5c27b917b2bbe8c341566c78ca6f8782.png" target="_blank">模板 ID </a>列表。</li> <li><strong>主企业模板 ID</strong>:<strong>Key</strong>设置为 <code>share-template-id</code> ,<strong>Values</strong>为您想要查询的 <a href="https://qcloudimg.tencent-cloud.cn/raw/5c27b917b2bbe8c341566c78ca6f8782.png" target="_blank">主企业模板 ID </a>列表。用来查询主企业分享模板到子企业场景下,子企业的模板信息,在此情境下,参数 <strong>Agent.ProxyOrganizationId</strong>(子企业的组织ID)为必填项。</li> <li><strong>模板名称</strong>:<strong>Key</strong>设置为 <code>template-name</code> ,<strong>Values</strong>为您想要查询的<a href="https://qcloudimg.tencent-cloud.cn/raw/03a924ee0a53d86575f8067d1c97876d.png" target="_blank">模板名称</a>列表。</li><li><strong>模板的用户合同类型</strong>:<strong>Key</strong>设置为 <code>user-flow-type-id</code> ,<strong>Values</strong>为您想要查询的用户模板类型id列表。</li></ul>
3623
3620
  */
3624
3621
  Filters?: Array<Filter>;
3625
3622
  /**
@@ -3688,7 +3685,7 @@ export interface DescribeFlowEvidenceReportResponse {
3688
3685
  RequestId?: string;
3689
3686
  }
3690
3687
  /**
3691
- * 批量认证企业任务详情信息,其中包括 TaskId,状态信息等等。
3688
+ * 批量认证企业任务详情信息,其中包括 TaskId,状态信息等。
3692
3689
  */
3693
3690
  export interface BatchOrganizationRegistrationTasksDetails {
3694
3691
  /**
@@ -4308,7 +4305,7 @@ export interface VerifyDigitFileResponse {
4308
4305
  */
4309
4306
  VerifyResult?: number;
4310
4307
  /**
4311
- * 验签序列号, 为11为数组组成的字符串
4308
+ * 验签序列号, 为11位数字组成的字符串
4312
4309
  */
4313
4310
  VerifySerialNo?: string;
4314
4311
  /**
@@ -4911,7 +4908,7 @@ export interface MiniAppCreateApproverInfo {
4911
4908
  */
4912
4909
  ApproverName?: string;
4913
4910
  /**
4914
- * 签署方经办人手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。 此手机号用于通知和用户的实名认证等环境,请确认手机号所有方为此合同签署方。
4911
+ * 签署方经办人手机号码, 支持中国大陆手机号11位数字(无需加+86前缀或其他字符)。 此手机号用于通知和用户的实名认证等环境,请确认手机号所有方为此合同签署方。
4915
4912
 
4916
4913
  注:`在未指定签署人电子签UserId情况下,为必填参数`
4917
4914
 
@@ -4998,13 +4995,7 @@ export interface CreateBatchSignUrlRequest {
4998
4995
  */
4999
4996
  Name?: string;
5000
4997
  /**
5001
- * 手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符)
5002
- 请确认手机号所有方为此业务通知方。
5003
-
5004
- 注:
5005
- <ul>
5006
- <li>请确保和合同中填入的一致, 若无法保持一致,请确保在发起和生成批量签署链接时传入相同的参与方证件信息。</li><li>在生成动态签署人补充链接场景中,可以通过传入此值,对补充的个人参与方信息进行限制。仅匹配传入手机号的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。 </li>
5007
- </ul>
4998
+ * 手机号码, 支持中国大陆手机号11位数字(无需加+86前缀或其他字符)。请确认手机号所有方为此业务通知方。注:<ul><li>请确保和合同中填入的一致, 若无法保持一致,请确保在发起和生成批量签署链接时传入相同的参与方证件信息。</li><li>在生成动态签署人补充链接场景中,可以通过传入此值,对补充的个人参与方信息进行限制。仅匹配传入手机号的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。 </li></ul>
5008
4999
  */
5009
5000
  Mobile?: string;
5010
5001
  /**
@@ -9135,7 +9126,7 @@ export interface Component {
9135
9126
 
9136
9127
 
9137
9128
  <b>控件值约束说明</b>:
9138
- <table> <thead> <tr> <th>特殊控件</th> <th>填写约束</th> </tr> </thead> <tbody> <tr> <td>企业全称控件</td> <td>企业名称中文字符中文括号</td> </tr> <tr> <td>统一社会信用代码控件</td> <td>企业注册的统一社会信用代码</td> </tr> <tr> <td>法人名称控件</td> <td>最大50个字符,2到25个汉字或者1到50个字母</td> </tr> <tr> <td>签署意见控件</td> <td>签署意见最大长度为50字符</td> </tr> <tr> <td>签署人手机号控件</td> <td>国内手机号 13,14,15,16,17,18,19号段长度11位</td> </tr> <tr> <td>签署人身份证控件</td> <td>合法的身份证号码检查</td> </tr> <tr> <td>控件名称</td> <td>控件名称最大长度为20字符,不支持表情</td> </tr> <tr> <td>单行文本控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>多行文本控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>勾选框控件</td> <td>选择填字符串true,不选填字符串false</td> </tr> <tr> <td>选择器控件</td> <td>同单行文本控件约束,填写选择值中的字符串</td> </tr> <tr> <td>数字控件</td> <td>请输入有效的数字(可带小数点)</td> </tr> <tr> <td>日期控件</td> <td>格式:yyyy年mm月dd日</td> </tr> <tr> <td>附件控件</td> <td>JPG或PNG图片,上传数量限制,1到6个,最大6个附件,填写上传的资源ID</td> </tr> <tr> <td>图片控件</td> <td>JPG或PNG图片,填写上传的图片资源ID</td> </tr> <tr> <td>邮箱控件</td> <td>有效的邮箱地址, w3c标准</td> </tr> <tr> <td>地址控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>省市区控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>性别控件</td> <td>选择值中的字符串</td> </tr> <tr> <td>学历控件</td> <td>选择值中的字符串</td> </tr> <tr> <td>水印控件</td> <td>水印控件设置为CUSTOM_WATERMARK类型时的水印内容</td> </tr> </tbody> </table>
9129
+ <table> <thead> <tr> <th>特殊控件</th> <th>填写约束</th> </tr> </thead> <tbody> <tr> <td>企业全称控件</td> <td>企业名称中文字符中文括号</td> </tr> <tr> <td>统一社会信用代码控件</td> <td>企业注册的统一社会信用代码</td> </tr> <tr> <td>法人名称控件</td> <td>最大50个字符,2到25个汉字或者1到50个字母</td> </tr> <tr> <td>签署意见控件</td> <td>签署意见最大长度为50字符</td> </tr> <tr> <td>签署人手机号控件</td> <td>中国大陆手机号 13,14,15,16,17,18,19号段长度11位</td> </tr> <tr> <td>签署人身份证控件</td> <td>合法的身份证号码检查</td> </tr> <tr> <td>控件名称</td> <td>控件名称最大长度为20字符,不支持表情</td> </tr> <tr> <td>单行文本控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>多行文本控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>勾选框控件</td> <td>选择填字符串true,不选填字符串false</td> </tr> <tr> <td>选择器控件</td> <td>同单行文本控件约束,填写选择值中的字符串</td> </tr> <tr> <td>数字控件</td> <td>请输入有效的数字(可带小数点)</td> </tr> <tr> <td>日期控件</td> <td>格式:yyyy年mm月dd日</td> </tr> <tr> <td>附件控件</td> <td>JPG或PNG图片,上传数量限制,1到6个,最大6个附件,填写上传的资源ID</td> </tr> <tr> <td>图片控件</td> <td>JPG或PNG图片,填写上传的图片资源ID</td> </tr> <tr> <td>邮箱控件</td> <td>有效的邮箱地址, w3c标准</td> </tr> <tr> <td>地址控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>省市区控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>性别控件</td> <td>选择值中的字符串</td> </tr> <tr> <td>学历控件</td> <td>选择值中的字符串</td> </tr> <tr> <td>水印控件</td> <td>水印控件设置为CUSTOM_WATERMARK类型时的水印内容</td> </tr> </tbody> </table>
9139
9130
  注: `部分特殊控件需要在控制台配置模板形式创建`
9140
9131
  */
9141
9132
  ComponentValue?: string;
@@ -10940,7 +10931,7 @@ export interface ApproverInfo {
10940
10931
  */
10941
10932
  ApproverName?: string;
10942
10933
  /**
10943
- * 签署方经办人手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。
10934
+ * 签署方经办人手机号码, 支持中国大陆手机号11位数字(无需加+86前缀或其他字符)。
10944
10935
  请确认手机号所有方为此合同签署方。
10945
10936
  */
10946
10937
  ApproverMobile?: string;
@@ -365,31 +365,31 @@ export interface FaceInfo {
365
365
  人脸框包含人脸五官位置并在此基础上进行一定的扩展,若人脸框超出图片范围,会导致坐标负值。
366
366
  若需截取完整人脸,可以在完整分completess满足需求的情况下,将负值坐标取0。
367
367
  */
368
- X: number;
368
+ X?: number;
369
369
  /**
370
370
  * 人脸框左上角纵坐标。
371
371
  人脸框包含人脸五官位置并在此基础上进行一定的扩展,若人脸框超出图片范围,会导致坐标负值。
372
372
  若需截取完整人脸,可以在完整分completess满足需求的情况下,将负值坐标取0。
373
373
  */
374
- Y: number;
374
+ Y?: number;
375
375
  /**
376
376
  * 人脸框宽度。
377
377
  */
378
- Width: number;
378
+ Width?: number;
379
379
  /**
380
380
  * 人脸框高度。
381
381
  */
382
- Height: number;
382
+ Height?: number;
383
383
  /**
384
384
  * 人脸属性信息,包含性别( gender )、年龄( age )、表情( expression )、
385
385
  魅力( beauty )、眼镜( glass )、口罩(mask)、头发(hair)和姿态 (pitch,roll,yaw )。只有当 NeedFaceAttributes 设为 1 时才返回有效信息。
386
386
  */
387
- FaceAttributesInfo: FaceAttributesInfo;
387
+ FaceAttributesInfo?: FaceAttributesInfo;
388
388
  /**
389
389
  * 人脸质量信息,包含质量分(score)、模糊分(sharpness)、光照分(brightness)、遮挡分(completeness)。只有当NeedFaceDetection设为1时才返回有效信息。
390
390
  注意:此字段可能返回 null,表示取不到有效值。
391
391
  */
392
- FaceQualityInfo: FaceQualityInfo;
392
+ FaceQualityInfo?: FaceQualityInfo;
393
393
  }
394
394
  /**
395
395
  * 眉毛信息
@@ -639,11 +639,11 @@ export interface GroupCandidate {
639
639
  /**
640
640
  * 人员库ID 。
641
641
  */
642
- GroupId: string;
642
+ GroupId?: string;
643
643
  /**
644
644
  * 识别出的最相似候选人。
645
645
  */
646
- Candidates: Array<Candidate>;
646
+ Candidates?: Array<Candidate>;
647
647
  }
648
648
  /**
649
649
  * DeleteFace返回参数结构体
@@ -840,32 +840,32 @@ export interface GroupInfo {
840
840
  /**
841
841
  * 人员库名称
842
842
  */
843
- GroupName: string;
843
+ GroupName?: string;
844
844
  /**
845
845
  * 人员库ID
846
846
  */
847
- GroupId: string;
847
+ GroupId?: string;
848
848
  /**
849
849
  * 人员库自定义描述字段
850
850
  注意:此字段可能返回 null,表示取不到有效值。
851
851
  */
852
- GroupExDescriptions: Array<string>;
852
+ GroupExDescriptions?: Array<string>;
853
853
  /**
854
854
  * 人员库信息备注
855
855
  注意:此字段可能返回 null,表示取不到有效值。
856
856
  */
857
- Tag: string;
857
+ Tag?: string;
858
858
  /**
859
859
  * 人脸识别所用的算法模型版本。
860
860
  注意:此字段可能返回 null,表示取不到有效值。
861
861
  */
862
- FaceModelVersion: string;
862
+ FaceModelVersion?: string;
863
863
  /**
864
864
  * Group的创建时间和日期 CreationTimestamp。CreationTimestamp 的值是自 Unix 纪元时间到Group创建时间的毫秒数。
865
865
  Unix 纪元时间是 1970 年 1 月 1 日星期四,协调世界时 (UTC) 00:00:00。有关更多信息,请参阅 Unix 时间。
866
866
  注意:此字段可能返回 null,表示取不到有效值。
867
867
  */
868
- CreationTimestamp: number;
868
+ CreationTimestamp?: number;
869
869
  }
870
870
  /**
871
871
  * 人脸质量信息,包含质量分(score)、模糊分(sharpness)、光照分(brightness)、遮挡分(completeness)。只有当NeedFaceDetection设为1时才返回有效信息。
@@ -878,26 +878,26 @@ export interface FaceQualityInfo {
878
878
  建议:人脸入库选取70以上的图片。
879
879
  注意:此字段可能返回 null,表示取不到有效值。
880
880
  */
881
- Score: number;
881
+ Score?: number;
882
882
  /**
883
883
  * 清晰分:[0,100],评价图片清晰程度,分数越高越清晰。
884
884
  参考范围:[0,40]特别模糊,[40,60]模糊,[60,80]一般,[80,100]清晰。
885
885
  建议:人脸入库选取80以上的图片。
886
886
  注意:此字段可能返回 null,表示取不到有效值。
887
887
  */
888
- Sharpness: number;
888
+ Sharpness?: number;
889
889
  /**
890
890
  * 光照分:[0,100],评价图片光照程度,分数越高越亮。
891
891
  参考范围: [0,30]偏暗,[30,70]光照正常,[70,100]偏亮。
892
892
  建议:人脸入库选取[30,70]的图片。
893
893
  注意:此字段可能返回 null,表示取不到有效值。
894
894
  */
895
- Brightness: number;
895
+ Brightness?: number;
896
896
  /**
897
897
  * 五官遮挡分,评价眉毛(Eyebrow)、眼睛(Eye)、鼻子(Nose)、脸颊(Cheek)、嘴巴(Mouth)、下巴(Chin)的被遮挡程度。
898
898
  注意:此字段可能返回 null,表示取不到有效值。
899
899
  */
900
- Completeness: FaceQualityCompleteness;
900
+ Completeness?: FaceQualityCompleteness;
901
901
  }
902
902
  /**
903
903
  * SearchFacesReturnsByGroup返回参数结构体
@@ -1412,37 +1412,37 @@ export interface FaceQualityCompleteness {
1412
1412
  参考范围:[0,80]表示发生遮挡。
1413
1413
  注意:此字段可能返回 null,表示取不到有效值。
1414
1414
  */
1415
- Eyebrow: number;
1415
+ Eyebrow?: number;
1416
1416
  /**
1417
1417
  * 眼睛的遮挡分数[0,100],分数越高遮挡越少。
1418
1418
  参考范围:[0,80]表示发生遮挡。
1419
1419
  注意:此字段可能返回 null,表示取不到有效值。
1420
1420
  */
1421
- Eye: number;
1421
+ Eye?: number;
1422
1422
  /**
1423
1423
  * 鼻子的遮挡分数[0,100],分数越高遮挡越少。
1424
1424
  参考范围:[0,60]表示发生遮挡。
1425
1425
  注意:此字段可能返回 null,表示取不到有效值。
1426
1426
  */
1427
- Nose: number;
1427
+ Nose?: number;
1428
1428
  /**
1429
1429
  * 脸颊的遮挡分数[0,100],分数越高遮挡越少。
1430
1430
  参考范围:[0,70]表示发生遮挡。
1431
1431
  注意:此字段可能返回 null,表示取不到有效值。
1432
1432
  */
1433
- Cheek: number;
1433
+ Cheek?: number;
1434
1434
  /**
1435
1435
  * 嘴巴的遮挡分数[0,100],分数越高遮挡越少。
1436
1436
  参考范围:[0,50]表示发生遮挡。
1437
1437
  注意:此字段可能返回 null,表示取不到有效值。
1438
1438
  */
1439
- Mouth: number;
1439
+ Mouth?: number;
1440
1440
  /**
1441
1441
  * 下巴的遮挡分数[0,100],分数越高遮挡越少。
1442
1442
  参考范围:[0,70]表示发生遮挡。
1443
1443
  注意:此字段可能返回 null,表示取不到有效值。
1444
1444
  */
1445
- Chin: number;
1445
+ Chin?: number;
1446
1446
  }
1447
1447
  /**
1448
1448
  * 人脸属性信息,包含性别( gender )、年龄( age )、表情( expression )、
@@ -3981,7 +3981,7 @@ export interface InvokeAISearchServiceRequest {
3981
3981
 
3982
3982
  注:
3983
3983
  1. 单位为毫秒(ms)
3984
- 2. 如果同时指定了StartTimeMs与EndTimeMs,时间区间不能大于7天;如果只指定其中一个(例如只指定StartTimeMs,则查询自StartTimeMs后7天内的数据, 反之EndTimeMs也一样)
3984
+ 2. 如果同时指定了StartTimeMs与EndTimeMs,时间区间不能大于7天;如果只指定其中一个(例如只指定StartTimeMs,则查询自StartTimeMs后1天内的数据, 反之EndTimeMs也一样)
3985
3985
  3. 只要指定了其中一个参数,接口则会忽略Query参数中关于时间的描述;(例如Query为"过去三天关于猫咪的视频", 则会将"过去三天忽略")
3986
3986
  */
3987
3987
  StartTimeMs?: number;
@@ -3990,7 +3990,7 @@ export interface InvokeAISearchServiceRequest {
3990
3990
 
3991
3991
  注:
3992
3992
  1. 单位为毫秒(ms)
3993
- 2. 如果同时指定了StartTimeMs与EndTimeMs,时间区间不能大于7天;如果只指定其中一个(例如只指定StartTimeMs,则查询自StartTimeMs后7天内的数据, 反之EndTimeMs也一样)
3993
+ 2. 如果同时指定了StartTimeMs与EndTimeMs,时间区间不能大于7天;如果只指定其中一个(例如只指定StartTimeMs,则查询自StartTimeMs后1天内的数据, 反之EndTimeMs也一样)
3994
3994
  3. 只要指定了其中一个参数,接口则会忽略Query参数中关于时间的描述;(例如Query为"过去三天关于猫咪的视频", 则会将"过去三天忽略")
3995
3995
  */
3996
3996
  EndTimeMs?: number;
@@ -3724,7 +3724,6 @@ export interface DescribeGroupListResponse {
3724
3724
  export interface ModifyRoomRequest {
3725
3725
  /**
3726
3726
  * 房间ID。
3727
- 字符数不超过256
3728
3727
  */
3729
3728
  RoomId: number;
3730
3729
  /**
@@ -3745,6 +3744,7 @@ export interface ModifyRoomRequest {
3745
3744
  TeacherId?: string;
3746
3745
  /**
3747
3746
  * 房间名称。
3747
+ 字符数不超过256
3748
3748
  */
3749
3749
  Name?: string;
3750
3750
  /**
@@ -24,7 +24,9 @@ export interface ChatCompletionsRequest {
24
24
  */
25
25
  Temperature?: number;
26
26
  /**
27
- * 最大生成的token数量,默认为4096,最大可设置为16384
27
+ * 模型最大输出长度(单位 token),不包含思维链内容。
28
+ 默认为4096,取值范围:各个模型不同,参考各个模型最大输出长度(示例:4k,即4096)。
29
+ 输出 token 的总长度受模型的上下文长度限制。
28
30
  */
29
31
  MaxTokens?: number;
30
32
  /**
@@ -202,8 +204,7 @@ export interface DocItem {
202
204
  */
203
205
  export interface GetEmbeddingRequest {
204
206
  /**
205
- * 说明:选择生成向量的模型
206
- 备注:仅一个模型可选
207
+ * 说明:选择生成向量的模型备注:可选[lke-text-embedding-v1,lke-text-embedding-v2]
207
208
  */
208
209
  Model: string;
209
210
  /**
@@ -495,25 +496,36 @@ export interface CreateQAResponse {
495
496
  */
496
497
  export interface ModifyAttributeLabelRequest {
497
498
  /**
498
- * 知识库ID
499
+ * 说明:知识库ID
500
+ 备注:通过创建知识库接口(DeleteKnowledgeBase)得到知识库ID(KnowledgeBaseId)
499
501
  */
500
502
  KnowledgeBaseId: string;
501
503
  /**
502
- * 属性ID
504
+ * 说明:属性ID
505
+ 备注:通过CreateAttributeLabel接口创建属性时会生成AttributeId,通过ListAttributeLabels接口可查询得到AttributeId、AttributeKey、AttributeName以及LabelId、LabelName的对应关系
503
506
  */
504
507
  AttributeId: string;
505
508
  /**
506
- * 属性标识,最大40个英文字符,如style
509
+ * 说明:属性标识,
510
+ 备注:仅支持英文字符,不支持数字,支持下划线。最大支持40个英文字符,如style
507
511
  */
508
512
  AttributeKey: string;
509
513
  /**
510
- * 属性名称,最大80个英文字符,如风格
514
+ * 说明:属性名称
515
+ 备注:支持中英文字符。最大支持80个中英文字符,如风格
511
516
  */
512
517
  AttributeName: string;
513
518
  /**
514
- * 属性标签
519
+ * 说明:标签ID(LabelId)以及标签名(LabelName)
520
+ 备注:
521
+ - 不填写LabelId,默认在当前AttributeId下新增标签值(LabelName);
522
+ - 若填写该AttributeId下的LabelId以及LabelName,则为修改该LabelId对应的标签值
515
523
  */
516
524
  Labels?: Array<AttributeLabelItem>;
525
+ /**
526
+ * 说明:删除的标签id
527
+ */
528
+ DeleteLabelIds?: Array<string>;
517
529
  }
518
530
  /**
519
531
  * GetReconstructDocumentResult返回参数结构体
@@ -766,8 +778,10 @@ export interface CreateReconstructDocumentFlowConfig {
766
778
  1:只返回每一页的OCR原始Json;
767
779
  2:只返回每一页的MD,
768
780
  3:返回全文MD + 每一页的OCR原始Json;
769
- 4:返回全文MD + 每一页的MD
781
+ 4:返回全文MD + 每一页的MD
782
+ 5: 返回全文md,每一页ocr原始json,每一页md
770
783
  默认值为0
784
+
771
785
  */
772
786
  ResultType?: string;
773
787
  /**
@@ -1324,10 +1338,10 @@ export interface CreateSplitDocumentFlowConfig {
1324
1338
  * 智能文档解析返回结果的格式
1325
1339
  0:只返回全文MD;
1326
1340
  1:只返回每一页的OCR原始Json;
1327
- 2:只返回每一页的MD
1341
+ 2:只返回每一页的MD
1328
1342
  3:返回全文MD + 每一页的OCR原始Json;
1329
- 4:返回全文MD + 每一页的MD
1330
- 默认值为3(返回全文MD + 每一页的OCR原始Json)
1343
+ 4:返回全文MD + 每一页的MD
1344
+ 5:返回全文md,每一页ocr原始json,每一页md。
1331
1345
 
1332
1346
 
1333
1347
  * @deprecated
@@ -1345,6 +1359,25 @@ export interface CreateSplitDocumentFlowConfig {
1345
1359
  * 是否忽略返回失败页码
1346
1360
  */
1347
1361
  IgnoreFailedPage?: boolean;
1362
+ /**
1363
+ * 智能文档解析返回结果的格式
1364
+ 0:只返回全文MD;
1365
+ 1:只返回每一页的OCR原始Json;
1366
+ 2:只返回每一页的MD;
1367
+ 3:返回全文MD + 每一页的OCR原始Json;
1368
+ 4:返回全文MD + 每一页的MD;
1369
+ 5:返回全文md,每一页ocr原始json,每一页md。
1370
+
1371
+
1372
+ */
1373
+ SplitResultType?: string;
1374
+ /**
1375
+ * Markdown文件中表格返回的形式
1376
+ 0,表格以MD形式返回
1377
+ 1,表格以HTML形式返回
1378
+ 默认为
1379
+ */
1380
+ SplitTableResultType?: string;
1348
1381
  }
1349
1382
  /**
1350
1383
  * RunRerank返回参数结构体
@@ -1050,6 +1050,10 @@ export interface TranslationConfig {
1050
1050
  * 语音同传配置,开启同传时,需要传递
1051
1051
  */
1052
1052
  TTSConfig?: TTSConfig;
1053
+ /**
1054
+ * 翻译术语集合
1055
+ */
1056
+ Terminology?: Array<Terminology>;
1053
1057
  }
1054
1058
  /**
1055
1059
  * Mcu转推录制,腾讯云点播相关参数。
@@ -3882,6 +3886,19 @@ export interface ModifyCloudModerationResponse {
3882
3886
  */
3883
3887
  RequestId?: string;
3884
3888
  }
3889
+ /**
3890
+ * 翻译术语
3891
+ */
3892
+ export interface Terminology {
3893
+ /**
3894
+ * 源术语
3895
+ */
3896
+ Source: string;
3897
+ /**
3898
+ * 目标术语翻译结果
3899
+ */
3900
+ Target: string;
3901
+ }
3885
3902
  /**
3886
3903
  * TRTC数据大盘/实时监控 API接口数据出参
3887
3904
  */
@@ -15159,7 +15159,7 @@ export interface DescribeGroupsRequest {
15159
15159
  */
15160
15160
  Status?: string;
15161
15161
  /**
15162
- *
15162
+ * 部署组ID列表
15163
15163
  */
15164
15164
  GroupIdList?: Array<string>;
15165
15165
  }
@@ -11413,31 +11413,21 @@ export interface AddSpartaProtectionRequest {
11413
11413
  */
11414
11414
  InstanceID: string;
11415
11415
  /**
11416
- * 必填项,是否开启HTTP强制跳转到HTTPS。
11417
- 0:不强制跳转
11418
- 1:开启强制跳转
11416
+ * 是否开启HTTP强制跳转到HTTPS。0:不强制跳转1:开启强制跳转
11419
11417
  */
11420
- HttpsRewrite: number;
11418
+ HttpsRewrite?: number;
11421
11419
  /**
11422
- * 必填项,是否开启HTTP2,需要开启HTTPS协议支持。
11423
- 0:关闭
11424
- 1:开启
11420
+ * 是否开启HTTP2,需要开启HTTPS协议支持。0:关闭1:开启
11425
11421
  */
11426
- IsHttp2: number;
11422
+ IsHttp2?: number;
11427
11423
  /**
11428
- * 必填项,是否开启主动健康检测。
11429
- 0:不开启
11430
- 1:开启
11424
+ * 是否开启主动健康检测。0:不开启1:开启
11431
11425
  */
11432
- ActiveCheck: number;
11426
+ ActiveCheck?: number;
11433
11427
  /**
11434
- * 必填项,加密套件模板。
11435
- 0:不支持选择,使用默认模板
11436
- 1:通用型模板
11437
- 2:安全型模板
11438
- 3:自定义模板
11428
+ * 加密套件模板。0:不支持选择,使用默认模板 1:通用型模板 2:安全型模板3:自定义模板
11439
11429
  */
11440
- CipherTemplate: number;
11430
+ CipherTemplate?: number;
11441
11431
  /**
11442
11432
  * CertType为1时,需要填充此参数,表示自有证书的证书链
11443
11433
  */