1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
|
<?php return [
'version' => '1.0',
'info' => [
'style' => 'RPC',
'product' => 'videoseg',
'version' => '2020-03-20',
],
'directories' => [
[
'id' => 208339,
'title' => 'API操作',
'type' => 'directory',
'children' => [
'SegmentVideoBody',
],
],
'GetAsyncJobResult',
],
'components' => [
'schemas' => [],
],
'apis' => [
'SegmentVideoBody' => [
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'VideoUrl',
'in' => 'formData',
'schema' => [
'description' => '视频URL地址。推荐使用上海地域的OSS链接，对于文件在本地或者非上海地域OSS链接的情况，请参见[文件URL处理](~~155645~~)。',
'type' => 'string',
'required' => true,
'example' => 'http://viapi-test.oss-cn-shanghai.aliyuncs.com/viapi-3.0domepic/videoseg/SegmentVideoBody/SegmentVideoBody1.mp4',
'isFileTransferUrl' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '49E2CC28-ED1D-4CC5-854D-7D0AE2B20976',
],
'Data' => [
'description' => '返回的数据内容。该数据需要在异步任务执行成功后，通过调用[GetAsyncJobResult](~~607824~~)接口，对其Result字段进行JSON反序列化之后得到。',
'type' => 'object',
'properties' => [
'VideoUrl' => [
'description' => '输出结果图像URL地址。'."\n"
.'> 该URL地址为临时地址，有效期为30分钟，过期后将无法访问。若需要长时间或者永久保存文件，请在30分钟内访问URL地址，下载文件转存到自己的OSS或者其他存储空间。',
'type' => 'string',
'example' => 'http://algo-app-aic-vd-cn-shanghai-prod.oss-cn-shanghai.aliyuncs.com/video-human-segmentation/D86DDFBC-B8ED-4780-9E6A-E5BA98D7CC9F.mp4?Expires=1584709406&OSSAccessKeyId=LTAI****************&Signature=Fx5HVxvRjAMIjWL2OvhTlOO4cC****',
],
],
],
'Message' => [
'description' => '提交异步任务后的提示信息。',
'type' => 'string',
'example' => '该调用为异步调用，任务已提交成功，请以requestId的值作为jobId参数调用同类目下GetAsyncJobResult接口查询任务执行状态和结果。',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ParameterError',
'errorMessage' => 'The parameter is invalid. Please check again.',
],
],
403 => [
[
'errorCode' => 'AuthFailed',
'errorMessage' => 'An error occurred while performing authorization. Please check your RAM configuration.',
],
],
408 => [
[
'errorCode' => 'Timeout',
'errorMessage' => 'The request has timed out.',
],
],
503 => [
[
'errorCode' => 'ServiceUnavailable',
'errorMessage' => 'The service is unavailable.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"49E2CC28-ED1D-4CC5-854D-7D0AE2B20976\\",\\n \\"Data\\": {\\n \\"VideoUrl\\": \\"http://algo-app-aic-vd-cn-shanghai-prod.oss-cn-shanghai.aliyuncs.com/video-human-segmentation/D86DDFBC-B8ED-4780-9E6A-E5BA98D7CC9F.mp4?Expires=1584709406&OSSAccessKeyId=LTAI****************&Signature=Fx5HVxvRjAMIjWL2OvhTlOO4cC****\\"\\n },\\n \\"Message\\": \\"该调用为异步调用，任务已提交成功，请以requestId的值作为jobId参数调用同类目下GetAsyncJobResult接口查询任务执行状态和结果。\\"\\n}","errorExample":""},{"type":"xml","example":"<SegmentVideoBodyResponse>\\n <RequestId>49E2CC28-ED1D-4CC5-854D-7D0AE2B20976</RequestId>\\n <Message>该调用为异步调用，任务已提交成功，请以requestId的值作为jobId参数调用同类目下GetAsyncJobResult接口查询任务执行状态和结果。</Message>\\n</SegmentVideoBodyResponse>","errorExample":""}]',
'title' => '视频人像分割',
'summary' => '本文介绍视频人像分割SegmentVideoBody的语法及示例。',
'description' => '## 功能描述'."\n"
.'视频人像分割能力对输入的视频进行解析，将人像区域的mask作为视频序列返回。'."\n"
."\n"
.'> - 您可以进入[在线咨询](https://www.aliyun.com/core/online-consult?from=aZgW6LJHr2)获取在线人工帮助。'."\n"
.'>- 当前能力可在视觉智能开放平台有完整的免费产品体验，您可以单击[立即试用](https://vision.aliyun.com/experience/detail?&tagName=videoseg&children=SegmentVideoBody)对该能力进行更直观试用以及在线购买。'."\n"
.'>- 阿里云视觉智能开放平台视觉AI能力API接入、接口使用或问题咨询等，请通过钉钉群（23109592）加入阿里云视觉智能开放平台咨询群联系我们。'."\n"
."\n"
.'## 接入指引'."\n"
.'1. 注册阿里云账号：打开[阿里云官网](https://www.aliyun.com)，在阿里云官网右上角，单击**立即注册**，按照操作提示完成账号注册。'."\n"
.'2. 开通能力：请确保您已开通[视频分割服务](https://vision.aliyun.com/videoseg)，若未开通服务请[立即开通](https://common-buy.aliyun.com/?commodityCode=viapi_videoseg_public_cn#/open)。'."\n"
.'3. 创建AccessKey：请确保您已[创建AccessKey](~~175144~~)，如果您使用的是子账号AccessKey，您需要给子账号赋予AliyunVIAPIFullAccess权限，具体操作，请参见[RAM授权](~~145025~~)。'."\n"
.'4. 在线调试（可选）：您可以通过[OpenAPI Explorer](https://next.api.aliyun.com/api/videoseg/2020-03-20/SegmentVideoBody?lang=JAVA&sdkStyle=dara¶ms=%7B%22VideoUrl%22%3A%22http%3A%2F%2Fviapi-test.oss-cn-shanghai.aliyuncs.com%2Fviapi-3.0domepic%2Fvideoseg%2FSegmentVideoBody%2FSegmentVideoBody1.mp4%22%7D&tab=DEMO)在线调试能力，查看完整的调用示例代码及SDK依赖信息，也可以下载完整的工程。'."\n"
.'5. 开发接入步骤： '."\n"
.'- 在[SDK总览](~~145033~~)中选择您要接入使用的SDK语言。'."\n"
.'- 在对应语言的SDK文档中找到AI类目为视频分割（videoseg）类目的SDK包进行安装。'."\n"
.'- 参考文档中提供的示例代码进行适当修改后调用。'."\n"
."\n"
.'6. 示例代码：该能力常用语言的示例代码，请参见[视频人像分割示例代码](~~610206~~)，常用语言查询异步任务结果的示例代码，请参见[查询异步任务结果示例代码](~~607974~~)。'."\n"
.'7. 客户端直接调用：该能力常用的客户端调用方式包括以下几种。'."\n"
.'- [Web前端直接调用](~~467779~~)'."\n"
.'- [小程序场景下直接调用](~~467780~~)'."\n"
.'- [Android端直接调用](~~467781~~)'."\n"
.'- [iOS端直接调用](~~467782~~)'."\n"
."\n"
.'## 输入限制'."\n"
."\n"
.'- 视频格式：MP4、AVI、FLV、MOV。'."\n"
.'- 视频大小：不超过1 GB。'."\n"
.'- 视频要求总帧数不超过2000帧。'."\n"
.'- URL地址中不能包含中文字符。'."\n"
.'## 安全声明'."\n"
.'- 请确保上传的图片或文件来源符合相应的法律法规。'."\n"
.'- 通过体验调试上传的临时文件有效期为1小时，在24小时后会被系统自动清理删除。'."\n"
."\n"
.'## 计费说明'."\n"
.'关于视频人像分割的计费方式及报价，请参见[计费介绍](~~202488~~)。'."\n"
."\n"
.'> 下方调试接口为付费接口。'."\n"
."\n"
.'## 调用步骤'."\n"
.'该能力为异步能力，需分两步进行调用。'."\n"
."\n"
.'第一步调用SegmentVideoBody接口提交任务，请求成功后，得到一个任务ID。'."\n"
."\n"
.'第二步调用[GetAsyncJobResult](~~607824~~)接口查询结果，根据任务ID查询任务执行状态和结果。如果任务还在处理中，可稍等一段时间后再进行查询。当同一个任务还未处理完时，建议不要重复提交任务。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => '## 查询结果'."\n"
.'该接口为异步接口，当前并未返回真实的请求结果，您需要通过返回的RequestId调用GetAsyncJobResult接口来获取该接口的真实请求结果。详情请参见[GetAsyncJobResult](~~607824~~)。'."\n"
."\n"
.'## SDK参考'."\n"
.'阿里云视觉AI视频分割类目下的视频人像分割能力推荐使用SDK调用，支持多种编程语言，调用时请选择AI类目为视频分割（videoseg）的SDK包，文件参数通过SDK调用可支持本地文件及任意URL，具体可参见[SDK总览](~~145033~~)。'."\n"
."\n"
.'## 示例代码'."\n"
.'该能力常用语言的示例代码，请参见[视频人像分割示例代码](~~610206~~)，常用语言查询异步任务结果的示例代码，请参见[查询异步任务结果示例代码](~~607974~~)。',
],
'GetAsyncJobResult' => [
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'JobId',
'in' => 'formData',
'schema' => [
'description' => '异步接口返回的RequestId，输入后可以查询异步接口的真实请求结果。',
'type' => 'string',
'required' => true,
'example' => 'E75FE679-0303-4DD1-8252-1143B4FA8A27',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '1',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '6BD843FB-E7B9-45B6-ADE1-9AB1FF450148',
],
'Data' => [
'description' => '返回的数据内容。',
'type' => 'object',
'properties' => [
'Status' => [
'description' => '异步任务状态。包括：'."\n"
."\n"
.'- QUEUING：任务排队中'."\n"
."\n"
.'- PROCESSING：异步处理中'."\n"
."\n"
.'- PROCESS_SUCCESS：处理成功'."\n"
."\n"
.'- PROCESS_FAILED：处理失败'."\n"
."\n"
.'- TIMEOUT_FAILED：任务超时未处理完成'."\n"
."\n"
.'- LIMIT_RETRY_FAILED：超过最大重试次数',
'type' => 'string',
'example' => 'PROCESS_SUCCESS',
],
'ErrorMessage' => [
'description' => '异步任务错误码信息。',
'type' => 'string',
'example' => 'paramsIllegal',
],
'Result' => [
'description' => '异步任务返回的真实请求结果。',
'type' => 'string',
'example' => '{\\"VideoUrl\\":\\"http://algo-app-aic-vd-cn-shanghai-prod.oss-cn-shanghai.aliyuncs.com/film-summary/49E2CC28-ED1D-4CC5-854D-7D0AE2B20976_rf8mv0.mp4?Expires=1585111875&OSSAccessKeyId=LTAI4FoLmvQ9urWXgSRp****&Signature=7uE0ppt6uwkdwAFz73PPZN4KG7****\\"}',
],
'ErrorCode' => [
'description' => '异步任务错误码。',
'type' => 'string',
'example' => 'InvalidParameter',
],
'JobId' => [
'description' => '异步任务ID。',
'type' => 'string',
'example' => '49E2CC28-ED1D-4CC5-854D-7D0AE2B20976',
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ParameterError',
'errorMessage' => 'The parameter is invalid. Please check again.',
],
],
403 => [
[
'errorCode' => 'AuthFailed',
'errorMessage' => 'An error occurred while performing authorization. Please check your RAM configuration.',
],
],
408 => [
[
'errorCode' => 'Timeout',
'errorMessage' => 'The request has timed out.',
],
],
503 => [
[
'errorCode' => 'ServiceUnavailable',
'errorMessage' => 'The service is unavailable.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6BD843FB-E7B9-45B6-ADE1-9AB1FF450148\\",\\n \\"Data\\": {\\n \\"Status\\": \\"PROCESS_SUCCESS\\",\\n \\"ErrorMessage\\": \\"paramsIllegal\\",\\n \\"Result\\": \\"{\\\\\\\\\\\\\\"VideoUrl\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"http://algo-app-aic-vd-cn-shanghai-prod.oss-cn-shanghai.aliyuncs.com/film-summary/49E2CC28-ED1D-4CC5-854D-7D0AE2B20976_rf8mv0.mp4?Expires=1585111875&OSSAccessKeyId=LTAI4FoLmvQ9urWXgSRp****&Signature=7uE0ppt6uwkdwAFz73PPZN4KG7****\\\\\\\\\\\\\\"}\\",\\n \\"ErrorCode\\": \\"InvalidParameter\\",\\n \\"JobId\\": \\"49E2CC28-ED1D-4CC5-854D-7D0AE2B20976\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>6BD843FB-E7B9-45B6-ADE1-9AB1FF450148</RequestId>\\n<Data>\\n <Status>PROCESS_SUCCESS</Status>\\n <JobId>9CDE688A-8FC8-4B8D-8C34-1C3490703F23</JobId>\\n <Result>{\\"VideoUrl\\":\\"http://algo-app-aic-vd-cn-shanghai-prod.oss-cn-shanghai.aliyuncs.com/video-human-segmentation/9CDE688A-8FC8-4B8D-8C34-1C3490703F23.mp4?Expires=1585193584&OSSAccessKeyId=LTAI4FoLmvQ9urWXgSRp****&Signature=z6DQV%2F14CFvammxkgXLcYm0wsW****\\"}</Result>\\n</Data>","errorExample":""}]',
'title' => '查询异步任务结果',
'summary' => '本文介绍查询异步任务结果GetAsyncJobResult的语法及示例。',
'description' => '## 功能描述'."\n"
.'异步接口调用API接口后，返回的并不是真正的请求结果，您需要保存返回结果中的RequestId，然后调用GetAsyncJobResult来获取真正的请求结果。'."\n"
."\n"
.'> - 异步任务的文件有过期时间，有效期是30分钟。如需长期使用，需及时将文件下载到本地服务器或存储在OSS中。有关OSS更多操作信息，请参见[上传文件](~~31886~~)。'."\n"
.'- 阿里云视觉智能开放平台视觉AI能力API接入、接口使用或问题咨询等，请通过钉钉群（23109592）加入阿里云视觉智能开放平台咨询群联系我们。'."\n"
."\n\n"
.'当前视频分割类目所有接口均为异步接口，均需要调用GetAsyncJobResult来获取真实的请求结果。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => '## SDK参考'."\n"
.'阿里云视觉AI能力推荐使用SDK调用，支持多种编程语言，文件参数通过SDK调用可支持本地文件及任意URL，具体可参见[SDK总览](~~145033~~)。',
'extraInfo' => '## Result反序列化'."\n"
.'将上面Result反序列化展示如下。'."\n"
.'```'."\n"
.'{'."\n"
.' "VideoUrl": "http://algo-app-aic-vd-cn-shanghai-prod.oss-cn-shanghai.aliyuncs.com/video-human-segmentation/9CDE688A-8FC8-4B8D-8C34-1C3490703F23.mp4?Expires=1585193584&OSSAccessKeyId=LTAI4FoLmvQ9urWXgSRp****&Signature=z6DQV%2F14CFvammxkgXLcYm0wsW****"'."\n"
.'}'."\n"
.'```'."\n"
."\n\n"
.'## 错误码'."\n"
.'关于查询异步任务结果的错误码，详情请参见[常见错误码](~~159108~~)。'."\n"
."\n"
.'## 安全声明'."\n"
.'- 请确保上传的图片或文件来源符合相应的法律法规。'."\n"
.'- 通过体验调试上传的临时文件有效期为1小时，在24小时后会被系统自动清理删除。',
],
],
'endpoints' => [
[
'regionId' => 'cn-shanghai',
'endpoint' => 'videoseg.cn-shanghai.aliyuncs.com',
],
],
];
|
