tencentcloud-sdk-nodejs 4.0.442 → 4.0.443

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 (67) hide show
  1. package/CHANGELOG.md +246 -0
  2. package/SERVICE_CHANGELOG.md +332 -59
  3. package/package.json +1 -1
  4. package/products.md +15 -15
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/cat/v20180409/cat_models.ts +1 -1
  7. package/src/services/cdn/v20180606/cdn_models.ts +0 -1
  8. package/src/services/cvm/v20170312/cvm_models.ts +5 -0
  9. package/src/services/cwp/v20180228/cwp_models.ts +1 -1
  10. package/src/services/dnspod/v20210323/dnspod_client.ts +14 -1
  11. package/src/services/dnspod/v20210323/dnspod_models.ts +57 -12
  12. package/src/services/es/v20180416/es_models.ts +16 -0
  13. package/src/services/ess/v20201111/ess_client.ts +1 -0
  14. package/src/services/ess/v20201111/ess_models.ts +33 -7
  15. package/src/services/essbasic/v20210526/essbasic_client.ts +8 -4
  16. package/src/services/essbasic/v20210526/essbasic_models.ts +6 -7
  17. package/src/services/live/v20180801/live_client.ts +31 -19
  18. package/src/services/live/v20180801/live_models.ts +107 -49
  19. package/src/services/redis/v20180412/redis_client.ts +1 -1
  20. package/src/services/redis/v20180412/redis_models.ts +6 -6
  21. package/src/services/tiia/v20190529/tiia_client.ts +8 -8
  22. package/src/services/tiia/v20190529/tiia_models.ts +65 -50
  23. package/src/services/vm/v20210922/vm_models.ts +14 -7
  24. package/src/services/vod/v20180717/vod_client.ts +20 -1
  25. package/src/services/vod/v20180717/vod_models.ts +394 -51
  26. package/src/services/vpc/v20170312/vpc_client.ts +13 -0
  27. package/src/services/vpc/v20170312/vpc_models.ts +81 -0
  28. package/src/services/yinsuda/v20220527/yinsuda_client.ts +30 -3
  29. package/src/services/yinsuda/v20220527/yinsuda_models.ts +163 -16
  30. package/tencentcloud/common/sdk_version.d.ts +1 -1
  31. package/tencentcloud/common/sdk_version.js +1 -1
  32. package/tencentcloud/services/cat/v20180409/cat_models.d.ts +1 -1
  33. package/tencentcloud/services/cdn/v20180606/cdn_models.d.ts +0 -1
  34. package/tencentcloud/services/cvm/v20170312/cvm_models.d.ts +4 -0
  35. package/tencentcloud/services/cwp/v20180228/cwp_models.d.ts +1 -1
  36. package/tencentcloud/services/dnspod/v20210323/dnspod_client.d.ts +5 -1
  37. package/tencentcloud/services/dnspod/v20210323/dnspod_client.js +6 -0
  38. package/tencentcloud/services/dnspod/v20210323/dnspod_models.d.ts +49 -11
  39. package/tencentcloud/services/es/v20180416/es_models.d.ts +13 -0
  40. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +29 -6
  41. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +7 -3
  42. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +7 -3
  43. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +5 -6
  44. package/tencentcloud/services/live/v20180801/live_client.d.ts +11 -7
  45. package/tencentcloud/services/live/v20180801/live_client.js +14 -8
  46. package/tencentcloud/services/live/v20180801/live_models.d.ts +96 -45
  47. package/tencentcloud/services/redis/v20180412/redis_client.d.ts +1 -1
  48. package/tencentcloud/services/redis/v20180412/redis_client.js +1 -1
  49. package/tencentcloud/services/redis/v20180412/redis_models.d.ts +6 -6
  50. package/tencentcloud/services/tiia/v20190529/tiia_client.d.ts +8 -8
  51. package/tencentcloud/services/tiia/v20190529/tiia_client.js +8 -8
  52. package/tencentcloud/services/tiia/v20190529/tiia_models.d.ts +62 -47
  53. package/tencentcloud/services/vm/v20210922/vm_models.d.ts +13 -7
  54. package/tencentcloud/services/vod/v20180717/vod_client.d.ts +5 -1
  55. package/tencentcloud/services/vod/v20180717/vod_client.js +6 -0
  56. package/tencentcloud/services/vod/v20180717/vod_models.d.ts +334 -45
  57. package/tencentcloud/services/vpc/v20170312/vpc_client.d.ts +5 -1
  58. package/tencentcloud/services/vpc/v20170312/vpc_client.js +6 -0
  59. package/tencentcloud/services/vpc/v20170312/vpc_models.d.ts +68 -0
  60. package/tencentcloud/services/yinsuda/v20220527/yinsuda_client.d.ts +9 -1
  61. package/tencentcloud/services/yinsuda/v20220527/yinsuda_client.js +12 -0
  62. package/tencentcloud/services/yinsuda/v20220527/yinsuda_models.d.ts +142 -16
  63. package/test/dnspod.v20210323.test.js +10 -0
  64. package/test/live.v20180801.test.js +14 -4
  65. package/test/vod.v20180717.test.js +10 -0
  66. package/test/vpc.v20170312.test.js +10 -0
  67. package/test/yinsuda.v20220527.test.js +20 -0
@@ -308,18 +308,52 @@ export interface ResumeDelayLiveStreamRequest {
308
308
  }
309
309
 
310
310
  /**
311
- * DescribeLiveWatermarkRules返回参数结构体
311
+ * DescribeLiveStreamPublishedList请求参数结构体
312
312
  */
313
- export interface DescribeLiveWatermarkRulesResponse {
313
+ export interface DescribeLiveStreamPublishedListRequest {
314
314
  /**
315
- * 水印规则列表。
315
+ * 您的推流域名。
316
316
  */
317
- Rules: Array<RuleInfo>
317
+ DomainName: string
318
318
 
319
319
  /**
320
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
320
+ * 结束时间。
321
+ UTC 格式,例如:2016-06-30T19:00:00Z。
322
+ 不超过当前时间。
323
+ 注意:EndTime和StartTime相差不可超过30天。
324
+ */
325
+ EndTime: string
326
+
327
+ /**
328
+ * 起始时间。
329
+ UTC 格式,例如:2016-06-29T19:00:00Z。
330
+ 最长支持查询60天内数据。
331
+ */
332
+ StartTime: string
333
+
334
+ /**
335
+ * 推流路径,与推流和播放地址中的 AppName 保持一致,默认为 live。不支持模糊匹配。
321
336
  */
322
- RequestId?: string
337
+ AppName?: string
338
+
339
+ /**
340
+ * 取得第几页。
341
+ 默认值:1。
342
+ */
343
+ PageNum?: number
344
+
345
+ /**
346
+ * 分页大小。
347
+ 最大值:100。
348
+ 取值范围:10~100 之前的任意整数。
349
+ 默认值:10。
350
+ */
351
+ PageSize?: number
352
+
353
+ /**
354
+ * 流名称,支持模糊匹配。
355
+ */
356
+ StreamName?: string
323
357
  }
324
358
 
325
359
  /**
@@ -1483,52 +1517,33 @@ export interface DescribeLiveDomainRequest {
1483
1517
  }
1484
1518
 
1485
1519
  /**
1486
- * DescribeLiveStreamPublishedList请求参数结构体
1520
+ * AuthenticateDomainOwner返回参数结构体
1487
1521
  */
1488
- export interface DescribeLiveStreamPublishedListRequest {
1489
- /**
1490
- * 您的推流域名。
1491
- */
1492
- DomainName: string
1493
-
1522
+ export interface AuthenticateDomainOwnerResponse {
1494
1523
  /**
1495
- * 结束时间。
1496
- UTC 格式,例如:2016-06-30T19:00:00Z。
1497
- 不超过当前时间。
1498
- 注意:EndTime和StartTime相差不可超过30天。
1524
+ * 验证内容。
1525
+ VerifyType 传 dnsCheck 时,为要配的 TXT 记录值。
1526
+ VerifyType 传 fileCheck 时,为文件内容。
1499
1527
  */
1500
- EndTime: string
1528
+ Content: string
1501
1529
 
1502
1530
  /**
1503
- * 起始时间。
1504
- UTC 格式,例如:2016-06-29T19:00:00Z。
1505
- 最长支持查询60天内数据。
1531
+ * 域名验证状态。
1532
+ >=0 为已验证归属。
1533
+ <0 未验证归属权。
1506
1534
  */
1507
- StartTime: string
1508
-
1509
- /**
1510
- * 推流路径,与推流和播放地址中的 AppName 保持一致,默认为 live。不支持模糊匹配。
1511
- */
1512
- AppName?: string
1513
-
1514
- /**
1515
- * 取得第几页。
1516
- 默认值:1。
1517
- */
1518
- PageNum?: number
1535
+ Status: number
1519
1536
 
1520
1537
  /**
1521
- * 分页大小。
1522
- 最大值:100。
1523
- 取值范围:10~100 之前的任意整数。
1524
- 默认值:10。
1538
+ * DomainName 对应的主域名。
1539
+ 同一主域名下的所有域名只需成功验证一次,后续均无需再验证。
1525
1540
  */
1526
- PageSize?: number
1541
+ MainDomain: string
1527
1542
 
1528
1543
  /**
1529
- * 流名称,支持模糊匹配。
1544
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1530
1545
  */
1531
- StreamName?: string
1546
+ RequestId?: string
1532
1547
  }
1533
1548
 
1534
1549
  /**
@@ -3081,18 +3096,13 @@ export interface WatermarkInfo {
3081
3096
  }
3082
3097
 
3083
3098
  /**
3084
- * DescribeProvinceIspPlayInfoList返回参数结构体
3099
+ * DescribeLiveWatermarkRules返回参数结构体
3085
3100
  */
3086
- export interface DescribeProvinceIspPlayInfoListResponse {
3087
- /**
3088
- * 播放信息列表。
3089
- */
3090
- DataInfoList: Array<PlayStatInfo>
3091
-
3101
+ export interface DescribeLiveWatermarkRulesResponse {
3092
3102
  /**
3093
- * 统计的类型,和输入参数保持一致。
3103
+ * 水印规则列表。
3094
3104
  */
3095
- StatType: string
3105
+ Rules: Array<RuleInfo>
3096
3106
 
3097
3107
  /**
3098
3108
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
@@ -3636,6 +3646,26 @@ URL中禁止包含的字符:
3636
3646
  Location: number
3637
3647
  }
3638
3648
 
3649
+ /**
3650
+ * DescribeProvinceIspPlayInfoList返回参数结构体
3651
+ */
3652
+ export interface DescribeProvinceIspPlayInfoListResponse {
3653
+ /**
3654
+ * 播放信息列表。
3655
+ */
3656
+ DataInfoList: Array<PlayStatInfo>
3657
+
3658
+ /**
3659
+ * 统计的类型,和输入参数保持一致。
3660
+ */
3661
+ StatType: string
3662
+
3663
+ /**
3664
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
3665
+ */
3666
+ RequestId?: string
3667
+ }
3668
+
3639
3669
  /**
3640
3670
  * CreateCommonMixStream请求参数结构体
3641
3671
  */
@@ -4083,6 +4113,16 @@ export interface AddLiveDomainRequest {
4083
4113
  默认值: 0。
4084
4114
  */
4085
4115
  IsMiniProgramLive?: number
4116
+
4117
+ /**
4118
+ * 域名归属校验类型。
4119
+ 可取值(与 AuthenticateDomainOwner 接口的 VerifyType 参数一致。):
4120
+ dnsCheck :立即验证配置 dns 的解析记录是否与待验证内容一致,成功则保存记录。
4121
+ fileCheck :立即验证 web 文件是否与待验证内容一致,成功则保存记录。
4122
+ dbCheck : 检查是否已经验证成功过。
4123
+ 若不传默认为 dbCheck 。
4124
+ */
4125
+ VerifyOwnerType?: string
4086
4126
  }
4087
4127
 
4088
4128
  /**
@@ -4504,6 +4544,24 @@ export interface DeleteLivePullStreamTaskResponse {
4504
4544
  RequestId?: string
4505
4545
  }
4506
4546
 
4547
+ /**
4548
+ * AuthenticateDomainOwner请求参数结构体
4549
+ */
4550
+ export interface AuthenticateDomainOwnerRequest {
4551
+ /**
4552
+ * 要验证的域名。
4553
+ */
4554
+ DomainName: string
4555
+
4556
+ /**
4557
+ * 验证类型。可取值:
4558
+ dnsCheck :立即验证配置 dns 的解析记录是否与待验证内容一致,成功则保存记录。
4559
+ fileCheck :立即验证 web 文件是否与待验证内容一致,成功则保存记录。
4560
+ dbCheck : 检查是否已经验证成功过。
4561
+ */
4562
+ VerifyType: string
4563
+ }
4564
+
4507
4565
  /**
4508
4566
  * DescribeLiveForbidStreamList返回参数结构体
4509
4567
  */
@@ -726,7 +726,7 @@ export class Client extends AbstractClient {
726
726
  }
727
727
 
728
728
  /**
729
- * 本接口(ModifyInstanceParams)用于修改实例参数。
729
+ * 本接口(ModifyInstanceParams)用于修改Redis实例的参数配置。
730
730
  */
731
731
  async ModifyInstanceParams(
732
732
  req: ModifyInstanceParamsRequest,
@@ -45,12 +45,12 @@ export interface UpgradeSmallVersionRequest {
45
45
  */
46
46
  export interface ModifyInstanceParamsResponse {
47
47
  /**
48
- * 修改是否成功。
48
+ * 修改是否成功。修改成功为true,失败为false。
49
49
  */
50
50
  Changed: boolean
51
51
 
52
52
  /**
53
- * 任务ID
53
+ * 任务ID
54
54
  */
55
55
  TaskId: number
56
56
 
@@ -4424,12 +4424,12 @@ export interface UpgradeSmallVersionResponse {
4424
4424
  */
4425
4425
  export interface ModifyInstanceParamsRequest {
4426
4426
  /**
4427
- * 实例ID
4427
+ * 实例ID
4428
4428
  */
4429
4429
  InstanceId: string
4430
4430
 
4431
4431
  /**
4432
- * 实例修改的参数列表
4432
+ * 实例修改的参数列表。
4433
4433
  */
4434
4434
  InstanceParams: Array<InstanceParam>
4435
4435
  }
@@ -5457,12 +5457,12 @@ export interface DescribeInstanceMonitorHotKeyResponse {
5457
5457
  */
5458
5458
  export interface InstanceParam {
5459
5459
  /**
5460
- * 设置参数的名字
5460
+ * 设置参数的名称。例如timeout。
5461
5461
  */
5462
5462
  Key: string
5463
5463
 
5464
5464
  /**
5465
- * 设置参数的值
5465
+ * 设置参数名称对应的运行值。例如timeout对应运行值可设置为120, 单位为秒(s)。指当客户端连接闲置时间达到120 s时,将关闭连接。
5466
5466
  */
5467
5467
  Value: string
5468
5468
  }
@@ -86,7 +86,7 @@ export class Client extends AbstractClient {
86
86
  }
87
87
 
88
88
  /**
89
- * 创建图片,并添加对应图片的自定义信息。
89
+ * 创建图片,并添加对应图片的自定义信息。模型将在创建图片时自动提取图像特征并存储到指定的图片库中。
90
90
  */
91
91
  async CreateImage(
92
92
  req: CreateImageRequest,
@@ -232,7 +232,7 @@ export class Client extends AbstractClient {
232
232
  }
233
233
 
234
234
  /**
235
- * 本接口用于对一张待识别的商品图片,在指定图片库中检索出最相似的图片列表。
235
+ * 本接口用于对一张图片,在指定图片库中检索出与之相似的图片列表。
236
236
  */
237
237
  async SearchImage(
238
238
  req: SearchImageRequest,
@@ -264,13 +264,13 @@ export class Client extends AbstractClient {
264
264
  }
265
265
 
266
266
  /**
267
- * 用于创建一个空的图片库,如果图片库已存在则返回错误。不同类型图库对应不同的图像搜索服务,根据输入参数GroupType区分。
267
+ * 本接口用于创建一个空的图片库,图片库主要用于存储在创建图片时提取的图片特征数据,如果图片库已存在则返回错误。不同的图片库类型对应不同的图像搜索服务类型,根据输入参数GroupType区分。
268
268
 
269
- | 服务类型 | GroupType参数值 |功能描述 |
270
- | :------ | :----- |:----------------- |
271
- | 相同图像搜索<img width=30/> | 4 |在自建图库中搜索相同原图,可支持裁剪、翻转、调色、加水印后的图片搜索,适用于图片版权保护、原图查询等场景。|
272
- | 商品图像搜索<img width=30/> | 5 |在自建图库中搜索相同或相似的商品图片,适用于商品分类、检索、推荐等电商场景。|
273
- | 相似图像搜索<img width=30/> | 6 |在自建图片库中搜索与输入图片高度相似的图片,适用于相似图案、logo、纹理等图像元素的搜索。|
269
+ | 服务类型 | GroupType入参 |功能描述 |
270
+ | :---------- | :----- |:----------------- |
271
+ | 相同图像搜索<div style="width: 70pt"> | 4 |在自建图片库中搜索相同原图或高相似图,并给出相似度打分,可支持裁剪、翻转、调色、加水印等二次编辑后的图片搜索。适用于图片版权保护、原图查询等场景。|
272
+ | 商品图像搜索<div style="width: 70pt"> | 5 |在自建图库中搜索同款商品,并给出相似度打分。对于服饰类商品可支持识别服饰类别、属性等信息。适用于商品分类、检索、推荐等电商场景。|
273
+ | 相似图像搜索<div style="width: 70pt"> | 6 |在自建图库中搜索相似的图案、logo、纹理等图像元素或主体,并给出相似度打分。|
274
274
 
275
275
  */
276
276
  async CreateGroup(
@@ -85,7 +85,7 @@ export interface SearchImageResponse {
85
85
  /**
86
86
  * 输入图的主体信息。
87
87
  若启用主体识别且在请求中指定了类目ID或主体区域,以指定的主体为准。若启用主体识别且没有指定,以最大面积主体为准。
88
- 注意:此字段可能返回 null,表示取不到有效值。服务类型为商品图像搜索时生效。
88
+ **<font color=#1E90FF>注意:仅服务类型为商品图像搜索时才生效。</font>**
89
89
  注意:此字段可能返回 null,表示取不到有效值。
90
90
  */
91
91
  Object: ObjectInfo
@@ -131,37 +131,39 @@ export interface CreateImageRequest {
131
131
 
132
132
  /**
133
133
  * 物品ID,最多支持64个字符。
134
- EntityId已存在,则对其追加图片。
134
+ 一个物品ID可以包含多张图片,若EntityId已存在,则对其追加图片。同一个EntityId,最大支持10张图。
135
135
  */
136
136
  EntityId: string
137
137
 
138
138
  /**
139
139
  * 图片名称,最多支持64个字符,
140
- 同一个EntityId,最大支持10张图。
140
+ PicName唯一确定一张图片,具有唯一性。
141
141
  */
142
142
  PicName: string
143
143
 
144
144
  /**
145
145
  * 图片的 Url 。对应图片 base64 编码后大小不可超过5M。
146
- Url、Image必须提供一个,如果都提供,只使用 Url
147
- 图片分辨率不超过4096\*4096。
148
- 图片存储于腾讯云的Url可保障更高下载速度和稳定性,建议图片存储于腾讯云。
149
- 非腾讯云存储的Url速度和稳定性可能受一定影响。
150
- 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
151
- 注意:开启主体识别分辨率不超过2000\*2000,图片长宽比小于10(长/短 < 10)。
146
+ ImageUrl和ImageBase64必须提供一个,如果都提供,只使用ImageUrl
147
+ 图片限制:
148
+ 图片格式:支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
149
+ 图片大小:对应图片 base64 编码后大小不可超过5M。图片分辨率不超过4096\*4096。
150
+ 如果在商品图像搜索中开启主体识别,分辨率不超过2000\*2000,图片长宽比小于10。
151
+ 建议:
152
+ • 图片存储于腾讯云的Url可保障更高下载速度和稳定性,建议图片存储于腾讯云。非腾讯云存储的Url速度和稳定性可能受一定影响。
152
153
  */
153
154
  ImageUrl?: string
154
155
 
155
156
  /**
156
- * 用户自定义的内容,最多支持4096个字符,查询时原样带回。
157
+ * 图片自定义备注内容,最多支持4096个字符,查询时原样带回。
157
158
  */
158
159
  CustomContent?: string
159
160
 
160
161
  /**
161
162
  * 图片 base64 数据,base64 编码后大小不可超过5M。
162
- 图片分辨率不超过4096\*4096。
163
- 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
164
- 注意:开启主体识别分辨率不超过2000\*2000,图片长宽比小于10(长/短 < 10)。
163
+ 图片限制:
164
+ • 图片格式:支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
165
+ 图片大小:base64 编码后大小不可超过5M。图片分辨率不超过4096\*4096。
166
+ • 如果在商品图像搜索中开启主体识别,分辨率不超过2000\*2000,图片长宽比小于10。
165
167
  */
166
168
  ImageBase64?: string
167
169
 
@@ -172,23 +174,23 @@ Url、Image必须提供一个,如果都提供,只使用 Url。
172
174
 
173
175
  /**
174
176
  * 是否需要启用主体识别,默认为**TRUE**。
175
- 1. 为**TRUE**时,启用主体识别,返回主体信息。若没有指定**ImageRect**,自动提取最大面积主体创建图片并进行主体识别。主体识别结果可在**Response**中获取。
176
- 2. 为**FALSE**时,不启用主体识别,不返回主体信息。若没有指定**ImageRect**,以整张图创建图片。
177
- 注意:服务类型为商品图像搜索时生效。
177
+ 为**TRUE**时,启用主体识别,返回主体信息。若没有指定**ImageRect**,自动提取最大面积主体创建图片并进行主体识别。主体识别结果可在**Response**中获取。
178
+ 为**FALSE**时,不启用主体识别,不返回主体信息。若没有指定**ImageRect**,以整张图创建图片。
179
+ **<font color=#1E90FF>注意:仅服务类型为商品图像搜索时才生效。</font>**
178
180
  */
179
181
  EnableDetect?: boolean
180
182
 
181
183
  /**
182
184
  * 图像类目ID。
183
- 若设置类目ID,提取对应类目的主体创建图片。
184
- 注意:服务类型为商品图像搜索时生效。
185
- 类目信息:
185
+ 若设置类目ID,提取以下类目的主体创建图片。
186
+ 类目取值说明:
186
187
  0:上衣。
187
188
  1:裙装。
188
189
  2:下装。
189
190
  3:包。
190
191
  4:鞋。
191
192
  5:配饰。
193
+ **<font color=#1E90FF>注意:仅服务类型为商品图像搜索时才生效。</font>**
192
194
  */
193
195
  CategoryId?: number
194
196
 
@@ -510,42 +512,55 @@ export interface SearchImageRequest {
510
512
  GroupId: string
511
513
 
512
514
  /**
513
- * 图片的 Url 。对应图片 base64 编码后大小不可超过5M
514
- 图片分辨率不超4096\*4096
515
- Url、Image必须提供一个,如果都提供,只使用 Url。
516
- 图片存储于腾讯云的Url可保障更高下载速度和稳定性,建议图片存储于腾讯云。
517
- 非腾讯云存储的Url速度和稳定性可能受一定影响。
518
- 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
519
- 注意:开启主体识别分辨率不超过2000\*2000,图片长宽比小于10(长/短 < 10)。
515
+ * 图片的 Url 。
516
+ ImageUrl和ImageBase64必须提供一个,如果都提供,只使用ImageUrl
517
+ 图片限制:
518
+ 图片格式:支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
519
+ 图片大小:对应图片 base64 编码后大小不可超过5M。图片分辨率不超过4096\*4096。
520
+ 如果在商品图像搜索中开启主体识别,分辨率不超过2000\*2000,图片长宽比小于10。
521
+ 建议:
522
+ • 图片存储于腾讯云的Url可保障更高下载速度和稳定性,建议图片存储于腾讯云。非腾讯云存储的Url速度和稳定性可能受一定影响。
520
523
  */
521
524
  ImageUrl?: string
522
525
 
523
526
  /**
524
- * 图片 base64 数据,base64 编码后大小不可超过5M。
525
- 图片分辨率不超过4096\*4096
526
- 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
527
- 注意:开启主体识别分辨率不超过2000\*2000,图片长宽比小于10(长/短 < 10)。
527
+ * 图片 base64 数据。
528
+ ImageUrl和ImageBase64必须提供一个,如果都提供,只使用ImageUrl
529
+ 图片限制:
530
+ 图片格式:支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
531
+ • 图片大小:base64 编码后大小不可超过5M。图片分辨率不超过4096\*4096。
532
+ • 如果在商品图像搜索中开启主体识别,分辨率不超过2000\*2000,图片长宽比小于10。
528
533
  */
529
534
  ImageBase64?: string
530
535
 
531
536
  /**
532
- * 返回数量,默认值为10,最大值为100。
533
- */
537
+ * 返回结果的数量,默认值为10,最大值为100。
538
+ 按照相似度分数由高到低排序。
539
+ **<font color=#1E90FF>注意:服务类型为相似图像搜索时返回数量限制为1,即返回top1的结果。</font>**
540
+ */
534
541
  Limit?: number
535
542
 
536
543
  /**
537
- * 起始序号,默认值为0。
544
+ * 返回结果的起始序号,默认值为0。
538
545
  */
539
546
  Offset?: number
540
547
 
541
548
  /**
542
- * 出参Score中,只有超过**MatchThreshold**值的结果才会返回。默认为0
543
- */
549
+ * 匹配阈值。
550
+ 只有图片相似度分数超过MatchThreshold值的结果才会返回。
551
+ 默认值:
552
+ • 相同图像搜索:50。
553
+ • 商品图像搜索:28。
554
+ • 相似图像搜索:56。
555
+ 建议:
556
+ 可以手动调整MatchThreshold值来控制输出结果的范围。入股发现无检索结果,建议调整为较低的阈值。
557
+ */
544
558
  MatchThreshold?: number
545
559
 
546
560
  /**
547
- * 针对入库时提交的Tags信息进行条件过滤。支持>、>=、 <、 <=、=,!=,多个条件之间支持AND和OR进行连接。
548
- */
561
+ * 标签过滤条件。
562
+ 针对创建图片时提交的Tags信息进行条件过滤。支持>、>=、 <、 <=、=,!=,多个条件之间支持AND和OR进行连接。
563
+ */
549
564
  Filter?: string
550
565
 
551
566
  /**
@@ -556,23 +571,23 @@ Url、Image必须提供一个,如果都提供,只使用 Url。
556
571
 
557
572
  /**
558
573
  * 是否需要启用主体识别,默认为**TRUE** 。
559
- 1. 为**TRUE**时,启用主体识别,返回主体信息。若没有指定**ImageRect**,自动提取最大面积主体进行检索并进行主体识别。主体识别结果可在**Response中**获取。
560
- 2. 为**FALSE**时,不启用主体识别,不返回主体信息。若没有指定**ImageRect**,以整张图检索图片。
561
- 注意:服务类型为商品图像搜索时生效。
574
+ 为**TRUE**时,启用主体识别,返回主体信息。若没有指定**ImageRect**,自动提取最大面积主体进行检索并进行主体识别。主体识别结果可在**Response中**获取。
575
+ 为**FALSE**时,不启用主体识别,不返回主体信息。若没有指定**ImageRect**,以整张图检索图片。
576
+ **<font color=#1E90FF>注意:仅服务类型为商品图像搜索时才生效。</font>**
562
577
  */
563
578
  EnableDetect?: boolean
564
579
 
565
580
  /**
566
581
  * 图像类目ID。
567
- 若设置类目ID,提取对应类目的主体进行检索。
568
- 注意:服务类型为商品图像搜索时生效。
569
- 类目信息:
582
+ 若设置类目ID,提取以下类目的主体进行检索。
583
+ 类目取值说明:
570
584
  0:上衣。
571
585
  1:裙装。
572
586
  2:下装。
573
587
  3:包。
574
588
  4:鞋。
575
589
  5:配饰。
590
+ **<font color=#1E90FF>注意:仅服务类型为商品图像搜索时才生效。</font>**
576
591
  */
577
592
  CategoryId?: number
578
593
  }
@@ -786,7 +801,7 @@ export interface CreateGroupRequest {
786
801
  MaxCapacity: number
787
802
 
788
803
  /**
789
- * 简介。
804
+ * 图库简介。
790
805
  */
791
806
  Brief?: string
792
807
 
@@ -796,11 +811,11 @@ export interface CreateGroupRequest {
796
811
  MaxQps?: number
797
812
 
798
813
  /**
799
- * 图库类型,对应不同服务类型,默认为4。1~3为历史版本,不推荐。
800
- 参数值:
801
- 4:在自建图库中搜索相同原图,可支持裁剪、翻转、调色、加水印后的图片搜索,适用于图片版权保护、原图查询等场景。
802
- 5:在自建图库中搜索相同或相似的商品图片,适用于商品分类、检索、推荐等电商场景。
803
- 6:在自建图片库中搜索与输入图片高度相似的图片,适用于相似图案、logo、纹理等图像元素的搜索。
814
+ * 图库类型,对应不同的图像搜索服务类型,默认为4。1~3为历史版本,不推荐。
815
+ 参数取值:
816
+ 4:相同图像搜索。
817
+ 5:商品图像搜索。
818
+ 6:相似图像搜索。
804
819
  */
805
820
  GroupType?: number
806
821
  }
@@ -1187,7 +1202,7 @@ export interface CreateImageResponse {
1187
1202
  /**
1188
1203
  * 输入图的主体信息。
1189
1204
  若启用主体识别且在请求中指定了类目ID或主体区域,以指定的主体为准。若启用主体识别且没有指定,以最大面积主体为准。
1190
- 注意:此字段可能返回 null,表示取不到有效值。服务类型为商品图像搜索时生效。
1205
+ **<font color=#1E90FF>注意:仅服务类型为商品图像搜索时才生效。</font>**
1191
1206
  注意:此字段可能返回 null,表示取不到有效值。
1192
1207
  */
1193
1208
  Object: ObjectInfo
@@ -675,46 +675,53 @@ export interface CancelTaskResponse {
675
675
  */
676
676
  export interface AudioResultDetailTextResult {
677
677
  /**
678
- * 标签
678
+ * 该字段用于返回检测结果所对应的恶意标签。<br>返回值:**Normal**:正常,**Porn**:色情,**Abuse**:谩骂,**Ad**:广告,**Custom**:自定义违规;以及其他令人反感、不安全或不适宜的内容类型。
679
679
  注意:此字段可能返回 null,表示取不到有效值。
680
680
  */
681
681
  Label: string
682
682
 
683
683
  /**
684
- * 命中的关键词
684
+ * 该字段用于返回ASR识别出的文本内容命中的关键词信息,用于标注内容违规的具体原因(如:加我微信)。该参数可能会有多个返回值,代表命中的多个关键词;若返回值为空,Score不为空,则代表识别结果所对应的恶意标签(Label)来自于语义模型判断的返回值。
685
685
  注意:此字段可能返回 null,表示取不到有效值。
686
686
  */
687
687
  Keywords: Array<string>
688
688
 
689
689
  /**
690
- * 命中的LibId
690
+ * 该字段**仅当Label为Custom:自定义关键词时该参数有效**,用于返回自定义库的ID,以方便自定义库管理和配置。
691
691
  注意:此字段可能返回 null,表示取不到有效值。
692
692
  */
693
693
  LibId: string
694
694
 
695
695
  /**
696
- * 命中的LibName
696
+ * 该字段**仅当Label为Custom:自定义关键词时该参数有效**,用于返回自定义库的名称,以方便自定义库管理和配置。
697
697
  注意:此字段可能返回 null,表示取不到有效值。
698
698
  */
699
699
  LibName: string
700
700
 
701
701
  /**
702
- * 得分
702
+ * 该字段用于返回当前标签下的置信度,取值范围:0(**置信度最低**)-100(**置信度最高**),越高代表文本越有可能属于当前返回的标签;如:*色情 99*,则表明该文本非常有可能属于色情内容。
703
703
  注意:此字段可能返回 null,表示取不到有效值。
704
704
  */
705
705
  Score: number
706
706
 
707
707
  /**
708
- * 词库类型 1 黑白库 2 自定义库
708
+ * 该字段用于返回自定义关键词对应的词库类型,取值为**1**(黑白库)和**2**(自定义关键词库),若未配置自定义关键词库,则默认值为1(黑白库匹配)。
709
709
  注意:此字段可能返回 null,表示取不到有效值。
710
710
  */
711
711
  LibType: number
712
712
 
713
713
  /**
714
- * 审核建议
714
+ * 该字段用于返回后续操作建议。当您获取到判定结果后,返回值表示具体的后续建议操作。<br>
715
+ 返回值:**Block**:建议屏蔽,**Review** :建议人工复审,**Pass**:建议通过
715
716
  注意:此字段可能返回 null,表示取不到有效值。
716
717
  */
717
718
  Suggestion: string
719
+
720
+ /**
721
+ * 该字段用于返回当前标签(Lable)下的二级标签。
722
+ 注意:此字段可能返回 null,表示取不到有效值。
723
+ */
724
+ SubLabel: string
718
725
  }
719
726
 
720
727
  /**