tencentcloud-sdk-nodejs 4.0.245 → 4.0.249

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 (148) hide show
  1. package/CHANGELOG.md +744 -35
  2. package/package.json +1 -1
  3. package/products.md +38 -35
  4. package/src/common/sdk_version.ts +1 -1
  5. package/src/services/ame/v20190916/ame_models.ts +5 -0
  6. package/src/services/antiddos/v20200309/antiddos_models.ts +6 -0
  7. package/src/services/apigateway/v20180808/apigateway_client.ts +1 -1
  8. package/src/services/apm/index.ts +5 -0
  9. package/src/services/apm/v20210622/apm_client.ts +70 -0
  10. package/src/services/apm/v20210622/apm_models.ts +306 -0
  11. package/src/services/apm/v20210622/index.ts +6 -0
  12. package/src/services/asw/v20200722/asw_models.ts +3 -3
  13. package/src/services/captcha/v20190722/captcha_models.ts +2 -1
  14. package/src/services/cdb/v20170320/cdb_models.ts +13 -3
  15. package/src/services/cfw/v20190904/cfw_models.ts +1 -1
  16. package/src/services/cii/v20210408/cii_models.ts +1 -1
  17. package/src/services/ckafka/v20190819/ckafka_models.ts +6 -0
  18. package/src/services/clb/v20180317/clb_client.ts +25 -1
  19. package/src/services/clb/v20180317/clb_models.ts +175 -18
  20. package/src/services/cme/v20191029/cme_client.ts +3 -3
  21. package/src/services/cme/v20191029/cme_models.ts +30 -25
  22. package/src/services/cr/v20180321/cr_models.ts +1 -1
  23. package/src/services/cwp/v20180228/cwp_models.ts +9 -8
  24. package/src/services/domain/v20180808/domain_models.ts +6 -1
  25. package/src/services/ecdn/v20191012/ecdn_client.ts +3 -0
  26. package/src/services/gaap/v20180529/gaap_models.ts +5 -0
  27. package/src/services/index.ts +3 -0
  28. package/src/services/iotvideo/v20201215/iotvideo_models.ts +11 -0
  29. package/src/services/iotvideoindustry/v20201201/iotvideoindustry_models.ts +31 -0
  30. package/src/services/ivld/index.ts +5 -0
  31. package/src/services/ivld/v20210903/index.ts +6 -0
  32. package/src/services/ivld/v20210903/ivld_client.ts +170 -0
  33. package/src/services/ivld/v20210903/ivld_models.ts +973 -0
  34. package/src/services/kms/v20190118/kms_client.ts +1 -1
  35. package/src/services/kms/v20190118/kms_models.ts +2 -2
  36. package/src/services/lighthouse/v20200324/lighthouse_client.ts +0 -1
  37. package/src/services/lighthouse/v20200324/lighthouse_models.ts +6 -35
  38. package/src/services/monitor/v20180724/monitor_models.ts +3 -3
  39. package/src/services/mrs/v20200910/mrs_client.ts +2 -0
  40. package/src/services/mrs/v20200910/mrs_models.ts +81 -5
  41. package/src/services/postgres/v20170312/postgres_models.ts +19 -7
  42. package/src/services/privatedns/v20201028/privatedns_client.ts +40 -3
  43. package/src/services/privatedns/v20201028/privatedns_models.ts +142 -32
  44. package/src/services/scf/v20180416/scf_client.ts +25 -12
  45. package/src/services/scf/v20180416/scf_models.ts +103 -1
  46. package/src/services/tat/v20201028/tat_models.ts +87 -11
  47. package/src/services/tdmq/v20200217/tdmq_client.ts +15 -2
  48. package/src/services/tdmq/v20200217/tdmq_models.ts +556 -146
  49. package/src/services/thpc/index.ts +5 -0
  50. package/src/services/thpc/v20211109/index.ts +6 -0
  51. package/src/services/thpc/v20211109/thpc_client.ts +64 -0
  52. package/src/services/thpc/v20211109/thpc_models.ts +332 -0
  53. package/src/services/tiw/v20190919/tiw_models.ts +2 -2
  54. package/src/services/tke/v20180525/tke_client.ts +50 -1
  55. package/src/services/tke/v20180525/tke_models.ts +158 -6
  56. package/src/services/tsf/v20180326/tsf_client.ts +13 -0
  57. package/src/services/tsf/v20180326/tsf_models.ts +85 -0
  58. package/src/services/vpc/v20170312/vpc_models.ts +2 -2
  59. package/src/services/waf/v20180125/waf_client.ts +1 -1
  60. package/src/services/waf/v20180125/waf_models.ts +26 -1
  61. package/tencentcloud/common/sdk_version.d.ts +1 -1
  62. package/tencentcloud/common/sdk_version.js +1 -1
  63. package/tencentcloud/services/ame/v20190916/ame_models.d.ts +4 -0
  64. package/tencentcloud/services/antiddos/v20200309/antiddos_models.d.ts +5 -0
  65. package/tencentcloud/services/apigateway/v20180808/apigateway_client.d.ts +1 -1
  66. package/tencentcloud/services/apigateway/v20180808/apigateway_client.js +1 -1
  67. package/tencentcloud/services/apm/index.d.ts +6 -0
  68. package/tencentcloud/services/apm/index.js +7 -0
  69. package/tencentcloud/services/apm/v20210622/apm_client.d.ts +22 -0
  70. package/tencentcloud/services/apm/v20210622/apm_client.js +49 -0
  71. package/tencentcloud/services/apm/v20210622/apm_models.d.ts +246 -0
  72. package/tencentcloud/services/apm/v20210622/apm_models.js +18 -0
  73. package/tencentcloud/services/apm/v20210622/index.d.ts +6 -0
  74. package/tencentcloud/services/apm/v20210622/index.js +9 -0
  75. package/tencentcloud/services/asw/v20200722/asw_models.d.ts +3 -3
  76. package/tencentcloud/services/captcha/v20190722/captcha_models.d.ts +1 -0
  77. package/tencentcloud/services/cdb/v20170320/cdb_models.d.ts +11 -3
  78. package/tencentcloud/services/cfw/v20190904/cfw_models.d.ts +1 -1
  79. package/tencentcloud/services/cii/v20210408/cii_models.d.ts +1 -1
  80. package/tencentcloud/services/ckafka/v20190819/ckafka_models.d.ts +5 -0
  81. package/tencentcloud/services/clb/v20180317/clb_client.d.ts +9 -1
  82. package/tencentcloud/services/clb/v20180317/clb_client.js +12 -0
  83. package/tencentcloud/services/clb/v20180317/clb_models.d.ts +145 -15
  84. package/tencentcloud/services/cme/v20191029/cme_client.d.ts +3 -3
  85. package/tencentcloud/services/cme/v20191029/cme_client.js +3 -3
  86. package/tencentcloud/services/cme/v20191029/cme_models.d.ts +29 -25
  87. package/tencentcloud/services/cr/v20180321/cr_models.d.ts +1 -1
  88. package/tencentcloud/services/cwp/v20180228/cwp_models.d.ts +9 -8
  89. package/tencentcloud/services/domain/v20180808/domain_models.d.ts +5 -1
  90. package/tencentcloud/services/ecdn/v20191012/ecdn_client.d.ts +3 -0
  91. package/tencentcloud/services/ecdn/v20191012/ecdn_client.js +3 -0
  92. package/tencentcloud/services/gaap/v20180529/gaap_models.d.ts +4 -0
  93. package/tencentcloud/services/index.d.ts +3 -0
  94. package/tencentcloud/services/index.js +6 -0
  95. package/tencentcloud/services/iotvideo/v20201215/iotvideo_models.d.ts +9 -0
  96. package/tencentcloud/services/iotvideoindustry/v20201201/iotvideoindustry_models.d.ts +26 -0
  97. package/tencentcloud/services/ivld/index.d.ts +6 -0
  98. package/tencentcloud/services/ivld/index.js +7 -0
  99. package/tencentcloud/services/ivld/v20210903/index.d.ts +6 -0
  100. package/tencentcloud/services/ivld/v20210903/index.js +9 -0
  101. package/tencentcloud/services/ivld/v20210903/ivld_client.d.ts +66 -0
  102. package/tencentcloud/services/ivld/v20210903/ivld_client.js +103 -0
  103. package/tencentcloud/services/ivld/v20210903/ivld_models.d.ts +831 -0
  104. package/tencentcloud/services/ivld/v20210903/ivld_models.js +18 -0
  105. package/tencentcloud/services/kms/v20190118/kms_client.d.ts +1 -1
  106. package/tencentcloud/services/kms/v20190118/kms_client.js +1 -1
  107. package/tencentcloud/services/kms/v20190118/kms_models.d.ts +2 -2
  108. package/tencentcloud/services/lighthouse/v20200324/lighthouse_models.d.ts +6 -29
  109. package/tencentcloud/services/monitor/v20180724/monitor_models.d.ts +3 -3
  110. package/tencentcloud/services/mrs/v20200910/mrs_models.d.ts +70 -5
  111. package/tencentcloud/services/postgres/v20170312/postgres_models.d.ts +17 -7
  112. package/tencentcloud/services/privatedns/v20201028/privatedns_client.d.ts +13 -1
  113. package/tencentcloud/services/privatedns/v20201028/privatedns_client.js +18 -0
  114. package/tencentcloud/services/privatedns/v20201028/privatedns_models.d.ts +124 -29
  115. package/tencentcloud/services/scf/v20180416/scf_client.d.ts +9 -5
  116. package/tencentcloud/services/scf/v20180416/scf_client.js +12 -6
  117. package/tencentcloud/services/scf/v20180416/scf_models.d.ts +86 -1
  118. package/tencentcloud/services/tat/v20201028/tat_models.d.ts +75 -11
  119. package/tencentcloud/services/tdmq/v20200217/tdmq_client.d.ts +5 -1
  120. package/tencentcloud/services/tdmq/v20200217/tdmq_client.js +6 -0
  121. package/tencentcloud/services/tdmq/v20200217/tdmq_models.d.ts +434 -94
  122. package/tencentcloud/services/thpc/index.d.ts +6 -0
  123. package/tencentcloud/services/thpc/index.js +7 -0
  124. package/tencentcloud/services/thpc/v20211109/index.d.ts +6 -0
  125. package/tencentcloud/services/thpc/v20211109/index.js +9 -0
  126. package/tencentcloud/services/thpc/v20211109/thpc_client.d.ts +18 -0
  127. package/tencentcloud/services/thpc/v20211109/thpc_client.js +43 -0
  128. package/tencentcloud/services/thpc/v20211109/thpc_models.d.ts +272 -0
  129. package/tencentcloud/services/thpc/v20211109/thpc_models.js +18 -0
  130. package/tencentcloud/services/tiw/v20190919/tiw_models.d.ts +2 -2
  131. package/tencentcloud/services/tke/v20180525/tke_client.d.ts +17 -1
  132. package/tencentcloud/services/tke/v20180525/tke_client.js +24 -0
  133. package/tencentcloud/services/tke/v20180525/tke_models.d.ts +136 -5
  134. package/tencentcloud/services/tsf/v20180326/tsf_client.d.ts +5 -1
  135. package/tencentcloud/services/tsf/v20180326/tsf_client.js +6 -0
  136. package/tencentcloud/services/tsf/v20180326/tsf_models.d.ts +73 -0
  137. package/tencentcloud/services/vpc/v20170312/vpc_models.d.ts +2 -2
  138. package/tencentcloud/services/waf/v20180125/waf_client.d.ts +1 -1
  139. package/tencentcloud/services/waf/v20180125/waf_models.d.ts +22 -1
  140. package/test/apm.v20210622.test.js +51 -0
  141. package/test/clb.v20180317.test.js +20 -0
  142. package/test/ivld.v20210903.test.js +101 -0
  143. package/test/privatedns.v20201028.test.js +30 -0
  144. package/test/scf.v20180416.test.js +14 -4
  145. package/test/tdmq.v20200217.test.js +10 -0
  146. package/test/thpc.v20211109.test.js +41 -0
  147. package/test/tke.v20180525.test.js +40 -0
  148. package/test/tsf.v20180326.test.js +10 -0
@@ -0,0 +1,973 @@
1
+ /*
2
+ * Copyright (c) 2018 THL A29 Limited, a Tencent company. All Rights Reserved.
3
+ *
4
+ * Licensed under the Apache License, Version 2.0 (the "License");
5
+ * you may not use this file except in compliance with the License.
6
+ * You may obtain a copy of the License at
7
+ *
8
+ * http://www.apache.org/licenses/LICENSE-2.0
9
+ *
10
+ * Unless required by applicable law or agreed to in writing,
11
+ * software distributed under the License is distributed on an
12
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
13
+ * KIND, either express or implied. See the License for the
14
+ * specific language governing permissions and limitations
15
+ * under the License.
16
+ */
17
+
18
+ /**
19
+ * DeleteMedia返回参数结构体
20
+ */
21
+ export interface DeleteMediaResponse {
22
+ /**
23
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
24
+ */
25
+ RequestId?: string
26
+ }
27
+
28
+ /**
29
+ * 视频结构化结果
30
+ */
31
+ export interface ShowInfo {
32
+ /**
33
+ * 节目日期(只在新闻有效)
34
+ 注意:此字段可能返回 null,表示取不到有效值。
35
+ */
36
+ Date: string
37
+
38
+ /**
39
+ * 台标
40
+ 注意:此字段可能返回 null,表示取不到有效值。
41
+ */
42
+ Logo: string
43
+
44
+ /**
45
+ * 节目名称
46
+ 注意:此字段可能返回 null,表示取不到有效值。
47
+ */
48
+ Column: string
49
+
50
+ /**
51
+ * 来源信息
52
+ 注意:此字段可能返回 null,表示取不到有效值。
53
+ */
54
+ Source: string
55
+
56
+ /**
57
+ * 节目封面
58
+ 注意:此字段可能返回 null,表示取不到有效值。
59
+ */
60
+ CoverImageURL: string
61
+
62
+ /**
63
+ * 节目内容概要列表
64
+ 注意:此字段可能返回 null,表示取不到有效值。
65
+ */
66
+ SummarySet: Array<string>
67
+
68
+ /**
69
+ * 节目片段标题列表
70
+ 注意:此字段可能返回 null,表示取不到有效值。
71
+ */
72
+ TitleSet: Array<string>
73
+
74
+ /**
75
+ * 音频识别结果列表
76
+ 注意:此字段可能返回 null,表示取不到有效值。
77
+ */
78
+ AudioInfoSet: Array<AudioInfo>
79
+
80
+ /**
81
+ * 可视文字识别结果列表
82
+ 注意:此字段可能返回 null,表示取不到有效值。
83
+ */
84
+ TextInfoSet: Array<TextInfo>
85
+
86
+ /**
87
+ * 文本标签列表,包含标签内容和出现信息
88
+ 注意:此字段可能返回 null,表示取不到有效值。
89
+ */
90
+ TextTagSet: MultiLevelTag
91
+
92
+ /**
93
+ * 帧标签列表,包括人物信息,场景信息等
94
+ 注意:此字段可能返回 null,表示取不到有效值。
95
+ */
96
+ FrameTagSet: MultiLevelTag
97
+
98
+ /**
99
+ * 视频下载地址
100
+ 注意:此字段可能返回 null,表示取不到有效值。
101
+ */
102
+ WebMediaURL: string
103
+
104
+ /**
105
+ * 媒资分类信息
106
+ 注意:此字段可能返回 null,表示取不到有效值。
107
+ */
108
+ MediaClassifierSet: Array<string>
109
+
110
+ /**
111
+ * 概要标签信息
112
+ 注意:此字段可能返回 null,表示取不到有效值。
113
+ */
114
+ SummaryTagSet: Array<string>
115
+ }
116
+
117
+ /**
118
+ * 标签信息结构体
119
+
120
+ 包含多级(最多三级)标签结果,以及这些标签在识别结果中的出现位置
121
+ */
122
+ export interface MultiLevelTag {
123
+ /**
124
+ * 树状标签信息
125
+ 注意:此字段可能返回 null,表示取不到有效值。
126
+ */
127
+ TagSet: Array<L1Tag>
128
+
129
+ /**
130
+ * 标签在识别结果中的定位信息
131
+ 注意:此字段可能返回 null,表示取不到有效值。
132
+ */
133
+ AppearInfo: AppearInfo
134
+ }
135
+
136
+ /**
137
+ * DescribeTasks请求参数结构体
138
+ */
139
+ export interface DescribeTasksRequest {
140
+ /**
141
+ * 分页序号,从1开始
142
+ */
143
+ PageNumber?: number
144
+
145
+ /**
146
+ * 每个分页所包含的元素数量,最大为50
147
+ */
148
+ PageSize?: number
149
+
150
+ /**
151
+ * 任务过滤条件,相关限制参见TaskFilter
152
+ */
153
+ TaskFilter?: TaskFilter
154
+
155
+ /**
156
+ * 返回结果排序信息,By字段只支持CreateTimeStamp
157
+ */
158
+ SortBy?: SortBy
159
+ }
160
+
161
+ /**
162
+ * 二级标签信息
163
+
164
+ 请注意,二级标签信息可能不包含三级标签(此时L3TagSet为空)。
165
+
166
+ */
167
+ export interface L2Tag {
168
+ /**
169
+ * 二级标签名
170
+ */
171
+ Name: string
172
+
173
+ /**
174
+ * 从属于此二级标签的三级标签数组
175
+ 注意:此字段可能返回 null,表示取不到有效值。
176
+ */
177
+ L3TagSet: Array<L3Tag>
178
+
179
+ /**
180
+ * 二级标签出现信息
181
+ 注意:此字段可能返回 null,表示取不到有效值。
182
+ */
183
+ AppearIndexPairSet: Array<AppearIndexPair>
184
+
185
+ /**
186
+ * 二级标签首次出现信息
187
+ 注意:此字段可能返回 null,表示取不到有效值。
188
+ */
189
+ FirstAppear: number
190
+ }
191
+
192
+ /**
193
+ * ImportMedia请求参数结构体
194
+ */
195
+ export interface ImportMediaRequest {
196
+ /**
197
+ * 待分析视频的URL,目前只支持*不带签名的*COS地址,长度最长1KB
198
+ */
199
+ URL: string
200
+
201
+ /**
202
+ * 待分析视频的MD5,为空时不做校验,否则会做MD5校验,长度必须为32B
203
+ */
204
+ MD5?: string
205
+
206
+ /**
207
+ * 待分析视频的名称,指定后可支持筛选,最多100个中文字符
208
+ */
209
+ Name?: string
210
+ }
211
+
212
+ /**
213
+ * DescribeMedias请求参数结构体
214
+ */
215
+ export interface DescribeMediasRequest {
216
+ /**
217
+ * 分页序号,从1开始
218
+ */
219
+ PageNumber: number
220
+
221
+ /**
222
+ * 每个分页所包含的元素数量,最大为50
223
+ */
224
+ PageSize: number
225
+
226
+ /**
227
+ * 列举过滤条件,相关限制相见MediaFilter
228
+ */
229
+ MediaFilter?: MediaFilter
230
+
231
+ /**
232
+ * 返回结果排序信息,By字段只支持CreateTime
233
+ */
234
+ SortBy?: SortBy
235
+ }
236
+
237
+ /**
238
+ * 关键词在视觉结果中的定位信息
239
+ */
240
+ export interface VideoAppearInfo {
241
+ /**
242
+ * 视觉信息起始时间戳,从0开始
243
+ */
244
+ StartTimeStamp: number
245
+
246
+ /**
247
+ * 视觉信息终止时间戳,从0开始
248
+ 关键词在视觉信息中的区间为[StartTimeStamp, EndTimeStamp)
249
+ */
250
+ EndTimeStamp: number
251
+
252
+ /**
253
+ * 关键词在视觉信息中的封面图片
254
+ */
255
+ ImageURL: string
256
+ }
257
+
258
+ /**
259
+ * 可视文本识别结果信息(OCR)
260
+ */
261
+ export interface TextInfo {
262
+ /**
263
+ * OCR提取的内容
264
+ */
265
+ Content: string
266
+
267
+ /**
268
+ * OCR起始时间戳,从0开始
269
+ */
270
+ StartTimeStamp: number
271
+
272
+ /**
273
+ * OCR结束时间戳,从0开始
274
+ */
275
+ EndTimeStamp: number
276
+
277
+ /**
278
+ * OCR标签信息
279
+ */
280
+ Tag: string
281
+ }
282
+
283
+ /**
284
+ * DescribeTask返回参数结构体
285
+ */
286
+ export interface DescribeTaskResponse {
287
+ /**
288
+ * 任务信息,详情参见TaskInfo的定义
289
+ 注意:此字段可能返回 null,表示取不到有效值。
290
+ */
291
+ TaskInfo: TaskInfo
292
+
293
+ /**
294
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
295
+ */
296
+ RequestId?: string
297
+ }
298
+
299
+ /**
300
+ * 出现信息索引对
301
+
302
+ AppearIndex可选值定义如下:
303
+
304
+ | AppearIndex名称 | AppearIndex取值 | AppearIndex描述 |
305
+ |---|---|---|
306
+ | APPEAR_INDEX_INVALID | 0 | 非法的任务状态 |
307
+ | APPEAR_INDEX_AUDIO | 1 | 音频出现信息|
308
+ | APPEAR_INDEX_TEXT | 2 | 可视文本出现信息|
309
+ | APPEAR_INDEX_VIDEO | 3 | 视频出现信息|
310
+
311
+ 例如,当AppearIndex=1,Index=15,则意味着目标关键词出现在第16个(Index计数从0开始)音频文字识别结果之中
312
+ */
313
+ export interface AppearIndexPair {
314
+ /**
315
+ * 出现信息,取值范围为[1,3]
316
+ */
317
+ AppearIndex: number
318
+
319
+ /**
320
+ * AppearInfo中AppearIndex对应元素的第Index元素,从0开始技术
321
+ */
322
+ Index: number
323
+ }
324
+
325
+ /**
326
+ * DescribeTaskDetail返回参数结构体
327
+ */
328
+ export interface DescribeTaskDetailResponse {
329
+ /**
330
+ * 任务信息,不包含任务结果
331
+ */
332
+ TaskInfo: TaskInfo
333
+
334
+ /**
335
+ * 任务结果数据,只在任务结束时返回
336
+ */
337
+ TaskData: Data
338
+
339
+ /**
340
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
341
+ */
342
+ RequestId?: string
343
+ }
344
+
345
+ /**
346
+ * CreateTask返回参数结构体
347
+ */
348
+ export interface CreateTaskResponse {
349
+ /**
350
+ * 智能标签视频分析任务ID
351
+ */
352
+ TaskId: string
353
+
354
+ /**
355
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
356
+ */
357
+ RequestId?: string
358
+ }
359
+
360
+ /**
361
+ * DescribeTaskDetail请求参数结构体
362
+ */
363
+ export interface DescribeTaskDetailRequest {
364
+ /**
365
+ * 创建任务返回的TaskId
366
+ */
367
+ TaskId: string
368
+ }
369
+
370
+ /**
371
+ * 任务筛选条件结构体
372
+ */
373
+ export interface TaskFilter {
374
+ /**
375
+ * 媒资文件类型
376
+ */
377
+ MediaTypeSet?: Array<number>
378
+
379
+ /**
380
+ * 待筛选的任务状态列表
381
+ */
382
+ TaskStatusSet?: Array<number>
383
+
384
+ /**
385
+ * 待筛选的任务名称数组
386
+ */
387
+ TaskNameSet?: Array<string>
388
+
389
+ /**
390
+ * TaskId数组
391
+ */
392
+ TaskIdSet?: Array<string>
393
+
394
+ /**
395
+ * 媒资文件名数组
396
+ */
397
+ MediaNameSet?: Array<string>
398
+
399
+ /**
400
+ * 媒资语言类型
401
+ */
402
+ MediaLangSet?: Array<number>
403
+
404
+ /**
405
+ * 媒资素材一级类型
406
+ */
407
+ MediaLabelSet?: Array<number>
408
+ }
409
+
410
+ /**
411
+ * 关键词在文本中的定位信息
412
+
413
+ Position为关键词在文本中的偏移量,从0开始。例如,给定文本结果"欢迎收看新闻三十分”,以及关键词"新闻三十分",那么StartPosition的值为4,EndPosition的值为9
414
+ */
415
+ export interface TextAppearInfo {
416
+ /**
417
+ * 文本结果数组中的下标
418
+ */
419
+ Index: number
420
+
421
+ /**
422
+ * 关键词在文本中出现的起始偏移量(包含)
423
+ */
424
+ StartPosition: number
425
+
426
+ /**
427
+ * 关键词在文本中出现的结束偏移量(不包含)
428
+ */
429
+ EndPosition: number
430
+ }
431
+
432
+ /**
433
+ * DescribeMedia返回参数结构体
434
+ */
435
+ export interface DescribeMediaResponse {
436
+ /**
437
+ * 媒资信息
438
+ 注意:此字段可能返回 null,表示取不到有效值。
439
+ */
440
+ MediaInfo: MediaInfo
441
+
442
+ /**
443
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
444
+ */
445
+ RequestId?: string
446
+ }
447
+
448
+ /**
449
+ * 任务结果数据
450
+ */
451
+ export interface Data {
452
+ /**
453
+ * 节目粒度结构化结果
454
+ 注意:此字段可能返回 null,表示取不到有效值。
455
+ */
456
+ ShowInfo: ShowInfo
457
+ }
458
+
459
+ /**
460
+ * DescribeTask请求参数结构体
461
+ */
462
+ export interface DescribeTaskRequest {
463
+ /**
464
+ * CreateTask返回的任务ID,最长32B
465
+ */
466
+ TaskId: string
467
+ }
468
+
469
+ /**
470
+ * 一级标签信息
471
+
472
+ 请注意,一级标签信息可能不包含二级标签(此时L2TagSet为空)。在这种情况下,一级标签可直接包含出现信息。
473
+ */
474
+ export interface L1Tag {
475
+ /**
476
+ * 一级标签名
477
+ */
478
+ Name: string
479
+
480
+ /**
481
+ * 二级标签数组
482
+ 注意:此字段可能返回 null,表示取不到有效值。
483
+ */
484
+ L2TagSet: Array<L2Tag>
485
+
486
+ /**
487
+ * 一级标签出现信息
488
+ 注意:此字段可能返回 null,表示取不到有效值。
489
+ */
490
+ AppearIndexPairSet: Array<AppearIndexPair>
491
+
492
+ /**
493
+ * 一级标签首次出现信息
494
+ 注意:此字段可能返回 null,表示取不到有效值。
495
+ */
496
+ FirstAppear: number
497
+ }
498
+
499
+ /**
500
+ * DescribeTasks返回参数结构体
501
+ */
502
+ export interface DescribeTasksResponse {
503
+ /**
504
+ * 满足过滤条件的任务总数量
505
+ */
506
+ TotalCount: number
507
+
508
+ /**
509
+ * 满足过滤条件的任务数组
510
+ 注意:此字段可能返回 null,表示取不到有效值。
511
+ */
512
+ TaskInfoSet: Array<TaskInfo>
513
+
514
+ /**
515
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
516
+ */
517
+ RequestId?: string
518
+ }
519
+
520
+ /**
521
+ * 音频识别结果信息
522
+ */
523
+ export interface AudioInfo {
524
+ /**
525
+ * ASR提取的文字信息
526
+ */
527
+ Content: string
528
+
529
+ /**
530
+ * ASR起始时间戳,从0开始
531
+ */
532
+ StartTimeStamp: number
533
+
534
+ /**
535
+ * ASR结束时间戳,从0开始
536
+ */
537
+ EndTimeStamp: number
538
+
539
+ /**
540
+ * ASR提取的音频标签
541
+ */
542
+ Tag: string
543
+ }
544
+
545
+ /**
546
+ * CreateTask请求参数结构体
547
+ */
548
+ export interface CreateTaskRequest {
549
+ /**
550
+ * 媒资文件ID,最长32B
551
+ */
552
+ MediaId: string
553
+
554
+ /**
555
+ * 媒资素材先验知识,相关限制参考MediaPreknownInfo
556
+ */
557
+ MediaPreknownInfo: MediaPreknownInfo
558
+
559
+ /**
560
+ * 任务名称,最长100个中文字符
561
+ */
562
+ TaskName?: string
563
+
564
+ /**
565
+ * 是否上传转码后的视频,仅设置true时上传,默认为false
566
+ */
567
+ UploadVideo?: boolean
568
+ }
569
+
570
+ /**
571
+ * 三级标签信息。
572
+
573
+ 三级标签不再包含任何子标签。所有三级标签都对应着识别结果中的出现信息,出现信息使用AppearIndexPairSet定位。
574
+ */
575
+ export interface L3Tag {
576
+ /**
577
+ * 三级标签名
578
+ */
579
+ Name: string
580
+
581
+ /**
582
+ * 三级标签出现信息索引数组
583
+ 注意:此字段可能返回 null,表示取不到有效值。
584
+ */
585
+ AppearIndexPairSet: Array<AppearIndexPair>
586
+
587
+ /**
588
+ * 三级标签首次出现信息,可选值为[1,3]
589
+ 注意:此字段可能返回 null,表示取不到有效值。
590
+ */
591
+ FirstAppear: number
592
+ }
593
+
594
+ /**
595
+ * 媒资过滤条件
596
+
597
+
598
+ */
599
+ export interface MediaFilter {
600
+ /**
601
+ * 媒资名称过滤条件
602
+ 注意:此字段可能返回 null,表示取不到有效值。
603
+ */
604
+ MediaNameSet?: Array<string>
605
+
606
+ /**
607
+ * 媒资状态数组,媒资状态可选值参见MediaInfo
608
+ 注意:此字段可能返回 null,表示取不到有效值。
609
+ */
610
+ StatusSet?: Array<number>
611
+
612
+ /**
613
+ * 媒资ID数组
614
+ 注意:此字段可能返回 null,表示取不到有效值。
615
+ */
616
+ MediaIdSet?: Array<string>
617
+ }
618
+
619
+ /**
620
+ * 描述输入媒资的先验知识,例如文件类型(视频),媒体类型(新闻/综艺等)
621
+
622
+ MediaPreknownInfo.MediaType:
623
+
624
+ | MediaType 名称| MediaType取值 | MediaType描述 |
625
+ |---|---|---|
626
+ | MEDIA_TYPE_INVALID | 0 | 非法的媒资文件类型 |
627
+ | MEDIA_TYPE_IMAGE | 1 | 图片,当前不支持 |
628
+ | MEDIA_TYPE_VIDEO | 2 | 视频,当前只支持此类型媒资文件 |
629
+
630
+ MediaPreknownInfo.MediaLabel:
631
+
632
+ | MediaLabel名称 | MediaLabel取值 | MediaLabel描述 |
633
+ |---|---|---|
634
+ | MEDIA_LABEL_INVALID | 0 | 非法的一级媒资素材类型 |
635
+ | MEDIA_LABEL_NEWS | 1 | 新闻 |
636
+ | MEDIA_LABEL_ENTERTAINMENT | 2 | 综艺|
637
+ | MEDIA_LABEL_INTERNET_INFO | 3 | 互联网资讯 |
638
+ | MEDIA_LABEL_MOVIE | 4 | 电影 |
639
+ | MEDIA_LABEL_SERIES | 5 | 电视连续剧 |
640
+ | MEDIA_LABEL_SPECIAL | 6 | 专题 |
641
+ | MEDIA_LABEL_SPORT | 7 | 体育 |
642
+
643
+ MediaPreknownInfo.MediaSecondLabel
644
+ 请注意:**当且仅当MediaLabel=2(综艺)时MediaSecondLabel才有意义**
645
+
646
+ | MediaSecondLabel名称 | MediaSecondLabel取值 | MediaSecondLabel 描述|
647
+ |---|---|---|
648
+ | MEDIA_SECOND_LABEL_INVALID | 0 | 非法的MediaSecondLabel |
649
+ | MEDIA_SECOND_LABEL_EVENING | 1 | 综艺晚会 |
650
+ | MEDIA_SECOND_LABEL_OTHERS | 2 | 其他 |
651
+
652
+ MediaMeta.MediaLang
653
+
654
+ | MediaLang名称 | MediaLang取值 | MediaLang描述 |
655
+ |---|---|---|
656
+ | MEDIA_LANG_INVALID | 0 | 非法的MediaLang |
657
+ | MEDIA_LANG_MANDARIN | 1 | 普通话 |
658
+ | MEDIA_LANG_CANTONESE | 2 | 粤语 |
659
+ */
660
+ export interface MediaPreknownInfo {
661
+ /**
662
+ * 媒资文件类型,参见MediaPreknownInfo结构体定义
663
+ */
664
+ MediaType: number
665
+
666
+ /**
667
+ * 媒资素材一级类型,参见MediaPreknownInfo结构体定义
668
+ */
669
+ MediaLabel: number
670
+
671
+ /**
672
+ * 媒资素材二级类型,参见MediaPreknownInfo结构体定义
673
+ 注意:此字段可能返回 null,表示取不到有效值。
674
+ */
675
+ MediaSecondLabel: number
676
+
677
+ /**
678
+ * 媒资音频类型,参见MediaPreknownInfo结构体定义
679
+ 注意:此字段可能返回 null,表示取不到有效值。
680
+ */
681
+ MediaLang?: number
682
+ }
683
+
684
+ /**
685
+ * 出现信息结构
686
+
687
+ 包含关键词在音频转文字(ASR),图片转文字(OCR)以及视频结果中的出现信息
688
+
689
+ */
690
+ export interface AppearInfo {
691
+ /**
692
+ * 关键词在音频文本结果中的出现位置数组
693
+ 注意:此字段可能返回 null,表示取不到有效值。
694
+ */
695
+ AudioAppearSet: Array<TextAppearInfo>
696
+
697
+ /**
698
+ * 关键词在可视文本结果中的出现位置数组
699
+ 注意:此字段可能返回 null,表示取不到有效值。
700
+ */
701
+ TextAppearSet: Array<TextAppearInfo>
702
+
703
+ /**
704
+ * 关键词在视频信息中的出现位置数组
705
+ 注意:此字段可能返回 null,表示取不到有效值。
706
+ */
707
+ VideoAppearSet: Array<VideoAppearInfo>
708
+ }
709
+
710
+ /**
711
+ * DeleteMedia请求参数结构体
712
+ */
713
+ export interface DeleteMediaRequest {
714
+ /**
715
+ * 媒资文件在系统中的ID
716
+ */
717
+ MediaId: string
718
+ }
719
+
720
+ /**
721
+ * ImportMedia返回参数结构体
722
+ */
723
+ export interface ImportMediaResponse {
724
+ /**
725
+ * 媒资文件在系统中的ID
726
+ */
727
+ MediaId: string
728
+
729
+ /**
730
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
731
+ */
732
+ RequestId?: string
733
+ }
734
+
735
+ /**
736
+ * DescribeMedias返回参数结构体
737
+ */
738
+ export interface DescribeMediasResponse {
739
+ /**
740
+ * 满足过滤条件的媒资视频总数量
741
+ */
742
+ TotalCount: number
743
+
744
+ /**
745
+ * 满足过滤条件的媒资信息
746
+ 注意:此字段可能返回 null,表示取不到有效值。
747
+ */
748
+ MediaInfoSet: Array<MediaInfo>
749
+
750
+ /**
751
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
752
+ */
753
+ RequestId?: string
754
+ }
755
+
756
+ /**
757
+ * 媒资信息结构体
758
+
759
+ 媒资状态定义如下:
760
+
761
+ | 状态名 | 状态值 | 状态描述 |
762
+ |---|---|---|
763
+ | MEDIA_STATUS_INVALID | 0 | 非法状态|
764
+ | MEDIA_STATUS_WAITING| 1 | 等待中 |
765
+ | MEDIA_STATUS_DOWNLOADING | 2 | 下载中 |
766
+ | MEDIA_STATUS_DOWNLOADED | 3 | 下载完成 |
767
+ | MEDIA_STATUS_DOWNLOAD_FAILED | 4 | 下载失败 |
768
+ | MEDIA_STATUS_TRANSCODING | 5 | 转码中 |
769
+ | MEDIA_STATUS_TRANSCODED | 6 | 转码完成 |
770
+ | MEDIA_STATUS_TRANCODE_FAILED | 7 | 转码失败 |
771
+ | MEDIA_STATUS_SUCCESS | 8 | 媒资文件状态就绪,可发起任务 |
772
+ | MEDIA_STATUS_EXPIRED | 9 | 媒资文件已过期 |
773
+
774
+ */
775
+ export interface MediaInfo {
776
+ /**
777
+ * 媒资ID
778
+ */
779
+ MediaId: string
780
+
781
+ /**
782
+ * 媒资名称
783
+ 注意:此字段可能返回 null,表示取不到有效值。
784
+ */
785
+ Name: string
786
+
787
+ /**
788
+ * 媒资下载地址
789
+ 注意:此字段可能返回 null,表示取不到有效值。
790
+ */
791
+ DownLoadURL: string
792
+
793
+ /**
794
+ * 媒资状态,取值参看上方表格
795
+ 注意:此字段可能返回 null,表示取不到有效值。
796
+ */
797
+ Status: number
798
+
799
+ /**
800
+ * 若状态为失败,表示失败原因
801
+ 注意:此字段可能返回 null,表示取不到有效值。
802
+ */
803
+ FailedReason: string
804
+
805
+ /**
806
+ * 媒资视频元信息
807
+ 注意:此字段可能返回 null,表示取不到有效值。
808
+ */
809
+ Metadata: MediaMetadata
810
+
811
+ /**
812
+ * 导入视频进度,取值范围为[0,100]
813
+ 注意:此字段可能返回 null,表示取不到有效值。
814
+ */
815
+ Progress: number
816
+ }
817
+
818
+ /**
819
+ * 排序条件
820
+ */
821
+ export interface SortBy {
822
+ /**
823
+ * 排序字段,默认为CreateTime
824
+ */
825
+ By?: string
826
+
827
+ /**
828
+ * true表示降序,false表示升序
829
+ */
830
+ Descend?: boolean
831
+ }
832
+
833
+ /**
834
+ * 媒资文件视频元信息,包括分辨率,帧率,码率等
835
+ */
836
+ export interface MediaMetadata {
837
+ /**
838
+ * 媒资视频文件大小
839
+ */
840
+ FileSize: number
841
+
842
+ /**
843
+ * 媒资视频文件MD5
844
+ */
845
+ MD5: string
846
+
847
+ /**
848
+ * 媒资视频时长,单位为秒
849
+ 注意:此字段可能返回 null,表示取不到有效值。
850
+ */
851
+ Duration: number
852
+
853
+ /**
854
+ * 媒资视频总帧数
855
+ 注意:此字段可能返回 null,表示取不到有效值。
856
+ */
857
+ NumFrames: number
858
+
859
+ /**
860
+ * 媒资视频宽度,单位为像素
861
+ 注意:此字段可能返回 null,表示取不到有效值。
862
+ */
863
+ Width: number
864
+
865
+ /**
866
+ * 媒资视频高度,单位为像素
867
+ 注意:此字段可能返回 null,表示取不到有效值。
868
+ */
869
+ Height: number
870
+
871
+ /**
872
+ * 媒资视频帧率,单位为Hz
873
+ 注意:此字段可能返回 null,表示取不到有效值。
874
+ */
875
+ FPS: number
876
+
877
+ /**
878
+ * 媒资视频比特率,单位为kbps
879
+ 注意:此字段可能返回 null,表示取不到有效值。
880
+ */
881
+ BitRate: number
882
+ }
883
+
884
+ /**
885
+ * DescribeMedia请求参数结构体
886
+ */
887
+ export interface DescribeMediaRequest {
888
+ /**
889
+ * 导入媒资返回的媒资ID,最长32B
890
+ */
891
+ MediaId: string
892
+ }
893
+
894
+ /**
895
+ * 任务信息
896
+
897
+ TaskStatus定义如下:
898
+
899
+ | TaskStatus名称 | TaskStatus取值 | TaskStatus描述 |
900
+ |---|---|---|
901
+ | TASK_STATUS_INVALID | 0 | 非法的任务状态 |
902
+ | TASK_STATUS_WAITING | 1 | 排队中 |
903
+ | TASK_STATUS_ANALYSING | 2 | 任务分析中 |
904
+ | TASK_STATUS_ANALYSED | 3 | 任务分析完成 |
905
+ | TASK_STATUS_SNAPSHOT_CREATING | 4 | 任务结果快照生成中 |
906
+ | TASK_STATUS_SNAPSHOT_CREATED | 5 | 任务结果快照生成完成 |
907
+ | TASK_STATUS_RESULT_UPLOADING | 6 | 任务结果快照上传中 |
908
+ | TASK_STATUS_RESULT_UPLOADED | 7 | 任务结果快照上传完成 |
909
+ | TASK_STATUS_SUCCESS | 8 | 任务执行完成 |
910
+ | TASK_STATUS_FAILED | 9 | 任务执行失败 |
911
+ */
912
+ export interface TaskInfo {
913
+ /**
914
+ * 任务ID
915
+ */
916
+ TaskId: string
917
+
918
+ /**
919
+ * 描述任务名称,指定后可根据名称筛选
920
+ 注意:此字段可能返回 null,表示取不到有效值。
921
+ */
922
+ TaskName: string
923
+
924
+ /**
925
+ * 媒资文件ID
926
+ */
927
+ MediaId: string
928
+
929
+ /**
930
+ * 任务执行状态
931
+ */
932
+ TaskStatus: number
933
+
934
+ /**
935
+ * 任务进度,范围为[0,100]
936
+ 注意:此字段可能返回 null,表示取不到有效值。
937
+ */
938
+ TaskProgress: number
939
+
940
+ /**
941
+ * 任务执行时间
942
+ 注意:此字段可能返回 null,表示取不到有效值。
943
+ */
944
+ TaskTimeCost: number
945
+
946
+ /**
947
+ * 任务创建时间
948
+ */
949
+ TaskCreateTime: string
950
+
951
+ /**
952
+ * 任务开始执行时间
953
+ 注意:此字段可能返回 null,表示取不到有效值。
954
+ */
955
+ TaskStartTime: string
956
+
957
+ /**
958
+ * 任务失败原因
959
+ 注意:此字段可能返回 null,表示取不到有效值。
960
+ */
961
+ FailedReason: string
962
+
963
+ /**
964
+ * 任务执行时指定的先验知识
965
+ */
966
+ MediaPreknownInfo: MediaPreknownInfo
967
+
968
+ /**
969
+ * 媒资文件名称
970
+ 注意:此字段可能返回 null,表示取不到有效值。
971
+ */
972
+ MediaName: string
973
+ }