summaryrefslogtreecommitdiff
path: root/data/en_us/imageaudit/2019-12-30/api-docs.php
blob: 9c4d15f9ef575f2c88b2f42df08b9435a9937aed (plain)
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
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
<?php return [
    'version' => '1.0',
    'info' => [
        'style' => 'RPC',
        'product' => 'imageaudit',
        'version' => '2019-12-30',
    ],
    'directories' => [
        [
            'id' => 64301,
            'title' => null,
            'type' => 'directory',
            'children' => [
                'ScanImage',
                'ScanText',
            ],
        ],
    ],
    'components' => [
        'schemas' => [],
    ],
    'apis' => [
        'ScanImage' => [
            'summary' => '图片审核接口',
            'methods' => [
                'post',
            ],
            'schemes' => [
                'http',
                'https',
            ],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'operationType' => 'read',
            'deprecated' => false,
            'systemTags' => [
                'operationType' => 'none',
                'riskType' => 'none',
                'chargeType' => 'paid',
            ],
            'parameters' => [
                [
                    'name' => 'Task',
                    'in' => 'formData',
                    'style' => 'repeatList',
                    'schema' => [
                        'description' => '1',
                        'type' => 'array',
                        'items' => [
                            'description' => '1',
                            'type' => 'object',
                            'properties' => [
                                'ImageTimeMillisecond' => [
                                    'description' => '',
                                    'type' => 'integer',
                                    'format' => 'int64',
                                    'required' => false,
                                    'example' => '1',
                                ],
                                'Interval' => [
                                    'description' => '',
                                    'type' => 'integer',
                                    'format' => 'int32',
                                    'required' => false,
                                    'example' => '1',
                                ],
                                'ImageURL' => [
                                    'description' => '',
                                    'type' => 'string',
                                    'required' => true,
                                    'example' => 'http://xxx.xxx.com/xxx.jpg',
                                    'isFileTransferUrl' => true,
                                ],
                                'MaxFrames' => [
                                    'description' => '',
                                    'type' => 'integer',
                                    'format' => 'int32',
                                    'required' => false,
                                    'example' => '1',
                                ],
                                'DataId' => [
                                    'description' => '',
                                    'type' => 'string',
                                    'required' => false,
                                    'example' => 'uuid-xxxx-xxxx-1234',
                                ],
                            ],
                            'required' => false,
                        ],
                        'required' => true,
                        'maxItems' => 10,
                    ],
                ],
                [
                    'name' => 'Scene',
                    'in' => 'formData',
                    'style' => 'repeatList',
                    'schema' => [
                        'description' => '1',
                        'type' => 'array',
                        'items' => [
                            'description' => '',
                            'type' => 'string',
                            'required' => false,
                            'example' => 'porn',
                        ],
                        'required' => true,
                        'example' => 'porn',
                        'maxItems' => 6,
                    ],
                ],
            ],
            'responses' => [
                200 => [
                    'headers' => [],
                    'schema' => [
                        'description' => '1',
                        'type' => 'object',
                        'properties' => [
                            'RequestId' => [
                                'description' => '',
                                'type' => 'string',
                                'example' => '69B41AE8-1234-1234-1234-12D395695D2D',
                            ],
                            'Data' => [
                                'description' => '',
                                'type' => 'object',
                                'properties' => [
                                    'Results' => [
                                        'description' => '',
                                        'type' => 'array',
                                        'items' => [
                                            'description' => '1',
                                            'type' => 'object',
                                            'properties' => [
                                                'ImageURL' => [
                                                    'description' => '',
                                                    'type' => 'string',
                                                    'example' => 'http://xxx.xxx.xxx/xxx.jpg',
                                                ],
                                                'DataId' => [
                                                    'description' => '',
                                                    'type' => 'string',
                                                    'example' => 'uuid-xxxx-xxx-1234',
                                                ],
                                                'SubResults' => [
                                                    'description' => '',
                                                    'type' => 'array',
                                                    'items' => [
                                                        'description' => '1',
                                                        'type' => 'object',
                                                        'properties' => [
                                                            'SfaceDataList' => [
                                                                'description' => '',
                                                                'type' => 'array',
                                                                'items' => [
                                                                    'description' => '1',
                                                                    'type' => 'object',
                                                                    'properties' => [
                                                                        'Width' => [
                                                                            'description' => '',
                                                                            'type' => 'number',
                                                                            'format' => 'float',
                                                                            'example' => '97',
                                                                        ],
                                                                        'Faces' => [
                                                                            'description' => '',
                                                                            'type' => 'array',
                                                                            'items' => [
                                                                                'description' => '1',
                                                                                'type' => 'object',
                                                                                'properties' => [
                                                                                    'Name' => [
                                                                                        'description' => '',
                                                                                        'type' => 'string',
                                                                                        'example' => 'abc',
                                                                                    ],
                                                                                    'Id' => [
                                                                                        'description' => '',
                                                                                        'type' => 'string',
                                                                                        'example' => 'AliFace_0001234',
                                                                                    ],
                                                                                    'Rate' => [
                                                                                        'description' => '',
                                                                                        'type' => 'number',
                                                                                        'format' => 'float',
                                                                                        'example' => '91.54',
                                                                                    ],
                                                                                ],
                                                                            ],
                                                                        ],
                                                                        'Height' => [
                                                                            'description' => '',
                                                                            'type' => 'number',
                                                                            'format' => 'float',
                                                                            'example' => '131',
                                                                        ],
                                                                        'Y' => [
                                                                            'description' => '',
                                                                            'type' => 'number',
                                                                            'format' => 'float',
                                                                            'example' => '39',
                                                                        ],
                                                                        'X' => [
                                                                            'description' => '',
                                                                            'type' => 'number',
                                                                            'format' => 'float',
                                                                            'example' => '49',
                                                                        ],
                                                                    ],
                                                                ],
                                                            ],
                                                            'HintWordsInfoList' => [
                                                                'description' => '',
                                                                'type' => 'array',
                                                                'items' => [
                                                                    'description' => '1',
                                                                    'type' => 'object',
                                                                    'properties' => [
                                                                        'Context' => [
                                                                            'description' => '',
                                                                            'type' => 'string',
                                                                            'example' => 'abc',
                                                                        ],
                                                                    ],
                                                                ],
                                                            ],
                                                            'Suggestion' => [
                                                                'description' => '',
                                                                'type' => 'string',
                                                                'example' => 'block',
                                                            ],
                                                            'ProgramCodeDataList' => [
                                                                'description' => '',
                                                                'type' => 'array',
                                                                'items' => [
                                                                    'description' => '1',
                                                                    'type' => 'object',
                                                                    'properties' => [
                                                                        'Width' => [
                                                                            'description' => '',
                                                                            'type' => 'number',
                                                                            'format' => 'float',
                                                                            'example' => '402.0',
                                                                        ],
                                                                        'Height' => [
                                                                            'description' => '',
                                                                            'type' => 'number',
                                                                            'format' => 'float',
                                                                            'example' => '413.0',
                                                                        ],
                                                                        'Y' => [
                                                                            'description' => '',
                                                                            'type' => 'number',
                                                                            'format' => 'float',
                                                                            'example' => '0.0',
                                                                        ],
                                                                        'X' => [
                                                                            'description' => '',
                                                                            'type' => 'number',
                                                                            'format' => 'float',
                                                                            'example' => '11.0',
                                                                        ],
                                                                    ],
                                                                ],
                                                            ],
                                                            'OCRDataList' => [
                                                                'description' => '1',
                                                                'type' => 'array',
                                                                'items' => [
                                                                    'description' => '',
                                                                    'type' => 'string',
                                                                    'example' => 'abc',
                                                                ],
                                                            ],
                                                            'Frames' => [
                                                                'description' => '',
                                                                'type' => 'array',
                                                                'items' => [
                                                                    'description' => '1',
                                                                    'type' => 'object',
                                                                    'properties' => [
                                                                        'URL' => [
                                                                            'description' => '',
                                                                            'type' => 'string',
                                                                            'example' => 'http://xxx.xxx.com/xxx-0.jpg',
                                                                        ],
                                                                        'Rate' => [
                                                                            'description' => '',
                                                                            'type' => 'number',
                                                                            'format' => 'float',
                                                                            'example' => '89.85',
                                                                        ],
                                                                    ],
                                                                ],
                                                            ],
                                                            'LogoDataList' => [
                                                                'description' => '',
                                                                'type' => 'array',
                                                                'items' => [
                                                                    'description' => '1',
                                                                    'type' => 'object',
                                                                    'properties' => [
                                                                        'Type' => [
                                                                            'description' => '',
                                                                            'type' => 'string',
                                                                            'example' => 'TV',
                                                                        ],
                                                                        'Width' => [
                                                                            'description' => '',
                                                                            'type' => 'number',
                                                                            'format' => 'float',
                                                                            'example' => '106',
                                                                        ],
                                                                        'Height' => [
                                                                            'description' => '',
                                                                            'type' => 'number',
                                                                            'format' => 'float',
                                                                            'example' => '106',
                                                                        ],
                                                                        'Y' => [
                                                                            'description' => '',
                                                                            'type' => 'number',
                                                                            'format' => 'float',
                                                                            'example' => '68',
                                                                        ],
                                                                        'Name' => [
                                                                            'description' => '',
                                                                            'type' => 'string',
                                                                            'example' => 'abc',
                                                                        ],
                                                                        'X' => [
                                                                            'description' => '',
                                                                            'type' => 'number',
                                                                            'format' => 'float',
                                                                            'example' => '140',
                                                                        ],
                                                                    ],
                                                                ],
                                                            ],
                                                            'Label' => [
                                                                'description' => '',
                                                                'type' => 'string',
                                                                'example' => 'normal',
                                                            ],
                                                            'Scene' => [
                                                                'description' => '',
                                                                'type' => 'string',
                                                                'example' => 'ad',
                                                            ],
                                                            'Rate' => [
                                                                'description' => '',
                                                                'type' => 'number',
                                                                'format' => 'float',
                                                                'example' => '99.91',
                                                            ],
                                                        ],
                                                    ],
                                                ],
                                                'TaskId' => [
                                                    'description' => '',
                                                    'type' => 'string',
                                                    'example' => 'img4wlJcb7p4wH4lAP3111111-123456',
                                                ],
                                            ],
                                        ],
                                    ],
                                ],
                            ],
                        ],
                    ],
                ],
            ],
            'responseDemo' => '[{"type":"json","example":"{\\n  \\"RequestId\\": \\"69B41AE8-1234-1234-1234-12D395695D2D\\",\\n  \\"Data\\": {\\n    \\"Results\\": [\\n      {\\n        \\"ImageURL\\": \\"http://xxx.xxx.xxx/xxx.jpg\\",\\n        \\"DataId\\": \\"uuid-xxxx-xxx-1234\\",\\n        \\"SubResults\\": [\\n          {\\n            \\"SfaceDataList\\": [\\n              {\\n                \\"Width\\": 97,\\n                \\"Faces\\": [\\n                  {\\n                    \\"Name\\": \\"abc\\",\\n                    \\"Id\\": \\"AliFace_0001234\\",\\n                    \\"Rate\\": 91.54\\n                  }\\n                ],\\n                \\"Height\\": 131,\\n                \\"Y\\": 39,\\n                \\"X\\": 49\\n              }\\n            ],\\n            \\"HintWordsInfoList\\": [\\n              {\\n                \\"Context\\": \\"abc\\"\\n              }\\n            ],\\n            \\"Suggestion\\": \\"block\\",\\n            \\"ProgramCodeDataList\\": [\\n              {\\n                \\"Width\\": 402,\\n                \\"Height\\": 413,\\n                \\"Y\\": 0,\\n                \\"X\\": 11\\n              }\\n            ],\\n            \\"OCRDataList\\": [\\n              \\"abc\\"\\n            ],\\n            \\"Frames\\": [\\n              {\\n                \\"URL\\": \\"http://xxx.xxx.com/xxx-0.jpg\\",\\n                \\"Rate\\": 89.85\\n              }\\n            ],\\n            \\"LogoDataList\\": [\\n              {\\n                \\"Type\\": \\"TV\\",\\n                \\"Width\\": 106,\\n                \\"Height\\": 106,\\n                \\"Y\\": 68,\\n                \\"Name\\": \\"abc\\",\\n                \\"X\\": 140\\n              }\\n            ],\\n            \\"Label\\": \\"normal\\",\\n            \\"Scene\\": \\"ad\\",\\n            \\"Rate\\": 99.91\\n          }\\n        ],\\n        \\"TaskId\\": \\"img4wlJcb7p4wH4lAP3111111-123456\\"\\n      }\\n    ]\\n  }\\n}","errorExample":""},{"type":"xml","example":"<Data>\\n    <Results>\\n        <Code>200</Code>\\n        <Message>OK</Message>\\n        <DataId>uuid-xxxx-xxx-1234</DataId>\\n        <SubResults>\\n            <Rate>99.63</Rate>\\n            <Suggestion>block</Suggestion>\\n            <Label>sexy</Label>\\n            <Scene>porn</Scene>\\n        </SubResults>\\n        <SubResults>\\n            <Label>politics</Label>\\n            <Rate>91.54</Rate>\\n            <Scene>terrorism</Scene>\\n            <SfaceDataList>\\n                <Faces>\\n                    <Id>AliFace_0001234</Id>\\n                    <Name>命中人名</Name>\\n                    <Rate>91.54</Rate>\\n                </Faces>\\n                <Height>131</Height>\\n                <Width>97</Width>\\n                <X>49</X>\\n                <y>39</y>\\n            </SfaceDataList>\\n            <Suggestion>block</Suggestion>\\n        </SubResults>\\n        <SubResults>\\n            <ProgramCodeDataList>\\n                <Width>402</Width>\\n                <Height>413</Height>\\n                <X>11</X>\\n                <y>0</y>\\n            </ProgramCodeDataList>\\n            <Frames>\\n                <Rate>89.85</Rate>\\n                <URL>http://xxx.xxx.com/xxx-0.jpg</URL>\\n            </Frames>\\n            <Frames>\\n                <Rate>68.06</Rate>\\n                <URL>http://xxx.xxx.com/xxx-1.jpg</URL>\\n            </Frames>\\n            <Rate>99.91</Rate>\\n            <Suggestion>block</Suggestion>\\n            <Label>ad</Label>\\n            <Scene>ad</Scene>\\n        </SubResults>\\n        <SubResults>\\n            <Rate>99.91</Rate>\\n            <Suggestion>block</Suggestion>\\n            <Label>drug</Label>\\n            <Scene>live</Scene>\\n        </SubResults>\\n        <SubResults>\\n            <LogoDataList>\\n                <Name>xxx台</Name>\\n                <Type>TV</Type>\\n                <X>140</X>\\n                <y>68</y>\\n                <Width>106</Width>\\n                <Height>106</Height>\\n            </LogoDataList>\\n            <Rate>99.9</Rate>\\n            <Suggestion>block</Suggestion>\\n            <Label>TV</Label>\\n            <Scene>logo</Scene>\\n        </SubResults>\\n        <TaskId>img4wlJcb7p4wH4lAP3111111-123456</TaskId>\\n        <ImageURL>http://xxx.xxx.xxx/xxx.jpg</ImageURL>\\n    </Results>\\n</Data>\\n<RequestId>69B41AE8-1234-1234-1234-12D395695D2D</RequestId>","errorExample":""}]',
        ],
        'ScanText' => [
            'methods' => [
                'post',
            ],
            'schemes' => [
                'http',
                'https',
            ],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'operationType' => 'read',
            'deprecated' => false,
            'systemTags' => [],
            'parameters' => [
                [
                    'name' => 'Tasks',
                    'in' => 'formData',
                    'style' => 'repeatList',
                    'schema' => [
                        'description' => '1',
                        'items' => [
                            'properties' => [
                                'Content' => [
                                    'description' => '',
                                    'example' => '',
                                    'required' => true,
                                    'type' => 'string',
                                ],
                            ],
                            'required' => false,
                            'type' => 'object',
                        ],
                        'maxItems' => 10,
                        'required' => true,
                        'type' => 'array',
                    ],
                ],
                [
                    'name' => 'Labels',
                    'in' => 'formData',
                    'style' => 'repeatList',
                    'schema' => [
                        'description' => '1',
                        'items' => [
                            'properties' => [
                                'Label' => [
                                    'description' => '',
                                    'example' => 'ad',
                                    'required' => true,
                                    'type' => 'string',
                                ],
                            ],
                            'required' => false,
                            'type' => 'object',
                        ],
                        'maxItems' => 10,
                        'required' => true,
                        'type' => 'array',
                    ],
                ],
            ],
            'responses' => [
                200 => [
                    'schema' => [
                        'properties' => [
                            'RequestId' => [
                                'description' => '',
                                'example' => 'C7CD87E3-57A5-4E2F-8A44-809F3554692C',
                                'type' => 'string',
                            ],
                            'Data' => [
                                'description' => '',
                                'properties' => [
                                    'Elements' => [
                                        'description' => '',
                                        'items' => [
                                            'properties' => [
                                                'TaskId' => [
                                                    'description' => '',
                                                    'example' => 'txt6Vh5Fv0DAFy5hgdVRt3pqf-1s82jj',
                                                    'type' => 'string',
                                                ],
                                                'Results' => [
                                                    'description' => '',
                                                    'items' => [
                                                        'properties' => [
                                                            'Suggestion' => [
                                                                'description' => '',
                                                                'example' => 'block',
                                                                'type' => 'string',
                                                            ],
                                                            'Label' => [
                                                                'description' => '',
                                                                'example' => 'ad',
                                                                'type' => 'string',
                                                            ],
                                                            'Rate' => [
                                                                'description' => '',
                                                                'example' => '99.91',
                                                                'format' => 'float',
                                                                'type' => 'number',
                                                            ],
                                                            'Details' => [
                                                                'description' => '',
                                                                'items' => [
                                                                    'properties' => [
                                                                        'Label' => [
                                                                            'description' => '',
                                                                            'example' => 'ad',
                                                                            'type' => 'string',
                                                                        ],
                                                                        'Contexts' => [
                                                                            'description' => '',
                                                                            'items' => [
                                                                                'properties' => [
                                                                                    'Context' => [
                                                                                        'description' => '',
                                                                                        'example' => '',
                                                                                        'type' => 'string',
                                                                                    ],
                                                                                ],
                                                                                'type' => 'object',
                                                                            ],
                                                                            'type' => 'array',
                                                                        ],
                                                                    ],
                                                                    'type' => 'object',
                                                                ],
                                                                'type' => 'array',
                                                            ],
                                                        ],
                                                        'type' => 'object',
                                                    ],
                                                    'type' => 'array',
                                                ],
                                            ],
                                            'type' => 'object',
                                        ],
                                        'type' => 'array',
                                    ],
                                ],
                                'type' => 'object',
                            ],
                        ],
                        'type' => 'object',
                    ],
                ],
            ],
            'responseDemo' => '[{"type":"json","example":"{\\n  \\"RequestId\\": \\"C7CD87E3-57A5-4E2F-8A44-809F3554692C\\",\\n  \\"Data\\": {\\n    \\"Elements\\": [\\n      {\\n        \\"TaskId\\": \\"txt6Vh5Fv0DAFy5hgdVRt3pqf-1s82jj\\",\\n        \\"Results\\": [\\n          {\\n            \\"Suggestion\\": \\"block\\",\\n            \\"Label\\": \\"ad\\",\\n            \\"Rate\\": 99.91,\\n            \\"Details\\": [\\n              {\\n                \\"Label\\": \\"ad\\",\\n                \\"Contexts\\": [\\n                  {\\n                    \\"Context\\": \\"联系weixin\\"\\n                  }\\n                ]\\n              }\\n            ]\\n          }\\n        ]\\n      }\\n    ]\\n  }\\n}","errorExample":""},{"type":"xml","example":"<ScanTextResponse>\\n    <RequestId>4FCBCC61-6264-56DE-9CF3-44C014F63B75</RequestId>\\n    <Data>\\n        <Elements>\\n            <TaskId>txt4OFqbn2s4WQ6kVA$dQGn9X-1vvHuZ</TaskId>\\n            <Results>\\n                <Suggestion>block</Suggestion>\\n                <Details>\\n                    <Label>ad</Label>\\n                    <Contexts>\\n                        <Context>联系weixin </Context>\\n                    </Contexts>\\n                </Details>\\n                <Rate>99.91</Rate>\\n                <Label>ad</Label>\\n            </Results>\\n        </Elements>\\n    </Data>\\n</ScanTextResponse>","errorExample":""}]',
            'requestParamsDescription' => ' ',
        ],
    ],
    'endpoints' => [
        [
            'regionId' => 'cn-shanghai',
            'endpoint' => 'imageaudit.cn-shanghai.aliyuncs.com',
        ],
    ],
];