tencentcloud-sdk-nodejs 4.0.445 → 4.0.447

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 (79) hide show
  1. package/CHANGELOG.md +590 -0
  2. package/SERVICE_CHANGELOG.md +699 -7
  3. package/package.json +1 -1
  4. package/products.md +16 -16
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/ccc/v20200210/ccc_models.ts +1 -1
  7. package/src/services/cdb/v20170320/cdb_models.ts +7 -2
  8. package/src/services/cfw/v20190904/cfw_client.ts +2 -14
  9. package/src/services/cfw/v20190904/cfw_models.ts +22 -60
  10. package/src/services/cvm/v20170312/cvm_models.ts +2 -4
  11. package/src/services/ess/v20201111/ess_client.ts +13 -0
  12. package/src/services/ess/v20201111/ess_models.ts +108 -2
  13. package/src/services/essbasic/v20210526/essbasic_client.ts +36 -18
  14. package/src/services/essbasic/v20210526/essbasic_models.ts +128 -12
  15. package/src/services/faceid/v20180301/faceid_models.ts +22 -0
  16. package/src/services/iotvideo/v20211125/iotvideo_models.ts +20 -7
  17. package/src/services/ivld/v20210903/ivld_client.ts +62 -51
  18. package/src/services/ivld/v20210903/ivld_models.ts +1179 -803
  19. package/src/services/mongodb/v20190725/mongodb_client.ts +13 -0
  20. package/src/services/mongodb/v20190725/mongodb_models.ts +55 -0
  21. package/src/services/mps/v20190612/mps_client.ts +1 -1
  22. package/src/services/mps/v20190612/mps_models.ts +5 -0
  23. package/src/services/ocr/v20181119/ocr_client.ts +22 -10
  24. package/src/services/ocr/v20181119/ocr_models.ts +159 -93
  25. package/src/services/teo/index.ts +2 -0
  26. package/src/services/teo/v20220901/index.ts +6 -0
  27. package/src/services/teo/v20220901/teo_client.ts +1630 -0
  28. package/src/services/teo/v20220901/teo_models.ts +11306 -0
  29. package/src/services/tiia/v20190529/tiia_models.ts +1 -1
  30. package/src/services/trtc/v20190722/trtc_models.ts +4 -3
  31. package/src/services/wedata/v20210820/wedata_client.ts +61 -8
  32. package/src/services/wedata/v20210820/wedata_models.ts +499 -51
  33. package/tencentcloud/common/sdk_version.d.ts +1 -1
  34. package/tencentcloud/common/sdk_version.js +1 -1
  35. package/tencentcloud/services/ccc/v20200210/ccc_models.d.ts +1 -1
  36. package/tencentcloud/services/cdb/v20170320/cdb_models.d.ts +6 -2
  37. package/tencentcloud/services/cfw/v20190904/cfw_client.d.ts +1 -5
  38. package/tencentcloud/services/cfw/v20190904/cfw_client.js +0 -6
  39. package/tencentcloud/services/cfw/v20190904/cfw_models.d.ts +20 -53
  40. package/tencentcloud/services/cvm/v20170312/cvm_models.d.ts +1 -3
  41. package/tencentcloud/services/ess/v20201111/ess_client.d.ts +5 -1
  42. package/tencentcloud/services/ess/v20201111/ess_client.js +6 -0
  43. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +90 -2
  44. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +17 -8
  45. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +20 -9
  46. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +108 -12
  47. package/tencentcloud/services/faceid/v20180301/faceid_models.d.ts +20 -0
  48. package/tencentcloud/services/iotvideo/v20211125/iotvideo_models.d.ts +15 -4
  49. package/tencentcloud/services/ivld/v20210903/ivld_client.d.ts +1 -1
  50. package/tencentcloud/services/ivld/v20210903/ivld_models.d.ts +1081 -758
  51. package/tencentcloud/services/mongodb/v20190725/mongodb_client.d.ts +5 -1
  52. package/tencentcloud/services/mongodb/v20190725/mongodb_client.js +6 -0
  53. package/tencentcloud/services/mongodb/v20190725/mongodb_models.d.ts +47 -0
  54. package/tencentcloud/services/mps/v20190612/mps_client.d.ts +1 -1
  55. package/tencentcloud/services/mps/v20190612/mps_client.js +1 -1
  56. package/tencentcloud/services/mps/v20190612/mps_models.d.ts +4 -0
  57. package/tencentcloud/services/ocr/v20181119/ocr_client.d.ts +7 -3
  58. package/tencentcloud/services/ocr/v20181119/ocr_client.js +9 -3
  59. package/tencentcloud/services/ocr/v20181119/ocr_models.d.ts +137 -78
  60. package/tencentcloud/services/teo/index.d.ts +4 -0
  61. package/tencentcloud/services/teo/index.js +2 -0
  62. package/tencentcloud/services/teo/v20220901/index.d.ts +6 -0
  63. package/tencentcloud/services/teo/v20220901/index.js +9 -0
  64. package/tencentcloud/services/teo/v20220901/teo_client.d.ts +490 -0
  65. package/tencentcloud/services/teo/v20220901/teo_client.js +751 -0
  66. package/tencentcloud/services/teo/v20220901/teo_models.d.ts +9713 -0
  67. package/tencentcloud/services/teo/v20220901/teo_models.js +18 -0
  68. package/tencentcloud/services/tiia/v20190529/tiia_models.d.ts +1 -1
  69. package/tencentcloud/services/trtc/v20190722/trtc_models.d.ts +3 -2
  70. package/tencentcloud/services/wedata/v20210820/wedata_client.d.ts +23 -3
  71. package/tencentcloud/services/wedata/v20210820/wedata_client.js +31 -3
  72. package/tencentcloud/services/wedata/v20210820/wedata_models.d.ts +421 -47
  73. package/test/cfw.v20190904.test.js +0 -10
  74. package/test/ess.v20201111.test.js +10 -0
  75. package/test/essbasic.v20210526.test.js +14 -4
  76. package/test/mongodb.v20190725.test.js +10 -0
  77. package/test/ocr.v20181119.test.js +12 -2
  78. package/test/teo.v20220901.test.js +1221 -0
  79. package/test/wedata.v20210820.test.js +42 -2
@@ -16,182 +16,123 @@
16
16
  */
17
17
 
18
18
  /**
19
- * 一级标签信息
19
+ * 标签信息结构体
20
20
 
21
- 请注意,一级标签信息可能不包含二级标签(此时L2TagSet为空)。在这种情况下,一级标签可直接包含出现信息。
21
+ 包含多级(最多三级)标签结果,以及这些标签在识别结果中的出现位置
22
22
  */
23
- export interface L1Tag {
24
- /**
25
- * 一级标签名
26
- */
27
- Name: string
28
-
29
- /**
30
- * 二级标签数组
31
- 注意:此字段可能返回 null,表示取不到有效值。
32
- */
33
- L2TagSet: Array<L2Tag>
34
-
23
+ export interface MultiLevelTag {
35
24
  /**
36
- * 一级标签出现信息
25
+ * 树状标签信息
37
26
  注意:此字段可能返回 null,表示取不到有效值。
38
27
  */
39
- AppearIndexPairSet: Array<AppearIndexPair>
28
+ TagSet: Array<L1Tag>
40
29
 
41
30
  /**
42
- * 一级标签首次出现信息
31
+ * 标签在识别结果中的定位信息
43
32
  注意:此字段可能返回 null,表示取不到有效值。
44
33
  */
45
- FirstAppear: number
46
- }
47
-
48
- /**
49
- * DeleteMedia返回参数结构体
50
- */
51
- export interface DeleteMediaResponse {
52
- /**
53
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
54
- */
55
- RequestId?: string
34
+ AppearInfo: AppearInfo
56
35
  }
57
36
 
58
37
  /**
59
- * UpdateCustomPerson请求参数结构体
38
+ * AddCustomPersonImage请求参数结构体
60
39
  */
61
- export interface UpdateCustomPersonRequest {
40
+ export interface AddCustomPersonImageRequest {
62
41
  /**
63
- * 待更新的自定义人物Id
42
+ * 自定义人物Id
64
43
  */
65
44
  PersonId: string
66
45
 
67
46
  /**
68
- * 更新后的自定义人物名称,如为空则不更新
69
- */
70
- Name?: string
71
-
72
- /**
73
- * 更新后的自定义人物简介,如为空则不更新
47
+ * 自定义人物图片地址
74
48
  */
75
- BasicInfo?: string
49
+ ImageURL?: string
76
50
 
77
51
  /**
78
- * 更新后的分类信息,如为空则不更新
52
+ * 图片数据base64之后的结果
79
53
  */
80
- CategoryId?: string
54
+ Image?: string
81
55
  }
82
56
 
83
57
  /**
84
- * 视频结构化结果
85
- */
86
- export interface ShowInfo {
87
- /**
88
- * 节目日期(只在新闻有效)
89
- 注意:此字段可能返回 null,表示取不到有效值。
90
- */
91
- Date: string
92
-
93
- /**
94
- * 台标
95
- 注意:此字段可能返回 null,表示取不到有效值。
96
- */
97
- Logo: string
98
-
99
- /**
100
- * 节目名称
101
- 注意:此字段可能返回 null,表示取不到有效值。
102
- */
103
- Column: string
104
-
105
- /**
106
- * 来源信息
107
- 注意:此字段可能返回 null,表示取不到有效值。
108
- */
109
- Source: string
58
+ * 二级标签信息
110
59
 
111
- /**
112
- * 节目封面
113
- 注意:此字段可能返回 null,表示取不到有效值。
114
- */
115
- CoverImageURL: string
60
+ 请注意,二级标签信息可能不包含三级标签(此时L3TagSet为空)。
116
61
 
62
+ */
63
+ export interface L2Tag {
117
64
  /**
118
- * 节目内容概要列表
119
- 注意:此字段可能返回 null,表示取不到有效值。
120
- */
121
- SummarySet: Array<string>
65
+ * 二级标签名
66
+ */
67
+ Name: string
122
68
 
123
69
  /**
124
- * 节目片段标题列表
70
+ * 从属于此二级标签的三级标签数组
125
71
  注意:此字段可能返回 null,表示取不到有效值。
126
72
  */
127
- TitleSet: Array<string>
73
+ L3TagSet: Array<L3Tag>
128
74
 
129
75
  /**
130
- * 音频识别结果列表
76
+ * 二级标签出现信息
131
77
  注意:此字段可能返回 null,表示取不到有效值。
132
78
  */
133
- AudioInfoSet: Array<AudioInfo>
79
+ AppearIndexPairSet: Array<AppearIndexPair>
134
80
 
135
81
  /**
136
- * 可视文字识别结果列表
82
+ * 二级标签首次出现信息
137
83
  注意:此字段可能返回 null,表示取不到有效值。
138
84
  */
139
- TextInfoSet: Array<TextInfo>
85
+ FirstAppear: number
86
+ }
140
87
 
88
+ /**
89
+ * DescribeTaskDetail返回参数结构体
90
+ */
91
+ export interface DescribeTaskDetailResponse {
141
92
  /**
142
- * 已分类人物信息列表
93
+ * 任务信息,不包含任务结果
143
94
  注意:此字段可能返回 null,表示取不到有效值。
144
95
  */
145
- ClassifiedPersonInfoSet: Array<ClassifiedPersonInfo>
96
+ TaskInfo: TaskInfo
146
97
 
147
98
  /**
148
- * 文本标签列表,包含标签内容和出现信息
99
+ * 视频任务结果数据,只在视频任务结束时返回
149
100
  注意:此字段可能返回 null,表示取不到有效值。
150
101
  */
151
- TextTagSet: MultiLevelTag
102
+ TaskData: Data
152
103
 
153
104
  /**
154
- * 帧标签列表,包括人物信息,场景信息等
105
+ * 图片任务结果数据,只在图片任务结束时返回
155
106
  注意:此字段可能返回 null,表示取不到有效值。
156
107
  */
157
- FrameTagSet: MultiLevelTag
108
+ ImageTaskData: ImageData
158
109
 
159
110
  /**
160
- * 视频下载地址
111
+ * 音频任务结果数据,只在音频任务结束时返回
161
112
  注意:此字段可能返回 null,表示取不到有效值。
162
113
  */
163
- WebMediaURL: string
114
+ AudioTaskData: AudioData
164
115
 
165
116
  /**
166
- * 媒资分类信息
117
+ * 文本任务结果数据,只在文本任务结束时返回
167
118
  注意:此字段可能返回 null,表示取不到有效值。
168
119
  */
169
- MediaClassifierSet: Array<string>
120
+ TextTaskData: TextData
170
121
 
171
122
  /**
172
- * 概要标签信息
173
- 注意:此字段可能返回 null,表示取不到有效值。
174
- */
175
- SummaryTagSet: Array<string>
123
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
124
+ */
125
+ RequestId?: string
176
126
  }
177
127
 
178
128
  /**
179
- * 标签信息结构体
180
-
181
- 包含多级(最多三级)标签结果,以及这些标签在识别结果中的出现位置
129
+ * DeleteCustomCategory请求参数结构体
182
130
  */
183
- export interface MultiLevelTag {
184
- /**
185
- * 树状标签信息
186
- 注意:此字段可能返回 null,表示取不到有效值。
187
- */
188
- TagSet: Array<L1Tag>
189
-
131
+ export interface DeleteCustomCategoryRequest {
190
132
  /**
191
- * 标签在识别结果中的定位信息
192
- 注意:此字段可能返回 null,表示取不到有效值。
193
- */
194
- AppearInfo: AppearInfo
133
+ * 自定义分类ID
134
+ */
135
+ CategoryId: string
195
136
  }
196
137
 
197
138
  /**
@@ -223,51 +164,53 @@ export interface MediaFilter {
223
164
  注意:此字段可能返回 null,表示取不到有效值。
224
165
  */
225
166
  LabelSet?: Array<string>
167
+
168
+ /**
169
+ * 媒资文件类型,定义参见[MediaPreknownInfo.MediaType](https://cloud.tencent.com/document/product/1509/65063#MediaPreknownInfo)
170
+ 注意:此字段可能返回 null,表示取不到有效值。
171
+ */
172
+ MediaType?: number
226
173
  }
227
174
 
228
175
  /**
229
- * AddCustomPersonImage请求参数结构体
176
+ * 自定义分类信息
230
177
  */
231
- export interface AddCustomPersonImageRequest {
178
+ export interface CustomCategory {
232
179
  /**
233
- * 自定义人物Id
180
+ * 自定义分类ID
234
181
  */
235
- PersonId: string
182
+ CategoryId: string
236
183
 
237
184
  /**
238
- * 自定义人物图片地址
185
+ * 一级自定义类型
239
186
  */
240
- ImageURL?: string
187
+ L1Category: string
241
188
 
242
189
  /**
243
- * 图片数据base64之后的结果
190
+ * 二级自定义类型
244
191
  */
245
- Image?: string
192
+ L2Category: string
246
193
  }
247
194
 
248
195
  /**
249
- * ModifyCallback请求参数结构体
196
+ * DescribeCustomCategories请求参数结构体
250
197
  */
251
- export interface ModifyCallbackRequest {
252
- /**
253
- * 任务分析完成后回调地址
254
- */
255
- TaskFinishNotifyURL: string
256
-
257
- /**
258
- * 媒体导入完成后回调地址
259
- */
260
- MediaFinishNotifyURL: string
261
- }
198
+ export type DescribeCustomCategoriesRequest = null
262
199
 
263
200
  /**
264
- * DeleteCustomPerson返回参数结构体
201
+ * DescribeTasks返回参数结构体
265
202
  */
266
- export interface DeleteCustomPersonResponse {
203
+ export interface DescribeTasksResponse {
267
204
  /**
268
- * 已删除的自定义人物Id
205
+ * 满足过滤条件的任务总数量
269
206
  */
270
- PersonId: string
207
+ TotalCount: number
208
+
209
+ /**
210
+ * 满足过滤条件的任务数组
211
+ 注意:此字段可能返回 null,表示取不到有效值。
212
+ */
213
+ TaskInfoSet: Array<TaskInfo>
271
214
 
272
215
  /**
273
216
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
@@ -276,178 +219,460 @@ export interface DeleteCustomPersonResponse {
276
219
  }
277
220
 
278
221
  /**
279
- * 二级标签信息
280
-
281
- 请注意,二级标签信息可能不包含三级标签(此时L3TagSet为空)。
282
-
222
+ * 自定义人物批量查询过滤条件
283
223
  */
284
- export interface L2Tag {
224
+ export interface CustomPersonFilter {
285
225
  /**
286
- * 二级标签名
226
+ * 待查询的人物姓名
287
227
  */
288
228
  Name: string
289
229
 
290
230
  /**
291
- * 从属于此二级标签的三级标签数组
292
- 注意:此字段可能返回 null,表示取不到有效值。
293
- */
294
- L3TagSet: Array<L3Tag>
295
-
296
- /**
297
- * 二级标签出现信息
298
- 注意:此字段可能返回 null,表示取不到有效值。
299
- */
300
- AppearIndexPairSet: Array<AppearIndexPair>
231
+ * 待过滤的自定义类型Id数组
232
+ */
233
+ CategoryIdSet: Array<string>
301
234
 
302
235
  /**
303
- * 二级标签首次出现信息
304
- 注意:此字段可能返回 null,表示取不到有效值。
305
- */
306
- FirstAppear: number
307
- }
236
+ * 待过滤的自定义人物Id数组
237
+ */
238
+ PersonIdSet: Array<string>
308
239
 
309
- /**
310
- * DeleteTask请求参数结构体
311
- */
312
- export interface DeleteTaskRequest {
313
240
  /**
314
- * 任务Id
241
+ * 一级自定义人物类型数组
315
242
  */
316
- TaskId: string
243
+ L1CategorySet: Array<string>
317
244
  }
318
245
 
319
246
  /**
320
- * DescribeCustomCategories请求参数结构体
321
- */
322
- export type DescribeCustomCategoriesRequest = null
323
-
324
- /**
325
- * ImportMedia请求参数结构体
247
+ * CreateCustomPerson返回参数结构体
326
248
  */
327
- export interface ImportMediaRequest {
249
+ export interface CreateCustomPersonResponse {
328
250
  /**
329
- * 待分析视频的URL,目前只支持*不带签名的*COS地址,长度最长1KB
251
+ * 自定义人物Id
330
252
  */
331
- URL: string
253
+ PersonId: string
332
254
 
333
255
  /**
334
- * 待分析视频的MD5,为空时不做校验,否则会做MD5校验,长度必须为32B
256
+ * 自定义人脸信息
335
257
  */
336
- MD5?: string
258
+ ImageInfo: PersonImageInfo
337
259
 
338
260
  /**
339
- * 待分析视频的名称,指定后可支持筛选,最多100个中文字符
261
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
340
262
  */
341
- Name?: string
263
+ RequestId?: string
264
+ }
342
265
 
266
+ /**
267
+ * ImportMedia返回参数结构体
268
+ */
269
+ export interface ImportMediaResponse {
343
270
  /**
344
- * 当非本人外部视频地址导入时,该字段为转存的cos桶地址且不可为空; 示例:https://${Bucket}-${AppId}.cos.${Region}.myqcloud.com/${PathPrefix}/ (注意,cos路径需要以/分隔符结尾)。
345
- 推荐采用本主帐号COS桶,如果使用其他帐号COS桶,请确保COS桶可写,否则可导致分析失败
346
- */
347
- WriteBackCosPath?: string
271
+ * 媒资文件在系统中的ID
272
+ */
273
+ MediaId: string
348
274
 
349
275
  /**
350
- * 自定义标签,可用于查询
276
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
351
277
  */
352
- Label?: string
278
+ RequestId?: string
279
+ }
353
280
 
281
+ /**
282
+ * QueryCallback请求参数结构体
283
+ */
284
+ export type QueryCallbackRequest = null
285
+
286
+ /**
287
+ * DescribeMedia请求参数结构体
288
+ */
289
+ export interface DescribeMediaRequest {
354
290
  /**
355
- * 媒资导入完成的回调地址,该设置优先级高于控制台全局的设置;
291
+ * 导入媒资返回的媒资ID,最长32B
356
292
  */
357
- CallbackURL?: string
293
+ MediaId: string
358
294
  }
359
295
 
360
296
  /**
361
- * CreateCustomCategory请求参数结构体
297
+ * 任务信息
298
+
299
+ TaskStatus定义如下:
300
+
301
+ | TaskStatus名称 | TaskStatus取值 | TaskStatus描述 |
302
+ |---|---|---|
303
+ | TASK_STATUS_INVALID | 0 | 非法的任务状态 |
304
+ | TASK_STATUS_WAITING | 1 | 排队中 |
305
+ | TASK_STATUS_ANALYSING | 2 | 任务分析中 |
306
+ | TASK_STATUS_ANALYSED | 3 | 任务分析完成 |
307
+ | TASK_STATUS_SNAPSHOT_CREATING | 4 | 任务结果快照生成中 |
308
+ | TASK_STATUS_SNAPSHOT_CREATED | 5 | 任务结果快照生成完成 |
309
+ | TASK_STATUS_RESULT_UPLOADING | 6 | 任务结果快照上传中 |
310
+ | TASK_STATUS_RESULT_UPLOADED | 7 | 任务结果快照上传完成 |
311
+ | TASK_STATUS_SUCCESS | 8 | 任务执行完成 |
312
+ | TASK_STATUS_FAILED | 9 | 任务执行失败 |
362
313
  */
363
- export interface CreateCustomCategoryRequest {
314
+ export interface TaskInfo {
364
315
  /**
365
- * 自定义一级类型
316
+ * 任务ID
366
317
  */
367
- L1Category: string
318
+ TaskId: string
368
319
 
369
320
  /**
370
- * 自定义二级类型
321
+ * 描述任务名称,指定后可根据名称筛选
322
+ 注意:此字段可能返回 null,表示取不到有效值。
323
+ */
324
+ TaskName: string
325
+
326
+ /**
327
+ * 媒资文件ID
371
328
  */
372
- L2Category: string
329
+ MediaId: string
330
+
331
+ /**
332
+ * 任务执行状态
333
+ */
334
+ TaskStatus: number
335
+
336
+ /**
337
+ * 任务进度,范围为[0,100]
338
+ 注意:此字段可能返回 null,表示取不到有效值。
339
+ */
340
+ TaskProgress: number
341
+
342
+ /**
343
+ * 任务执行时间
344
+ 注意:此字段可能返回 null,表示取不到有效值。
345
+ */
346
+ TaskTimeCost: number
347
+
348
+ /**
349
+ * 任务创建时间
350
+ */
351
+ TaskCreateTime: string
352
+
353
+ /**
354
+ * 任务开始执行时间
355
+ 注意:此字段可能返回 null,表示取不到有效值。
356
+ */
357
+ TaskStartTime: string
358
+
359
+ /**
360
+ * 任务失败原因
361
+ 注意:此字段可能返回 null,表示取不到有效值。
362
+ */
363
+ FailedReason: string
364
+
365
+ /**
366
+ * 任务执行时指定的先验知识
367
+ */
368
+ MediaPreknownInfo: MediaPreknownInfo
369
+
370
+ /**
371
+ * 媒资文件名称
372
+ 注意:此字段可能返回 null,表示取不到有效值。
373
+ */
374
+ MediaName: string
375
+
376
+ /**
377
+ * 媒资自定义标签
378
+ 注意:此字段可能返回 null,表示取不到有效值。
379
+ */
380
+ Label: string
381
+
382
+ /**
383
+ * 任务分析完成后的后调地址
384
+ 注意:此字段可能返回 null,表示取不到有效值。
385
+ */
386
+ CallbackURL: string
387
+
388
+ /**
389
+ * 任务对应的媒资文件元信息,仅在MediaType为Audio时有效
390
+ 注意:此字段可能返回 null,表示取不到有效值。
391
+ */
392
+ AudioMetadata: AudioMetadata
393
+
394
+ /**
395
+ * 任务对应的媒资文件元信息,仅在MediaType为Audio时有效
396
+ 注意:此字段可能返回 null,表示取不到有效值。
397
+ */
398
+ ImageMetadata: ImageMetadata
399
+
400
+ /**
401
+ * 任务对应的媒资文件元信息,仅在MediaType为Text时有效
402
+ 注意:此字段可能返回 null,表示取不到有效值。
403
+ */
404
+ TextMetadata: TextMetadata
405
+
406
+ /**
407
+ * 任务对应的媒资文件元信息,仅在MediaType为Video时有效
408
+ 注意:此字段可能返回 null,表示取不到有效值。
409
+ */
410
+ Metadata: MediaMetadata
373
411
  }
374
412
 
375
413
  /**
376
- * DescribeMedia请求参数结构体
414
+ * 视频结构化结果
377
415
  */
378
- export interface DescribeMediaRequest {
416
+ export interface ShowInfo {
379
417
  /**
380
- * 导入媒资返回的媒资ID,最长32B
381
- */
382
- MediaId: string
418
+ * 节目日期(只在新闻有效)
419
+ 注意:此字段可能返回 null,表示取不到有效值。
420
+ */
421
+ Date: string
422
+
423
+ /**
424
+ * 台标
425
+ 注意:此字段可能返回 null,表示取不到有效值。
426
+ */
427
+ Logo: string
428
+
429
+ /**
430
+ * 节目名称
431
+ 注意:此字段可能返回 null,表示取不到有效值。
432
+ */
433
+ Column: string
434
+
435
+ /**
436
+ * 来源信息
437
+ 注意:此字段可能返回 null,表示取不到有效值。
438
+ */
439
+ Source: string
440
+
441
+ /**
442
+ * 节目封面
443
+ 注意:此字段可能返回 null,表示取不到有效值。
444
+ */
445
+ CoverImageURL: string
446
+
447
+ /**
448
+ * 节目内容概要列表
449
+ 注意:此字段可能返回 null,表示取不到有效值。
450
+ */
451
+ SummarySet: Array<string>
452
+
453
+ /**
454
+ * 节目片段标题列表
455
+ 注意:此字段可能返回 null,表示取不到有效值。
456
+ */
457
+ TitleSet: Array<string>
458
+
459
+ /**
460
+ * 音频识别结果列表
461
+ 注意:此字段可能返回 null,表示取不到有效值。
462
+ */
463
+ AudioInfoSet: Array<AudioInfo>
464
+
465
+ /**
466
+ * 可视文字识别结果列表
467
+ 注意:此字段可能返回 null,表示取不到有效值。
468
+ */
469
+ TextInfoSet: Array<TextInfo>
470
+
471
+ /**
472
+ * 已分类人物信息列表
473
+ 注意:此字段可能返回 null,表示取不到有效值。
474
+ */
475
+ ClassifiedPersonInfoSet: Array<ClassifiedPersonInfo>
476
+
477
+ /**
478
+ * 文本标签列表,包含标签内容和出现信息
479
+ 注意:此字段可能返回 null,表示取不到有效值。
480
+ */
481
+ TextTagSet: MultiLevelTag
482
+
483
+ /**
484
+ * 帧标签列表,包括人物信息,场景信息等
485
+ 注意:此字段可能返回 null,表示取不到有效值。
486
+ */
487
+ FrameTagSet: MultiLevelTag
488
+
489
+ /**
490
+ * 视频下载地址
491
+ 注意:此字段可能返回 null,表示取不到有效值。
492
+ */
493
+ WebMediaURL: string
494
+
495
+ /**
496
+ * 媒资分类信息
497
+ 注意:此字段可能返回 null,表示取不到有效值。
498
+ */
499
+ MediaClassifierSet: Array<string>
500
+
501
+ /**
502
+ * 概要标签信息
503
+ 注意:此字段可能返回 null,表示取不到有效值。
504
+ */
505
+ SummaryTagSet: Array<string>
506
+
507
+ /**
508
+ * 未知人物信息
509
+ 注意:此字段可能返回 null,表示取不到有效值。
510
+ */
511
+ UnknownPersonSet: Array<UnknownPerson>
512
+
513
+ /**
514
+ * 树状已分类人物信息
515
+ 注意:此字段可能返回 null,表示取不到有效值。
516
+ */
517
+ MultiLevelPersonInfoSet: Array<MultiLevelPersonInfo>
383
518
  }
384
519
 
385
520
  /**
386
- * DescribeMedias请求参数结构体
521
+ * DescribeTasks请求参数结构体
387
522
  */
388
- export interface DescribeMediasRequest {
523
+ export interface DescribeTasksRequest {
389
524
  /**
390
525
  * 分页序号,从1开始
391
526
  */
392
- PageNumber: number
527
+ PageNumber?: number
393
528
 
394
529
  /**
395
530
  * 每个分页所包含的元素数量,最大为50
396
531
  */
397
- PageSize: number
532
+ PageSize?: number
398
533
 
399
534
  /**
400
- * 列举过滤条件,相关限制相见MediaFilter
535
+ * 任务过滤条件,相关限制参见TaskFilter
401
536
  */
402
- MediaFilter?: MediaFilter
537
+ TaskFilter?: TaskFilter
538
+
539
+ /**
540
+ * 返回结果排序信息,By字段只支持CreateTimeStamp
541
+ */
542
+ SortBy?: SortBy
543
+ }
544
+
545
+ /**
546
+ * DescribeCustomPersons返回参数结构体
547
+ */
548
+ export interface DescribeCustomPersonsResponse {
549
+ /**
550
+ * 满足过滤条件的自定义人物数量
551
+ */
552
+ TotalCount: number
553
+
554
+ /**
555
+ * 自定义人物信息
556
+ */
557
+ PersonInfoSet: Array<CustomPersonInfo>
558
+
559
+ /**
560
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
561
+ */
562
+ RequestId?: string
563
+ }
564
+
565
+ /**
566
+ * 文本文件标签识别结果
567
+ */
568
+ export interface TextData {
569
+ /**
570
+ * 文本内容信息
571
+ 注意:此字段可能返回 null,表示取不到有效值。
572
+ */
573
+ Content: string
574
+
575
+ /**
576
+ * 文本概要信息
577
+ 注意:此字段可能返回 null,表示取不到有效值。
578
+ */
579
+ Summary: string
580
+
581
+ /**
582
+ * 文本标签信息
583
+ 注意:此字段可能返回 null,表示取不到有效值。
584
+ */
585
+ TextTagSet: MultiLevelTag
586
+ }
587
+
588
+ /**
589
+ * 图片文件元信息
590
+ */
591
+ export interface ImageMetadata {
592
+ /**
593
+ * 媒资图片文件大小,单位为Byte
594
+ 注意:此字段可能返回 null,表示取不到有效值。
595
+ */
596
+ FileSize: number
597
+
598
+ /**
599
+ * 媒资图片文件MD5
600
+ 注意:此字段可能返回 null,表示取不到有效值。
601
+ */
602
+ MD5: string
603
+
604
+ /**
605
+ * 媒资图片文件宽度
606
+ 注意:此字段可能返回 null,表示取不到有效值。
607
+ */
608
+ Width: number
609
+
610
+ /**
611
+ * 媒资图片文件高度
612
+ 注意:此字段可能返回 null,表示取不到有效值。
613
+ */
614
+ Height: number
615
+
616
+ /**
617
+ * 媒资图片文件格式
618
+ 注意:此字段可能返回 null,表示取不到有效值。
619
+ */
620
+ Format: string
621
+ }
403
622
 
623
+ /**
624
+ * CreateCustomGroup请求参数结构体
625
+ */
626
+ export interface CreateCustomGroupRequest {
404
627
  /**
405
- * 返回结果排序信息,By字段只支持CreateTime
628
+ * 人脸图片COS存储桶Host地址
406
629
  */
407
- SortBy?: SortBy
630
+ Bucket: string
408
631
  }
409
632
 
410
633
  /**
411
- * 关键词在视觉结果中的定位信息
634
+ * 文本文件元信息
412
635
  */
413
- export interface VideoAppearInfo {
636
+ export interface TextMetadata {
414
637
  /**
415
- * 视觉信息起始时间戳,从0开始
416
- */
417
- StartTimeStamp: number
638
+ * 媒资文本文件大小,单位为字节
639
+ 注意:此字段可能返回 null,表示取不到有效值。
640
+ */
641
+ FileSize: number
418
642
 
419
643
  /**
420
- * 视觉信息终止时间戳,从0开始
421
- 关键词在视觉信息中的区间为[StartTimeStamp, EndTimeStamp)
644
+ * 媒资文本文件MD5
645
+ 注意:此字段可能返回 null,表示取不到有效值。
422
646
  */
423
- EndTimeStamp: number
647
+ MD5: string
424
648
 
425
649
  /**
426
- * 关键词在视觉信息中的封面图片
427
- */
428
- ImageURL: string
650
+ * 媒资文本文件字符数
651
+ 注意:此字段可能返回 null,表示取不到有效值。
652
+ */
653
+ Length: number
654
+
655
+ /**
656
+ * 媒资文本文件格式
657
+ 注意:此字段可能返回 null,表示取不到有效值。
658
+ */
659
+ Format: string
429
660
  }
430
661
 
431
662
  /**
432
- * DescribeTask返回参数结构体
663
+ * AddCustomPersonImage返回参数结构体
433
664
  */
434
- export interface DescribeTaskResponse {
665
+ export interface AddCustomPersonImageResponse {
435
666
  /**
436
- * 任务信息,详情参见TaskInfo的定义
437
- 注意:此字段可能返回 null,表示取不到有效值。
438
- */
439
- TaskInfo: TaskInfo
667
+ * 自定义人物Id
668
+ */
669
+ PersonId: string
440
670
 
441
671
  /**
442
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
672
+ * 自定义人脸图片信息
443
673
  */
444
- RequestId?: string
445
- }
674
+ ImageInfo: PersonImageInfo
446
675
 
447
- /**
448
- * CreateDefaultCategories返回参数结构体
449
- */
450
- export interface CreateDefaultCategoriesResponse {
451
676
  /**
452
677
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
453
678
  */
@@ -455,167 +680,193 @@ export interface CreateDefaultCategoriesResponse {
455
680
  }
456
681
 
457
682
  /**
458
- * 出现信息索引对
683
+ * CreateDefaultCategories请求参数结构体
684
+ */
685
+ export type CreateDefaultCategoriesRequest = null
459
686
 
460
- AppearIndex可选值定义如下:
687
+ /**
688
+ * 任务筛选条件结构体
689
+ */
690
+ export interface TaskFilter {
691
+ /**
692
+ * 媒资文件类型
693
+ */
694
+ MediaTypeSet?: Array<number>
461
695
 
462
- | AppearIndex名称 | AppearIndex取值 | AppearIndex描述 |
463
- |---|---|---|
464
- | APPEAR_INDEX_INVALID | 0 | 非法的任务状态 |
465
- | APPEAR_INDEX_AUDIO | 1 | 音频出现信息|
466
- | APPEAR_INDEX_TEXT | 2 | 可视文本出现信息|
467
- | APPEAR_INDEX_VIDEO | 3 | 视频出现信息|
696
+ /**
697
+ * 待筛选的任务状态列表
698
+ */
699
+ TaskStatusSet?: Array<number>
468
700
 
469
- 例如,当AppearIndex=1,Index=15,则意味着目标关键词出现在第16个(Index计数从0开始)音频文字识别结果之中
470
- */
471
- export interface AppearIndexPair {
472
701
  /**
473
- * 出现信息,取值范围为[1,3]
702
+ * 待筛选的任务名称数组
474
703
  */
475
- AppearIndex: number
704
+ TaskNameSet?: Array<string>
476
705
 
477
706
  /**
478
- * AppearInfo中AppearIndex对应元素的第Index元素,从0开始技术
707
+ * TaskId数组
479
708
  */
480
- Index: number
481
- }
709
+ TaskIdSet?: Array<string>
482
710
 
483
- /**
484
- * CreateTask返回参数结构体
485
- */
486
- export interface CreateTaskResponse {
487
711
  /**
488
- * 智能标签视频分析任务ID
712
+ * 媒资文件名数组
489
713
  */
490
- TaskId: string
714
+ MediaNameSet?: Array<string>
491
715
 
492
716
  /**
493
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
717
+ * 媒资语言类型
494
718
  */
495
- RequestId?: string
496
- }
719
+ MediaLangSet?: Array<number>
497
720
 
498
- /**
499
- * DeleteCustomCategory请求参数结构体
500
- */
501
- export interface DeleteCustomCategoryRequest {
502
721
  /**
503
- * 自定义分类ID
722
+ * 媒资素材一级类型
504
723
  */
505
- CategoryId: string
506
- }
724
+ MediaLabelSet?: Array<number>
507
725
 
508
- /**
509
- * DescribeTasks请求参数结构体
510
- */
511
- export interface DescribeTasksRequest {
512
726
  /**
513
- * 分页序号,从1开始
727
+ * 媒资自定义标签数组
514
728
  */
515
- PageNumber?: number
729
+ LabelSet?: Array<string>
730
+ }
516
731
 
732
+ /**
733
+ * 关键词在文本中的定位信息
734
+
735
+ Position为关键词在文本中的偏移量,从0开始。例如,给定文本结果"欢迎收看新闻三十分”,以及关键词"新闻三十分",那么StartPosition的值为4,EndPosition的值为9
736
+ */
737
+ export interface TextAppearInfo {
517
738
  /**
518
- * 每个分页所包含的元素数量,最大为50
739
+ * 文本结果数组中的下标
519
740
  */
520
- PageSize?: number
741
+ Index: number
521
742
 
522
743
  /**
523
- * 任务过滤条件,相关限制参见TaskFilter
744
+ * 关键词在文本中出现的起始偏移量(包含)
524
745
  */
525
- TaskFilter?: TaskFilter
746
+ StartPosition: number
526
747
 
527
748
  /**
528
- * 返回结果排序信息,By字段只支持CreateTimeStamp
749
+ * 关键词在文本中出现的结束偏移量(不包含)
529
750
  */
530
- SortBy?: SortBy
751
+ EndPosition: number
531
752
  }
532
753
 
533
754
  /**
534
- * DescribeTaskDetail返回参数结构体
755
+ * 描述输入媒资的先验知识,例如文件类型(视频),媒体类型(新闻/综艺等)
756
+
757
+ MediaPreknownInfo.MediaType:
758
+
759
+ | MediaType 名称| MediaType取值 | MediaType描述 |
760
+ |---|---|---|
761
+ | MEDIA_TYPE_INVALID | 0 | 非法的媒资文件类型 |
762
+ | MEDIA_TYPE_IMAGE | 1 | 图片 |
763
+ | MEDIA_TYPE_VIDEO | 2 | 视频 |
764
+ | MEDIA_TYPE_AUDIO | 3 | 音频 |
765
+ | MEDIA_TYPE_VIDEO_STREAM | 4 | 视频流,暂不支持 |
766
+ | MEDIA_TYPE_TEXT | 5 | 文本 |
767
+
768
+ MediaPreknownInfo.MediaLabel:
769
+
770
+ | MediaLabel名称 | MediaLabel取值 | MediaLabel描述 |
771
+ |---|---|---|
772
+ | MEDIA_LABEL_INVALID | 0 | 非法的一级媒资素材类型 |
773
+ | MEDIA_LABEL_NEWS | 1 | 新闻 |
774
+ | MEDIA_LABEL_ENTERTAINMENT | 2 | 综艺|
775
+ | MEDIA_LABEL_INTERNET_INFO | 3 | 互联网资讯 |
776
+ | MEDIA_LABEL_MOVIE | 4 | 电影 |
777
+ | MEDIA_LABEL_SERIES | 5 | 电视连续剧 |
778
+ | MEDIA_LABEL_SPECIAL | 6 | 专题 |
779
+ | MEDIA_LABEL_SPORT | 7 | 体育 |
780
+
781
+ MediaPreknownInfo.MediaSecondLabel
782
+ 请注意:**当且仅当MediaLabel=2(综艺)时MediaSecondLabel才有意义**
783
+
784
+ | MediaSecondLabel名称 | MediaSecondLabel取值 | MediaSecondLabel 描述|
785
+ |---|---|---|
786
+ | MEDIA_SECOND_LABEL_INVALID | 0 | 非法的MediaSecondLabel |
787
+ | MEDIA_SECOND_LABEL_EVENING | 1 | 综艺晚会 |
788
+ | MEDIA_SECOND_LABEL_OTHERS | 2 | 其他 |
789
+
790
+ MediaMeta.MediaLang
791
+
792
+ | MediaLang名称 | MediaLang取值 | MediaLang描述 |
793
+ |---|---|---|
794
+ | MEDIA_LANG_INVALID | 0 | 非法的MediaLang |
795
+ | MEDIA_LANG_MANDARIN | 1 | 普通话 |
796
+ | MEDIA_LANG_CANTONESE | 2 | 粤语 |
535
797
  */
536
- export interface DescribeTaskDetailResponse {
798
+ export interface MediaPreknownInfo {
537
799
  /**
538
- * 任务信息,不包含任务结果
539
- 注意:此字段可能返回 null,表示取不到有效值。
540
- */
541
- TaskInfo: TaskInfo
800
+ * 媒资文件类型,参见MediaPreknownInfo结构体定义
801
+ */
802
+ MediaType: number
542
803
 
543
804
  /**
544
- * 任务结果数据,只在任务结束时返回
805
+ * 媒资素材一级类型,参见MediaPreknownInfo结构体定义
545
806
  */
546
- TaskData: Data
807
+ MediaLabel: number
547
808
 
548
809
  /**
549
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
550
- */
551
- RequestId?: string
810
+ * 媒资素材二级类型,参见MediaPreknownInfo结构体定义
811
+ 注意:此字段可能返回 null,表示取不到有效值。
812
+ */
813
+ MediaSecondLabel: number
814
+
815
+ /**
816
+ * 媒资音频类型,参见MediaPreknownInfo结构体定义
817
+ 注意:此字段可能返回 null,表示取不到有效值。
818
+ */
819
+ MediaLang?: number
552
820
  }
553
821
 
554
822
  /**
555
- * 自定义人物人脸图片信息
823
+ * 自定义人物信息
556
824
  */
557
- export interface PersonImageInfo {
825
+ export interface CustomPersonInfo {
558
826
  /**
559
- * 人脸图片ID
827
+ * 自定义人物Id
560
828
  */
561
- ImageId: string
829
+ PersonId: string
562
830
 
563
831
  /**
564
- * 自定义人脸图片的URL,存储在IVLDCustomPreson存储桶内
832
+ * 自定义人物姓名
565
833
  */
566
- ImageURL: string
834
+ Name: string
567
835
 
568
836
  /**
569
- * 自定义人脸图片处理错误码
837
+ * 自定义人物简介信息
570
838
  */
571
- ErrorCode: string
839
+ BasicInfo: string
572
840
 
573
841
  /**
574
- * 自定义人脸图片处理错误信息
842
+ * 一级自定义人物类型
575
843
  */
576
- ErrorMsg: string
577
- }
844
+ L1Category: string
578
845
 
579
- /**
580
- * 已分类的人物信息
581
- */
582
- export interface ClassifiedPersonInfo {
583
846
  /**
584
- * 人物分类名称
585
- 注意:此字段可能返回 null,表示取不到有效值。
586
- */
587
- ClassifyName: string
847
+ * 二级自定义人物类型
848
+ */
849
+ L2Category: string
588
850
 
589
851
  /**
590
- * 符合特定分类的人物信息数组
591
- 注意:此字段可能返回 null,表示取不到有效值。
592
- */
593
- PersonInfoSet: Array<PersonInfo>
594
- }
852
+ * 自定义人物图片信息
853
+ */
854
+ ImageInfoSet: Array<PersonImageInfo>
595
855
 
596
- /**
597
- * CreateCustomGroup请求参数结构体
598
- */
599
- export interface CreateCustomGroupRequest {
600
856
  /**
601
- * 人脸图片COS存储桶Host地址
857
+ * 自定义人物创建时间
602
858
  */
603
- Bucket: string
859
+ CreateTime: string
604
860
  }
605
861
 
606
862
  /**
607
- * DescribeCustomPersons返回参数结构体
863
+ * UpdateCustomPerson返回参数结构体
608
864
  */
609
- export interface DescribeCustomPersonsResponse {
610
- /**
611
- * 满足过滤条件的自定义人物数量
612
- */
613
- TotalCount: number
614
-
865
+ export interface UpdateCustomPersonResponse {
615
866
  /**
616
- * 自定义人物信息
867
+ * 成功更新的自定义人物Id
617
868
  */
618
- PersonInfoSet: Array<CustomPersonInfo>
869
+ PersonId: string
619
870
 
620
871
  /**
621
872
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
@@ -624,243 +875,300 @@ export interface DescribeCustomPersonsResponse {
624
875
  }
625
876
 
626
877
  /**
627
- * AddCustomPersonImage返回参数结构体
878
+ * UpdateCustomCategory请求参数结构体
628
879
  */
629
- export interface AddCustomPersonImageResponse {
880
+ export interface UpdateCustomCategoryRequest {
630
881
  /**
631
- * 自定义人物Id
882
+ * 自定义人物类型Id
632
883
  */
633
- PersonId: string
884
+ CategoryId: string
634
885
 
635
886
  /**
636
- * 自定义人脸图片信息
887
+ * 一级自定义人物类型
637
888
  */
638
- ImageInfo: PersonImageInfo
889
+ L1Category: string
639
890
 
640
891
  /**
641
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
892
+ * 二级自定义人物类型
642
893
  */
643
- RequestId?: string
894
+ L2Category?: string
644
895
  }
645
896
 
646
897
  /**
647
- * CreateDefaultCategories请求参数结构体
648
- */
649
- export type CreateDefaultCategoriesRequest = null
650
-
651
- /**
652
- * 任务筛选条件结构体
898
+ * CreateTask请求参数结构体
653
899
  */
654
- export interface TaskFilter {
900
+ export interface CreateTaskRequest {
655
901
  /**
656
- * 媒资文件类型
902
+ * 媒资文件ID,最长32B
657
903
  */
658
- MediaTypeSet?: Array<number>
904
+ MediaId: string
659
905
 
660
906
  /**
661
- * 待筛选的任务状态列表
907
+ * 媒资素材先验知识,相关限制参考MediaPreknownInfo
662
908
  */
663
- TaskStatusSet?: Array<number>
909
+ MediaPreknownInfo: MediaPreknownInfo
664
910
 
665
911
  /**
666
- * 待筛选的任务名称数组
912
+ * 任务名称,最长100个中文字符
667
913
  */
668
- TaskNameSet?: Array<string>
914
+ TaskName?: string
669
915
 
670
916
  /**
671
- * TaskId数组
917
+ * 是否上传转码后的视频,仅设置true时上传,默认为false
672
918
  */
673
- TaskIdSet?: Array<string>
919
+ UploadVideo?: boolean
674
920
 
675
921
  /**
676
- * 媒资文件名数组
922
+ * 自定义标签,可用于查询
677
923
  */
678
- MediaNameSet?: Array<string>
924
+ Label?: string
679
925
 
680
926
  /**
681
- * 媒资语言类型
927
+ * 任务分析完成的回调地址,该设置优先级高于控制台全局的设置;
682
928
  */
683
- MediaLangSet?: Array<number>
929
+ CallbackURL?: string
930
+ }
684
931
 
932
+ /**
933
+ * DescribeCustomCategories返回参数结构体
934
+ */
935
+ export interface DescribeCustomCategoriesResponse {
685
936
  /**
686
- * 媒资素材一级类型
937
+ * 自定义人物类型数组
687
938
  */
688
- MediaLabelSet?: Array<number>
939
+ CategorySet: Array<CustomCategory>
689
940
 
690
941
  /**
691
- * 媒资自定义标签数组
942
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
692
943
  */
693
- LabelSet?: Array<string>
944
+ RequestId?: string
694
945
  }
695
946
 
696
947
  /**
697
- * 关键词在文本中的定位信息
948
+ * DescribeCustomGroup返回参数结构体
949
+ */
950
+ export interface DescribeCustomGroupResponse {
951
+ /**
952
+ * 自定义人物库所包含的人物个数
953
+ */
954
+ GroupSize: number
698
955
 
699
- Position为关键词在文本中的偏移量,从0开始。例如,给定文本结果"欢迎收看新闻三十分”,以及关键词"新闻三十分",那么StartPosition的值为4,EndPosition的值为9
956
+ /**
957
+ * 自定义人物库图片后续所在的存储桶
958
+ */
959
+ Bucket: string
960
+
961
+ /**
962
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
963
+ */
964
+ RequestId?: string
965
+ }
966
+
967
+ /**
968
+ * 自定义人物人脸图片信息
700
969
  */
701
- export interface TextAppearInfo {
970
+ export interface PersonImageInfo {
702
971
  /**
703
- * 文本结果数组中的下标
972
+ * 人脸图片ID
704
973
  */
705
- Index: number
974
+ ImageId: string
706
975
 
707
976
  /**
708
- * 关键词在文本中出现的起始偏移量(包含)
977
+ * 自定义人脸图片的URL,存储在IVLDCustomPreson存储桶内
709
978
  */
710
- StartPosition: number
979
+ ImageURL: string
711
980
 
712
981
  /**
713
- * 关键词在文本中出现的结束偏移量(不包含)
982
+ * 自定义人脸图片处理错误码
714
983
  */
715
- EndPosition: number
984
+ ErrorCode: string
985
+
986
+ /**
987
+ * 自定义人脸图片处理错误信息
988
+ */
989
+ ErrorMsg: string
716
990
  }
717
991
 
718
992
  /**
719
- * DescribeMedia返回参数结构体
993
+ * 排序条件
720
994
  */
721
- export interface DescribeMediaResponse {
995
+ export interface SortBy {
722
996
  /**
723
- * 媒资信息
724
- 注意:此字段可能返回 null,表示取不到有效值。
725
- */
726
- MediaInfo: MediaInfo
997
+ * 排序字段,默认为CreateTime
998
+ */
999
+ By?: string
727
1000
 
728
1001
  /**
729
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1002
+ * true表示降序,false表示升序
730
1003
  */
731
- RequestId?: string
1004
+ Descend?: boolean
732
1005
  }
733
1006
 
734
1007
  /**
735
- * 自定义分类信息
1008
+ * DeleteCustomPersonImage请求参数结构体
736
1009
  */
737
- export interface CustomCategory {
1010
+ export interface DeleteCustomPersonImageRequest {
738
1011
  /**
739
- * 自定义分类ID
1012
+ * 自定义人物Id
740
1013
  */
741
- CategoryId: string
1014
+ PersonId: string
742
1015
 
743
1016
  /**
744
- * 一级自定义类型
1017
+ * 自定义人脸图片Id
745
1018
  */
746
- L1Category: string
1019
+ ImageId: string
1020
+ }
747
1021
 
1022
+ /**
1023
+ * DeleteMedia返回参数结构体
1024
+ */
1025
+ export interface DeleteMediaResponse {
748
1026
  /**
749
- * 二级自定义类型
1027
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
750
1028
  */
751
- L2Category: string
1029
+ RequestId?: string
752
1030
  }
753
1031
 
754
1032
  /**
755
- * 任务结果数据
1033
+ * 矩形内容框
756
1034
  */
757
- export interface Data {
1035
+ export interface Rectf {
758
1036
  /**
759
- * 节目粒度结构化结果
1037
+ * 矩形框左上角水平座标
760
1038
  注意:此字段可能返回 null,表示取不到有效值。
761
1039
  */
762
- ShowInfo: ShowInfo
1040
+ X: number
1041
+
1042
+ /**
1043
+ * 矩形框左上角竖直座标
1044
+ 注意:此字段可能返回 null,表示取不到有效值。
1045
+ */
1046
+ Y: number
1047
+
1048
+ /**
1049
+ * 矩形框宽度
1050
+ 注意:此字段可能返回 null,表示取不到有效值。
1051
+ */
1052
+ Width: number
1053
+
1054
+ /**
1055
+ * 矩形框长度
1056
+ 注意:此字段可能返回 null,表示取不到有效值。
1057
+ */
1058
+ Height: number
763
1059
  }
764
1060
 
765
1061
  /**
766
- * DeleteTask返回参数结构体
1062
+ * ModifyCallback请求参数结构体
767
1063
  */
768
- export interface DeleteTaskResponse {
1064
+ export interface ModifyCallbackRequest {
769
1065
  /**
770
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1066
+ * 任务分析完成后回调地址
771
1067
  */
772
- RequestId?: string
1068
+ TaskFinishNotifyURL: string
1069
+
1070
+ /**
1071
+ * 媒体导入完成后回调地址
1072
+ */
1073
+ MediaFinishNotifyURL: string
773
1074
  }
774
1075
 
775
1076
  /**
776
- * DescribeTask请求参数结构体
1077
+ * DeleteCustomPerson返回参数结构体
777
1078
  */
778
- export interface DescribeTaskRequest {
1079
+ export interface DeleteCustomPersonResponse {
779
1080
  /**
780
- * CreateTask返回的任务ID,最长32B
1081
+ * 已删除的自定义人物Id
781
1082
  */
782
- TaskId: string
1083
+ PersonId: string
1084
+
1085
+ /**
1086
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1087
+ */
1088
+ RequestId?: string
783
1089
  }
784
1090
 
785
1091
  /**
786
- * DescribeCustomPersonDetail请求参数结构体
1092
+ * DeleteTask请求参数结构体
787
1093
  */
788
- export interface DescribeCustomPersonDetailRequest {
1094
+ export interface DeleteTaskRequest {
789
1095
  /**
790
- * 自定义人物Id
1096
+ * 任务Id
791
1097
  */
792
- PersonId: string
1098
+ TaskId: string
793
1099
  }
794
1100
 
795
1101
  /**
796
- * 自定义人物信息
1102
+ * ImportMedia请求参数结构体
797
1103
  */
798
- export interface CustomPersonInfo {
1104
+ export interface ImportMediaRequest {
799
1105
  /**
800
- * 自定义人物Id
1106
+ * 待分析视频的URL,目前只支持*不带签名的*COS地址,长度最长1KB
801
1107
  */
802
- PersonId: string
1108
+ URL: string
803
1109
 
804
1110
  /**
805
- * 自定义人物姓名
1111
+ * 待分析视频的MD5,为空时不做校验,否则会做MD5校验,长度必须为32B
806
1112
  */
807
- Name: string
1113
+ MD5?: string
808
1114
 
809
1115
  /**
810
- * 自定义人物简介信息
1116
+ * 待分析视频的名称,指定后可支持筛选,最多64B
811
1117
  */
812
- BasicInfo: string
1118
+ Name?: string
813
1119
 
814
1120
  /**
815
- * 一级自定义人物类型
816
- */
817
- L1Category: string
1121
+ * 当非本人外部视频地址导入时,该字段为转存的cos桶地址且不可为空; 示例:https://${Bucket}-${AppId}.cos.${Region}.myqcloud.com/${PathPrefix}/ (注意,cos路径需要以/分隔符结尾)。
1122
+ 推荐采用本主帐号COS桶,如果使用其他帐号COS桶,请确保COS桶可写,否则可导致分析失败
1123
+ */
1124
+ WriteBackCosPath?: string
818
1125
 
819
1126
  /**
820
- * 二级自定义人物类型
1127
+ * 自定义标签,可用于查询
821
1128
  */
822
- L2Category: string
1129
+ Label?: string
823
1130
 
824
1131
  /**
825
- * 自定义人物图片信息
1132
+ * 媒资导入完成的回调地址,该设置优先级高于控制台全局的设置;
826
1133
  */
827
- ImageInfoSet: Array<PersonImageInfo>
1134
+ CallbackURL?: string
828
1135
 
829
1136
  /**
830
- * 自定义人物创建时间
831
- */
832
- CreateTime: string
1137
+ * 媒资文件类型,详细定义参见[MediaPreknownInfo.MediaType](https://cloud.tencent.com/document/product/1509/65063#MediaPreknownInfo)
1138
+ 默认为2(视频)
1139
+ */
1140
+ MediaType?: number
833
1141
  }
834
1142
 
835
1143
  /**
836
- * UpdateCustomPerson返回参数结构体
1144
+ * DescribeMedias请求参数结构体
837
1145
  */
838
- export interface UpdateCustomPersonResponse {
1146
+ export interface DescribeMediasRequest {
839
1147
  /**
840
- * 成功更新的自定义人物Id
1148
+ * 分页序号,从1开始
841
1149
  */
842
- PersonId: string
1150
+ PageNumber: number
843
1151
 
844
1152
  /**
845
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1153
+ * 每个分页所包含的元素数量,最大为50
846
1154
  */
847
- RequestId?: string
848
- }
1155
+ PageSize: number
849
1156
 
850
- /**
851
- * DescribeCustomGroup返回参数结构体
852
- */
853
- export interface DescribeCustomGroupResponse {
854
1157
  /**
855
- * 自定义人物库所包含的人物个数
1158
+ * 列举过滤条件,相关限制相见MediaFilter
856
1159
  */
857
- GroupSize: number
1160
+ MediaFilter?: MediaFilter
858
1161
 
859
1162
  /**
860
- * 自定义人物库图片后续所在的存储桶
1163
+ * 返回结果排序信息,By字段只支持CreateTime
861
1164
  */
862
- Bucket: string
1165
+ SortBy?: SortBy
1166
+ }
863
1167
 
1168
+ /**
1169
+ * CreateDefaultCategories返回参数结构体
1170
+ */
1171
+ export interface CreateDefaultCategoriesResponse {
864
1172
  /**
865
1173
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
866
1174
  */
@@ -868,13 +1176,20 @@ export interface DescribeCustomGroupResponse {
868
1176
  }
869
1177
 
870
1178
  /**
871
- * ModifyCallback返回参数结构体
1179
+ * 已分类的人物信息
872
1180
  */
873
- export interface ModifyCallbackResponse {
1181
+ export interface ClassifiedPersonInfo {
874
1182
  /**
875
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
876
- */
877
- RequestId?: string
1183
+ * 人物分类名称
1184
+ 注意:此字段可能返回 null,表示取不到有效值。
1185
+ */
1186
+ ClassifyName: string
1187
+
1188
+ /**
1189
+ * 符合特定分类的人物信息数组
1190
+ 注意:此字段可能返回 null,表示取不到有效值。
1191
+ */
1192
+ PersonInfoSet: Array<PersonInfo>
878
1193
  }
879
1194
 
880
1195
  /**
@@ -903,19 +1218,14 @@ export interface DescribeCustomPersonsRequest {
903
1218
  }
904
1219
 
905
1220
  /**
906
- * DescribeTasks返回参数结构体
1221
+ * DescribeMedia返回参数结构体
907
1222
  */
908
- export interface DescribeTasksResponse {
909
- /**
910
- * 满足过滤条件的任务总数量
911
- */
912
- TotalCount: number
913
-
1223
+ export interface DescribeMediaResponse {
914
1224
  /**
915
- * 满足过滤条件的任务数组
1225
+ * 媒资信息
916
1226
  注意:此字段可能返回 null,表示取不到有效值。
917
1227
  */
918
- TaskInfoSet: Array<TaskInfo>
1228
+ MediaInfo: MediaInfo
919
1229
 
920
1230
  /**
921
1231
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
@@ -924,53 +1234,65 @@ export interface DescribeTasksResponse {
924
1234
  }
925
1235
 
926
1236
  /**
927
- * 人物信息
1237
+ * 任务结果数据
928
1238
  */
929
- export interface PersonInfo {
1239
+ export interface Data {
930
1240
  /**
931
- * 公众人物姓名
932
- */
933
- Name: string
1241
+ * 节目粒度结构化结果
1242
+ 注意:此字段可能返回 null,表示取不到有效值。
1243
+ */
1244
+ ShowInfo: ShowInfo
1245
+ }
1246
+
1247
+ /**
1248
+ * 出现信息结构
1249
+
1250
+ 包含关键词在音频转文字(ASR),图片转文字(OCR)以及视频结果中的出现信息
934
1251
 
1252
+ */
1253
+ export interface AppearInfo {
935
1254
  /**
936
- * 公众人物职务
937
- */
938
- Job: string
1255
+ * 关键词在音频文本结果中的出现位置数组
1256
+ 注意:此字段可能返回 null,表示取不到有效值。
1257
+ */
1258
+ AudioAppearSet: Array<TextAppearInfo>
939
1259
 
940
1260
  /**
941
- * 首次出现模态,可选值为[1,3],详细参见AppearIndex定义
942
- */
943
- FirstAppear: number
1261
+ * 关键词在可视文本结果中的出现位置数组
1262
+ 注意:此字段可能返回 null,表示取不到有效值。
1263
+ */
1264
+ TextAppearSet: Array<TextAppearInfo>
944
1265
 
945
1266
  /**
946
- * 人物出现信息
947
- */
948
- AppearInfo: AppearInfo
1267
+ * 关键词在视频信息中的出现位置数组
1268
+ 注意:此字段可能返回 null,表示取不到有效值。
1269
+ */
1270
+ VideoAppearSet: Array<VideoAppearInfo>
949
1271
  }
950
1272
 
951
1273
  /**
952
- * 可视文本识别结果信息(OCR)
1274
+ * 人物信息
953
1275
  */
954
- export interface TextInfo {
1276
+ export interface PersonInfo {
955
1277
  /**
956
- * OCR提取的内容
1278
+ * 公众人物姓名
957
1279
  */
958
- Content: string
1280
+ Name: string
959
1281
 
960
1282
  /**
961
- * OCR起始时间戳,从0开始
1283
+ * 公众人物职务
962
1284
  */
963
- StartTimeStamp: number
1285
+ Job: string
964
1286
 
965
1287
  /**
966
- * OCR结束时间戳,从0开始
1288
+ * 首次出现模态,可选值为[1,3],详细参见AppearIndex定义
967
1289
  */
968
- EndTimeStamp: number
1290
+ FirstAppear: number
969
1291
 
970
1292
  /**
971
- * OCR标签信息
1293
+ * 人物出现信息
972
1294
  */
973
- Tag: string
1295
+ AppearInfo: AppearInfo
974
1296
  }
975
1297
 
976
1298
  /**
@@ -999,123 +1321,75 @@ export interface AudioInfo {
999
1321
  }
1000
1322
 
1001
1323
  /**
1002
- * 自定义人物批量查询过滤条件
1324
+ * 图片OCR识别结果
1003
1325
  */
1004
- export interface CustomPersonFilter {
1005
- /**
1006
- * 待查询的人物姓名
1007
- */
1008
- Name: string
1009
-
1010
- /**
1011
- * 待过滤的自定义类型Id数组
1012
- */
1013
- CategoryIdSet: Array<string>
1014
-
1326
+ export interface ImageOcr {
1015
1327
  /**
1016
- * 待过滤的自定义人物Id数组
1017
- */
1018
- PersonIdSet: Array<string>
1328
+ * 图片中可视文本识别结果
1329
+ 注意:此字段可能返回 null,表示取不到有效值。
1330
+ */
1331
+ Content: string
1019
1332
 
1020
1333
  /**
1021
- * 一级自定义人物类型数组
1022
- */
1023
- L1CategorySet: Array<string>
1334
+ * 可视文本在图片中的位置信息
1335
+ 注意:此字段可能返回 null,表示取不到有效值。
1336
+ */
1337
+ AppearRect: Rectf
1024
1338
  }
1025
1339
 
1026
1340
  /**
1027
- * CreateTask请求参数结构体
1341
+ * DeleteCustomPersonImage返回参数结构体
1028
1342
  */
1029
- export interface CreateTaskRequest {
1030
- /**
1031
- * 媒资文件ID,最长32B
1032
- */
1033
- MediaId: string
1034
-
1035
- /**
1036
- * 媒资素材先验知识,相关限制参考MediaPreknownInfo
1037
- */
1038
- MediaPreknownInfo: MediaPreknownInfo
1039
-
1040
- /**
1041
- * 任务名称,最长100个中文字符
1042
- */
1043
- TaskName?: string
1044
-
1343
+ export interface DeleteCustomPersonImageResponse {
1045
1344
  /**
1046
- * 是否上传转码后的视频,仅设置true时上传,默认为false
1345
+ * 自定义人物Id
1047
1346
  */
1048
- UploadVideo?: boolean
1347
+ PersonId: string
1049
1348
 
1050
1349
  /**
1051
- * 自定义标签,可用于查询
1350
+ * 已删除的人物图片Id
1052
1351
  */
1053
- Label?: string
1352
+ ImageId: string
1054
1353
 
1055
1354
  /**
1056
- * 任务分析完成的回调地址,该设置优先级高于控制台全局的设置;
1355
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1057
1356
  */
1058
- CallbackURL?: string
1357
+ RequestId?: string
1059
1358
  }
1060
1359
 
1061
1360
  /**
1062
- * 三级标签信息。
1063
-
1064
- 三级标签不再包含任何子标签。所有三级标签都对应着识别结果中的出现信息,出现信息使用AppearIndexPairSet定位。
1361
+ * 可视文本识别结果信息(OCR)
1065
1362
  */
1066
- export interface L3Tag {
1363
+ export interface TextInfo {
1067
1364
  /**
1068
- * 三级标签名
1365
+ * OCR提取的内容
1069
1366
  */
1070
- Name: string
1071
-
1072
- /**
1073
- * 三级标签出现信息索引数组
1074
- 注意:此字段可能返回 null,表示取不到有效值。
1075
- */
1076
- AppearIndexPairSet: Array<AppearIndexPair>
1077
-
1078
- /**
1079
- * 三级标签首次出现信息,可选值为[1,3]
1080
- 注意:此字段可能返回 null,表示取不到有效值。
1081
- */
1082
- FirstAppear: number
1083
- }
1367
+ Content: string
1084
1368
 
1085
- /**
1086
- * QueryCallback返回参数结构体
1087
- */
1088
- export interface QueryCallbackResponse {
1089
1369
  /**
1090
- * 任务分析完成后回调地址
1370
+ * OCR起始时间戳,从0开始
1091
1371
  */
1092
- TaskFinishNotifyURL: string
1372
+ StartTimeStamp: number
1093
1373
 
1094
1374
  /**
1095
- * 媒体导入完成后回调地址
1375
+ * OCR结束时间戳,从0开始
1096
1376
  */
1097
- MediaFinishNotifyURL: string
1377
+ EndTimeStamp: number
1098
1378
 
1099
1379
  /**
1100
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1380
+ * OCR标签信息
1101
1381
  */
1102
- RequestId?: string
1382
+ Tag: string
1103
1383
  }
1104
1384
 
1105
1385
  /**
1106
- * DescribeCustomPersonDetail返回参数结构体
1386
+ * CreateCustomCategory返回参数结构体
1107
1387
  */
1108
- export interface DescribeCustomPersonDetailResponse {
1388
+ export interface CreateCustomCategoryResponse {
1109
1389
  /**
1110
- * 自定义人物信息
1390
+ * 自定义分类信息ID
1111
1391
  */
1112
- PersonInfo: CustomPersonInfo
1113
-
1114
- /**
1115
- * 出现该自定义人物的所有分析人物Id
1116
- 注意:此字段可能返回 null,表示取不到有效值。
1117
- */
1118
- TaskIdSet: Array<string>
1392
+ CategoryId: string
1119
1393
 
1120
1394
  /**
1121
1395
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
@@ -1124,18 +1398,18 @@ export interface DescribeCustomPersonDetailResponse {
1124
1398
  }
1125
1399
 
1126
1400
  /**
1127
- * DeleteCustomPersonImage返回参数结构体
1401
+ * QueryCallback返回参数结构体
1128
1402
  */
1129
- export interface DeleteCustomPersonImageResponse {
1403
+ export interface QueryCallbackResponse {
1130
1404
  /**
1131
- * 自定义人物Id
1405
+ * 任务分析完成后回调地址
1132
1406
  */
1133
- PersonId: string
1407
+ TaskFinishNotifyURL: string
1134
1408
 
1135
1409
  /**
1136
- * 已删除的人物图片Id
1410
+ * 媒体导入完成后回调地址
1137
1411
  */
1138
- ImageId: string
1412
+ MediaFinishNotifyURL: string
1139
1413
 
1140
1414
  /**
1141
1415
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
@@ -1144,79 +1418,32 @@ export interface DeleteCustomPersonImageResponse {
1144
1418
  }
1145
1419
 
1146
1420
  /**
1147
- * 描述输入媒资的先验知识,例如文件类型(视频),媒体类型(新闻/综艺等)
1148
-
1149
- MediaPreknownInfo.MediaType:
1150
-
1151
- | MediaType 名称| MediaType取值 | MediaType描述 |
1152
- |---|---|---|
1153
- | MEDIA_TYPE_INVALID | 0 | 非法的媒资文件类型 |
1154
- | MEDIA_TYPE_IMAGE | 1 | 图片,当前不支持 |
1155
- | MEDIA_TYPE_VIDEO | 2 | 视频,当前只支持此类型媒资文件 |
1156
-
1157
- MediaPreknownInfo.MediaLabel:
1158
-
1159
- | MediaLabel名称 | MediaLabel取值 | MediaLabel描述 |
1160
- |---|---|---|
1161
- | MEDIA_LABEL_INVALID | 0 | 非法的一级媒资素材类型 |
1162
- | MEDIA_LABEL_NEWS | 1 | 新闻 |
1163
- | MEDIA_LABEL_ENTERTAINMENT | 2 | 综艺|
1164
- | MEDIA_LABEL_INTERNET_INFO | 3 | 互联网资讯 |
1165
- | MEDIA_LABEL_MOVIE | 4 | 电影 |
1166
- | MEDIA_LABEL_SERIES | 5 | 电视连续剧 |
1167
- | MEDIA_LABEL_SPECIAL | 6 | 专题 |
1168
- | MEDIA_LABEL_SPORT | 7 | 体育 |
1169
-
1170
- MediaPreknownInfo.MediaSecondLabel
1171
- 请注意:**当且仅当MediaLabel=2(综艺)时MediaSecondLabel才有意义**
1172
-
1173
- | MediaSecondLabel名称 | MediaSecondLabel取值 | MediaSecondLabel 描述|
1174
- |---|---|---|
1175
- | MEDIA_SECOND_LABEL_INVALID | 0 | 非法的MediaSecondLabel |
1176
- | MEDIA_SECOND_LABEL_EVENING | 1 | 综艺晚会 |
1177
- | MEDIA_SECOND_LABEL_OTHERS | 2 | 其他 |
1178
-
1179
- MediaMeta.MediaLang
1180
-
1181
- | MediaLang名称 | MediaLang取值 | MediaLang描述 |
1182
- |---|---|---|
1183
- | MEDIA_LANG_INVALID | 0 | 非法的MediaLang |
1184
- | MEDIA_LANG_MANDARIN | 1 | 普通话 |
1185
- | MEDIA_LANG_CANTONESE | 2 | 粤语 |
1421
+ * 带类型树的已分类人物信息
1186
1422
  */
1187
- export interface MediaPreknownInfo {
1423
+ export interface MultiLevelPersonInfo {
1188
1424
  /**
1189
- * 媒资文件类型,参见MediaPreknownInfo结构体定义
1190
- */
1191
- MediaType: number
1192
-
1193
- /**
1194
- * 媒资素材一级类型,参见MediaPreknownInfo结构体定义
1195
- */
1196
- MediaLabel: number
1425
+ * 一级分类名称(分类信息参见自定义人物类型)
1426
+ 注意:此字段可能返回 null,表示取不到有效值。
1427
+ */
1428
+ L1ClassifyName: string
1197
1429
 
1198
1430
  /**
1199
- * 媒资素材二级类型,参见MediaPreknownInfo结构体定义
1431
+ * 已分类人物信息数组(所有分类类型为二级分类)
1200
1432
  注意:此字段可能返回 null,表示取不到有效值。
1201
1433
  */
1202
- MediaSecondLabel: number
1434
+ L2ClassifiedPersonInfoSet: Array<ClassifiedPersonInfo>
1203
1435
 
1204
1436
  /**
1205
- * 媒资音频类型,参见MediaPreknownInfo结构体定义
1437
+ * 检测结果来源
1206
1438
  注意:此字段可能返回 null,表示取不到有效值。
1207
1439
  */
1208
- MediaLang?: number
1440
+ Source: number
1209
1441
  }
1210
1442
 
1211
1443
  /**
1212
- * DescribeCustomCategories返回参数结构体
1444
+ * CreateCustomGroup返回参数结构体
1213
1445
  */
1214
- export interface DescribeCustomCategoriesResponse {
1215
- /**
1216
- * 自定义人物类型数组
1217
- */
1218
- CategorySet: Array<CustomCategory>
1219
-
1446
+ export interface CreateCustomGroupResponse {
1220
1447
  /**
1221
1448
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1222
1449
  */
@@ -1224,11 +1451,11 @@ export interface DescribeCustomCategoriesResponse {
1224
1451
  }
1225
1452
 
1226
1453
  /**
1227
- * CreateCustomCategory返回参数结构体
1454
+ * UpdateCustomCategory返回参数结构体
1228
1455
  */
1229
- export interface CreateCustomCategoryResponse {
1456
+ export interface UpdateCustomCategoryResponse {
1230
1457
  /**
1231
- * 自定义分类信息ID
1458
+ * 成功更新的自定义人物类型Id
1232
1459
  */
1233
1460
  CategoryId: string
1234
1461
 
@@ -1239,18 +1466,19 @@ export interface CreateCustomCategoryResponse {
1239
1466
  }
1240
1467
 
1241
1468
  /**
1242
- * CreateCustomPerson返回参数结构体
1469
+ * DescribeMedias返回参数结构体
1243
1470
  */
1244
- export interface CreateCustomPersonResponse {
1471
+ export interface DescribeMediasResponse {
1245
1472
  /**
1246
- * 自定义人物Id
1473
+ * 满足过滤条件的媒资视频总数量
1247
1474
  */
1248
- PersonId: string
1475
+ TotalCount: number
1249
1476
 
1250
1477
  /**
1251
- * 自定义人脸信息
1252
- */
1253
- ImageInfo: PersonImageInfo
1478
+ * 满足过滤条件的媒资信息
1479
+ 注意:此字段可能返回 null,表示取不到有效值。
1480
+ */
1481
+ MediaInfoSet: Array<MediaInfo>
1254
1482
 
1255
1483
  /**
1256
1484
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
@@ -1259,64 +1487,138 @@ export interface CreateCustomPersonResponse {
1259
1487
  }
1260
1488
 
1261
1489
  /**
1262
- * 出现信息结构
1490
+ * 未知人物信息
1491
+ */
1492
+ export interface UnknownPerson {
1493
+ /**
1494
+ * 视觉出现信息
1495
+ 注意:此字段可能返回 null,表示取不到有效值。
1496
+ */
1497
+ VideoAppearSet: Array<VideoAppearInfo>
1263
1498
 
1264
- 包含关键词在音频转文字(ASR),图片转文字(OCR)以及视频结果中的出现信息
1499
+ /**
1500
+ * 未知人物是否可以入库(只有当未知人物人脸小图质量分符合要求时才可入库)
1501
+ 注意:此字段可能返回 null,表示取不到有效值。
1502
+ */
1503
+ PutLibraryAllowed: boolean
1504
+ }
1265
1505
 
1506
+ /**
1507
+ * 媒资文件视频元信息,包括分辨率,帧率,码率等
1266
1508
  */
1267
- export interface AppearInfo {
1509
+ export interface MediaMetadata {
1268
1510
  /**
1269
- * 关键词在音频文本结果中的出现位置数组
1511
+ * 媒资视频文件大小,单位为字节
1512
+ */
1513
+ FileSize: number
1514
+
1515
+ /**
1516
+ * 媒资视频文件MD5
1517
+ */
1518
+ MD5: string
1519
+
1520
+ /**
1521
+ * 媒资视频时长,单位为秒
1270
1522
  注意:此字段可能返回 null,表示取不到有效值。
1271
1523
  */
1272
- AudioAppearSet: Array<TextAppearInfo>
1524
+ Duration: number
1273
1525
 
1274
1526
  /**
1275
- * 关键词在可视文本结果中的出现位置数组
1527
+ * 媒资视频总帧数
1276
1528
  注意:此字段可能返回 null,表示取不到有效值。
1277
1529
  */
1278
- TextAppearSet: Array<TextAppearInfo>
1530
+ NumFrames: number
1279
1531
 
1280
1532
  /**
1281
- * 关键词在视频信息中的出现位置数组
1533
+ * 媒资视频宽度,单位为像素
1282
1534
  注意:此字段可能返回 null,表示取不到有效值。
1283
1535
  */
1284
- VideoAppearSet: Array<VideoAppearInfo>
1285
- }
1536
+ Width: number
1286
1537
 
1287
- /**
1288
- * UpdateCustomCategory请求参数结构体
1289
- */
1290
- export interface UpdateCustomCategoryRequest {
1291
1538
  /**
1292
- * 自定义人物类型Id
1293
- */
1294
- CategoryId: string
1539
+ * 媒资视频高度,单位为像素
1540
+ 注意:此字段可能返回 null,表示取不到有效值。
1541
+ */
1542
+ Height: number
1295
1543
 
1296
1544
  /**
1297
- * 一级自定义人物类型
1298
- */
1299
- L1Category: string
1545
+ * 媒资视频帧率,单位为Hz
1546
+ 注意:此字段可能返回 null,表示取不到有效值。
1547
+ */
1548
+ FPS: number
1300
1549
 
1301
1550
  /**
1302
- * 二级自定义人物类型
1551
+ * 媒资视频比特率,单位为kbps
1552
+ 注意:此字段可能返回 null,表示取不到有效值。
1553
+ */
1554
+ BitRate: number
1555
+ }
1556
+
1557
+ /**
1558
+ * DeleteCustomPerson请求参数结构体
1559
+ */
1560
+ export interface DeleteCustomPersonRequest {
1561
+ /**
1562
+ * 待删除的自定义人物ID
1303
1563
  */
1304
- L2Category?: string
1564
+ PersonId: string
1305
1565
  }
1306
1566
 
1307
1567
  /**
1308
- * DescribeCustomGroup请求参数结构体
1568
+ * 音频文件元信息
1309
1569
  */
1310
- export type DescribeCustomGroupRequest = null
1570
+ export interface AudioMetadata {
1571
+ /**
1572
+ * 媒资音频文件大小,单位为Byte
1573
+ 注意:此字段可能返回 null,表示取不到有效值。
1574
+ */
1575
+ FileSize: number
1576
+
1577
+ /**
1578
+ * 媒资音频文件MD5
1579
+ 注意:此字段可能返回 null,表示取不到有效值。
1580
+ */
1581
+ MD5: string
1582
+
1583
+ /**
1584
+ * 媒资音频时长,单位为秒
1585
+ 注意:此字段可能返回 null,表示取不到有效值。
1586
+ */
1587
+ Duration: number
1588
+
1589
+ /**
1590
+ * 媒资音频采样率,单位为khz
1591
+ 注意:此字段可能返回 null,表示取不到有效值。
1592
+ */
1593
+ SampleRate: number
1594
+
1595
+ /**
1596
+ * 媒资音频码率,单位为kbps
1597
+ 注意:此字段可能返回 null,表示取不到有效值。
1598
+ */
1599
+ BitRate: number
1600
+
1601
+ /**
1602
+ * 媒资音频文件格式
1603
+ 注意:此字段可能返回 null,表示取不到有效值。
1604
+ */
1605
+ Format: string
1606
+ }
1311
1607
 
1312
1608
  /**
1313
- * UpdateCustomCategory返回参数结构体
1609
+ * DescribeCustomPersonDetail返回参数结构体
1314
1610
  */
1315
- export interface UpdateCustomCategoryResponse {
1611
+ export interface DescribeCustomPersonDetailResponse {
1316
1612
  /**
1317
- * 成功更新的自定义人物类型Id
1613
+ * 自定义人物信息
1318
1614
  */
1319
- CategoryId: string
1615
+ PersonInfo: CustomPersonInfo
1616
+
1617
+ /**
1618
+ * 出现该自定义人物的所有分析人物Id
1619
+ 注意:此字段可能返回 null,表示取不到有效值。
1620
+ */
1621
+ TaskIdSet: Array<string>
1320
1622
 
1321
1623
  /**
1322
1624
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
@@ -1335,54 +1637,50 @@ export interface DeleteMediaRequest {
1335
1637
  }
1336
1638
 
1337
1639
  /**
1338
- * CreateCustomGroup返回参数结构体
1640
+ * CreateCustomCategory请求参数结构体
1339
1641
  */
1340
- export interface CreateCustomGroupResponse {
1642
+ export interface CreateCustomCategoryRequest {
1341
1643
  /**
1342
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1644
+ * 自定义一级类型
1343
1645
  */
1344
- RequestId?: string
1646
+ L1Category: string
1647
+
1648
+ /**
1649
+ * 自定义二级类型
1650
+ */
1651
+ L2Category: string
1345
1652
  }
1346
1653
 
1347
1654
  /**
1348
- * ImportMedia返回参数结构体
1655
+ * 关键词在视觉结果中的定位信息
1349
1656
  */
1350
- export interface ImportMediaResponse {
1657
+ export interface VideoAppearInfo {
1351
1658
  /**
1352
- * 媒资文件在系统中的ID
1659
+ * 视觉信息起始时间戳,从0开始
1353
1660
  */
1354
- MediaId: string
1661
+ StartTimeStamp: number
1355
1662
 
1356
1663
  /**
1357
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1358
- */
1359
- RequestId?: string
1360
- }
1664
+ * 视觉信息终止时间戳,从0开始
1665
+ 关键词在视觉信息中的区间为[StartTimeStamp, EndTimeStamp)
1666
+ */
1667
+ EndTimeStamp: number
1361
1668
 
1362
- /**
1363
- * DescribeTaskDetail请求参数结构体
1364
- */
1365
- export interface DescribeTaskDetailRequest {
1366
1669
  /**
1367
- * 创建任务返回的TaskId
1670
+ * 关键词在视觉信息中的封面图片
1368
1671
  */
1369
- TaskId: string
1672
+ ImageURL: string
1370
1673
  }
1371
1674
 
1372
1675
  /**
1373
- * DescribeMedias返回参数结构体
1676
+ * DescribeTask返回参数结构体
1374
1677
  */
1375
- export interface DescribeMediasResponse {
1376
- /**
1377
- * 满足过滤条件的媒资视频总数量
1378
- */
1379
- TotalCount: number
1380
-
1678
+ export interface DescribeTaskResponse {
1381
1679
  /**
1382
- * 满足过滤条件的媒资信息
1680
+ * 任务信息,详情参见TaskInfo的定义
1383
1681
  注意:此字段可能返回 null,表示取不到有效值。
1384
1682
  */
1385
- MediaInfoSet: Array<MediaInfo>
1683
+ TaskInfo: TaskInfo
1386
1684
 
1387
1685
  /**
1388
1686
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
@@ -1391,188 +1689,241 @@ export interface DescribeMediasResponse {
1391
1689
  }
1392
1690
 
1393
1691
  /**
1394
- * 媒资信息结构体
1692
+ * 出现信息索引对
1395
1693
 
1396
- 媒资状态定义如下:
1694
+ AppearIndex可选值定义如下:
1397
1695
 
1398
- | 状态名 | 状态值 | 状态描述 |
1696
+ | AppearIndex名称 | AppearIndex取值 | AppearIndex描述 |
1399
1697
  |---|---|---|
1400
- | MEDIA_STATUS_INVALID | 0 | 非法状态|
1401
- | MEDIA_STATUS_WAITING| 1 | 等待中 |
1402
- | MEDIA_STATUS_DOWNLOADING | 2 | 下载中 |
1403
- | MEDIA_STATUS_DOWNLOADED | 3 | 下载完成 |
1404
- | MEDIA_STATUS_DOWNLOAD_FAILED | 4 | 下载失败 |
1405
- | MEDIA_STATUS_TRANSCODING | 5 | 转码中 |
1406
- | MEDIA_STATUS_TRANSCODED | 6 | 转码完成 |
1407
- | MEDIA_STATUS_TRANCODE_FAILED | 7 | 转码失败 |
1408
- | MEDIA_STATUS_SUCCESS | 8 | 媒资文件状态就绪,可发起任务 |
1409
- | MEDIA_STATUS_EXPIRED | 9 | 媒资文件已过期 |
1698
+ | APPEAR_INDEX_INVALID | 0 | 非法的任务状态 |
1699
+ | APPEAR_INDEX_AUDIO | 1 | 音频出现信息|
1700
+ | APPEAR_INDEX_TEXT | 2 | 可视文本出现信息|
1701
+ | APPEAR_INDEX_VIDEO | 3 | 视频出现信息|
1410
1702
 
1703
+ 例如,当AppearIndex=1,Index=15,则意味着目标关键词出现在第16个(Index计数从0开始)音频文字识别结果之中
1411
1704
  */
1412
- export interface MediaInfo {
1705
+ export interface AppearIndexPair {
1413
1706
  /**
1414
- * 媒资ID
1707
+ * 出现信息,取值范围为[1,3]
1415
1708
  */
1416
- MediaId: string
1709
+ AppearIndex: number
1417
1710
 
1418
1711
  /**
1419
- * 媒资名称
1420
- 注意:此字段可能返回 null,表示取不到有效值。
1421
- */
1422
- Name: string
1712
+ * AppearInfo中AppearIndex对应元素的第Index元素,从0开始技术
1713
+ */
1714
+ Index: number
1715
+ }
1423
1716
 
1717
+ /**
1718
+ * CreateTask返回参数结构体
1719
+ */
1720
+ export interface CreateTaskResponse {
1424
1721
  /**
1425
- * 媒资下载地址
1426
- 注意:此字段可能返回 null,表示取不到有效值。
1427
- */
1428
- DownLoadURL: string
1722
+ * 智能标签视频分析任务ID
1723
+ */
1724
+ TaskId: string
1725
+
1726
+ /**
1727
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1728
+ */
1729
+ RequestId?: string
1730
+ }
1429
1731
 
1732
+ /**
1733
+ * DescribeCustomPersonDetail请求参数结构体
1734
+ */
1735
+ export interface DescribeCustomPersonDetailRequest {
1430
1736
  /**
1431
- * 媒资状态,取值参看上方表格
1432
- 注意:此字段可能返回 null,表示取不到有效值。
1433
- */
1434
- Status: number
1737
+ * 自定义人物Id
1738
+ */
1739
+ PersonId: string
1740
+ }
1435
1741
 
1742
+ /**
1743
+ * 图片文件标签结果
1744
+ */
1745
+ export interface ImageData {
1436
1746
  /**
1437
- * 若状态为失败,表示失败原因
1747
+ * 图片中出现的可视文本识别结果
1438
1748
  注意:此字段可能返回 null,表示取不到有效值。
1439
1749
  */
1440
- FailedReason: string
1750
+ OcrSet: Array<ImageOcr>
1441
1751
 
1442
1752
  /**
1443
- * 媒资视频元信息
1753
+ * 图片中出现的帧标签识别结果
1444
1754
  注意:此字段可能返回 null,表示取不到有效值。
1445
1755
  */
1446
- Metadata: MediaMetadata
1756
+ FrameTagSet: MultiLevelTag
1447
1757
 
1448
1758
  /**
1449
- * 导入视频进度,取值范围为[0,100]
1759
+ * 图片中出现的层级人物识别结果
1450
1760
  注意:此字段可能返回 null,表示取不到有效值。
1451
1761
  */
1452
- Progress: number
1762
+ MultiLevelPersonInfoSet: Array<MultiLevelPersonInfo>
1453
1763
 
1454
1764
  /**
1455
- * 媒资自定义标签
1765
+ * 图片中出现的台标识别结果
1456
1766
  注意:此字段可能返回 null,表示取不到有效值。
1457
1767
  */
1458
- Label: string
1768
+ TvLogo: ImageLogo
1459
1769
 
1460
1770
  /**
1461
- * 媒资导入完成后的回调地址
1771
+ * 图片中出现的来源信息识别结果
1462
1772
  注意:此字段可能返回 null,表示取不到有效值。
1463
1773
  */
1464
- CallbackURL: string
1774
+ SourceLogo: ImageLogo
1465
1775
  }
1466
1776
 
1467
1777
  /**
1468
- * QueryCallback请求参数结构体
1778
+ * DescribeTaskDetail请求参数结构体
1469
1779
  */
1470
- export type QueryCallbackRequest = null
1780
+ export interface DescribeTaskDetailRequest {
1781
+ /**
1782
+ * 创建任务返回的TaskId
1783
+ */
1784
+ TaskId: string
1785
+ }
1471
1786
 
1472
1787
  /**
1473
- * 排序条件
1788
+ * DeleteTask返回参数结构体
1474
1789
  */
1475
- export interface SortBy {
1790
+ export interface DeleteTaskResponse {
1476
1791
  /**
1477
- * 排序字段,默认为CreateTime
1792
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1478
1793
  */
1479
- By?: string
1794
+ RequestId?: string
1795
+ }
1480
1796
 
1797
+ /**
1798
+ * DescribeTask请求参数结构体
1799
+ */
1800
+ export interface DescribeTaskRequest {
1481
1801
  /**
1482
- * true表示降序,false表示升序
1802
+ * CreateTask返回的任务ID,最长32B
1483
1803
  */
1484
- Descend?: boolean
1804
+ TaskId: string
1485
1805
  }
1486
1806
 
1487
1807
  /**
1488
- * 媒资文件视频元信息,包括分辨率,帧率,码率等
1808
+ * UpdateCustomPerson请求参数结构体
1489
1809
  */
1490
- export interface MediaMetadata {
1810
+ export interface UpdateCustomPersonRequest {
1491
1811
  /**
1492
- * 媒资视频文件大小
1812
+ * 待更新的自定义人物Id
1493
1813
  */
1494
- FileSize: number
1814
+ PersonId: string
1495
1815
 
1496
1816
  /**
1497
- * 媒资视频文件MD5
1817
+ * 更新后的自定义人物名称,如为空则不更新
1498
1818
  */
1499
- MD5: string
1819
+ Name?: string
1500
1820
 
1501
1821
  /**
1502
- * 媒资视频时长,单位为秒
1503
- 注意:此字段可能返回 null,表示取不到有效值。
1504
- */
1505
- Duration: number
1822
+ * 更新后的自定义人物简介,如为空则不更新
1823
+ */
1824
+ BasicInfo?: string
1506
1825
 
1507
1826
  /**
1508
- * 媒资视频总帧数
1509
- 注意:此字段可能返回 null,表示取不到有效值。
1510
- */
1511
- NumFrames: number
1827
+ * 更新后的分类信息,如为空则不更新
1828
+ */
1829
+ CategoryId?: string
1830
+ }
1512
1831
 
1832
+ /**
1833
+ * 一级标签信息
1834
+
1835
+ 请注意,一级标签信息可能不包含二级标签(此时L2TagSet为空)。在这种情况下,一级标签可直接包含出现信息。
1836
+ */
1837
+ export interface L1Tag {
1513
1838
  /**
1514
- * 媒资视频宽度,单位为像素
1515
- 注意:此字段可能返回 null,表示取不到有效值。
1516
- */
1517
- Width: number
1839
+ * 一级标签名
1840
+ */
1841
+ Name: string
1518
1842
 
1519
1843
  /**
1520
- * 媒资视频高度,单位为像素
1844
+ * 二级标签数组
1521
1845
  注意:此字段可能返回 null,表示取不到有效值。
1522
1846
  */
1523
- Height: number
1847
+ L2TagSet: Array<L2Tag>
1524
1848
 
1525
1849
  /**
1526
- * 媒资视频帧率,单位为Hz
1850
+ * 一级标签出现信息
1527
1851
  注意:此字段可能返回 null,表示取不到有效值。
1528
1852
  */
1529
- FPS: number
1853
+ AppearIndexPairSet: Array<AppearIndexPair>
1530
1854
 
1531
1855
  /**
1532
- * 媒资视频比特率,单位为kbps
1856
+ * 一级标签首次出现信息
1533
1857
  注意:此字段可能返回 null,表示取不到有效值。
1534
1858
  */
1535
- BitRate: number
1859
+ FirstAppear: number
1536
1860
  }
1537
1861
 
1538
1862
  /**
1539
- * DeleteCustomPerson请求参数结构体
1863
+ * ModifyCallback返回参数结构体
1540
1864
  */
1541
- export interface DeleteCustomPersonRequest {
1865
+ export interface ModifyCallbackResponse {
1542
1866
  /**
1543
- * 待删除的自定义人物ID
1867
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1544
1868
  */
1545
- PersonId: string
1869
+ RequestId?: string
1546
1870
  }
1547
1871
 
1548
1872
  /**
1549
- * DeleteCustomCategory返回参数结构体
1873
+ * 图片中出现的Logo信息
1550
1874
  */
1551
- export interface DeleteCustomCategoryResponse {
1875
+ export interface ImageLogo {
1552
1876
  /**
1553
- * 123
1554
- */
1555
- CategoryId: string
1877
+ * 图片中出现的Logo识别结果
1878
+ 注意:此字段可能返回 null,表示取不到有效值。
1879
+ */
1880
+ Logo: string
1556
1881
 
1557
1882
  /**
1558
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1559
- */
1560
- RequestId?: string
1883
+ * Logo在图片中出现的位置
1884
+ 注意:此字段可能返回 null,表示取不到有效值。
1885
+ */
1886
+ AppearRect: Rectf
1561
1887
  }
1562
1888
 
1563
1889
  /**
1564
- * DeleteCustomPersonImage请求参数结构体
1890
+ * 三级标签信息。
1891
+
1892
+ 三级标签不再包含任何子标签。所有三级标签都对应着识别结果中的出现信息,出现信息使用AppearIndexPairSet定位。
1565
1893
  */
1566
- export interface DeleteCustomPersonImageRequest {
1894
+ export interface L3Tag {
1567
1895
  /**
1568
- * 自定义人物Id
1896
+ * 三级标签名
1569
1897
  */
1570
- PersonId: string
1898
+ Name: string
1571
1899
 
1572
1900
  /**
1573
- * 自定义人脸图片Id
1901
+ * 三级标签出现信息索引数组
1902
+ 注意:此字段可能返回 null,表示取不到有效值。
1903
+ */
1904
+ AppearIndexPairSet: Array<AppearIndexPair>
1905
+
1906
+ /**
1907
+ * 三级标签首次出现信息,可选值为[1,3]
1908
+ 注意:此字段可能返回 null,表示取不到有效值。
1909
+ */
1910
+ FirstAppear: number
1911
+ }
1912
+
1913
+ /**
1914
+ * 音频文件分析结果数据
1915
+ */
1916
+ export interface AudioData {
1917
+ /**
1918
+ * 音频识别文本结果
1919
+ 注意:此字段可能返回 null,表示取不到有效值。
1920
+ */
1921
+ AudioInfoSet: Array<AudioInfo>
1922
+
1923
+ /**
1924
+ * 音频识别标签数据
1574
1925
  */
1575
- ImageId: string
1926
+ TextTagSet: MultiLevelTag
1576
1927
  }
1577
1928
 
1578
1929
  /**
@@ -1606,94 +1957,119 @@ export interface CreateCustomPersonRequest {
1606
1957
  }
1607
1958
 
1608
1959
  /**
1609
- * 任务信息
1960
+ * 媒资信息结构体
1610
1961
 
1611
- TaskStatus定义如下:
1962
+ 媒资状态定义如下:
1612
1963
 
1613
- | TaskStatus名称 | TaskStatus取值 | TaskStatus描述 |
1964
+ | 状态名 | 状态值 | 状态描述 |
1614
1965
  |---|---|---|
1615
- | TASK_STATUS_INVALID | 0 | 非法的任务状态 |
1616
- | TASK_STATUS_WAITING | 1 | 排队中 |
1617
- | TASK_STATUS_ANALYSING | 2 | 任务分析中 |
1618
- | TASK_STATUS_ANALYSED | 3 | 任务分析完成 |
1619
- | TASK_STATUS_SNAPSHOT_CREATING | 4 | 任务结果快照生成中 |
1620
- | TASK_STATUS_SNAPSHOT_CREATED | 5 | 任务结果快照生成完成 |
1621
- | TASK_STATUS_RESULT_UPLOADING | 6 | 任务结果快照上传中 |
1622
- | TASK_STATUS_RESULT_UPLOADED | 7 | 任务结果快照上传完成 |
1623
- | TASK_STATUS_SUCCESS | 8 | 任务执行完成 |
1624
- | TASK_STATUS_FAILED | 9 | 任务执行失败 |
1966
+ | MEDIA_STATUS_INVALID | 0 | 非法状态|
1967
+ | MEDIA_STATUS_WAITING| 1 | 等待中 |
1968
+ | MEDIA_STATUS_DOWNLOADING | 2 | 下载中 |
1969
+ | MEDIA_STATUS_DOWNLOADED | 3 | 下载完成 |
1970
+ | MEDIA_STATUS_DOWNLOAD_FAILED | 4 | 下载失败 |
1971
+ | MEDIA_STATUS_TRANSCODING | 5 | 转码中 |
1972
+ | MEDIA_STATUS_TRANSCODED | 6 | 转码完成 |
1973
+ | MEDIA_STATUS_TRANCODE_FAILED | 7 | 转码失败 |
1974
+ | MEDIA_STATUS_SUCCESS | 8 | 媒资文件状态就绪,可发起任务 |
1975
+ | MEDIA_STATUS_EXPIRED | 9 | 媒资文件已过期 |
1976
+
1625
1977
  */
1626
- export interface TaskInfo {
1978
+ export interface MediaInfo {
1627
1979
  /**
1628
- * 任务ID
1980
+ * 媒资ID
1629
1981
  */
1630
- TaskId: string
1982
+ MediaId: string
1631
1983
 
1632
1984
  /**
1633
- * 描述任务名称,指定后可根据名称筛选
1985
+ * 媒资名称
1634
1986
  注意:此字段可能返回 null,表示取不到有效值。
1635
1987
  */
1636
- TaskName: string
1988
+ Name: string
1637
1989
 
1638
1990
  /**
1639
- * 媒资文件ID
1640
- */
1641
- MediaId: string
1991
+ * 媒资下载地址
1992
+ 注意:此字段可能返回 null,表示取不到有效值。
1993
+ */
1994
+ DownLoadURL: string
1642
1995
 
1643
1996
  /**
1644
- * 任务执行状态
1645
- */
1646
- TaskStatus: number
1997
+ * 媒资状态,取值参看上方表格
1998
+ 注意:此字段可能返回 null,表示取不到有效值。
1999
+ */
2000
+ Status: number
1647
2001
 
1648
2002
  /**
1649
- * 任务进度,范围为[0,100]
2003
+ * 若状态为失败,表示失败原因
1650
2004
  注意:此字段可能返回 null,表示取不到有效值。
1651
2005
  */
1652
- TaskProgress: number
2006
+ FailedReason: string
1653
2007
 
1654
2008
  /**
1655
- * 任务执行时间
2009
+ * 媒资视频元信息,仅在MediaType=VIDEO时有效
1656
2010
  注意:此字段可能返回 null,表示取不到有效值。
1657
2011
  */
1658
- TaskTimeCost: number
2012
+ Metadata: MediaMetadata
1659
2013
 
1660
2014
  /**
1661
- * 任务创建时间
1662
- */
1663
- TaskCreateTime: string
2015
+ * 导入视频进度,取值范围为[0,100]
2016
+ 注意:此字段可能返回 null,表示取不到有效值。
2017
+ */
2018
+ Progress: number
1664
2019
 
1665
2020
  /**
1666
- * 任务开始执行时间
2021
+ * 媒资自定义标签
1667
2022
  注意:此字段可能返回 null,表示取不到有效值。
1668
2023
  */
1669
- TaskStartTime: string
2024
+ Label: string
1670
2025
 
1671
2026
  /**
1672
- * 任务失败原因
2027
+ * 媒资导入完成后的回调地址
1673
2028
  注意:此字段可能返回 null,表示取不到有效值。
1674
2029
  */
1675
- FailedReason: string
2030
+ CallbackURL: string
1676
2031
 
1677
2032
  /**
1678
- * 任务执行时指定的先验知识
1679
- */
1680
- MediaPreknownInfo: MediaPreknownInfo
2033
+ * 媒资文件类型,具体参看[MediaPreknownInfo](https://cloud.tencent.com/document/product/1509/65063#MediaPreknownInfo)
2034
+ 注意:此字段可能返回 null,表示取不到有效值。
2035
+ */
2036
+ MediaType: number
1681
2037
 
1682
2038
  /**
1683
- * 媒资文件名称
2039
+ * 媒资音频元信息,仅在MediaType=Audio时有效
1684
2040
  注意:此字段可能返回 null,表示取不到有效值。
1685
2041
  */
1686
- MediaName: string
2042
+ AudioMetadata: AudioMetadata
1687
2043
 
1688
2044
  /**
1689
- * 媒资自定义标签
2045
+ * 媒资图片文件元信息,仅在MediaType=Image时有效
1690
2046
  注意:此字段可能返回 null,表示取不到有效值。
1691
2047
  */
1692
- Label: string
2048
+ ImageMetadata: ImageMetadata
1693
2049
 
1694
2050
  /**
1695
- * 任务分析完成后的后调地址
2051
+ * 媒资文本文件元信息,仅在MediaType=Text时有效
1696
2052
  注意:此字段可能返回 null,表示取不到有效值。
1697
2053
  */
1698
- CallbackURL: string
2054
+ TextMetadata: TextMetadata
2055
+ }
2056
+
2057
+ /**
2058
+ * DeleteCustomCategory返回参数结构体
2059
+ */
2060
+ export interface DeleteCustomCategoryResponse {
2061
+ /**
2062
+ * 123
2063
+ */
2064
+ CategoryId: string
2065
+
2066
+ /**
2067
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2068
+ */
2069
+ RequestId?: string
1699
2070
  }
2071
+
2072
+ /**
2073
+ * DescribeCustomGroup请求参数结构体
2074
+ */
2075
+ export type DescribeCustomGroupRequest = null