data/en_us/imgsearch/2020-03-20/api-docs.php


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
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611

<?php return [
    'version' => '1.0',
    'info' => [
        'style' => 'RPC',
        'product' => 'imgsearch',
        'version' => '2020-03-20',
    ],
    'directories' => [
        [
            'id' => 64439,
            'title' => null,
            'type' => 'directory',
            'children' => [
                'CreateImageDb',
                'ListImageDbs',
                'AddImage',
                'ListImages',
                'SearchImage',
                'DeleteImageDb',
                'DeleteImage',
            ],
        ],
    ],
    'components' => [
        'schemas' => [],
    ],
    'apis' => [
        'CreateImageDb' => [
            'methods' => [
                'post',
                'get',
            ],
            'schemes' => [
                'http',
                'https',
            ],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'operationType' => 'read',
            'deprecated' => false,
            'systemTags' => [
                'operationType' => 'create',
            ],
            'parameters' => [
                [
                    'name' => 'Name',
                    'in' => 'formData',
                    'schema' => [
                        'description' => '',
                        'example' => 'default',
                        'required' => true,
                        'type' => 'string',
                    ],
                ],
            ],
            'responses' => [
                200 => [
                    'schema' => [
                        'properties' => [
                            'RequestId' => [
                                'description' => '',
                                'example' => 'DD106AE3-838A-41D7-8CD0-B902DC2BC109',
                                'type' => 'string',
                            ],
                        ],
                        'type' => 'object',
                    ],
                ],
            ],
            'responseDemo' => '[{"type":"json","example":"{\\n  \\"RequestId\\": \\"DD106AE3-838A-41D7-8CD0-B902DC2BC109\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>DD106AE3-838A-41D7-8CD0-B902DC2BC109</RequestId>","errorExample":""}]',
            'requestParamsDescription' => ' ',
            'responseParamsDescription' => ' ',
        ],
        'ListImageDbs' => [
            'methods' => [
                'post',
                'get',
            ],
            'schemes' => [
                'http',
                'https',
            ],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'operationType' => 'read',
            'deprecated' => false,
            'systemTags' => [
                'operationType' => 'get',
            ],
            'parameters' => [],
            'responses' => [
                200 => [
                    'schema' => [
                        'properties' => [
                            'RequestId' => [
                                'description' => '',
                                'example' => '4E010B89-B370-458A-A586-B9A9F3BC3058',
                                'type' => 'string',
                            ],
                            'Data' => [
                                'description' => '',
                                'properties' => [
                                    'DbList' => [
                                        'description' => '',
                                        'items' => [
                                            'properties' => [
                                                'Name' => [
                                                    'description' => '',
                                                    'example' => 'default',
                                                    'type' => 'string',
                                                ],
                                            ],
                                            'type' => 'object',
                                        ],
                                        'type' => 'array',
                                    ],
                                ],
                                'type' => 'object',
                            ],
                        ],
                        'type' => 'object',
                    ],
                ],
            ],
            'responseDemo' => '[{"type":"json","example":"{\\n  \\"RequestId\\": \\"4E010B89-B370-458A-A586-B9A9F3BC3058\\",\\n  \\"Data\\": {\\n    \\"DbList\\": [\\n      {\\n        \\"Name\\": \\"default\\"\\n      }\\n    ]\\n  }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>4E010B89-B370-458A-A586-B9A9F3BC3058</RequestId>\\n<Data>\\n    <DbList>\\n        <Name>default</Name>\\n    </DbList>\\n</Data>","errorExample":""}]',
            'requestParamsDescription' => ' ',
            'responseParamsDescription' => ' ',
        ],
        'AddImage' => [
            'methods' => [
                'post',
                'get',
            ],
            'schemes' => [
                'http',
                'https',
            ],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'operationType' => 'read',
            'deprecated' => false,
            'systemTags' => [
                'operationType' => 'create',
            ],
            'parameters' => [
                [
                    'name' => 'DbName',
                    'in' => 'formData',
                    'schema' => [
                        'description' => '',
                        'example' => 'default',
                        'required' => true,
                        'type' => 'string',
                    ],
                ],
                [
                    'name' => 'ImageUrl',
                    'in' => 'formData',
                    'schema' => [
                        'description' => '',
                        'example' => 'https://viapi-test.oss-cn-shanghai.aliyuncs.com/test/imgsearch/xxxx.png',
                        'isFileTransferUrl' => true,
                        'required' => true,
                        'type' => 'string',
                    ],
                ],
                [
                    'name' => 'ExtraData',
                    'in' => 'formData',
                    'schema' => [
                        'description' => '',
                        'example' => '',
                        'required' => false,
                        'type' => 'string',
                    ],
                ],
                [
                    'name' => 'EntityId',
                    'in' => 'formData',
                    'schema' => [
                        'description' => '',
                        'example' => '001',
                        'required' => true,
                        'type' => 'string',
                    ],
                ],
            ],
            'responses' => [
                200 => [
                    'schema' => [
                        'properties' => [
                            'RequestId' => [
                                'description' => '',
                                'example' => '4DC6BB62-06D1-4242-939A-4AC500662E33',
                                'type' => 'string',
                            ],
                            'Data' => [
                                'description' => '',
                                'properties' => [
                                    'DataId' => [
                                        'description' => '',
                                        'example' => '1585903814940000',
                                        'type' => 'string',
                                    ],
                                ],
                                'type' => 'object',
                            ],
                        ],
                        'type' => 'object',
                    ],
                ],
            ],
            'responseDemo' => '[{"type":"json","example":"{\\n  \\"RequestId\\": \\"4DC6BB62-06D1-4242-939A-4AC500662E33\\",\\n  \\"Data\\": {\\n    \\"DataId\\": \\"1585903814940000\\"\\n  }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>4DC6BB62-06D1-4242-939A-4AC500662E33</RequestId>\\n<Data>\\n    <DataId>1585903814940000</DataId>\\n</Data>","errorExample":""}]',
            'requestParamsDescription' => ' ',
            'responseParamsDescription' => ' ',
        ],
        'ListImages' => [
            'methods' => [
                'post',
                'get',
            ],
            'schemes' => [
                'http',
                'https',
            ],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'operationType' => 'read',
            'deprecated' => false,
            'systemTags' => [
                'operationType' => 'get',
            ],
            'parameters' => [
                [
                    'name' => 'DbName',
                    'in' => 'formData',
                    'schema' => [
                        'description' => '',
                        'example' => 'default',
                        'required' => true,
                        'type' => 'string',
                    ],
                ],
                [
                    'name' => 'Token',
                    'in' => 'formData',
                    'schema' => [
                        'description' => '',
                        'example' => '2',
                        'required' => false,
                        'type' => 'string',
                    ],
                ],
                [
                    'name' => 'Offset',
                    'in' => 'formData',
                    'schema' => [
                        'description' => '',
                        'example' => '1',
                        'format' => 'int32',
                        'required' => false,
                        'type' => 'integer',
                    ],
                ],
                [
                    'name' => 'Limit',
                    'in' => 'formData',
                    'schema' => [
                        'description' => '',
                        'example' => '50',
                        'format' => 'int32',
                        'required' => false,
                        'type' => 'integer',
                    ],
                ],
                [
                    'name' => 'Order',
                    'in' => 'formData',
                    'schema' => [
                        'description' => '',
                        'example' => 'asc',
                        'required' => false,
                        'type' => 'string',
                    ],
                ],
                [
                    'name' => 'EntityIdPrefix',
                    'in' => 'formData',
                    'schema' => [
                        'description' => '',
                        'example' => 'U1',
                        'required' => false,
                        'type' => 'string',
                    ],
                ],
            ],
            'responses' => [
                200 => [
                    'schema' => [
                        'properties' => [
                            'RequestId' => [
                                'description' => '',
                                'example' => '2B93C43A-F824-40C8-AF79-844342B0F43A',
                                'type' => 'string',
                            ],
                            'Data' => [
                                'description' => '',
                                'properties' => [
                                    'ImageList' => [
                                        'description' => '',
                                        'items' => [
                                            'properties' => [
                                                'EntityId' => [
                                                    'description' => '',
                                                    'example' => '5',
                                                    'type' => 'string',
                                                ],
                                                'CreatedAt' => [
                                                    'description' => '',
                                                    'example' => '1582838489213',
                                                    'format' => 'int64',
                                                    'type' => 'integer',
                                                ],
                                                'UpdatedAt' => [
                                                    'description' => '',
                                                    'example' => '1582838489213',
                                                    'format' => 'int64',
                                                    'type' => 'integer',
                                                ],
                                                'DataId' => [
                                                    'description' => '',
                                                    'example' => '001',
                                                    'type' => 'string',
                                                ],
                                                'ExtraData' => [
                                                    'description' => '',
                                                    'example' => '',
                                                    'type' => 'string',
                                                ],
                                            ],
                                            'type' => 'object',
                                        ],
                                        'type' => 'array',
                                    ],
                                    'Token' => [
                                        'description' => '',
                                        'example' => '2',
                                        'type' => 'string',
                                    ],
                                    'TotalCount' => [
                                        'description' => '',
                                        'example' => '100',
                                        'format' => 'int32',
                                        'type' => 'integer',
                                    ],
                                ],
                                'type' => 'object',
                            ],
                        ],
                        'type' => 'object',
                    ],
                ],
            ],
            'responseDemo' => '[{"type":"json","example":"{\\n  \\"RequestId\\": \\"2B93C43A-F824-40C8-AF79-844342B0F43A\\",\\n  \\"Data\\": {\\n    \\"ImageList\\": [\\n      {\\n        \\"EntityId\\": \\"5\\",\\n        \\"CreatedAt\\": 1582838489213,\\n        \\"UpdatedAt\\": 1582838489213,\\n        \\"DataId\\": \\"001\\",\\n        \\"ExtraData\\": \\"元素\\"\\n      }\\n    ],\\n    \\"Token\\": \\"2\\",\\n    \\"TotalCount\\": 100\\n  }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>2B93C43A-F824-40C8-AF79-844342B0F43A</RequestId>\\n<Data>\\n    <Token>2</Token>\\n    <TotalCount>100</TotalCount>\\n    <ImageList>\\n        <DataId>22</DataId>\\n        <ExtraData>元素</ExtraData>\\n        <EntityId>5</EntityId>\\n        <UpdatedAt>1582838489213</UpdatedAt>\\n        <CreatedAt>1582838489213</CreatedAt>\\n    </ImageList>\\n</Data>","errorExample":""}]',
            'requestParamsDescription' => ' ',
            'responseParamsDescription' => ' ',
        ],
        'SearchImage' => [
            'methods' => [
                'post',
                'get',
            ],
            'schemes' => [
                'http',
                'https',
            ],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'operationType' => 'read',
            'deprecated' => false,
            'systemTags' => [
                'operationType' => 'get',
            ],
            'parameters' => [
                [
                    'name' => 'DbName',
                    'in' => 'formData',
                    'schema' => [
                        'description' => '',
                        'example' => 'default',
                        'required' => true,
                        'type' => 'string',
                    ],
                ],
                [
                    'name' => 'ImageUrl',
                    'in' => 'formData',
                    'schema' => [
                        'description' => '',
                        'example' => 'http://viapi-test.oss-cn-shanghai.aliyuncs.com/viapi-3.0domepic/imgsearch/SearchImage/SearchImage-ku8.png',
                        'isFileTransferUrl' => true,
                        'required' => true,
                        'type' => 'string',
                    ],
                ],
                [
                    'name' => 'Limit',
                    'in' => 'formData',
                    'schema' => [
                        'description' => '',
                        'example' => '5',
                        'format' => 'int32',
                        'maximum' => '1000',
                        'minimum' => '0',
                        'required' => true,
                        'type' => 'integer',
                    ],
                ],
            ],
            'responses' => [
                200 => [
                    'schema' => [
                        'description' => '1',
                        'properties' => [
                            'RequestId' => [
                                'description' => '',
                                'example' => 'A98DBCEB-45E2-5F5F-B5ED-F2340182FD87',
                                'type' => 'string',
                            ],
                            'Data' => [
                                'description' => '',
                                'properties' => [
                                    'MatchList' => [
                                        'description' => '',
                                        'items' => [
                                            'description' => '1',
                                            'properties' => [
                                                'ImageUrl' => [
                                                    'description' => '',
                                                    'example' => 'http://vision-console.oss-cn-shanghai.aliyuncs.com/1902352443710590/kv6dvd1ie0c6-ipvnszc8584116.jpg?Expires=1635150265&OSSAccessKeyId=LTAI4Fp1Gt5RzwdEXL3o****&Signature=8rj0%2Bxg%2Bni5NxQAcEQqISX5j1w****',
                                                    'type' => 'string',
                                                ],
                                                'EntityId' => [
                                                    'description' => '',
                                                    'example' => '123456',
                                                    'type' => 'string',
                                                ],
                                                'Score' => [
                                                    'description' => '',
                                                    'example' => '10',
                                                    'format' => 'float',
                                                    'type' => 'number',
                                                ],
                                                'DataId' => [
                                                    'description' => '',
                                                    'example' => '001',
                                                    'type' => 'string',
                                                ],
                                                'ExtraData' => [
                                                    'description' => '',
                                                    'example' => 'tangyan',
                                                    'type' => 'string',
                                                ],
                                            ],
                                            'type' => 'object',
                                        ],
                                        'type' => 'array',
                                    ],
                                ],
                                'type' => 'object',
                            ],
                        ],
                        'type' => 'object',
                    ],
                ],
            ],
            'responseDemo' => '[{"type":"json","example":"{\\n  \\"RequestId\\": \\"A98DBCEB-45E2-5F5F-B5ED-F2340182FD87\\",\\n  \\"Data\\": {\\n    \\"MatchList\\": [\\n      {\\n        \\"ImageUrl\\": \\"http://vision-console.oss-cn-shanghai.aliyuncs.com/1902352443710590/kv6dvd1ie0c6-ipvnszc8584116.jpg?Expires=1635150265&OSSAccessKeyId=LTAI****************&Signature=8rj0%2Bxg%2Bni5NxQAcEQqISX5j1w****\\",\\n        \\"EntityId\\": \\"123456\\",\\n        \\"Score\\": 10,\\n        \\"DataId\\": \\"001\\",\\n        \\"ExtraData\\": \\"tangyan\\"\\n      }\\n    ]\\n  }\\n}","errorExample":""},{"type":"xml","example":"<SearchImageResponse>\\n    <RequestId>A98DBCEB-45E2-5F5F-B5ED-F2340182FD87</RequestId>\\n    <Data>\\n        <MatchList>\\n            <EntityId>123456</EntityId>\\n            <Score>10</Score>\\n            <DataId>1</DataId>\\n            <ImageUrl>http://vision-console.oss-cn-shanghai.aliyuncs.com/1902352443710590/kv6dvd1ie0c6-ipvnszc8584116.jpg?Expires=1635150265&amp;OSSAccessKeyId=LTAI****************&amp;Signature=8rj0%2Bxg%2Bni5NxQAcEQqISX5j1w****</ImageUrl>\\n            <ExtraData>zhaoliu</ExtraData>\\n        </MatchList>\\n        <MatchList>\\n            <EntityId>123457</EntityId>\\n            <Score>1.1762875356333269</Score>\\n            <DataId>2</DataId>\\n            <ImageUrl>http://vision-console.oss-cn-shanghai.aliyuncs.com/1902352443710590/kv6dvd1uimages1.jpg?Expires=1635151060&amp;OSSAccessKeyId=LTAI****************&amp;Signature=%2Byceg79YwiShi1RWDSQ%2FSZcIec****</ImageUrl>\\n            <ExtraData>wangwu</ExtraData>\\n        </MatchList>\\n        <MatchList>\\n            <EntityId>123458</EntityId>\\n            <Score>0.9932686334385976</Score>\\n            <DataId>3</DataId>\\n            <ImageUrl>http://vision-console.oss-cn-shanghai.aliyuncs.com/1902352443710590/kv6dvd1ximages2.jpg?Expires=1635151141&amp;OSSAccessKeyId=LTAI****************&amp;Signature=rHoEnFco%2BfLWyzHZGFwUpOaySZ****</ImageUrl>\\n            <ExtraData>zhangsan</ExtraData>\\n        </MatchList>\\n        <MatchList>\\n            <EntityId>123459</EntityId>\\n            <Score>1.2938829068163327</Score>\\n            <DataId>4</DataId>\\n            <ImageUrl>http://vision-console.oss-cn-shanghai.aliyuncs.com/1902352443710590/kv6dvd1m641.jpg?Expires=1635150931&amp;OSSAccessKeyId=LTAI****************&amp;Signature=5m8NJ50eokih%2Fcxp%2B%2BnsA%2BTT%2BG****</ImageUrl>\\n            <ExtraData>lisi</ExtraData>\\n        </MatchList>\\n    </Data>\\n</SearchImageResponse>","errorExample":""}]',
            'requestParamsDescription' => ' ',
            'responseParamsDescription' => ' ',
        ],
        'DeleteImageDb' => [
            'methods' => [
                'post',
                'get',
            ],
            'schemes' => [
                'http',
                'https',
            ],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'operationType' => 'read',
            'deprecated' => false,
            'systemTags' => [
                'operationType' => 'delete',
            ],
            'parameters' => [
                [
                    'name' => 'Name',
                    'in' => 'formData',
                    'schema' => [
                        'description' => '',
                        'example' => 'default',
                        'required' => true,
                        'type' => 'string',
                    ],
                ],
            ],
            'responses' => [
                200 => [
                    'schema' => [
                        'properties' => [
                            'RequestId' => [
                                'description' => '',
                                'example' => '3F3F81A5-4C37-4716-AE5C-518D2537365C',
                                'type' => 'string',
                            ],
                        ],
                        'type' => 'object',
                    ],
                ],
            ],
            'responseDemo' => '[{"type":"json","example":"{\\n  \\"RequestId\\": \\"3F3F81A5-4C37-4716-AE5C-518D2537365C\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>3F3F81A5-4C37-4716-AE5C-518D2537365C</RequestId>","errorExample":""}]',
            'requestParamsDescription' => ' ',
            'responseParamsDescription' => ' ',
        ],
        'DeleteImage' => [
            'methods' => [
                'post',
                'get',
            ],
            'schemes' => [
                'http',
                'https',
            ],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'operationType' => 'read',
            'deprecated' => false,
            'systemTags' => [
                'operationType' => 'delete',
            ],
            'parameters' => [
                [
                    'name' => 'DbName',
                    'in' => 'formData',
                    'schema' => [
                        'description' => '',
                        'example' => 'default',
                        'required' => true,
                        'type' => 'string',
                    ],
                ],
                [
                    'name' => 'EntityId',
                    'in' => 'formData',
                    'schema' => [
                        'description' => '',
                        'example' => '1',
                        'required' => true,
                        'type' => 'string',
                    ],
                ],
            ],
            'responses' => [
                200 => [
                    'schema' => [
                        'properties' => [
                            'RequestId' => [
                                'description' => '',
                                'example' => '3F3F81A5-4C37-4716-AE5C-518D2537365C',
                                'type' => 'string',
                            ],
                        ],
                        'type' => 'object',
                    ],
                ],
            ],
            'responseDemo' => '[{"type":"json","example":"{\\n  \\"RequestId\\": \\"3F3F81A5-4C37-4716-AE5C-518D2537365C\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>3F3F81A5-4C37-4716-AE5C-518D2537365C</RequestId>","errorExample":""}]',
            'requestParamsDescription' => ' ',
            'responseParamsDescription' => ' ',
        ],
    ],
    'endpoints' => [
        [
            'regionId' => 'cn-shanghai',
            'endpoint' => 'imgsearch.cn-shanghai.aliyuncs.com',
        ],
    ],
];