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
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
|
<?php return [
'version' => '1.0',
'info' => ['style' => 'RPC', 'product' => 'ImageSearch', 'version' => '2020-12-14'],
'directories' => [
[
'children' => ['AddImage', 'DeleteImage'],
'type' => 'directory',
'title' => '管理',
'id' => 35413,
],
[
'children' => ['SearchImageByName', 'SearchImageByPic'],
'type' => 'directory',
'title' => '搜索',
'id' => 35416,
],
[
'children' => ['CompareSimilarByImage', 'Detail', 'DumpMeta', 'DumpMetaList', 'IncreaseInstance', 'IncreaseList', 'SearchImageByText', 'UpdateImage', 'CheckImageExists', 'SearchImageByFilter'],
'type' => 'directory',
'title' => '其他',
'id' => 35419,
],
],
'components' => [
'schemas' => [],
],
'apis' => [
'AddImage' => [
'summary' => '本文为您介绍AddImage接口的语法及示例,用于向图像搜索实例中添加图片信息。',
'methods' => ['post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREimagesearchAOOGRD'],
],
'parameters' => [
[
'name' => 'InstanceName',
'in' => 'formData',
'schema' => ['description' => '图搜实例名称。最多支持20个字符。'."\n"
.'如果已经购买图搜实例可登录[图像搜索管控台](https://imagesearch.console.aliyun.com/)查看。'."\n"
.'如果没有购买图搜实例可参考[开通服务](~~179178~~)和[创建实例](~~66569~~)。'."\n"
.'>这里的实例名称并非实例ID,使用时请区分。', 'type' => 'string', 'required' => true, 'example' => 'demoinstance1'],
],
[
'name' => 'ProductId',
'in' => 'formData',
'schema' => ['description' => '商品ID,最多支持256个字符。'."\n"
."\n"
.'>一个商品可以有多张图片。', 'type' => 'string', 'required' => true, 'example' => '2092061_1'],
],
[
'name' => 'PicName',
'in' => 'formData',
'schema' => ['description' => ' 图片名称,最多支持256个字符。'."\n"
.'> - ProductId和PicName唯一确定一张图片。'."\n"
.'- 如果多次添加图片具有相同的ProductId和PicName,以最后一次添加为准,前面添加的图片将被覆盖。'."\n", 'type' => 'string', 'required' => true, 'example' => '2092061_1.jpg'],
],
[
'name' => 'PicContent',
'in' => 'formData',
'schema' => ['description' => '图片内容。'."\n"
.' - 图片大小要求不超过4 MB。'."\n"
.' - 图片格式:PNG、JPG、JPEG、BMP、GIF、WEBP、TIFF、PPM。'."\n"
.' - 传输等待时间不超过5秒。'."\n"
.'<props="china">'."\n"
.' - 服务类型为商品图片搜索、通用图片搜索、家具家居图片搜索和工业五金图片搜索时,图片长和宽像素要求大于等于100PX且小于等于4096PX。'."\n"
.' 服务类型为商标图片搜索时,图片长和宽像素要求大于等于200PX且小于4096PX。'."\n"
.' 服务类型为布料图片搜索时,图片长和宽像素要求大于等于448PX且小于等于4096PX。'."\n"
.'</props>'."\n"
.'<props="intl">'."\n"
.' - 服务类型为商品图片搜索和通用图片搜索时,图片长和宽像素要求大于等于100PX且小于等于4096PX。'."\n"
.'</props>'."\n"
.'- 图片中不能包含旋转信息。'."\n"
."\n"
.'> - **使用SDK方式调用:**'."\n"
.' - 如使用V3版本SDK,则无需填写PicContent字段,SDK已将本字段封装为PicContentObject字段并自动转化为Base64编码。具体示例参考[JAVA SDK](~~179188~~)。'."\n"
.' - SDK不支持客户直接传递图片URL,V3版本SDK提供了一种变相实现URL上传的方式。具体示例参考[JAVA SDK](~~179188~~)。'."\n"
.'- **使用阿里云OpenAPI平台调用:**'."\n"
.' - 如使用**2019-03-25**版本,**PicContent**字段请填写图片的**Base64**编码。'."\n"
.' - 如使用**2020-12-14**版本,在**PicContent**字段直接点击上传图片即可。', 'type' => 'string', 'required' => true, 'example' => 'AAAANSUhEUgAAAPcAAAEVCAYAAAA8d3NuAAAAAXNSR0IArs......RK5CYII=', 'isFileTransferUrl' => true],
],
[
'name' => 'CategoryId',
'in' => 'formData',
'schema' => ['description' => '图片类目。具体请参考[类目参考](~~179184~~)。'."\n"
.'> - 对于商品搜索,若设置类目,则以设置的为准;若不设置类目,将由系统进行类目预测,预测的类目结果可在Response中获取 。'."\n"
.'<props="china">'."\n"
.'- 对于布料、商标、通用、家具家居和工业五金搜索,不论是否设置类目,系统会将类目设置为88888888。'."\n"
.'</props>'."\n"
.'- 对于通用搜索,不论是否设置类目,系统会将类目设置为88888888。'."\n"
."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '88888888'],
],
[
'name' => 'Crop',
'in' => 'formData',
'schema' => ['description' => '是否需要进行主体识别。默认true。'."\n"
.' - 为true:由系统进行主体识别,以识别的主体进行搜索,主体识别结果可在Response中获取。'."\n"
.'- 为false:则不进行主体识别,以整张图进行搜索。'."\n"
."\n"
.'<props="china">对于布料图片搜索,此参数会被忽略,系统会以整张图进行搜索。</props>'."\n"
."\n\n", 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'Region',
'in' => 'formData',
'schema' => ['description' => '图片的主体区域,格式为`x1,x2,y1,y2`, 其中`x1,y1 `是左上角的点,`x2,y2`是右下角的点。'."\n"
.'> - 若用户设置了Region,则不论Crop参数为何值,都将以用户输入Region进行搜索。'."\n"
.'<props="china">'."\n"
.'- 对于布料图片搜索,此参数会被忽略,系统会以整张图进行搜索。'."\n"
.'</props>'."\n"
.'- Region参数没有单位,是参考使用图片的长宽PX像素尺寸标记的结果,如果图片缩放对应Region参数值也要等比例缩放。', 'type' => 'string', 'required' => false, 'example' => '280,486,232,351'],
],
[
'name' => 'CustomContent',
'in' => 'formData',
'schema' => ['description' => '用户自定义的内容,最多支持4096个字符。'."\n"
.'>查询时会返回该字段。例如可添加图片的描述等文本。', 'type' => 'string', 'required' => false, 'example' => 'zidingyi'],
],
[
'name' => 'IntAttr',
'in' => 'formData',
'schema' => ['description' => '整数类型属性,可用于查询时过滤,查询时会返回该字段。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '22'],
],
[
'name' => 'StrAttr',
'in' => 'formData',
'schema' => ['description' => '字符串类型属性,最多支持128个字符。可用于查询时过滤,查询时会返回该字段。'."\n"
.'> 不支持特殊字符比如:\\¥$&%', 'type' => 'string', 'required' => false, 'example' => 'ss'],
],
[
'name' => 'IntAttr2',
'in' => 'formData',
'schema' => ['description' => '整数类型属性,可用于查询时过滤,查询时会返回该字段。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '22'],
],
[
'name' => 'StrAttr2',
'in' => 'formData',
'schema' => ['description' => '字符串类型属性,最多支持128个字符。可用于查询时过滤,查询时会返回该字段。'."\n"
.'> 不支持特殊字符比如:\\¥$&%', 'type' => 'string', 'required' => false, 'example' => 'ss'],
],
[
'name' => 'IntAttr3',
'in' => 'formData',
'schema' => ['description' => '整数类型属性,可用于查询时过滤,查询时会返回该字段。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '33'],
],
[
'name' => 'StrAttr3',
'in' => 'formData',
'schema' => ['description' => '字符串类型属性,最多支持128个字符。可用于查询时过滤,查询时会返回该字段。'."\n"
.'> 不支持特殊字符比如:\\¥$&%', 'type' => 'string', 'required' => false, 'example' => 'ss'],
],
[
'name' => 'IntAttr4',
'in' => 'formData',
'schema' => ['description' => '整数类型属性,可用于查询时过滤,查询时会返回该字段。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '44'],
],
[
'name' => 'StrAttr4',
'in' => 'formData',
'schema' => ['description' => '字符串类型属性,最多支持128个字符。可用于查询时过滤,查询时会返回该字段。'."\n"
.'> 不支持特殊字符比如:\\¥$&%', 'type' => 'string', 'required' => false, 'example' => 'ss'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '参数返回结果。',
'type' => 'object',
'properties' => [
'Message' => ['description' => '错误信息。'."\n"
.'> 成功请求不返回数据,失败请求返回错误信息。', 'type' => 'string', 'example' => 'success'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'E0845DE6-52AF-4B50-9F15-51ED4044E6AB'],
'Code' => ['description' => '错误码。'."\n"
."\n"
.'- 0:成功。'."\n"
.'- 非0:失败。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'PicInfo' => [
'description' => '类目预测、主体识别结果。',
'type' => 'object',
'properties' => [
'Region' => ['description' => '主体识别结果。图片的主体区域,格式为`x1,x2,y1,y2`,其中`x1,y1`是左上角的点,`x2,y2`是右下角的点。若用户请求中指定了主体区域,则以请求中为准。', 'type' => 'string', 'example' => '94,691,206,650'],
'CategoryId' => ['description' => '类目预测结果。若用户请求中指定了类目,则以请求中为准。', 'type' => 'integer', 'format' => 'int32', 'example' => '88888888'],
'MultiRegion' => [
'description' => '主体识别结果集合。'."\n"
.'> 需要版本升级至V3.1.1方可使用。',
'type' => 'array',
'items' => [
'description' => '主体识别结果。',
'type' => 'object',
'properties' => [
'Region' => ['description' => '主体识别结果。图片的主体区域,格式为x1,x2,y1,y2,其中 x1,y1 是左上角的点,x2,y2是右下角的点。若用户请求中指定了主体区域,则以请求中为准。', 'type' => 'string', 'example' => '94,691,206,650'],
],
],
],
'AllCategories' => [
'description' => '系统支持的所有类目信息。',
'type' => 'array',
'items' => [
'description' => '系统支持的所有类目信息。',
'type' => 'object',
'properties' => [
'Name' => ['description' => '类目名称。', 'type' => 'string', 'example' => 'Other'],
'Id' => ['description' => '类目ID。', 'type' => 'integer', 'format' => 'int32', 'example' => '88888888'],
],
],
],
],
],
'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'BadRequest', 'errorMessage' => 'The request has invalid parameters.', 'description' => ''],
['errorCode' => 'InstanceStatusError', 'errorMessage' => 'Your instance is unavailable.', 'description' => ''],
['errorCode' => 'InvalidInstance', 'errorMessage' => 'The specified instance name is invalid.', 'description' => '实例名错误'],
['errorCode' => 'NoCaretSeperator', 'errorMessage' => 'The body content is missing the ^ separator.', 'description' => '请求body缺少特定符号'],
['errorCode' => 'EmptyMeta', 'errorMessage' => 'The body content has an empty meta field.', 'description' => '请求body含有空的字段'],
['errorCode' => 'InvalidMetaItem', 'errorMessage' => 'The meta field is invalid.', 'description' => '无效的元信息字段'],
['errorCode' => 'NoPicList', 'errorMessage' => 'The body content is missing the pic_list parameter.', 'description' => '未指定pic_list字段'],
['errorCode' => 'NoSpecifiedPic', 'errorMessage' => 'The content of an image is not specified in the HTTP POST body.', 'description' => '图片未指定'],
['errorCode' => 'NoSpecifiedSearchPic', 'errorMessage' => 'The search image is not specified.', 'description' => ''],
['errorCode' => 'InvalidCategory', 'errorMessage' => 'The specified category is invalid.', 'description' => '无效的类目id'],
['errorCode' => 'OverflowMaxResultNum', 'errorMessage' => 'The specified number of total results exceeds the maximum of 500.', 'description' => '超过了最大的返回结果限制数500'],
['errorCode' => 'OverflowMaxReturnNum', 'errorMessage' => 'The specified number of results for each request exceeds the maximum of 100.', 'description' => '单次返回数超过限制值100'],
['errorCode' => 'InvalidStartParameter', 'errorMessage' => 'The specified parameter s is inavlid.', 'description' => ''],
['errorCode' => 'InvalidNumParameter', 'errorMessage' => 'The specified parameter n is invalid.', 'description' => ''],
['errorCode' => 'NoSpecifiedAddPic', 'errorMessage' => 'The image to insert is not specified.', 'description' => ''],
['errorCode' => 'NoSpecifiedItemId', 'errorMessage' => 'The item_id parameter is not specified.', 'description' => ''],
['errorCode' => 'InvalidIntAttr', 'errorMessage' => 'The specified int_attr field is invalid.', 'description' => '无效的int过滤字段'],
['errorCode' => 'UnsupportedPicFormat', 'errorMessage' => 'The specified image format is invalid.', 'description' => '无效的图片格式'],
['errorCode' => 'InvalidFilterClause', 'errorMessage' => 'The specified filtering condition is invalid.', 'description' => '无效的过滤条件'],
['errorCode' => 'InstanceOverQuota', 'errorMessage' => 'The number of items exceeds the limit.', 'description' => '实例的图片数量超过限制值'],
['errorCode' => 'IncorrectOrientation', 'errorMessage' => 'The image contains incorrect rotation flags in the meta data.', 'description' => '图片包含不支持的旋转参数'],
['errorCode' => 'UnsupportedPicPixels', 'errorMessage' => 'The specified pixels is not supported.', 'description' => '图片像素值不支持'],
['errorCode' => 'SearchTimeout', 'errorMessage' => 'The request is timed out.', 'description' => ''],
['errorCode' => 'PicNotExist', 'errorMessage' => 'The search picture does not exist.', 'description' => ''],
['errorCode' => 'NoSpecifiedProductId', 'errorMessage' => 'The parameter ProductId no specified.', 'description' => ''],
['errorCode' => 'NoSpecifiedPicName', 'errorMessage' => 'The parameter PicName no specified.', 'description' => ''],
['errorCode' => 'NoSpecifiedPicContent', 'errorMessage' => 'The parameter PicContent no specified.', 'description' => ''],
['errorCode' => 'InvalidType', 'errorMessage' => 'The specified parameter Type is not valid.', 'description' => ''],
['errorCode' => 'InvalidProductId', 'errorMessage' => 'The specified parameter ProductId is not valid.', 'description' => ''],
['errorCode' => 'InvalidPicName', 'errorMessage' => 'The specified parameter PicName is not valid.', 'description' => ''],
['errorCode' => 'InvalidStrAttr', 'errorMessage' => 'The specified parameter StrAttr is not valid.', 'description' => '无效StrAttr'],
['errorCode' => 'InvalidCustomContent', 'errorMessage' => 'The specified parameter CustomContent is not valid.', 'description' => ''],
['errorCode' => 'InvalidPicContent', 'errorMessage' => 'The specified parameter PicContent length greater than 4 * 1024 * 1024.', 'description' => ''],
['errorCode' => 'TimeoutForTransferImage', 'errorMessage' => 'Timeout after 5 seconds waiting for images transfer to complete.', 'description' => ''],
['errorCode' => 'InvalidPicUrl', 'errorMessage' => 'The search picture does not exist at the specific url.', 'description' => ''],
['errorCode' => 'InvalidInstanceName', 'errorMessage' => 'The parameter instanceName is not specified.', 'description' => ''],
['errorCode' => 'InvalidRequestId', 'errorMessage' => 'The parameter requestId is not specified.', 'description' => ''],
['errorCode' => 'InvalidRequestIdTooLarge', 'errorMessage' => 'The parameter requestId is too large.', 'description' => ''],
['errorCode' => 'InvalidRegion', 'errorMessage' => 'The specific region is illegal.', 'description' => ''],
['errorCode' => 'RegionError', 'errorMessage' => 'region.', 'description' => ''],
['errorCode' => 'InvalidStrAttr2', 'errorMessage' => 'The specified parameter StrAttr2 is not valid.', 'description' => '无效StrAttr2'],
['errorCode' => 'InvalidStrAttr3', 'errorMessage' => 'The specified parameter StrAttr3 is not valid.', 'description' => '无效StrAttr3'],
['errorCode' => 'InvalidStrAttr4', 'errorMessage' => 'The specified parameter StrAttr4 is not valid.', 'description' => '无效StrAttr4'],
['errorCode' => 'InvalidIntAttr2', 'errorMessage' => 'The specified parameter IntAttr2 is not valid.', 'description' => '无效IntAttr2'],
['errorCode' => 'InvalidIntAttr3', 'errorMessage' => 'The specified parameter IntAttr3 is not valid.', 'description' => '无效IntAttr3'],
['errorCode' => 'InvalidIntAttr4', 'errorMessage' => 'The specified parameter IntAttr4 is not valid.', 'description' => '无效IntAttr4'],
['errorCode' => 'PictureError', 'errorMessage' => '[download] Img Download Failed.', 'description' => '图片下载失败,请检查图片'],
['errorCode' => 'UnsupportedOperationType', 'errorMessage' => 'The specified action is not supported.', 'description' => '内部错误:不支持的action'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation.', 'description' => '未授权的行为'],
['errorCode' => 'DeniedRequest', 'errorMessage' => 'Your request was denied due to instance flow control.', 'description' => '请求被限流'],
],
500 => [
['errorCode' => 'UnknownException', 'errorMessage' => 'An internal server error occurred.', 'description' => '未知异常'],
['errorCode' => 'NetworkException', 'errorMessage' => 'A network error occurred.', 'description' => '内部错误:请求网络异常'],
['errorCode' => 'RequestTimeout', 'errorMessage' => 'The request is timeout.', 'description' => ''],
['errorCode' => 'ExtractFeatureTimeout', 'errorMessage' => 'The request was timed out while extracting features.', 'description' => ''],
['errorCode' => 'AccessEngineFailed', 'errorMessage' => 'An error occurred while accessing the search engine.', 'description' => ''],
['errorCode' => 'InternalOssError', 'errorMessage' => 'An internal OAS error occurred.', 'description' => '内部错误:请求内部算法错误'],
['errorCode' => 'InternalSwiftError', 'errorMessage' => 'An internal SWIFT error occurred.', 'description' => '内部错误:请求内部消息队列错误'],
['errorCode' => 'InternalTableStoreError', 'errorMessage' => 'An internal Table Store error occurred.', 'description' => '内部错误:请求特征存储错误'],
['errorCode' => 'ConnectionDVException', 'errorMessage' => 'Failed to obtain collection.', 'description' => 'internalError'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"E0845DE6-52AF-4B50-9F15-51ED4044E6AB\\",\\n \\"Code\\": 0,\\n \\"PicInfo\\": {\\n \\"Region\\": \\"94,691,206,650\\",\\n \\"CategoryId\\": 88888888,\\n \\"MultiRegion\\": [\\n {\\n \\"Region\\": \\"94,691,206,650\\"\\n }\\n ],\\n \\"AllCategories\\": [\\n {\\n \\"Name\\": \\"Other\\",\\n \\"Id\\": 88888888\\n }\\n ]\\n },\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<AddImageResponse>\\n <Message>success</Message>\\n <RequestId>E0845DE6-52AF-4B50-9F15-51ED4044E6AB</RequestId>\\n <Code>0</Code>\\n <PicInfo>\\n <Region>94,691,206,650</Region>\\n <CategoryId>88888888</CategoryId>\\n <MultiRegion>\\n <Region>94,691,206,650</Region>\\n </MultiRegion>\\n <AllCategories>\\n <Name>Other</Name>\\n <Id>88888888</Id>\\n </AllCategories>\\n </PicInfo>\\n <Success>true</Success>\\n</AddImageResponse>","errorExample":""}]',
'title' => '新增图片',
'description' => '## 使用说明'."\n"
.'本接口用于向图像搜索实例中添加图片信息。'."\n"
."\n"
.'## QPS限制'."\n"
.'10W图片容量的实例默认的并发量为1,也就是每秒钟最多处理1个图片新增请求。'."\n"
.'其他图片容量的实例默认的并发量为5,也就是每秒钟最多处理5个图片新增请求。',
'extraInfo' => '## 错误码'."\n"
.'请参见[错误码](~~66619~~)。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddImage'],
],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'imagesearch:AddImage',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ImageSearch', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'CheckImageExists' => [
'summary' => 'CheckImageExists',
'path' => '',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREimagesearchF4L5JA'],
],
'parameters' => [
[
'name' => 'InstanceName',
'in' => 'formData',
'schema' => ['description' => '图搜实例名称。最多支持20个字符。'."\n"
.'如果已经购买图搜实例可登录[图像搜索管控台](https://imagesearch.console.aliyun.com/)查看。'."\n"
.'如果没有购买图搜实例可参考[开通服务](~~179178~~)和[创建实例](~~66569~~)。'."\n"
.'>这里的实例名称并非实例ID,使用时请区分。', 'type' => 'string', 'required' => true, 'example' => 'demoinstance1'],
],
[
'name' => 'ProductId',
'in' => 'formData',
'schema' => ['description' => '商品ID。'."\n", 'type' => 'string', 'required' => true, 'example' => '2092061_1', 'isFileTransferUrl' => false],
],
[
'name' => 'PicName',
'in' => 'formData',
'schema' => ['description' => '图片名称。', 'type' => 'string', 'required' => true, 'example' => '2092061_1'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '结果返回。',
'type' => 'object',
'properties' => [
'Msg' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'success'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B3137727-7D6E-488C-BA21-0E034C38A879'],
'Auctions' => [
'description' => '所有返回的商品描述信息。',
'type' => 'object',
'properties' => [
'ProductId' => ['description' => '商品ID。', 'type' => 'string', 'example' => '2092061_1'],
'PicName' => ['description' => '图片名称。', 'type' => 'string', 'example' => '2092061_1.jpg'],
'CategoryId' => ['description' => '图片类目。', 'type' => 'integer', 'format' => 'int32', 'example' => '88888888'],
'CustomContent' => ['description' => '用户自定义的内容。', 'type' => 'string', 'example' => 'zidingyi'],
'IntAttr' => ['description' => '整数类型属性。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
'IntAttr2' => ['description' => '整数类型属性。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
'StrAttr' => ['description' => '字符串类型属性。'."\n", 'type' => 'string', 'example' => 'test'],
'StrAttr2' => ['description' => '字符串类型属性。'."\n", 'type' => 'string', 'example' => 'test'],
'StrAttr3' => ['description' => '字符串类型属性。'."\n", 'type' => 'string', 'example' => 'test'],
'StrAttr4' => ['description' => '字符串类型属性。'."\n", 'type' => 'string', 'example' => 'test'],
'IntAttr3' => ['description' => '整数类型属性。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
'IntAttr4' => ['description' => '整数类型属性。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
],
],
'Code' => ['description' => '错误码。'."\n"
.'- 0:成功。'."\n"
.'- 非0:失败。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'],
'Exists' => ['description' => '图片是否存在。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'BadRequest', 'errorMessage' => 'The request has invalid parameters.', 'description' => ''],
['errorCode' => 'InstanceStatusError', 'errorMessage' => 'Your instance is unavailable.', 'description' => ''],
['errorCode' => 'TimeoutForTransferImage', 'errorMessage' => 'Timeout after 5 seconds waiting for images transfer to complete.', 'description' => ''],
['errorCode' => 'InvalidInstance', 'errorMessage' => 'The specified instance name is invalid.', 'description' => '实例名错误'],
['errorCode' => 'NoCaretSeperator', 'errorMessage' => 'The body content is missing the ^ separator.', 'description' => '请求body缺少特定符号'],
['errorCode' => 'EmptyMeta', 'errorMessage' => 'The body content has an empty meta field.', 'description' => '请求body含有空的字段'],
['errorCode' => 'InvalidMetaItem', 'errorMessage' => 'The meta field is invalid.', 'description' => '无效的元信息字段'],
['errorCode' => 'NoPicList', 'errorMessage' => 'The body content is missing the pic_list parameter.', 'description' => '未指定pic_list字段'],
['errorCode' => 'InvalidPicList', 'errorMessage' => 'The specified pic_list parameter is invalid.', 'description' => '无效的pic_list字段'],
['errorCode' => 'NoSpecifiedPic', 'errorMessage' => 'he content of an image is not specified in the HTTP POST body.', 'description' => ''],
['errorCode' => 'NoSpecifiedSearchPic', 'errorMessage' => 'The search image is not specified.', 'description' => ''],
['errorCode' => 'InvalidCategory', 'errorMessage' => 'The specified category is invalid.', 'description' => '无效的类目id'],
['errorCode' => 'OverflowMaxResultNum', 'errorMessage' => 'The specified number of total results exceeds the maximum of 500.', 'description' => '超过了最大的返回结果限制数500'],
['errorCode' => 'OverflowMaxReturnNum', 'errorMessage' => 'The specified number of results for each request exceeds the maximum of 100.', 'description' => '单次返回数超过限制值100'],
['errorCode' => 'InvalidStartParameter', 'errorMessage' => 'The specified parameter start is inavlid.', 'description' => ''],
['errorCode' => 'InvalidNumParameter', 'errorMessage' => 'The specified parameter num is invalid.', 'description' => '无效的字段num'],
['errorCode' => 'NoSpecifiedAddPic', 'errorMessage' => 'The image to insert is not specified.', 'description' => ''],
['errorCode' => 'NoSpecifiedItemId', 'errorMessage' => 'The item_id parameter is not specified.', 'description' => ''],
['errorCode' => 'InvalidIntAttr', 'errorMessage' => 'The specified int_attr field is invalid.', 'description' => '无效的int过滤字段'],
['errorCode' => 'UnsupportedPicFormat', 'errorMessage' => 'The specified image format is invalid.', 'description' => '无效的图片格式'],
['errorCode' => 'InvalidFilterClause', 'errorMessage' => 'The specified filtering condition is invalid.', 'description' => '无效的过滤条件'],
['errorCode' => 'InstanceOverQuota', 'errorMessage' => 'The number of items exceeds the limit.', 'description' => '实例的图片数量超过限制值'],
['errorCode' => 'IncorrectOrientation', 'errorMessage' => 'The image contains incorrect rotation flags in the meta data.', 'description' => '图片包含不支持的旋转参数'],
['errorCode' => 'UnsupportedPicPixels', 'errorMessage' => 'The specified pixels is not supported.', 'description' => '图片像素值不支持'],
['errorCode' => 'SearchTimeout', 'errorMessage' => 'The request is timed out.', 'description' => ''],
['errorCode' => 'PicNotExist', 'errorMessage' => 'The search picture does not exist.', 'description' => ''],
['errorCode' => 'NoSpecifiedProductId', 'errorMessage' => 'The parameter ProductId no specified.', 'description' => ''],
['errorCode' => 'NoSpecifiedPicName', 'errorMessage' => 'The parameter PicName no specified.', 'description' => ''],
['errorCode' => 'NoSpecifiedPicContent', 'errorMessage' => 'The parameter PicContent no specified.', 'description' => ''],
['errorCode' => 'InvalidType', 'errorMessage' => 'The specified parameter Type is not valid.', 'description' => ''],
['errorCode' => 'InvalidProductId', 'errorMessage' => 'The specified parameter ProductId is not valid.', 'description' => ''],
['errorCode' => 'InvalidPicName', 'errorMessage' => 'The specified parameter PicName is not valid.', 'description' => ''],
['errorCode' => 'InvalidStrAttr', 'errorMessage' => 'The specified parameter StrAttr is not valid.', 'description' => '无效StrAttr'],
['errorCode' => 'InvalidCustomContent', 'errorMessage' => 'The specified parameter CustomContent is not valid.', 'description' => ''],
['errorCode' => 'InvalidPicContent', 'errorMessage' => 'The specified parameter PicContent length greater than 2 * 1024 * 1024.', 'description' => ''],
['errorCode' => 'InvalidStrAttr4', 'errorMessage' => 'The specified parameter StrAttr4 is not valid.', 'description' => '无效StrAttr4'],
['errorCode' => 'InvalidStrAttr3', 'errorMessage' => 'The specified parameter StrAttr3 is not valid.', 'description' => '无效StrAttr3'],
['errorCode' => 'InvalidStrAttr2', 'errorMessage' => 'The specified parameter StrAttr2 is not valid.', 'description' => '无效StrAttr2'],
['errorCode' => 'InvalidIntAttr4', 'errorMessage' => 'The specified parameter IntAttr4 is not valid.', 'description' => '无效IntAttr4'],
['errorCode' => 'InvalidIntAttr3', 'errorMessage' => 'The specified parameter IntAttr3 is not valid.', 'description' => '无效IntAttr3'],
['errorCode' => 'InvalidIntAttr2', 'errorMessage' => 'The specified parameter IntAttr2 is not valid.', 'description' => '无效IntAttr2'],
['errorCode' => 'UnsupportedOperationType', 'errorMessage' => 'The specified action is not supported.', 'description' => '内部错误:不支持的action'],
['errorCode' => 'UnsupportedInstanceType', 'errorMessage' => 'The instance type is not supported.', 'description' => '内部错误:不支持的实例类型'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation.', 'description' => '未授权的行为'],
['errorCode' => 'DeniedRequest', 'errorMessage' => 'Your request was denied due to instance flow control.', 'description' => '请求被限流'],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'An internal server error occurred.', 'description' => ''],
['errorCode' => 'NetworkException', 'errorMessage' => 'A network error occurred.', 'description' => '内部错误:请求网络异常'],
['errorCode' => 'RequestTimeout', 'errorMessage' => 'The request is timeout.', 'description' => ''],
['errorCode' => 'ExtractFeatureTimeout', 'errorMessage' => 'The request was timed out while extracting features.', 'description' => ''],
['errorCode' => 'AccessEngineFailed', 'errorMessage' => 'An error occurred while accessing the search engine.', 'description' => ''],
['errorCode' => 'InternalOssError', 'errorMessage' => 'An internal OAS error occurred.', 'description' => '内部错误:请求内部算法错误'],
['errorCode' => 'InternalSwiftError', 'errorMessage' => 'An internal SWIFT error occurred.', 'description' => '内部错误:请求内部消息队列错误'],
['errorCode' => 'InternalTableStoreError', 'errorMessage' => 'An internal Table Store error occurred.', 'description' => '内部错误:请求特征存储错误'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '检查图片',
'description' => '## 使用说明'."\n"
.'本接口用于根据图片查询图像搜索实例中的图片信息。'."\n"
."\n"
.'## QPS限制'."\n"
.'查询操作默认的最大访问频率可在控制台中查看,为您购买时所选择的访问频次(QPS),当前支持1QPS、5QPS、10QPS。'."\n"
."\n\n"
.'### SDK版本说明'."\n"
.'图像SDK版本升级到V3.1.1,可使用“多主体识别”、“相似性分数”功能。请参见[Java SDK](~~179188~~)。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'imagesearch:CheckImageExists',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ImageSearch', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Msg\\": \\"success\\",\\n \\"RequestId\\": \\"B3137727-7D6E-488C-BA21-0E034C38A879\\",\\n \\"Auctions\\": {\\n \\"ProductId\\": \\"2092061_1\\",\\n \\"PicName\\": \\"2092061_1.jpg\\",\\n \\"CategoryId\\": 88888888,\\n \\"CustomContent\\": \\"zidingyi\\",\\n \\"IntAttr\\": 2,\\n \\"IntAttr2\\": 2,\\n \\"StrAttr\\": \\"test\\",\\n \\"StrAttr2\\": \\"test\\",\\n \\"StrAttr3\\": \\"test\\",\\n \\"StrAttr4\\": \\"test\\",\\n \\"IntAttr3\\": 2,\\n \\"IntAttr4\\": 2\\n },\\n \\"Code\\": 0,\\n \\"Success\\": true,\\n \\"Exists\\": true\\n}","errorExample":""},{"type":"xml","example":"<CheckImageExistsResponse>\\n <Msg>success</Msg>\\n <RequestId>B3137727-7D6E-488C-BA21-0E034C38A879</RequestId>\\n <Auctions>\\n <ProductId>2092061_1</ProductId>\\n <PicName>2092061_1.jpg</PicName>\\n <CategoryId>88888888</CategoryId>\\n <CustomContent>zidingyi</CustomContent>\\n <IntAttr>2</IntAttr>\\n <IntAttr2>2</IntAttr2>\\n <StrAttr>test</StrAttr>\\n <StrAttr2>test</StrAttr2>\\n <StrAttr3>test</StrAttr3>\\n <StrAttr4>test</StrAttr4>\\n <IntAttr3>2</IntAttr3>\\n <IntAttr4>2</IntAttr4>\\n </Auctions>\\n <Code>0</Code>\\n <Success>true</Success>\\n <Exists>true</Exists>\\n</CheckImageExistsResponse>","errorExample":""}]',
],
'CompareSimilarByImage' => [
'path' => '',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREimagesearchAOOGRD'],
],
'parameters' => [
[
'name' => 'PrimaryPicContent',
'in' => 'formData',
'schema' => ['description' => '图片内容。'."\n"
."\n"
.'- 图片大小要求不超过4 MB。'."\n"
.'- 图片格式:PNG、JPG、JPEG、BMP、GIF、WEBP、TIFF、PPM。'."\n"
.'- 传输等待时间不超过5秒。'."\n"
.'<props="china">'."\n"
.'- 服务类型为商品图片搜索、通用图片搜索、家具家居图片搜索和工业五金图片搜索时,图片长和宽像素要求大于等于100PX且小于等于4096PX。'."\n"
.'</props>'."\n"
.'<props="china">'."\n"
.'- 服务类型为商标图片搜索时,图片长和宽像素要求大于等于200PX且小于4096PX。'."\n"
.'</props>'."\n"
.'<props="china">'."\n"
.'- 服务类型为布料图片搜索时,图片长和宽像素要求大于等于448PX且小于等于4096PX。'."\n"
.'</props>'."\n"
.'<props="intl">'."\n"
.'- 服务类型为商品图片搜索、通用图片搜索时,图片长和宽像素要求大于等于100PX且小于等于4096PX。'."\n"
.'</props>'."\n"
.'- 图片中不能包含旋转信息。'."\n"
."\n"
.'> **使用SDK方式调用:**- 仅支持V3版本SDK,无需填写PrimaryPicContent字段,SDK已将本字段封装为PrimaryPicContentObject字段并自动转化为Base64编码。具体示例参考 [JAVA SDK](~~179188~~)。- SDK不支持客户直接传递图片URL,V3版本SDK提供了一种变相实现URL上传的方式。具体示例参考 [JAVA SDK](~~179188~~)。', 'type' => 'string', 'required' => true, 'example' => 'AAAANSUhEUgAAAPcAAAEVCAYAAAA8d3NuAAAAAXNSR0IArs......RK5CYII=', 'isFileTransferUrl' => true],
],
[
'name' => 'SecondaryPicContent',
'in' => 'formData',
'schema' => ['description' => '图片内容。'."\n"
."\n"
.'- 图片大小要求不超过4 MB。'."\n"
.'- 图片格式:PNG、JPG、JPEG、BMP、GIF、WEBP、TIFF、PPM。'."\n"
.'- 传输等待时间不超过5秒。'."\n"
.'<props="china">'."\n"
.'- 服务类型为商品图片搜索、通用图片搜索、家具家居图片搜索和工业五金图片搜索时,图片长和宽像素要求大于等于100PX且小于等于4096PX。'."\n"
.'</props>'."\n"
.'<props="china">'."\n"
.'- 服务类型为商标图片搜索时,图片长和宽像素要求大于等于200PX且小于4096PX。'."\n"
.'</props>'."\n"
.'<props="china">'."\n"
.'- 服务类型为布料图片搜索时,图片长和宽像素要求大于等于448PX且小于等于4096PX。'."\n"
.'</props>'."\n"
.'<props="intl">'."\n"
.'- 服务类型为商品图片搜索、通用图片搜索时,图片长和宽像素要求大于等于100PX且小于等于4096PX。'."\n"
.'</props>'."\n"
.'- 图片中不能包含旋转信息。'."\n"
."\n"
.'> **使用SDK方式调用:**- 仅支持V3版本SDK,无需填写PrimaryPicContent字段,SDK已将本字段封装为PrimaryPicContentObject字段并自动转化为Base64编码。具体示例参考[JAVA SDK](~~179188~~)。- SDK不支持客户直接传递图片URL,V3版本SDK提供了一种变相实现URL上传的方式。具体示例参考[JAVA SDK](~~179188~~)。', 'type' => 'string', 'required' => true, 'example' => 'AAAANSUhEUgAAAPcAAAEVCAYAAAA8d3NuAAAAAXNSR0IArs......RK5CYII=', 'isFileTransferUrl' => true],
],
[
'name' => 'InstanceName',
'in' => 'formData',
'schema' => ['description' => '图搜实例名称。最多支持20个字符。'."\n"
.'如果已经购买图搜实例可登录<props="intl">[图像搜索管控台](https://imagesearch.console.alibabacloud.com)</props><props="china">[图像搜索管控台](https://imagesearch.console.aliyun.com)</props>查看。'."\n"
.'如果没有购买图搜实例可参考[开通服务](~~179178~~)和[创建实例](~~66569~~)。'."\n"
.'>这里的实例名称并非实例ID,使用时请区分。', 'type' => 'string', 'required' => true, 'example' => 'demoinstance1'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '相似度计算结果。',
'type' => 'object',
'properties' => [
'Score' => ['description' => '图片相似打分。取值范围:0~1。', 'type' => 'number', 'format' => 'double', 'example' => '0.85'],
'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B3137727-7D6E-488C-BA21-0E034C38A879'],
'Msg' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'success'],
'AccessDeniedDetail' => [
'description' => '鉴权返回集合。',
'type' => 'object',
'properties' => [
'AuthAction' => ['description' => '鉴权请求Action。', 'type' => 'string', 'example' => 'xxx'],
'AuthPrincipalDisplayName' => ['description' => '鉴权主体信息。', 'type' => 'string', 'example' => '111'],
'AuthPrincipalOwnerId' => ['description' => '鉴权主体的主账号ID。', 'type' => 'string', 'example' => '222'],
'AuthPrincipalType' => ['description' => '鉴权主体类型。', 'type' => 'string', 'example' => 'SubUser'],
'EncodedDiagnosticMessage' => ['description' => '加密后的完整诊断信息。', 'type' => 'string', 'example' => 'xxxxxx'],
'NoPermissionType' => ['description' => 'ImplicitDeny:未命中任何策略。'."\n"
.'ExplicitDeny:明确命中Deny策略。', 'type' => 'string', 'example' => 'ImplicitDeny'],
'PolicyType' => ['description' => '引起无权限的策略类型。', 'type' => 'string', 'example' => 'AccountLevelIdentityBasedPolicy'],
],
],
'Code' => ['description' => '错误码。'."\n"
.'- 0:成功。'."\n"
.'- 非0:失败。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'SearchTimeout', 'errorMessage' => 'The request timed out.', 'description' => '请求超时'],
['errorCode' => 'TimeoutForTransferImage', 'errorMessage' => 'Image transfer timed out.', 'description' => '客户端图片传输超时'],
['errorCode' => 'UnsupportedPicFormat', 'errorMessage' => 'The specified image format is invalid.', 'description' => '无效的图片格式'],
['errorCode' => 'UnsupportedPicPixels', 'errorMessage' => 'The specified pixels is not supported.', 'description' => '图片像素值不支持'],
['errorCode' => 'UnsupportedPictureFormat', 'errorMessage' => 'The format of the specified picture is not supported.', 'description' => '用户图片格式不支持'],
['errorCode' => 'Console.InstanceNotFound', 'errorMessage' => 'The specified ImageSearch instance is not found.', 'description' => '查找不到实例,检查购买的实例ID是否正确。'],
['errorCode' => 'Console.PidError', 'errorMessage' => 'The number of PID bindings of the current instance exceeds 50.', 'description' => '当前实例PID绑定数量超过50'],
['errorCode' => 'EmptyMeta', 'errorMessage' => 'The body content has an empty meta field.', 'description' => '请求body含有空的字段'],
['errorCode' => 'IncorrectOrientation', 'errorMessage' => 'The image contains incorrect rotation flags in the meta data.', 'description' => '图片包含不支持的旋转参数'],
['errorCode' => 'InstanceOverQuota', 'errorMessage' => 'The number of items exceeds the limit.', 'description' => '实例的图片数量超过限制值'],
['errorCode' => 'InstanceStatusError', 'errorMessage' => 'The current instance status does not support this operation.', 'description' => '实例状态不可用'],
['errorCode' => 'InvalidInstance', 'errorMessage' => 'The specified instance name is invalid.', 'description' => '实例名错误'],
['errorCode' => 'InvalidPicContent', 'errorMessage' => 'The image size exceeds 4 MB.', 'description' => '图片大小超过4M'],
['errorCode' => 'InvalidPicUrl', 'errorMessage' => 'The specified parameter PicUrl is not valid.', 'description' => '无效的PicUrl参数'],
['errorCode' => 'NeedRegisterBeforeInvoke', 'errorMessage' => 'Register for PID before invoking the service.', 'description' => '调用前需要先注册pid'],
['errorCode' => 'NoCaretSeperator', 'errorMessage' => 'The body content is missing the ^ separator.', 'description' => '请求body缺少特定符号'],
['errorCode' => 'NoSpecifiedPic', 'errorMessage' => 'The content of an image is not specified in the HTTP POST body.', 'description' => '图片未指定'],
['errorCode' => 'PicNotExist', 'errorMessage' => 'The specified image does not exist.', 'description' => '图片未指定'],
['errorCode' => 'InvalidSecondaryPicContent', 'errorMessage' => 'The specified parameter SecondaryPicContent is not valid.', 'description' => '无效的SecondaryPicContent参数'],
['errorCode' => 'InvalidPrimaryPicContent', 'errorMessage' => 'The specified parameter PrimaryPicContent is not valid.', 'description' => '无效的PrimaryPicContent参数'],
['errorCode' => 'PictureError', 'errorMessage' => '[download] Img Download Failed.', 'description' => '图片下载失败,请检查图片'],
['errorCode' => 'UnsupportedOperationType', 'errorMessage' => 'The specified action is not supported.', 'description' => '内部错误:不支持的action'],
['errorCode' => 'UnsupportedInstanceType', 'errorMessage' => 'The instance type is not supported.', 'description' => '内部错误:不支持的实例类型'],
],
403 => [
['errorCode' => 'Console.NoPermissionError', 'errorMessage' => 'You are not authorized to perform this operation.', 'description' => '你没有权限进行该操作'],
['errorCode' => 'Console.NotAllowedModifyToken', 'errorMessage' => 'You are not allowed to modify token today.', 'description' => '今天不允许用户修改该token值'],
['errorCode' => 'DeniedRequest', 'errorMessage' => 'Your request was denied due to instance flow control.', 'description' => '请求被限流'],
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation.', 'description' => '未授权的行为'],
],
409 => [
['errorCode' => 'Console.TaskAlreadyExist', 'errorMessage' => 'A task that is in progress already exists.', 'description' => '已经存在正在运行的任务。'],
],
500 => [
['errorCode' => 'ServerInternalError', 'errorMessage' => 'An internal error occurred.', 'description' => '系统内部错误'],
['errorCode' => 'UnknownException', 'errorMessage' => 'An internal server error occurred.', 'description' => '未知异常'],
['errorCode' => 'AccessEngineFailed', 'errorMessage' => 'An error occurred while accessing the search engine.', 'description' => ''],
['errorCode' => 'ConnectionDVException', 'errorMessage' => 'Failed to obtain collection.', 'description' => 'internalError'],
['errorCode' => 'Console.CallServiceError', 'errorMessage' => 'An internal service error occurred.', 'description' => '访问内部服务错误'],
['errorCode' => 'ExtractFeatureTimeout', 'errorMessage' => 'The request timed out while extracting features.', 'description' => '内部错误:提取特征超时'],
['errorCode' => 'InternalOssError', 'errorMessage' => 'An internal OAS error occurred.', 'description' => '内部错误:请求内部算法错误'],
['errorCode' => 'InternalSwiftError', 'errorMessage' => 'An internal SWIFT error occurred.', 'description' => '内部错误:请求内部消息队列错误'],
['errorCode' => 'InternalTableStoreError', 'errorMessage' => 'An internal Table Store error occurred.', 'description' => '内部错误:请求特征存储错误'],
['errorCode' => 'NetworkException', 'errorMessage' => 'A network error occurred.', 'description' => '内部错误:请求网络异常'],
['errorCode' => 'RequestTimeout', 'errorMessage' => 'The request timed out.', 'description' => '内部错误:请求超时'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '相似度比较',
'summary' => '本接口用于对比两张图片相似值。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'imagesearch:CompareSimilarByImage',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ImageSearch', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Score\\": 0.85,\\n \\"Success\\": true,\\n \\"RequestId\\": \\"B3137727-7D6E-488C-BA21-0E034C38A879\\",\\n \\"Msg\\": \\"success\\",\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"xxx\\",\\n \\"AuthPrincipalDisplayName\\": \\"111\\",\\n \\"AuthPrincipalOwnerId\\": \\"222\\",\\n \\"AuthPrincipalType\\": \\"SubUser\\",\\n \\"EncodedDiagnosticMessage\\": \\"xxxxxx\\",\\n \\"NoPermissionType\\": \\"ImplicitDeny\\",\\n \\"PolicyType\\": \\"AccountLevelIdentityBasedPolicy\\"\\n },\\n \\"Code\\": 0\\n}","errorExample":""},{"type":"xml","example":"<CompareSimilarByImageResponse>\\n <Score>0.85</Score>\\n <Success>true</Success>\\n <RequestId>B3137727-7D6E-488C-BA21-0E034C38A879</RequestId>\\n <Msg>success</Msg>\\n <AccessDeniedDetail>\\n <AuthAction>xxx</AuthAction>\\n <AuthPrincipalDisplayName>111</AuthPrincipalDisplayName>\\n <AuthPrincipalOwnerId>222</AuthPrincipalOwnerId>\\n <AuthPrincipalType>SubUser</AuthPrincipalType>\\n <EncodedDiagnosticMessage>xxxxxx</EncodedDiagnosticMessage>\\n <NoPermissionType>ImplicitDeny</NoPermissionType>\\n <PolicyType>AccountLevelIdentityBasedPolicy</PolicyType>\\n </AccessDeniedDetail>\\n <Code>0</Code>\\n</CompareSimilarByImageResponse>","errorExample":""}]',
],
'DeleteImage' => [
'summary' => '本文为您介绍DeleteImage接口的语法及示例,用于向图像搜索实例中删除图片信息。',
'methods' => ['post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREimagesearchIT4SIC'],
],
'parameters' => [
[
'name' => 'InstanceName',
'in' => 'formData',
'schema' => ['description' => '图搜实例名称。最多支持20个字符。'."\n"
.'如果已经购买图搜实例可登录[图像搜索管控台](https://imagesearch.console.aliyun.com/)查看。'."\n"
.'如果没有购买图搜实例可参考[开通服务](~~179178~~)和[创建实例](~~66569~~)。'."\n"
.'>这里的实例名称并非实例ID,且实例名称同区域内唯一不可重复,使用时请区分。', 'type' => 'string', 'required' => true, 'example' => 'demoinstance1'],
],
[
'name' => 'ProductId',
'in' => 'formData',
'schema' => ['description' => '商品ID。'."\n"
."\n"
.'> 1.一个商品可以有多张图片 2.若IsDeleteByFilter字段为false 则此字段必填', 'type' => 'string', 'required' => false, 'example' => '2092061_1'],
],
[
'name' => 'PicName',
'in' => 'formData',
'schema' => ['description' => '图片名称。'."\n"
.' - 如果不指定本参数,则删除ProductId下所有图片。'."\n"
.' - 如果指定本参数,则删除ProductId+PicName指定的图片。', 'type' => 'string', 'required' => false, 'example' => '2092061_1.jpg'],
],
[
'name' => 'IsDeleteByFilter',
'in' => 'formData',
'schema' => ['description' => '根据Filter字段去重'."\n"
.'> 1.若为true 则根据Filter或Filter+ProductId删除 且Filter必填。2.若为false 则根据ProductId或者ProductId+PicName进行删除 ProductId必填', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
'name' => 'Filter',
'in' => 'formData',
'schema' => ['description' => '过滤条件。int_attr支持的操作符有大于号(>)、大于等于号(>=)、小于号(<)、小于等于号(<=)、等于号(=)。str_attr支持的操作符有等于号(=)和不等号(!=),多个条件之支持AND和OR进行连接。'."\n"
.'例如:'."\n"
.'- int_attr >= 100。'."\n"
.'- str_attr != "value1"。'."\n"
.'- int_attr = 1000 AND str_attr = "value1"。'."\n"
.'>最多支持4096个字符。', 'type' => 'string', 'required' => false, 'example' => 'int_attr=1000 AND str_attr="value1"'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回对象。',
'type' => 'object',
'properties' => [
'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'success'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '0703956F-9BCC-48FA-99F7-96C0BF449C69'],
'Code' => ['description' => '错误码。'."\n"
.'- 0:成功。'."\n"
.'- 非0:失败。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'],
'Data' => [
'description' => '删除结果返回。',
'type' => 'object',
'properties' => [
'PicNames' => [
'description' => '删除的PicName。',
'type' => 'array',
'items' => ['description' => '删除的PicName。', 'type' => 'string', 'example' => 'xxx.jpg'],
'example' => '5555.jpg',
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'BadRequest', 'errorMessage' => 'The request has invalid parameters.', 'description' => ''],
['errorCode' => 'InstanceStatusError', 'errorMessage' => 'Your instance is unavailable.', 'description' => ''],
['errorCode' => 'InvalidInstance', 'errorMessage' => 'The specified instance name is invalid.', 'description' => '实例名错误'],
['errorCode' => 'NoCaretSeperator', 'errorMessage' => 'The body content is missing the ^ separator.', 'description' => '请求body缺少特定符号'],
['errorCode' => 'EmptyMeta', 'errorMessage' => 'The body content has an empty meta field.', 'description' => '请求body含有空的字段'],
['errorCode' => 'InvalidMetaItem', 'errorMessage' => 'The meta field is invalid.', 'description' => '无效的元信息字段'],
['errorCode' => 'InvalidPicList', 'errorMessage' => 'The specified pic_list parameter is invalid.', 'description' => '无效的pic_list字段'],
['errorCode' => 'NoSpecifiedPic', 'errorMessage' => 'The content of an image is not specified in the HTTP POST body.', 'description' => '图片未指定'],
['errorCode' => 'NoSpecifiedSearchPic', 'errorMessage' => 'The search image is not specified.', 'description' => ''],
['errorCode' => 'InvalidCategory', 'errorMessage' => 'The specified category is invalid.', 'description' => '无效的类目id'],
['errorCode' => 'OverflowMaxResultNum', 'errorMessage' => 'The specified number of total results exceeds the maximum of 500.', 'description' => '超过了最大的返回结果限制数500'],
['errorCode' => 'OverflowMaxReturnNum', 'errorMessage' => 'The specified number of results for each request exceeds the maximum of 100.', 'description' => '单次返回数超过限制值100'],
['errorCode' => 'InvalidStartParameter', 'errorMessage' => 'The specified parameter s is inavlid.', 'description' => ''],
['errorCode' => 'InvalidNumParameter', 'errorMessage' => 'The specified parameter n is invalid.', 'description' => ''],
['errorCode' => 'NoSpecifiedAddPic', 'errorMessage' => 'The image to insert is not specified.', 'description' => ''],
['errorCode' => 'NoSpecifiedItemId', 'errorMessage' => 'The item_id parameter is not specified.', 'description' => ''],
['errorCode' => 'InvalidIntAttr', 'errorMessage' => 'The specified int_attr field is invalid.', 'description' => '无效的int过滤字段'],
['errorCode' => 'UnsupportedPicFormat', 'errorMessage' => 'The specified image format is invalid.', 'description' => '无效的图片格式'],
['errorCode' => 'InvalidFilterClause', 'errorMessage' => 'The specified filtering condition is invalid.', 'description' => '无效的过滤条件'],
['errorCode' => 'InstanceOverQuota', 'errorMessage' => 'The number of items exceeds the limit.', 'description' => '实例的图片数量超过限制值'],
['errorCode' => 'IncorrectOrientation', 'errorMessage' => 'The image contains incorrect rotation flags in the meta data.', 'description' => '图片包含不支持的旋转参数'],
['errorCode' => 'UnsupportedPicPixels', 'errorMessage' => 'The specified pixels is not supported.', 'description' => '图片像素值不支持'],
['errorCode' => 'SearchTimeout', 'errorMessage' => 'The request is timed out.', 'description' => ''],
['errorCode' => 'NoSpecifiedProductId', 'errorMessage' => 'You must specify ProductId.', 'description' => '未指定商品id'],
['errorCode' => 'InvalidIntAttr4', 'errorMessage' => 'The specified parameter IntAttr4 is not valid.', 'description' => '无效IntAttr4'],
['errorCode' => 'InvalidIntAttr3', 'errorMessage' => 'The specified parameter IntAttr3 is not valid.', 'description' => '无效IntAttr3'],
['errorCode' => 'InvalidIntAttr2', 'errorMessage' => 'The specified parameter IntAttr2 is not valid.', 'description' => '无效IntAttr2'],
['errorCode' => 'InvalidStrAttr4', 'errorMessage' => 'The specified parameter StrAttr4 is not valid.', 'description' => '无效StrAttr4'],
['errorCode' => 'InvalidStrAttr3', 'errorMessage' => 'The specified parameter StrAttr3 is not valid.', 'description' => '无效StrAttr3'],
['errorCode' => 'InvalidStrAttr2', 'errorMessage' => 'The specified parameter StrAttr2 is not valid.', 'description' => '无效StrAttr2'],
['errorCode' => 'InvalidStrAttr', 'errorMessage' => 'The specified parameter StrAttr is not valid.', 'description' => '无效StrAttr'],
['errorCode' => 'UnsupportedOperationType', 'errorMessage' => 'The specified action is not supported.', 'description' => '内部错误:不支持的action'],
['errorCode' => 'UnsupportedInstanceType', 'errorMessage' => 'The instance type is not supported.', 'description' => '内部错误:不支持的实例类型'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation.', 'description' => '未授权的行为'],
['errorCode' => 'DeniedRequest', 'errorMessage' => 'Your request was denied due to instance flow control.', 'description' => '请求被限流'],
],
500 => [
['errorCode' => 'UnknownlException', 'errorMessage' => 'An internal server error occurred.', 'description' => ''],
['errorCode' => 'UnknownException', 'errorMessage' => 'An internal server error occurred.', 'description' => '未知异常'],
['errorCode' => 'NetworkException', 'errorMessage' => 'A network error occurred.', 'description' => '内部错误:请求网络异常'],
['errorCode' => 'RequestTimeout', 'errorMessage' => 'The request is timeout.', 'description' => ''],
['errorCode' => 'ExtractFeatureTimeout', 'errorMessage' => 'The request was timed out while extracting features.', 'description' => ''],
['errorCode' => 'AccessEngineFailed', 'errorMessage' => 'An error occurred while accessing the search engine.', 'description' => ''],
['errorCode' => 'InternalOssError', 'errorMessage' => 'An internal OAS error occurred.', 'description' => '内部错误:请求内部算法错误'],
['errorCode' => 'InternalSwiftError', 'errorMessage' => 'An internal SWIFT error occurred.', 'description' => '内部错误:请求内部消息队列错误'],
['errorCode' => 'InternalTableStoreError', 'errorMessage' => 'An internal Table Store error occurred.', 'description' => '内部错误:请求特征存储错误'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0703956F-9BCC-48FA-99F7-96C0BF449C69\\",\\n \\"Code\\": 0,\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PicNames\\": [\\n \\"xxx.jpg\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
'title' => '删除图片',
'description' => '## 使用说明'."\n"
.'本接口用于向图像搜索实例中删除图片信息。'."\n"
.'>- 如果指定图片在图像搜索实例中不存在,该接口依然会返回成功。不能用返回结果来判断图片是否存在。'."\n"
."\n"
.'## QPS限制'."\n"
.'删除操作默认的并发量为20,也就是每秒钟最多处理20个删除请求。',
'extraInfo' => '## 错误码'."\n"
.'请参见[错误码](~~66619~~)。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteImage'],
],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'imagesearch:DeleteImage',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ImageSearch', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'Detail' => [
'summary' => '本文为您介绍Detail接口的语法及示例,用于根据名称查询图像搜索实例的相关信息。',
'methods' => ['post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'InstanceName',
'in' => 'query',
'schema' => ['description' => '图搜实例名称。最多支持20个字符。'."\n"
.'如果已经购买图搜实例可登录[图像搜索管控台](https://imagesearch.console.aliyun.com/)查看。'."\n"
.'如果没有购买图搜实例可参考[开通服务](~~179178~~)和[创建实例](~~66569~~)。'."\n"
.'>这里的实例名称并非实例ID,且实例名称同区域内唯一不可重复,使用时请区分。', 'type' => 'string', 'required' => true, 'example' => 'imagesearchName'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '结果返回。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '36C43E96-8F68-44AA-B1AF-B1F7AB94A6C1'],
'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'],
'Instance' => [
'description' => '实例信息。',
'type' => 'object',
'properties' => [
'Capacity' => ['description' => '套餐容量。单位万。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'UtcExpireTime' => ['description' => '实例到期时间。单位毫秒。', 'type' => 'string', 'example' => '1623081600000'],
'UtcCreate' => ['description' => '实例创建时间。单位毫秒。', 'type' => 'string', 'example' => '1620382716000'],
'ServiceType' => ['description' => '图搜模型。'."\n"
."\n"
.'<props="intl">0:商品搜索;1:通用图片搜索。</props>'."\n"
.'<props="china">0:商品搜索;1:通用图片搜索;2:布料搜索;3、7:商标搜索;4:版权搜索;5:家具搜索;6:五金搜索。</props>'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'Region' => ['description' => '地域信息。', 'type' => 'string', 'example' => 'cn-shanghai'],
'Name' => ['description' => '实例名称。', 'type' => 'string', 'example' => 'imagesearchName'],
'TotalCount' => ['description' => '图片数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '10063'],
'Qps' => ['description' => '套餐QPS。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'DeniedRequest', 'errorMessage' => 'Your request was denied due to instance flow control.', 'description' => ''],
['errorCode' => 'InvalidInstance', 'errorMessage' => 'The specified instance name is invalid.', 'description' => '实例名错误'],
['errorCode' => 'Console.BadRequest', 'errorMessage' => 'The request has invalid parameters.', 'description' => '非法请求,请检查请求参数。'],
['errorCode' => 'Console.InstanceNotFound', 'errorMessage' => 'The specified ImageSearch instance is not found.', 'description' => '查找不到实例,检查购买的实例ID是否正确。'],
],
[
['errorCode' => 'Console.LoginError', 'errorMessage' => 'Check login failed.', 'description' => '登录失败,请检查用户名、密码、邮箱是否输入有误。'],
],
403 => [
['errorCode' => 'Console.NoPermission', 'errorMessage' => 'You are not authorized to this operation.', 'description' => ''],
],
409 => [
['errorCode' => 'Console.InstanceStatusError', 'errorMessage' => 'Current Instance status not supported this opreate.', 'description' => ''],
['errorCode' => 'Console.OrderStatusError', 'errorMessage' => 'Current Order status not supported this opreate.', 'description' => '用户订单错误,请确认订单处于有效状态'],
['errorCode' => 'Console.IncrementStatusError', 'errorMessage' => 'Current Increment status not supported this opreate.', 'description' => ''],
],
500 => [
['errorCode' => 'Console.InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => '服务器内部错误,请登录阿里云控制台提交工单。'],
['errorCode' => 'Console.CallServiceError', 'errorMessage' => 'Fail to call service.', 'description' => ''],
],
],
'title' => '查询实例状态',
'description' => '## 使用说明'."\n"
.'本接口用于向图像搜索实例中查询实例信息。'."\n"
.'> 如需了解更多产品详情和获取技术支持,请单击[在线咨询](https://www.aliyun.com/core/online-consult?from=aZgW6LJHr2)或通过钉钉群(35035130)联系我们。'."\n"
."\n"
.'## QPS限制'."\n"
.'查询操作默认的并发量为1,也就是每秒钟最多处理1个请求。',
'extraInfo' => '## 错误码'."\n"
.'请参见[错误码](~~66619~~)。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => '',
'ramAction' => [
'action' => 'imagesearch:Detail',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ImageSearch', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"36C43E96-8F68-44AA-B1AF-B1F7AB94A6C1\\",\\n \\"Success\\": true,\\n \\"Instance\\": {\\n \\"Capacity\\": 10,\\n \\"UtcExpireTime\\": \\"1623081600000\\",\\n \\"UtcCreate\\": \\"1620382716000\\",\\n \\"ServiceType\\": 0,\\n \\"Region\\": \\"cn-shanghai\\",\\n \\"Name\\": \\"imagesearchName\\",\\n \\"TotalCount\\": 10063,\\n \\"Qps\\": 1\\n }\\n}","errorExample":""},{"type":"xml","example":"<DetailResponse>\\n <RequestId>36C43E96-8F68-44AA-B1AF-B1F7AB94A6C1</RequestId>\\n <Success>true</Success>\\n <Instance>\\n <Name>imagesearchName</Name>\\n <UtcExpireTime>1623081600000</UtcExpireTime>\\n <TotalCount>10063</TotalCount>\\n <UtcCreate>1620382716000</UtcCreate>\\n <Capacity>10</Capacity>\\n <Qps>1</Qps>\\n <ServiceType>0</ServiceType>\\n <Region>cn-shanghai</Region>\\n </Instance>\\n</DetailResponse>","errorExample":""}]',
],
'DumpMeta' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'InstanceName',
'in' => 'query',
'schema' => ['description' => '图搜实例名称。最多支持20个字符。'."\n"
.'如果已经购买图搜实例可登录[图像搜索管控台](https://imagesearch.console.aliyun.com/)查看。'."\n"
.'如果没有购买图搜实例可参考[开通服务](~~179178~~)和[创建实例](~~66569~~)。'."\n"
.'>这里的实例名称并非实例ID,使用时请区分。', 'type' => 'string', 'required' => true, 'maximum' => '10000000', 'minimum' => '1', 'example' => 'imagesearchName'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '36C43E96-8F68-44AA-B1AF-B1F7AB94A6C1'],
'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'],
'Data' => [
'description' => '任务执行返回。',
'type' => 'object',
'properties' => [
'DumpMetaStatus' => ['description' => '元数据导出任务状态。'."\n"
.'- PROCESSING:任务处理中。'."\n"
.'- FAIL:任务执行失败。'."\n"
.'- SUCCESS:任务已完成。', 'type' => 'string', 'example' => 'PROCESSING'],
'Id' => ['description' => '任务ID。', 'type' => 'string', 'example' => '500'],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidInstance', 'errorMessage' => 'The specified instance name is invalid.', 'description' => '实例名错误'],
['errorCode' => 'Console.BadRequest', 'errorMessage' => 'The request has invalid parameters.', 'description' => '非法请求,请检查请求参数。'],
['errorCode' => 'Console.InstanceNotFound', 'errorMessage' => 'The specified ImageSearch instance is not found.', 'description' => '查找不到实例,检查购买的实例ID是否正确。'],
],
[
['errorCode' => 'Console.LoginError', 'errorMessage' => 'Check login failed.', 'description' => '登录失败,请检查用户名、密码、邮箱是否输入有误。'],
],
403 => [
['errorCode' => 'Console.NoPermission', 'errorMessage' => 'You are not authorized to this operation.', 'description' => ''],
],
409 => [
['errorCode' => 'Console.InstanceStatusError', 'errorMessage' => 'Current Instance status not supported this opreate.', 'description' => ''],
['errorCode' => 'Console.OrderStatusError', 'errorMessage' => 'Current Order status not supported this opreate.', 'description' => '用户订单错误,请确认订单处于有效状态'],
['errorCode' => 'Console.IncrementStatusError', 'errorMessage' => 'Current Increment status not supported this opreate.', 'description' => ''],
['errorCode' => 'Console.TaskAlreadyExist', 'errorMessage' => 'A task that is in progress already exists.', 'description' => '已经存在正在运行的任务。'],
],
500 => [
['errorCode' => 'Console.InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => '服务器内部错误,请登录阿里云控制台提交工单。'],
['errorCode' => 'Console.CallServiceError', 'errorMessage' => 'An internal service error occurred.', 'description' => '访问内部服务错误'],
],
],
'title' => '元数据导出',
'summary' => '本文为您介绍DumpMeta接口的语法及示例,用于根据名称新建图像搜索元数据导出任务。',
'description' => '## 使用说明'."\n"
.'本接口用于向图像搜索实例中提交元信息导出任务。'."\n"
.'> 如需了解更多产品详情和获取技术支持,请单击[在线咨询](https://www.aliyun.com/core/online-consult?from=aZgW6LJHr2)或通过钉钉群(35035130)联系我们。'."\n"
."\n"
.'## QPS限制'."\n"
.'提交操作默认的并发量为1,也就是每秒钟最多处理1个请求。'."\n"
.'> 当上一个元信息导出任务没有完成时,无法提交新的元信息导出任务。',
'extraInfo' => '## 错误码'."\n"
.'请参见[错误码](~~66619~~)。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => '',
'ramAction' => [
'action' => 'imagesearch:DumpMeta',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ImageSearch', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"36C43E96-8F68-44AA-B1AF-B1F7AB94A6C1\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"DumpMetaStatus\\": \\"PROCESSING\\",\\n \\"Id\\": \\"500\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
],
'DumpMetaList' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'InstanceName',
'in' => 'query',
'schema' => ['description' => '图搜实例名称。最多支持20个字符。'."\n"
.'如果已经购买图搜实例可登录[图像搜索管控台](https://imagesearch.console.aliyun.com/)查看。'."\n"
.'如果没有购买图搜实例可参考[开通服务](~~179178~~)和[创建实例](~~66569~~)。'."\n"
.'>这里的实例名称并非实例ID,且实例名称同区域内唯一不可重复,使用时请区分。', 'type' => 'string', 'required' => true, 'maximum' => '10000000', 'minimum' => '1', 'example' => 'demoinstance1'],
],
[
'name' => 'Id',
'in' => 'query',
'schema' => ['description' => '元信息导出任务ID。'."\n"
.'>导出任务ID,需要先执行[元数据导出](~~377466~~)从返回值得到。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '500'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '返回结果的数目。默认值为10,最大值30。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '500', 'exclusiveMaximum' => true, 'minimum' => '1', 'example' => '10'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '返回结果的起始位置。默认值为1,最大值30。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '500', 'minimum' => '1', 'example' => '1'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B3137727-7D6E-488C-BA21-0E034C38A879'],
'Data' => [
'description' => '元数据导出信息返回。',
'type' => 'object',
'properties' => [
'DumpMetaList' => [
'description' => '元信息导出任务集合。',
'type' => 'array',
'items' => [
'description' => '元信息导出任务详情。',
'type' => 'object',
'properties' => [
'Status' => ['description' => '任务状态。'."\n"
.'- PROCESSING:任务处理中。'."\n"
.'- FAIL:任务执行失败。'."\n"
.'- SUCCESS:任务已完成。', 'type' => 'string', 'example' => 'SUCCESS'],
'Msg' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'success'],
'UtcModified' => ['description' => '任务更新时间。单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1629095760000'],
'MetaUrl' => ['description' => '结果下载地址。有效期两个小时。', 'type' => 'string', 'example' => 'https://imagesearchname.oss-cn-shanghai.aliyuncs.com/xxx'],
'UtcCreate' => ['description' => '任务创建时间。单位毫秒。', 'type' => 'string', 'example' => '1629095713000'],
'Code' => ['description' => '错误码。'."\n"
."\n"
.'- 0:成功。'."\n"
.'- 非0:失败。', 'type' => 'string', 'example' => '0'],
'Id' => ['description' => '任务ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '500'],
],
],
],
'PageSize' => ['description' => '查询结果数目。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'PageNumber' => ['description' => '结果当前页数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'TotalCount' => ['description' => '任务总数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '15'],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidInstance', 'errorMessage' => 'The specified instance name is invalid.', 'description' => '实例名错误'],
['errorCode' => 'Console.BadRequest', 'errorMessage' => 'The request has invalid parameters.', 'description' => '非法请求,请检查请求参数。'],
['errorCode' => 'Console.InstanceNotFound', 'errorMessage' => 'The specified ImageSearch instance is not found.', 'description' => '查找不到实例,检查购买的实例ID是否正确。'],
],
[
['errorCode' => 'Console.LoginError', 'errorMessage' => 'Check login failed.', 'description' => '登录失败,请检查用户名、密码、邮箱是否输入有误。'],
],
403 => [
['errorCode' => 'Console.NoPermission', 'errorMessage' => 'You are not authorized to this operation.', 'description' => ''],
],
409 => [
['errorCode' => 'Console.InstanceStatusError', 'errorMessage' => 'Current Instance status not supported this opreate.', 'description' => ''],
['errorCode' => 'Console.OrderStatusError', 'errorMessage' => 'Current Order status not supported this opreate.', 'description' => '用户订单错误,请确认订单处于有效状态'],
['errorCode' => 'Console.IncrementStatusError', 'errorMessage' => 'Current Increment status not supported this opreate.', 'description' => ''],
],
500 => [
['errorCode' => 'Console.InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => '服务器内部错误,请登录阿里云控制台提交工单。'],
['errorCode' => 'Console.CallServiceError', 'errorMessage' => 'An internal service error occurred.', 'description' => '访问内部服务错误'],
],
],
'title' => '查询元信息导出任务',
'summary' => '本文为您介绍DumpMetaList接口的语法及示例,用于向图像搜索实例中查看元信息导出任务列表。',
'description' => '## 使用说明'."\n"
.'本接口用于向图像搜索实例中查询元信息导出任务。'."\n"
.'> 如需了解更多产品详情和获取技术支持,请单击[在线咨询](https://www.aliyun.com/core/online-consult?from=aZgW6LJHr2)或通过钉钉群(35035130)联系我们。'."\n"
."\n"
.'## QPS限制'."\n"
.'查询操作默认的并发量为1,也就是每秒钟最多处理1个请求。',
'extraInfo' => '## 错误码'."\n"
.'请参见[错误码](~~66619~~)。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => '',
'ramAction' => [
'action' => 'imagesearch:DumpMetaList',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ImageSearch', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B3137727-7D6E-488C-BA21-0E034C38A879\\",\\n \\"Data\\": {\\n \\"DumpMetaList\\": [\\n {\\n \\"Status\\": \\"SUCCESS\\",\\n \\"Msg\\": \\"success\\",\\n \\"UtcModified\\": 1629095760000,\\n \\"MetaUrl\\": \\"https://imagesearchname.oss-cn-shanghai.aliyuncs.com/xxx\\",\\n \\"UtcCreate\\": \\"1629095713000\\",\\n \\"Code\\": \\"0\\",\\n \\"Id\\": 500\\n }\\n ],\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 15\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
],
'IncreaseInstance' => [
'summary' => '本文为您介绍IncreaseInstance接口的语法及示例,用于根据名称新建图像搜索实例批量任务。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'InstanceName',
'in' => 'query',
'schema' => ['description' => '图搜实例名称。最多支持20个字符。'."\n"
.'如果已经购买图搜实例可登录[图像搜索管控台](https://imagesearch.console.aliyun.com/)查看。'."\n"
.'如果没有购买图搜实例可参考[开通服务](~~179178~~)和[创建实例](~~66569~~)。'."\n"
.'>这里的实例名称并非实例ID,使用时请区分。', 'type' => 'string', 'required' => true, 'example' => 'imagesearchName'],
],
[
'name' => 'BucketName',
'in' => 'query',
'schema' => ['description' => 'Bucket名称。'."\n"
.'> 仅支持实例同区域的BucketName。', 'type' => 'string', 'required' => true, 'example' => 'bucketName'],
],
[
'name' => 'Path',
'in' => 'query',
'schema' => ['description' => 'OSS中increment.meta文件的绝对路径。必须"/"开头,非"/"结尾。'."\n"
.'> 需要您提前准备increment.meta文件。具体请参见[批量操作](~~66580~~)。', 'type' => 'string', 'required' => true, 'example' => '/xxx/xxx'],
],
[
'name' => 'CallbackAddress',
'in' => 'query',
'schema' => ['description' => '任务回调地址。', 'type' => 'string', 'required' => false, 'example' => 'http://xxxxx'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '36C43E96-8F68-44AA-B1AF-B1F7AB94A6C1'],
'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'],
'Data' => [
'description' => '任务执行返回。',
'type' => 'object',
'properties' => [
'IncrementStatus' => ['description' => '批量任务状态。'."\n"
.'- PROCESSING:任务处理中。'."\n"
.'- FAIL:任务执行失败。'."\n"
.'- SUCCESS:任务已完成。', 'type' => 'string', 'example' => 'PROCESSING'],
'Id' => ['description' => '任务ID。', 'type' => 'string', 'example' => '500'],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidInstance', 'errorMessage' => 'The specified instance name is invalid.', 'description' => '实例名错误'],
['errorCode' => 'Console.BadRequest', 'errorMessage' => 'The request has invalid parameters.', 'description' => '非法请求,请检查请求参数。'],
['errorCode' => 'Console.InstanceNotFound', 'errorMessage' => 'The specified ImageSearch instance is not found.', 'description' => '查找不到实例,检查购买的实例ID是否正确。'],
],
[
['errorCode' => 'Console.LoginError', 'errorMessage' => 'Check login failed.', 'description' => '登录失败,请检查用户名、密码、邮箱是否输入有误。'],
],
403 => [
['errorCode' => 'Console.NoPermission', 'errorMessage' => 'You are not authorized to this operation.', 'description' => ''],
],
409 => [
['errorCode' => 'Console.InstanceStatusError', 'errorMessage' => 'Current Instance status not supported this opreate.', 'description' => ''],
['errorCode' => 'Console.OrderStatusError', 'errorMessage' => 'Current Order status not supported this opreate.', 'description' => '用户订单错误,请确认订单处于有效状态'],
['errorCode' => 'Console.IncrementStatusError', 'errorMessage' => 'Current Increment status not supported this opreate.', 'description' => ''],
],
500 => [
['errorCode' => 'Console.InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => '服务器内部错误,请登录阿里云控制台提交工单。'],
['errorCode' => 'Console.CallServiceError', 'errorMessage' => 'Fail to call service.', 'description' => ''],
],
],
'title' => '批量操作',
'description' => '## 使用说明'."\n"
.'本接口用于向图像搜索实例中提交批量任务。'."\n"
.'> <props="china">如需了解更多产品详情和获取技术支持,请单击[在线咨询](https://www.aliyun.com/core/online-consult?from=aZgW6LJHr2)或通过钉钉群(35035130)联系我们。</props>'."\n"
."\n"
.'## QPS限制'."\n"
.'同一时间,只能运行一个批量任务。'."\n"
.'> 当上一个批量任务没有完成时,无法提交新的批量任务。'."\n",
'extraInfo' => '## 错误码'."\n"
.'请参见[错误码](~~66619~~)。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => '',
'ramAction' => [
'action' => 'imagesearch:IncreaseInstance',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ImageSearch', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"36C43E96-8F68-44AA-B1AF-B1F7AB94A6C1\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"IncrementStatus\\": \\"PROCESSING\\",\\n \\"Id\\": \\"500\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
],
'IncreaseList' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'InstanceName',
'in' => 'query',
'schema' => ['description' => '图搜实例名称。最多支持20个字符。'."\n"
.'如果已经购买图搜实例可登录[图像搜索管控台](https://imagesearch.console.aliyun.com/)查看。'."\n"
.'如果没有购买图搜实例可参考[开通服务](~~179178~~)和[创建实例](~~66569~~)。'."\n"
.'>这里的实例名称并非实例ID,且实例名称同区域内唯一不可重复,使用时请区分。', 'type' => 'string', 'required' => true, 'example' => 'demoinstance1'],
],
[
'name' => 'Id',
'in' => 'query',
'schema' => ['description' => '批量任务ID。'."\n"
.'>批量任务ID,需要先执行[批量操作](~~377468~~)从返回值得到。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '500'],
],
[
'name' => 'BucketName',
'in' => 'query',
'schema' => ['description' => 'Bucket名称。', 'type' => 'string', 'required' => false, 'example' => 'bucketName'],
],
[
'name' => 'Path',
'in' => 'query',
'schema' => ['description' => 'OSS中increment.meta文件的绝对路径。必须"/"开头,非"/"结尾。', 'type' => 'string', 'required' => false, 'example' => '/xxx/xxx'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '返回结果的数目。默认值为10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '500', 'minimum' => '1', 'example' => '10'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '返回结果的起始位置。默认值为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '500', 'exclusiveMaximum' => true, 'minimum' => '1', 'example' => '1'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B3137727-7D6E-488C-BA21-0E034C38A879'],
'Data' => [
'description' => '批量任务信息返回。',
'type' => 'object',
'properties' => [
'Increments' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Instance' => [
'description' => '批量任务集合。',
'type' => 'array',
'items' => [
'description' => '批量任务详情。',
'type' => 'object',
'properties' => [
'Msg' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'sucess'],
'Status' => ['description' => '任务状态。'."\n"
.'- PROCESSING:任务处理中。'."\n"
.'- FAIL:任务执行失败。'."\n"
.'- SUCCESS:任务已完成。', 'type' => 'string', 'example' => 'SUCCESS'],
'UtcModified' => ['description' => '任务更新时间。单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1629095760000'],
'BucketName' => ['description' => 'Bucket名称。', 'type' => 'string', 'example' => 'bucketName'],
'UtcCreate' => ['description' => '任务创建时间。单位毫秒。', 'type' => 'string', 'example' => '1629095713000'],
'Code' => ['description' => '错误码。'."\n"
."\n"
.'- 0:成功。'."\n"
.'- 非0:失败。', 'type' => 'string', 'example' => '0'],
'Path' => ['description' => 'OSS中increment.meta文件的绝对路径。必须"/"开头,非"/"结尾。', 'type' => 'string', 'example' => '/xx/xx'],
'ErrorUrl' => ['description' => '结果下载地址。有效期两个小时。', 'type' => 'string', 'example' => 'https://imagesearchname.oss-cn-shanghai.aliyuncs.com/xxx'],
'Id' => ['description' => '任务ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '500'],
'CallbackAddress' => ['description' => '任务回调地址。', 'type' => 'string', 'example' => 'http://xxxxx'],
],
],
],
],
'description' => '',
],
'PageSize' => ['description' => '查询结果数目。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'PageNumber' => ['description' => '结果当前页数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'TotalCount' => ['description' => '任务总数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '15'],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidInstance', 'errorMessage' => 'The specified instance name is invalid.', 'description' => '实例名错误'],
['errorCode' => 'Console.BadRequest', 'errorMessage' => 'The request has invalid parameters.', 'description' => '非法请求,请检查请求参数。'],
['errorCode' => 'Console.InstanceNotFound', 'errorMessage' => 'The specified ImageSearch instance is not found.', 'description' => '查找不到实例,检查购买的实例ID是否正确。'],
],
[
['errorCode' => 'Console.LoginError', 'errorMessage' => 'Check login failed.', 'description' => '登录失败,请检查用户名、密码、邮箱是否输入有误。'],
],
403 => [
['errorCode' => 'Console.NoPermission', 'errorMessage' => 'You are not authorized to this operation.', 'description' => ''],
],
409 => [
['errorCode' => 'Console.InstanceStatusError', 'errorMessage' => 'Current Instance status not supported this opreate.', 'description' => ''],
['errorCode' => 'Console.OrderStatusError', 'errorMessage' => 'Current Order status not supported this opreate.', 'description' => '用户订单错误,请确认订单处于有效状态'],
['errorCode' => 'Console.IncrementStatusError', 'errorMessage' => 'Current Increment status not supported this opreate.', 'description' => ''],
],
500 => [
['errorCode' => 'Console.InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => '服务器内部错误,请登录阿里云控制台提交工单。'],
['errorCode' => 'Console.CallServiceError', 'errorMessage' => 'Fail to call service.', 'description' => ''],
],
],
'title' => '查询批量任务',
'summary' => '本文为您介绍IncreaseList接口的语法及示例,用于向图像搜索实例中查看批量任务列表。',
'description' => '## 使用说明'."\n"
.'本接口用于向图像搜索实例中查询批量任务。'."\n"
.'> 如需了解更多产品详情和获取技术支持,请单击[在线咨询](https://www.aliyun.com/core/online-consult?from=aZgW6LJHr2)或通过钉钉群(35035130)联系我们。'."\n"
."\n"
.'## QPS限制'."\n"
.'查询操作默认的并发量为1,也就是每秒钟最多处理1个请求。',
'extraInfo' => '## 错误码'."\n"
.'请参见[错误码](~~66619~~)。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => '',
'ramAction' => [
'action' => 'imagesearch:IncreaseList',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ImageSearch', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B3137727-7D6E-488C-BA21-0E034C38A879\\",\\n \\"Data\\": {\\n \\"Increments\\": {\\n \\"Instance\\": [\\n {\\n \\"Msg\\": \\"sucess\\",\\n \\"Status\\": \\"SUCCESS\\",\\n \\"UtcModified\\": 1629095760000,\\n \\"BucketName\\": \\"bucketName\\",\\n \\"UtcCreate\\": \\"1629095713000\\",\\n \\"Code\\": \\"0\\",\\n \\"Path\\": \\"/xx/xx\\",\\n \\"ErrorUrl\\": \\"https://imagesearchname.oss-cn-shanghai.aliyuncs.com/xxx\\",\\n \\"Id\\": 500,\\n \\"CallbackAddress\\": \\"http://xxxxx\\"\\n }\\n ]\\n },\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 15\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
],
'SearchImageByFilter' => [
'summary' => '本文为您介绍SearchImageByFilter的语法及示例,用于根据过滤条件查询图像搜索实例中的图片信息。',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREimagesearchF4L5JA'],
],
'parameters' => [
[
'name' => 'InstanceName',
'in' => 'formData',
'schema' => ['description' => '图搜实例名称。最多支持20个字符。'."\n"
.'如果已经购买图搜实例可登录[图像搜索管控台](https://imagesearch.console.aliyun.com/)查看。'."\n"
.'如果没有购买图搜实例可参考[开通服务](~~179178~~)和[创建实例](~~66569~~)。'."\n"
.'>这里的实例名称并非实例ID,使用时请区分。', 'type' => 'string', 'required' => true, 'example' => 'demoinstance1'],
],
[
'name' => 'Num',
'in' => 'formData',
'schema' => ['description' => '返回结果的数目。取值范围:1~100。默认值为10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'default' => '10'],
],
[
'name' => 'Start',
'in' => 'formData',
'schema' => ['description' => '返回结果的起始位置。取值范围:0~499。默认值为0。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '499', 'minimum' => '0', 'example' => '0', 'default' => '0'],
],
[
'name' => 'Filter',
'in' => 'formData',
'schema' => ['description' => '过滤条件。int_attr支持的操作符有in、not in、大于号(>)、大于等于号(>=)、小于号(<)、小于等于号(<=)、等于号(=)。str_attr支持的操作符有in、not in、等于号(=)和不等号(!=),多个条件之间支持AND和OR进行连接。'."\n"
.'例如:'."\n"
.'- int_attr >= 100。'."\n"
.'- str_attr != "value1"。'."\n"
.'- int_attr = 1000 AND str_attr = "value1"。'."\n"
."\n"
.'>最多支持4096个字符。', 'type' => 'string', 'required' => true, 'example' => 'int_attr=1000 AND str_attr="value1"'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '结果返回。',
'type' => 'object',
'properties' => [
'Msg' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'success'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B3137727-7D6E-488C-BA21-0E034C38A879'],
'Auctions' => [
'description' => '所有返回的商品描述信息。',
'type' => 'array',
'items' => [
'description' => '图片参数。',
'type' => 'object',
'properties' => [
'ProductId' => ['description' => '商品ID。', 'type' => 'string', 'example' => '2092061_1'],
'PicName' => ['description' => '图片名称。', 'type' => 'string', 'example' => '2092061_1.jpg'],
'CategoryId' => ['description' => '图片类目。', 'type' => 'integer', 'format' => 'int32', 'example' => '8888888'],
'CustomContent' => ['description' => '用户自定义的内容。', 'type' => 'string', 'example' => 'zidingyi'],
'IntAttr' => ['description' => '整数类型属性。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
'IntAttr2' => ['description' => '整数类型属性。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
'StrAttr2' => ['description' => '字符串类型属性。', 'type' => 'string', 'example' => 'test'],
'StrAttr' => ['description' => '字符串类型属性。', 'type' => 'string', 'example' => 'test'],
'StrAttr3' => ['description' => '字符串类型属性。', 'type' => 'string', 'example' => 'test'],
'StrAttr4' => ['description' => '字符串类型属性。', 'type' => 'string', 'example' => 'test'],
'IntAttr3' => ['description' => '整数类型属性。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
'IntAttr4' => ['description' => '整数类型属性。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
],
],
],
'Code' => ['description' => '错误码。'."\n"
.'- 0:成功。'."\n"
.'- 非0:失败。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'BadRequest', 'errorMessage' => 'The request has invalid parameters.', 'description' => ''],
['errorCode' => 'InstanceStatusError', 'errorMessage' => 'Your instance is unavailable.', 'description' => ''],
['errorCode' => 'TimeoutForTransferImage', 'errorMessage' => 'Timeout after 5 seconds waiting for images transfer to complete.', 'description' => ''],
['errorCode' => 'InvalidInstance', 'errorMessage' => 'The specified instance name is invalid.', 'description' => '实例名错误'],
['errorCode' => 'NoCaretSeperator', 'errorMessage' => 'The body content is missing the ^ separator.', 'description' => '请求body缺少特定符号'],
['errorCode' => 'EmptyMeta', 'errorMessage' => 'The body content has an empty meta field.', 'description' => '请求body含有空的字段'],
['errorCode' => 'InvalidMetaItem', 'errorMessage' => 'The meta field is invalid.', 'description' => '无效的元信息字段'],
['errorCode' => 'NoPicList', 'errorMessage' => 'The body content is missing the pic_list parameter.', 'description' => '未指定pic_list字段'],
['errorCode' => 'InvalidPicList', 'errorMessage' => 'The specified pic_list parameter is invalid.', 'description' => '无效的pic_list字段'],
['errorCode' => 'NoSpecifiedPic', 'errorMessage' => 'he content of an image is not specified in the HTTP POST body.', 'description' => ''],
['errorCode' => 'NoSpecifiedSearchPic', 'errorMessage' => 'The search image is not specified.', 'description' => ''],
['errorCode' => 'InvalidCategory', 'errorMessage' => 'The specified category is invalid.', 'description' => '无效的类目id'],
['errorCode' => 'OverflowMaxResultNum', 'errorMessage' => 'The specified number of total results exceeds the maximum of 500.', 'description' => '超过了最大的返回结果限制数500'],
['errorCode' => 'OverflowMaxReturnNum', 'errorMessage' => 'The specified number of results for each request exceeds the maximum of 100.', 'description' => '单次返回数超过限制值100'],
['errorCode' => 'InvalidStartParameter', 'errorMessage' => 'The specified parameter start is inavlid.', 'description' => ''],
['errorCode' => 'InvalidNumParameter', 'errorMessage' => 'The specified parameter num is invalid.', 'description' => '无效的字段num'],
['errorCode' => 'NoSpecifiedAddPic', 'errorMessage' => 'The image to insert is not specified.', 'description' => ''],
['errorCode' => 'NoSpecifiedItemId', 'errorMessage' => 'The item_id parameter is not specified.', 'description' => ''],
['errorCode' => 'InvalidIntAttr', 'errorMessage' => 'The specified int_attr field is invalid.', 'description' => '无效的int过滤字段'],
['errorCode' => 'UnsupportedPicFormat', 'errorMessage' => 'The specified image format is invalid.', 'description' => '无效的图片格式'],
['errorCode' => 'InvalidFilterClause', 'errorMessage' => 'The specified filtering condition is invalid.', 'description' => '无效的过滤条件'],
['errorCode' => 'InstanceOverQuota', 'errorMessage' => 'The number of items exceeds the limit.', 'description' => '实例的图片数量超过限制值'],
['errorCode' => 'IncorrectOrientation', 'errorMessage' => 'The image contains incorrect rotation flags in the meta data.', 'description' => '图片包含不支持的旋转参数'],
['errorCode' => 'UnsupportedPicPixels', 'errorMessage' => 'The specified pixels is not supported.', 'description' => '图片像素值不支持'],
['errorCode' => 'SearchTimeout', 'errorMessage' => 'The request is timed out.', 'description' => ''],
['errorCode' => 'PicNotExist', 'errorMessage' => 'The search picture does not exist.', 'description' => ''],
['errorCode' => 'NoSpecifiedProductId', 'errorMessage' => 'The parameter ProductId no specified.', 'description' => ''],
['errorCode' => 'NoSpecifiedPicName', 'errorMessage' => 'The parameter PicName no specified.', 'description' => ''],
['errorCode' => 'NoSpecifiedPicContent', 'errorMessage' => 'The parameter PicContent no specified.', 'description' => ''],
['errorCode' => 'InvalidType', 'errorMessage' => 'The specified parameter Type is not valid.', 'description' => ''],
['errorCode' => 'InvalidProductId', 'errorMessage' => 'The specified parameter ProductId is not valid.', 'description' => ''],
['errorCode' => 'InvalidPicName', 'errorMessage' => 'The specified parameter PicName is not valid.', 'description' => ''],
['errorCode' => 'InvalidStrAttr', 'errorMessage' => 'The specified parameter StrAttr is not valid.', 'description' => '无效StrAttr'],
['errorCode' => 'InvalidCustomContent', 'errorMessage' => 'The specified parameter CustomContent is not valid.', 'description' => ''],
['errorCode' => 'InvalidPicContent', 'errorMessage' => 'The specified parameter PicContent length greater than 4 * 1024 * 1024.', 'description' => ''],
['errorCode' => 'InvalidPicUrl', 'errorMessage' => 'The search picture does not exist at the specific url.', 'description' => ''],
['errorCode' => 'InvalidInstanceName', 'errorMessage' => 'The parameter instanceName is not specified.', 'description' => ''],
['errorCode' => 'InvalidRequestId', 'errorMessage' => 'The parameter requestId is not specified.', 'description' => ''],
['errorCode' => 'InvalidRequestIdTooLarge', 'errorMessage' => 'The parameter requestId is too large.', 'description' => ''],
['errorCode' => 'InvalidRegion', 'errorMessage' => 'The specific region is illegal', 'description' => ''],
['errorCode' => 'InvalidIntAttr4', 'errorMessage' => 'The specified parameter IntAttr4 is not valid.', 'description' => '无效IntAttr4'],
['errorCode' => 'InvalidIntAttr3', 'errorMessage' => 'The specified parameter IntAttr3 is not valid.', 'description' => '无效IntAttr3'],
['errorCode' => 'InvalidIntAttr2', 'errorMessage' => 'The specified parameter IntAttr2 is not valid.', 'description' => '无效IntAttr2'],
['errorCode' => 'InvalidStrAttr4', 'errorMessage' => 'The specified parameter StrAttr4 is not valid.', 'description' => '无效StrAttr4'],
['errorCode' => 'InvalidStrAttr3', 'errorMessage' => 'The specified parameter StrAttr3 is not valid.', 'description' => '无效StrAttr3'],
['errorCode' => 'InvalidStrAttr2', 'errorMessage' => 'The specified parameter StrAttr2 is not valid.', 'description' => '无效StrAttr2'],
['errorCode' => 'PictureError', 'errorMessage' => '[download] Img Download Failed.', 'description' => '图片下载失败,请检查图片'],
['errorCode' => 'UnsupportedOperationType', 'errorMessage' => 'The specified action is not supported.', 'description' => '内部错误:不支持的action'],
['errorCode' => 'UnsupportedInstanceType', 'errorMessage' => 'The instance type is not supported.', 'description' => '内部错误:不支持的实例类型'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation.', 'description' => '未授权的行为'],
['errorCode' => 'DeniedRequest', 'errorMessage' => 'Your request was denied due to instance flow control.', 'description' => '请求被限流'],
],
500 => [
['errorCode' => 'UnknownException', 'errorMessage' => 'An internal server error occurred.', 'description' => '未知异常'],
['errorCode' => 'NetworkException', 'errorMessage' => 'A network error occurred.', 'description' => '内部错误:请求网络异常'],
['errorCode' => 'RequestTimeout', 'errorMessage' => 'The request is timeout.', 'description' => ''],
['errorCode' => 'ExtractFeatureTimeout', 'errorMessage' => 'The request was timed out while extracting features.', 'description' => ''],
['errorCode' => 'AccessEngineFailed', 'errorMessage' => 'An error occurred while accessing the search engine.', 'description' => ''],
['errorCode' => 'InternalOssError', 'errorMessage' => 'An internal OAS error occurred.', 'description' => '内部错误:请求内部算法错误'],
['errorCode' => 'InternalSwiftError', 'errorMessage' => 'An internal SWIFT error occurred.', 'description' => '内部错误:请求内部消息队列错误'],
['errorCode' => 'InternalTableStoreError', 'errorMessage' => 'An internal Table Store error occurred.', 'description' => '内部错误:请求特征存储错误'],
['errorCode' => 'ConnectionDVException', 'errorMessage' => 'Failed to obtain collection.', 'description' => 'internalError'],
],
],
'title' => '根据过滤条件查询图片',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Msg\\": \\"success\\",\\n \\"RequestId\\": \\"B3137727-7D6E-488C-BA21-0E034C38A879\\",\\n \\"Auctions\\": [\\n {\\n \\"ProductId\\": \\"2092061_1\\",\\n \\"PicName\\": \\"2092061_1.jpg\\",\\n \\"CategoryId\\": 8888888,\\n \\"CustomContent\\": \\"zidingyi\\",\\n \\"IntAttr\\": 2,\\n \\"IntAttr2\\": 2,\\n \\"StrAttr2\\": \\"test\\",\\n \\"StrAttr\\": \\"test\\",\\n \\"StrAttr3\\": \\"test\\",\\n \\"StrAttr4\\": \\"test\\",\\n \\"IntAttr3\\": 2,\\n \\"IntAttr4\\": 2\\n }\\n ],\\n \\"Code\\": 0,\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<SearchImageByFilterResponse>\\n <Msg>success</Msg>\\n <RequestId>B3137727-7D6E-488C-BA21-0E034C38A879</RequestId>\\n <Auctions>\\n <ProductId>2092061_1</ProductId>\\n <PicName>2092061_1.jpg</PicName>\\n <CategoryId>8888888</CategoryId>\\n <CustomContent>zidingyi</CustomContent>\\n <IntAttr>2</IntAttr>\\n <IntAttr2>2</IntAttr2>\\n <StrAttr2>test</StrAttr2>\\n <StrAttr>test</StrAttr>\\n <StrAttr3>test</StrAttr3>\\n <StrAttr4>test</StrAttr4>\\n <IntAttr3>2</IntAttr3>\\n <IntAttr4>2</IntAttr4>\\n </Auctions>\\n <Code>0</Code>\\n <Success>true</Success>\\n</SearchImageByFilterResponse>","errorExample":""}]',
],
'SearchImageByName' => [
'methods' => ['post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREimagesearchF4L5JA'],
],
'parameters' => [
[
'name' => 'InstanceName',
'in' => 'formData',
'schema' => ['description' => '图搜实例名称。最多支持20个字符。'."\n"
.'如果已经购买图搜实例可登录[图像搜索管控台](https://imagesearch.console.aliyun.com/)查看。'."\n"
.'如果没有购买图搜实例可参考[开通服务](~~179178~~)和[创建实例](~~66569~~)。'."\n"
.'>这里的实例名称并非实例ID,使用时请区分。', 'type' => 'string', 'required' => true, 'example' => 'demoinstance1'],
],
[
'name' => 'ProductId',
'in' => 'formData',
'schema' => ['description' => '商品ID。'."\n", 'type' => 'string', 'required' => true, 'example' => '2092061_1', 'isFileTransferUrl' => false],
],
[
'name' => 'PicName',
'in' => 'formData',
'schema' => ['description' => '图片名称。', 'type' => 'string', 'required' => true, 'example' => '2092061_1.jpg'],
],
[
'name' => 'CategoryId',
'in' => 'formData',
'schema' => [
'description' => '商品类目。具体请参见[类目参考](~~179184~~)。'."\n"
.' - 对于商品搜索,如果设置类目,则以设置的为准;如果不设置类目,则由系统进行类目预测,预测的类目结果可以在Response中获取 。'."\n"
.'<props="china">'."\n"
.' - 对于布料、商标、通用、家具家居和工业五金搜索,不论是否设置类目,系统会将类目设置为88888888。'."\n"
.'</props>'."\n"
.'<props="intl">'."\n"
.'- 对于通用搜索,不论是否设置类目,系统会将类目设置为88888888。</props>'."\n"
."\n",
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '88888888',
'minimum' => '0',
'example' => '88888888',
'enum' => ['0', '1', '2', '3', '4', '5', '6', '7', '8', '9', '20', '21', '22', '88888888'],
],
],
[
'name' => 'Num',
'in' => 'formData',
'schema' => ['description' => '返回结果的数目。取值范围:1~100。默认值为10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'default' => '10'],
],
[
'name' => 'Start',
'in' => 'formData',
'schema' => ['description' => '返回结果的起始位置。取值范围:0~499。默认值为0。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '499', 'exclusiveMaximum' => false, 'minimum' => '0', 'exclusiveMinimum' => false, 'example' => '0', 'default' => '0'],
],
[
'name' => 'Filter',
'in' => 'formData',
'schema' => ['description' => '过滤条件。int_attr支持的操作符有in、not in、大于号(>)、大于等于号(>=)、小于号(<)、小于等于号(<=)、等于号(=)。str_attr支持的操作符有in、not in、等于号(=)和不等号(!=),多个条件之支持AND和OR进行连接。'."\n"
.'例如:'."\n"
.'- int_attr>=100。'."\n"
.'- str_attr!="value1"。'."\n"
.'- int_attr=1000 AND str_attr="value1"。'."\n"
."\n"
.'>最多支持4096个字符。', 'type' => 'string', 'required' => false, 'example' => 'int_attr>=100'],
],
[
'name' => 'DistinctProductId',
'in' => 'formData',
'schema' => ['description' => '根据ProductId进行去重复数据。'."\n"
.'> 设置为true则有效。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
'name' => 'ScoreThreshold',
'in' => 'query',
'schema' => ['description' => '填写相似度分数阈值后,只返回图片相似度分数大于等于阈值的图片信息。阈值范围0.00-1.00,最大支持2位小数,默认为0.00 。', 'type' => 'string', 'required' => false, 'example' => '0.50'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '结果返回。',
'type' => 'object',
'properties' => [
'Msg' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'success'],
'Head' => [
'description' => '搜索结果概述信息。',
'type' => 'object',
'properties' => [
'DocsFound' => ['description' => '返回结果数目。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'DocsReturn' => ['description' => '实例中命中结果数目。', 'type' => 'integer', 'format' => 'int32', 'example' => '10000'],
'SearchTime' => ['description' => '搜索耗时,单位毫秒。', 'type' => 'integer', 'format' => 'int32', 'example' => '95'],
],
],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '36C43E96-8F68-44AA-B1AF-B1F7AB94A6C1'],
'Auctions' => [
'description' => '所有返回的商品描述信息。',
'type' => 'array',
'items' => [
'description' => '图片参数。',
'type' => 'object',
'properties' => [
'ProductId' => ['description' => '商品ID。', 'type' => 'string', 'example' => '2092061_1'],
'PicName' => ['description' => '图片名称。', 'type' => 'string', 'example' => '2092061_1.jpg'],
'CategoryId' => ['description' => '图片类目。', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
'SortExprValues' => ['description' => '系统打分信息。'."\n"
.'> - 当前字段已弃用,建议使用Score。'."\n"
.'- SortExprValues是一个分号分隔的二元组,第一个值表示图片的相关性分数,值越大表示和查询的图片相关性越高。由于算法模型不同。'."\n"
.'- 当类目为0~2时,SortExprValues值域范围:0~7.33136443711219e+24。'."\n"
.'- 类目为其他值时,SortExprValues值域范围:0~5.37633353624177e+24。当两个图片完全一样时,这个分值最大。', 'type' => 'string', 'example' => '5.37633353624177e+24;0'],
'CustomContent' => ['description' => '用户自定义的内容。', 'type' => 'string', 'example' => 'zidingyi'],
'Score' => ['description' => '图片相似打分。取值范围:0~1。'."\n"
.'> 需要版本升级至V3.1.1方可使用。', 'type' => 'number', 'format' => 'float', 'example' => '1'],
'IntAttr' => ['description' => '整数类型属性。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
'IntAttr2' => ['description' => '整数类型属性。', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
'StrAttr' => ['description' => '字符串类型属性。'."\n", 'type' => 'string', 'example' => 'ss'],
'StrAttr2' => ['description' => '字符串类型属性。'."\n", 'type' => 'string', 'example' => 'test'],
'StrAttr3' => ['description' => '字符串类型属性,最多支持128个字符。可用于查询时过滤,查询时会返回该字段。', 'type' => 'string', 'example' => 'test'],
'StrAttr4' => ['description' => '字符串类型属性,最多支持128个字符。可用于查询时过滤,查询时会返回该字段。', 'type' => 'string', 'example' => 'test'],
'IntAttr3' => ['description' => '整数类型属性,可用于查询时过滤,查询时会返回该字段。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'IntAttr4' => ['description' => '整数类型属性,可用于查询时过滤,查询时会返回该字段。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
],
],
],
'Code' => ['description' => '错误码。'."\n"
.'- 0:成功。'."\n"
.'- 非0:失败。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'PicInfo' => [
'description' => '类目预测、主体识别结果等信息。',
'type' => 'object',
'properties' => [
'Region' => ['description' => ' 主体识别结果。'."\n"
.'图片的主体区域,格式为x1,x2,y1,y2,其中 x1,y1 是左上角的点,x2,y2是右下角的点。若用户请求中指定了主体区域,则以请求中为准。', 'type' => 'string', 'example' => '280,486,232,351'],
'CategoryId' => ['description' => ' 类目预测结果。'."\n"
.'若用户请求中指定了类目,则以请求中为准。', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
'MultiRegion' => [
'description' => '主体识别集合。',
'type' => 'array',
'items' => [
'description' => '主体集合。',
'type' => 'object',
'properties' => [
'Region' => ['description' => ' 主体识别结果。'."\n"
.'图片的主体区域,格式为x1,x2,y1,y2,其中 x1,y1 是左上角的点,x2,y2是右下角的点。若用户请求中指定了主体区域,则以请求中为准。', 'type' => 'string', 'example' => '280,486,232,351'],
],
],
],
'AllCategories' => [
'description' => '系统支持的所有类目信息。',
'type' => 'array',
'items' => [
'description' => '类目信息。',
'type' => 'object',
'properties' => [
'Name' => ['description' => ' 类目名称。', 'type' => 'string', 'example' => 'other'],
'Id' => ['description' => '类目ID。', 'type' => 'integer', 'format' => 'int32', 'example' => '88888888'],
],
],
],
],
],
'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'BadRequest', 'errorMessage' => 'The request has invalid parameters.', 'description' => ''],
['errorCode' => 'InstanceStatusError', 'errorMessage' => 'Your instance is unavailable.', 'description' => ''],
['errorCode' => 'TimeoutForTransferImage', 'errorMessage' => 'Timeout after 5 seconds waiting for images transfer to complete.', 'description' => ''],
['errorCode' => 'InvalidInstance', 'errorMessage' => 'The specified instance name is invalid.', 'description' => '实例名错误'],
['errorCode' => 'NoCaretSeperator', 'errorMessage' => 'The body content is missing the ^ separator.', 'description' => '请求body缺少特定符号'],
['errorCode' => 'EmptyMeta', 'errorMessage' => 'The body content has an empty meta field.', 'description' => '请求body含有空的字段'],
['errorCode' => 'InvalidMetaItem', 'errorMessage' => 'The meta field is invalid.', 'description' => '无效的元信息字段'],
['errorCode' => 'NoPicList', 'errorMessage' => 'The body content is missing the pic_list parameter.', 'description' => '未指定pic_list字段'],
['errorCode' => 'InvalidPicList', 'errorMessage' => 'The specified pic_list parameter is invalid.', 'description' => '无效的pic_list字段'],
['errorCode' => 'NoSpecifiedPic', 'errorMessage' => 'he content of an image is not specified in the HTTP POST body.', 'description' => ''],
['errorCode' => 'NoSpecifiedSearchPic', 'errorMessage' => 'The search image is not specified.', 'description' => ''],
['errorCode' => 'InvalidCategory', 'errorMessage' => 'The specified category is invalid.', 'description' => '无效的类目id'],
['errorCode' => 'OverflowMaxResultNum', 'errorMessage' => 'The specified number of total results exceeds the maximum of 500.', 'description' => '超过了最大的返回结果限制数500'],
['errorCode' => 'OverflowMaxReturnNum', 'errorMessage' => 'The specified number of results for each request exceeds the maximum of 100.', 'description' => '单次返回数超过限制值100'],
['errorCode' => 'InvalidStartParameter', 'errorMessage' => 'The specified parameter start is inavlid.', 'description' => ''],
['errorCode' => 'InvalidNumParameter', 'errorMessage' => 'The specified parameter num is invalid.', 'description' => '无效的字段num'],
['errorCode' => 'NoSpecifiedAddPic', 'errorMessage' => 'The image to insert is not specified.', 'description' => ''],
['errorCode' => 'NoSpecifiedItemId', 'errorMessage' => 'The item_id parameter is not specified.', 'description' => ''],
['errorCode' => 'InvalidIntAttr', 'errorMessage' => 'The specified int_attr field is invalid.', 'description' => '无效的int过滤字段'],
['errorCode' => 'UnsupportedPicFormat', 'errorMessage' => 'The specified image format is invalid.', 'description' => '无效的图片格式'],
['errorCode' => 'InvalidFilterClause', 'errorMessage' => 'The specified filtering condition is invalid.', 'description' => '无效的过滤条件'],
['errorCode' => 'InstanceOverQuota', 'errorMessage' => 'The number of items exceeds the limit.', 'description' => '实例的图片数量超过限制值'],
['errorCode' => 'IncorrectOrientation', 'errorMessage' => 'The image contains incorrect rotation flags in the meta data.', 'description' => '图片包含不支持的旋转参数'],
['errorCode' => 'UnsupportedPicPixels', 'errorMessage' => 'The specified pixels is not supported.', 'description' => '图片像素值不支持'],
['errorCode' => 'SearchTimeout', 'errorMessage' => 'The request is timed out.', 'description' => ''],
['errorCode' => 'PicNotExist', 'errorMessage' => 'The search picture does not exist.', 'description' => ''],
['errorCode' => 'NoSpecifiedProductId', 'errorMessage' => 'The parameter ProductId no specified.', 'description' => ''],
['errorCode' => 'NoSpecifiedPicName', 'errorMessage' => 'The parameter PicName no specified.', 'description' => ''],
['errorCode' => 'NoSpecifiedPicContent', 'errorMessage' => 'The parameter PicContent no specified.', 'description' => ''],
['errorCode' => 'InvalidType', 'errorMessage' => 'The specified parameter Type is not valid.', 'description' => ''],
['errorCode' => 'InvalidProductId', 'errorMessage' => 'The specified parameter ProductId is not valid.', 'description' => ''],
['errorCode' => 'InvalidPicName', 'errorMessage' => 'The specified parameter PicName is not valid.', 'description' => ''],
['errorCode' => 'InvalidStrAttr', 'errorMessage' => 'The specified parameter StrAttr is not valid.', 'description' => '无效StrAttr'],
['errorCode' => 'InvalidCustomContent', 'errorMessage' => 'The specified parameter CustomContent is not valid.', 'description' => ''],
['errorCode' => 'InvalidPicContent', 'errorMessage' => 'The specified parameter PicContent length greater than 2 * 1024 * 1024.', 'description' => ''],
['errorCode' => 'InvalidStrAttr4', 'errorMessage' => 'The specified parameter StrAttr4 is not valid.', 'description' => '无效StrAttr4'],
['errorCode' => 'InvalidStrAttr3', 'errorMessage' => 'The specified parameter StrAttr3 is not valid.', 'description' => '无效StrAttr3'],
['errorCode' => 'InvalidStrAttr2', 'errorMessage' => 'The specified parameter StrAttr2 is not valid.', 'description' => '无效StrAttr2'],
['errorCode' => 'InvalidIntAttr4', 'errorMessage' => 'The specified parameter IntAttr4 is not valid.', 'description' => '无效IntAttr4'],
['errorCode' => 'InvalidIntAttr3', 'errorMessage' => 'The specified parameter IntAttr3 is not valid.', 'description' => '无效IntAttr3'],
['errorCode' => 'InvalidIntAttr2', 'errorMessage' => 'The specified parameter IntAttr2 is not valid.', 'description' => '无效IntAttr2'],
['errorCode' => 'UnsupportedOperationType', 'errorMessage' => 'The specified action is not supported.', 'description' => '内部错误:不支持的action'],
['errorCode' => 'UnsupportedInstanceType', 'errorMessage' => 'The instance type is not supported.', 'description' => '内部错误:不支持的实例类型'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation.', 'description' => '未授权的行为'],
['errorCode' => 'DeniedRequest', 'errorMessage' => 'Your request was denied due to instance flow control.', 'description' => '请求被限流'],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'An internal server error occurred.', 'description' => ''],
['errorCode' => 'NetworkException', 'errorMessage' => 'A network error occurred.', 'description' => '内部错误:请求网络异常'],
['errorCode' => 'RequestTimeout', 'errorMessage' => 'The request is timeout.', 'description' => ''],
['errorCode' => 'ExtractFeatureTimeout', 'errorMessage' => 'The request was timed out while extracting features.', 'description' => ''],
['errorCode' => 'AccessEngineFailed', 'errorMessage' => 'An error occurred while accessing the search engine.', 'description' => ''],
['errorCode' => 'InternalOssError', 'errorMessage' => 'An internal OAS error occurred.', 'description' => '内部错误:请求内部算法错误'],
['errorCode' => 'InternalSwiftError', 'errorMessage' => 'An internal SWIFT error occurred.', 'description' => '内部错误:请求内部消息队列错误'],
['errorCode' => 'InternalTableStoreError', 'errorMessage' => 'An internal Table Store error occurred.', 'description' => '内部错误:请求特征存储错误'],
],
],
'title' => '通过名称搜索图像',
'summary' => '本文为您介绍SearchByName接口的语法及示例,用于根据名称查询图像搜索实例中的图片信息。',
'description' => '### 使用说明'."\n"
.'本接口用于根据名称(即ProductId和PicName)查询图像搜索实例中的图片信息。'."\n"
."\n"
.'> 如需了解更多产品详情和获取技术支持,请单击[在线咨询](https://www.aliyun.com/core/online-consult?from=aZgW6LJHr2)或通过钉钉群(35035130)联系我们。'."\n"
."\n\n"
.'### QPS限制'."\n"
.'查询操作默认的最大访问频率可在控制台中查看,为您购买时所选择的访问频次(QPS),当前支持1QPS、5QPS、10QPS。'."\n"
."\n",
'extraInfo' => '### 错误码'."\n"
.'请参见[错误码](~~66619~~)。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SearchImageByName'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'imagesearch:SearchImageByName',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ImageSearch', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Msg\\": \\"success\\",\\n \\"Head\\": {\\n \\"DocsFound\\": 10,\\n \\"DocsReturn\\": 10000,\\n \\"SearchTime\\": 95\\n },\\n \\"RequestId\\": \\"36C43E96-8F68-44AA-B1AF-B1F7AB94A6C1\\",\\n \\"Auctions\\": [\\n {\\n \\"ProductId\\": \\"2092061_1\\",\\n \\"PicName\\": \\"2092061_1.jpg\\",\\n \\"CategoryId\\": 20,\\n \\"SortExprValues\\": \\"5.37633353624177e+24;0\\",\\n \\"CustomContent\\": \\"zidingyi\\",\\n \\"Score\\": 1,\\n \\"IntAttr\\": 2,\\n \\"IntAttr2\\": 20,\\n \\"StrAttr\\": \\"ss\\",\\n \\"StrAttr2\\": \\"test\\",\\n \\"StrAttr3\\": \\"test\\",\\n \\"StrAttr4\\": \\"test\\",\\n \\"IntAttr3\\": 1,\\n \\"IntAttr4\\": 1\\n }\\n ],\\n \\"Code\\": 0,\\n \\"PicInfo\\": {\\n \\"Region\\": \\"280,486,232,351\\",\\n \\"CategoryId\\": 20,\\n \\"MultiRegion\\": [\\n {\\n \\"Region\\": \\"280,486,232,351\\"\\n }\\n ],\\n \\"AllCategories\\": [\\n {\\n \\"Name\\": \\"other\\",\\n \\"Id\\": 88888888\\n }\\n ]\\n },\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
],
'SearchImageByPic' => [
'summary' => '本文为您介绍SearchByPic的语法及示例,用于根据图片查询图像搜索实例中的图片信息。',
'methods' => ['post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREimagesearchF4L5JA'],
],
'parameters' => [
[
'name' => 'InstanceName',
'in' => 'formData',
'schema' => ['description' => '图搜实例名称。最多支持20个字符。'."\n"
.'如果已经购买图搜实例可登录[图像搜索管控台](https://imagesearch.console.aliyun.com/)查看。'."\n"
.'如果没有购买图搜实例可参考[开通服务](~~179178~~)和[创建实例](~~66569~~)。'."\n"
.'>这里的实例名称并非实例ID,使用时请区分。', 'type' => 'string', 'required' => true, 'example' => 'demoinstance1'],
],
[
'name' => 'PicContent',
'in' => 'formData',
'schema' => ['description' => '图片内容。'."\n"
.' - 图片大小要求不超过4 MB。'."\n"
.' - 图片格式:PNG、JPG、JPEG、BMP、GIF、WEBP、TIFF、PPM。'."\n"
.' - 传输等待时间不超过5秒。'."\n"
.'<props="china">'."\n"
.' - 服务类型为商品图片搜索、通用图片搜索、家具家居图片搜索和工业五金图片搜索时,图片长和宽像素要求大于等于100PX且小于等于4096PX。'."\n"
.'服务类型为商标图片搜索时,图片长和宽像素要求大于等于200PX且小于4096PX。'."\n"
.'服务类型为布料图片搜索时,图片长和宽像素要求大于等于448PX且小于等于4096PX。'."\n"
.'</props>'."\n"
.'<props="intl">'."\n"
.' - 服务类型为商品图片搜索和通用图片搜索时,图片长和宽像素要求大于等于100PX且小于等于4096PX。'."\n"
.'</props>'."\n"
.'- 图片中不能包含旋转信息。'."\n"
."\n"
.'> - **使用SDK方式调用:**'."\n"
.' - 如使用V3版本SDK,则无需填写PicContent字段,SDK已将本字段封装为PicContentObject字段并自动转化为Base64编码。具体示例参考[JAVA SDK](~~179188~~)。'."\n"
.' - SDK不支持客户直接传递图片URL,V3版本SDK提供了一种变相实现URL上传的方式。具体示例参考[JAVA SDK](~~179188~~)。'."\n"
.'- **使用阿里云OpenAPI平台调用:**'."\n"
.' - 如使用**2019-03-25**版本,**PicContent**字段请填写图片的**Base64**编码。'."\n"
.' - 如使用**2020-12-14**版本,在**PicContent**字段直接点击上传图片即可。', 'type' => 'string', 'required' => true, 'example' => 'AAAANSUhEUgAAAPcAAAEVCAYAAAA8d3NuAAAAAXNSR0IArs......RK5CYII=', 'isFileTransferUrl' => true],
],
[
'name' => 'CategoryId',
'in' => 'formData',
'schema' => [
'description' => '商品类目。具体请参见[类目参考](~~179184~~)。'."\n"
.' - 对于商品搜索,如果设置类目,则以设置的为准;如果不设置类目,则由系统进行类目预测,预测的类目结果可以在Response中获取 。'."\n"
.'<props="china">'."\n"
.' - 对于布料、商标、通用家具家居和工业五金搜索,不论是否设置类目,系统会将类目设置为88888888。'."\n"
.'</props>'."\n"
.'<props="intl">'."\n"
.' - 对于通用搜索,不论是否设置类目,系统会将类目设置为88888888。'."\n"
.'</props>'."\n",
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '88888888',
'minimum' => '0',
'example' => '88888888',
'enum' => ['0', '1', '2', '3', '4', '5', '6', '7', '8', '9', '20', '21', '22', '88888888'],
],
],
[
'name' => 'Crop',
'in' => 'formData',
'schema' => ['description' => '是否需要进行主体识别。默认true。'."\n"
.' - 为true时,由系统进行主体识别,以识别的主体进行搜索,主体识别结果可在Response中获取。'."\n"
.' - 为false时,则不进行主体识别,以整张图进行搜索。'."\n"
.'<props="china">'."\n"
.'- 对于布料图片搜索,此参数会被忽略,系统会以整张图进行搜索。'."\n"
.'</props>'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'Region',
'in' => 'formData',
'schema' => ['description' => '图片的主体区域,格式为`x1,x2,y1,y2,` 其中`x1,y1` 是左上角的点,`x2,y2`是右下角的点。'."\n"
.'> - 若用户设置了Region,则不论Crop参数为何值,都将以用户输入Region进行搜索。'."\n"
.'<props="china">'."\n"
.'- 对于布料图片搜索,此参数会被忽略,系统会以整张图进行搜索。'."\n"
.'</props>'."\n"
."\n\n", 'type' => 'string', 'required' => false, 'example' => '280,486,232,351'],
],
[
'name' => 'Num',
'in' => 'formData',
'schema' => ['description' => '返回结果的数目。取值范围:1~100。默认值为10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'default' => '10'],
],
[
'name' => 'Start',
'in' => 'formData',
'schema' => ['description' => '返回结果的起始位置。取值范围:0~499。默认值为0。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '499', 'minimum' => '0', 'example' => '0', 'default' => '0'],
],
[
'name' => 'Filter',
'in' => 'formData',
'schema' => ['description' => '过滤条件。int_attr支持的操作符有in、not in、大于号(>)、大于等于号(>=)、小于号(<)、小于等于号(<=)、等于号(=)。str_attr支持的操作符有in、not in、等于号(=)和不等号(!=),多个条件之间支持AND和OR进行连接。'."\n"
.'例如:'."\n"
.'- int_attr >= 100。'."\n"
.'- str_attr != "value1"。'."\n"
.'- int_attr = 1000 AND str_attr = "value1"。'."\n"
."\n"
.'>最多支持4096个字符。', 'type' => 'string', 'required' => false, 'example' => 'int_attr=1000 AND str_attr="value1"'],
],
[
'name' => 'DistinctProductId',
'in' => 'formData',
'schema' => ['description' => '如果为true则检索时根据ProductId字段进行去重复数据。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
'name' => 'ScoreThreshold',
'in' => 'query',
'schema' => ['description' => '填写相似度分数阈值后,只返回图片相似度分数大于等于阈值的图片信息。阈值范围0.00-1.00,最大支持2位小数,默认为0.00 。', 'type' => 'string', 'required' => false, 'example' => '0.50'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'Msg' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'success'],
'Head' => [
'description' => '搜索结果概述信息。',
'type' => 'object',
'properties' => [
'DocsFound' => ['description' => '返回结果数目。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'DocsReturn' => ['description' => '实例中命中结果数目。', 'type' => 'integer', 'format' => 'int32', 'example' => '10000'],
'SearchTime' => ['description' => '搜索耗时,单位毫秒。', 'type' => 'integer', 'format' => 'int32', 'example' => '95'],
],
],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B3137727-7D6E-488C-BA21-0E034C38A879'],
'Auctions' => [
'description' => '所有返回的商品描述信息。',
'type' => 'array',
'items' => [
'description' => '所有返回的商品描述信息。',
'type' => 'object',
'properties' => [
'ProductId' => ['description' => '商品ID。', 'type' => 'string', 'example' => '2092061_1'],
'PicName' => ['description' => '图片名称。', 'type' => 'string', 'example' => '2092061_1.jpg'],
'CategoryId' => ['description' => '图片类目。', 'type' => 'integer', 'format' => 'int32', 'example' => '8888888'],
'SortExprValues' => ['description' => '系统打分信息。'."\n"
.'> - 当前字段已弃用,建议使用Score。 '."\n"
.'- SortExprValues是一个分号分隔的二元组,第一个值表示图片的相关性分数,值越大表示和查询的图片相关性越高。由于算法模型不同。'."\n"
.'- 当类目为0~2时,SortExprValues值域范围:0~7.33136443711219e+24。'."\n"
.'- 类目为其他值时,SortExprValues值域范围:0~5.37633353624177e+24。当两个图片完全一样时,这个分值最大。', 'type' => 'string', 'example' => '5.37633353624177e+24;0'],
'CustomContent' => ['description' => '用户自定义的内容。', 'type' => 'string', 'example' => 'zidingyi'],
'Score' => ['description' => '图片相似打分。取值范围:0~1。'."\n"
.'> 需要版本升级至V3.1.1方可使用。', 'type' => 'number', 'format' => 'float', 'example' => '1'],
'IntAttr' => ['description' => '整数类型属性。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
'IntAttr2' => ['description' => '整数类型属性。', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
'StrAttr2' => ['description' => '字符串类型属性。', 'type' => 'string', 'example' => 'test'],
'StrAttr' => ['description' => '字符串类型属性。', 'type' => 'string', 'example' => 'test'],
'StrAttr3' => ['description' => '字符串类型属性。', 'type' => 'string', 'example' => 'test'],
'StrAttr4' => ['description' => '字符串类型属性。', 'type' => 'string', 'example' => 'test'],
'IntAttr3' => ['description' => '整数类型属性。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
'IntAttr4' => ['description' => '整数类型属性。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
],
],
],
'Code' => ['description' => ' 错误码。'."\n"
.'- 0:成功。'."\n"
.'- 非0:失败。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'PicInfo' => [
'description' => '类目预测、主体识别结果等信息。',
'type' => 'object',
'properties' => [
'Region' => ['description' => '主体识别结果。图片的主体区域,格式为x1,x2,y1,y2,其中 x1,y1 是左上角的点,x2,y2是右下角的点。若用户请求中指定了主体区域,则以请求中为准。', 'type' => 'string', 'example' => '280,486,232,351'],
'CategoryId' => ['description' => '类目预测结果。若用户请求中指定了类目,则以请求中为准。', 'type' => 'integer', 'format' => 'int32', 'example' => '88888888'],
'MultiRegion' => [
'description' => '主体识别结果集合。'."\n"
.'> 需要版本升级至V3.1.1方可使用。',
'type' => 'array',
'items' => [
'description' => '主体识别结果。',
'type' => 'object',
'properties' => [
'Region' => ['description' => '主体识别结果。图片的主体区域,格式为x1,x2,y1,y2,其中 x1,y1 是左上角的点,x2,y2是右下角的点。若用户请求中指定了主体区域,则以请求中为准。', 'type' => 'string', 'example' => '280,486,232,351'],
],
],
],
'AllCategories' => [
'description' => '系统支持的所有类目信息。',
'type' => 'array',
'items' => [
'description' => '系统支持的所有类目信息。',
'type' => 'object',
'properties' => [
'Name' => ['description' => '类目名称。', 'type' => 'string', 'example' => 'other'],
'Id' => ['description' => '类目ID。', 'type' => 'integer', 'format' => 'int32', 'example' => '88888888'],
],
],
],
],
],
'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'BadRequest', 'errorMessage' => 'The request has invalid parameters.', 'description' => ''],
['errorCode' => 'InstanceStatusError', 'errorMessage' => 'Your instance is unavailable.', 'description' => ''],
['errorCode' => 'TimeoutForTransferImage', 'errorMessage' => 'Timeout after 5 seconds waiting for images transfer to complete.', 'description' => ''],
['errorCode' => 'InvalidInstance', 'errorMessage' => 'The specified instance name is invalid.', 'description' => '实例名错误'],
['errorCode' => 'NoCaretSeperator', 'errorMessage' => 'The body content is missing the ^ separator.', 'description' => '请求body缺少特定符号'],
['errorCode' => 'EmptyMeta', 'errorMessage' => 'The body content has an empty meta field.', 'description' => '请求body含有空的字段'],
['errorCode' => 'InvalidMetaItem', 'errorMessage' => 'The meta field is invalid.', 'description' => '无效的元信息字段'],
['errorCode' => 'NoPicList', 'errorMessage' => 'The body content is missing the pic_list parameter.', 'description' => '未指定pic_list字段'],
['errorCode' => 'InvalidPicList', 'errorMessage' => 'The specified pic_list parameter is invalid.', 'description' => '无效的pic_list字段'],
['errorCode' => 'NoSpecifiedPic', 'errorMessage' => 'he content of an image is not specified in the HTTP POST body.', 'description' => ''],
['errorCode' => 'NoSpecifiedSearchPic', 'errorMessage' => 'The search image is not specified.', 'description' => ''],
['errorCode' => 'InvalidCategory', 'errorMessage' => 'The specified category is invalid.', 'description' => '无效的类目id'],
['errorCode' => 'OverflowMaxResultNum', 'errorMessage' => 'The specified number of total results exceeds the maximum of 500.', 'description' => '超过了最大的返回结果限制数500'],
['errorCode' => 'OverflowMaxReturnNum', 'errorMessage' => 'The specified number of results for each request exceeds the maximum of 100.', 'description' => '单次返回数超过限制值100'],
['errorCode' => 'InvalidStartParameter', 'errorMessage' => 'The specified parameter start is inavlid.', 'description' => ''],
['errorCode' => 'InvalidNumParameter', 'errorMessage' => 'The specified parameter num is invalid.', 'description' => '无效的字段num'],
['errorCode' => 'NoSpecifiedAddPic', 'errorMessage' => 'The image to insert is not specified.', 'description' => ''],
['errorCode' => 'NoSpecifiedItemId', 'errorMessage' => 'The item_id parameter is not specified.', 'description' => ''],
['errorCode' => 'InvalidIntAttr', 'errorMessage' => 'The specified int_attr field is invalid.', 'description' => '无效的int过滤字段'],
['errorCode' => 'UnsupportedPicFormat', 'errorMessage' => 'The specified image format is invalid.', 'description' => '无效的图片格式'],
['errorCode' => 'InvalidFilterClause', 'errorMessage' => 'The specified filtering condition is invalid.', 'description' => '无效的过滤条件'],
['errorCode' => 'InstanceOverQuota', 'errorMessage' => 'The number of items exceeds the limit.', 'description' => '实例的图片数量超过限制值'],
['errorCode' => 'IncorrectOrientation', 'errorMessage' => 'The image contains incorrect rotation flags in the meta data.', 'description' => '图片包含不支持的旋转参数'],
['errorCode' => 'UnsupportedPicPixels', 'errorMessage' => 'The specified pixels is not supported.', 'description' => '图片像素值不支持'],
['errorCode' => 'SearchTimeout', 'errorMessage' => 'The request is timed out.', 'description' => ''],
['errorCode' => 'PicNotExist', 'errorMessage' => 'The search picture does not exist.', 'description' => ''],
['errorCode' => 'NoSpecifiedProductId', 'errorMessage' => 'The parameter ProductId no specified.', 'description' => ''],
['errorCode' => 'NoSpecifiedPicName', 'errorMessage' => 'The parameter PicName no specified.', 'description' => ''],
['errorCode' => 'NoSpecifiedPicContent', 'errorMessage' => 'The parameter PicContent no specified.', 'description' => ''],
['errorCode' => 'InvalidType', 'errorMessage' => 'The specified parameter Type is not valid.', 'description' => ''],
['errorCode' => 'InvalidProductId', 'errorMessage' => 'The specified parameter ProductId is not valid.', 'description' => ''],
['errorCode' => 'InvalidPicName', 'errorMessage' => 'The specified parameter PicName is not valid.', 'description' => ''],
['errorCode' => 'InvalidStrAttr', 'errorMessage' => 'The specified parameter StrAttr is not valid.', 'description' => '无效StrAttr'],
['errorCode' => 'InvalidCustomContent', 'errorMessage' => 'The specified parameter CustomContent is not valid.', 'description' => ''],
['errorCode' => 'InvalidPicContent', 'errorMessage' => 'The specified parameter PicContent length greater than 4 * 1024 * 1024.', 'description' => ''],
['errorCode' => 'InvalidPicUrl', 'errorMessage' => 'The search picture does not exist at the specific url.', 'description' => ''],
['errorCode' => 'InvalidInstanceName', 'errorMessage' => 'The parameter instanceName is not specified.', 'description' => ''],
['errorCode' => 'InvalidRequestId', 'errorMessage' => 'The parameter requestId is not specified.', 'description' => ''],
['errorCode' => 'InvalidRequestIdTooLarge', 'errorMessage' => 'The parameter requestId is too large.', 'description' => ''],
['errorCode' => 'InvalidRegion', 'errorMessage' => 'The specific region is illegal', 'description' => ''],
['errorCode' => 'InvalidIntAttr4', 'errorMessage' => 'The specified parameter IntAttr4 is not valid.', 'description' => '无效IntAttr4'],
['errorCode' => 'InvalidIntAttr3', 'errorMessage' => 'The specified parameter IntAttr3 is not valid.', 'description' => '无效IntAttr3'],
['errorCode' => 'InvalidIntAttr2', 'errorMessage' => 'The specified parameter IntAttr2 is not valid.', 'description' => '无效IntAttr2'],
['errorCode' => 'InvalidStrAttr4', 'errorMessage' => 'The specified parameter StrAttr4 is not valid.', 'description' => '无效StrAttr4'],
['errorCode' => 'InvalidStrAttr3', 'errorMessage' => 'The specified parameter StrAttr3 is not valid.', 'description' => '无效StrAttr3'],
['errorCode' => 'InvalidStrAttr2', 'errorMessage' => 'The specified parameter StrAttr2 is not valid.', 'description' => '无效StrAttr2'],
['errorCode' => 'PictureError', 'errorMessage' => '[download] Img Download Failed.', 'description' => '图片下载失败,请检查图片'],
['errorCode' => 'UnsupportedOperationType', 'errorMessage' => 'The specified action is not supported.', 'description' => '内部错误:不支持的action'],
['errorCode' => 'UnsupportedInstanceType', 'errorMessage' => 'The instance type is not supported.', 'description' => '内部错误:不支持的实例类型'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation.', 'description' => '未授权的行为'],
['errorCode' => 'DeniedRequest', 'errorMessage' => 'Your request was denied due to instance flow control.', 'description' => '请求被限流'],
],
500 => [
['errorCode' => 'UnknownException', 'errorMessage' => 'An internal server error occurred.', 'description' => '未知异常'],
['errorCode' => 'NetworkException', 'errorMessage' => 'A network error occurred.', 'description' => '内部错误:请求网络异常'],
['errorCode' => 'RequestTimeout', 'errorMessage' => 'The request is timeout.', 'description' => ''],
['errorCode' => 'ExtractFeatureTimeout', 'errorMessage' => 'The request was timed out while extracting features.', 'description' => ''],
['errorCode' => 'AccessEngineFailed', 'errorMessage' => 'An error occurred while accessing the search engine.', 'description' => ''],
['errorCode' => 'InternalOssError', 'errorMessage' => 'An internal OAS error occurred.', 'description' => '内部错误:请求内部算法错误'],
['errorCode' => 'InternalSwiftError', 'errorMessage' => 'An internal SWIFT error occurred.', 'description' => '内部错误:请求内部消息队列错误'],
['errorCode' => 'InternalTableStoreError', 'errorMessage' => 'An internal Table Store error occurred.', 'description' => '内部错误:请求特征存储错误'],
['errorCode' => 'ConnectionDVException', 'errorMessage' => 'Failed to obtain collection.', 'description' => 'internalError'],
],
],
'title' => '根据图片查询图片',
'description' => '## 使用说明'."\n"
.'本接口用于根据图片查询图像搜索实例中的图片信息。'."\n"
.'> <props="china">如需了解更多产品详情和获取技术支持,请单击[在线咨询](https://www.aliyun.com/core/online-consult?from=aZgW6LJHr2)或通过钉钉群(35035130)联系我们。</props>'."\n"
."\n"
.'## QPS限制'."\n"
.'查询操作默认的最大访问频率可在控制台中查看,为您购买时所选择的访问频次(QPS),当前支持1QPS、5QPS、10QPS。'."\n"
."\n\n"
.'### SDK版本说明'."\n"
.'图像SDK版本升级到V3.1.1,可使用“多主体识别”、“相似性分数”功能。请参见[Java SDK](~~179188~~)。',
'extraInfo' => '## 错误码'."\n"
.'请参见[错误码](~~66619~~)。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SearchImageByPic'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'imagesearch:SearchImageByPic',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ImageSearch', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Msg\\": \\"success\\",\\n \\"Head\\": {\\n \\"DocsFound\\": 10,\\n \\"DocsReturn\\": 10000,\\n \\"SearchTime\\": 95\\n },\\n \\"RequestId\\": \\"B3137727-7D6E-488C-BA21-0E034C38A879\\",\\n \\"Auctions\\": [\\n {\\n \\"ProductId\\": \\"2092061_1\\",\\n \\"PicName\\": \\"2092061_1.jpg\\",\\n \\"CategoryId\\": 8888888,\\n \\"SortExprValues\\": \\"5.37633353624177e+24;0\\",\\n \\"CustomContent\\": \\"zidingyi\\",\\n \\"Score\\": 1,\\n \\"IntAttr\\": 2,\\n \\"IntAttr2\\": 20,\\n \\"StrAttr2\\": \\"test\\",\\n \\"StrAttr\\": \\"test\\",\\n \\"StrAttr3\\": \\"test\\",\\n \\"StrAttr4\\": \\"test\\",\\n \\"IntAttr3\\": 2,\\n \\"IntAttr4\\": 2\\n }\\n ],\\n \\"Code\\": 0,\\n \\"PicInfo\\": {\\n \\"Region\\": \\"280,486,232,351\\",\\n \\"CategoryId\\": 88888888,\\n \\"MultiRegion\\": [\\n {\\n \\"Region\\": \\"280,486,232,351\\"\\n }\\n ],\\n \\"AllCategories\\": [\\n {\\n \\"Name\\": \\"other\\",\\n \\"Id\\": 88888888\\n }\\n ]\\n },\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
],
'SearchImageByText' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREimagesearchF4L5JA'],
],
'parameters' => [
[
'name' => 'InstanceName',
'in' => 'formData',
'schema' => ['description' => '图搜实例名称。最多支持20个字符。'."\n"
.'如果已经购买图搜实例可登录[图像搜索管控台](https://imagesearch.console.aliyun.com/)查看。'."\n"
.'如果没有购买图搜实例可参考[开通服务](~~179178~~)和[创建实例](~~66569~~)。'."\n"
.'>这里的实例名称并非实例ID,使用时请区分。', 'type' => 'string', 'required' => true, 'example' => 'demoinstance1'],
],
[
'name' => 'Num',
'in' => 'formData',
'schema' => ['description' => '返回结果的数目。取值范围:1~100。默认值为10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'default' => '10'],
],
[
'name' => 'Start',
'in' => 'formData',
'schema' => ['description' => '返回结果的起始位置。取值范围:0~499。默认值为0。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '499', 'minimum' => '0', 'example' => '0', 'default' => '0'],
],
[
'name' => 'Filter',
'in' => 'formData',
'schema' => ['description' => '过滤条件。int_attr支持的操作符有in、not in、大于号(>)、大于等于号(>=)、小于号(<)、小于等于号(<=)、等于号(=)。str_attr支持的操作符有in、not in、等于号(=)和不等号(!=),多个条件之间支持AND和OR进行连接。'."\n"
.'例如:'."\n"
.'- int_attr >= 100。'."\n"
.'- str_attr != "value1"。'."\n"
.'- int_attr = 1000 AND str_attr = "value1"。'."\n"
."\n"
.'>最多支持4096个字符。', 'type' => 'string', 'required' => false, 'example' => 'int_attr=1000 AND str_attr="value1"'],
],
[
'name' => 'DistinctProductId',
'in' => 'formData',
'schema' => ['description' => '如果为true则检索时根据ProductId字段进行去重复数据。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
'name' => 'Text',
'in' => 'formData',
'schema' => ['description' => '搜索图片的描述文本,支持中英文。'."\n"
."\n"
.'>最多支持512个字符。', 'type' => 'string', 'required' => true, 'example' => 'xxxx'],
],
[
'name' => 'ScoreThreshold',
'in' => 'query',
'schema' => ['description' => '填写相似度分数阈值后,只返回图片相似度分数大于等于阈值的图片信息。阈值范围0.00-1.00,最大支持2位小数,默认为0.00 。', 'type' => 'string', 'required' => false, 'example' => '0.50'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'Msg' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'success'],
'Head' => [
'description' => '搜索结果概述信息。',
'type' => 'object',
'properties' => [
'DocsFound' => ['description' => '返回结果数目。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'DocsReturn' => ['description' => '实例中命中结果数目。', 'type' => 'integer', 'format' => 'int32', 'example' => '10000'],
'SearchTime' => ['description' => '搜索耗时,单位毫秒。', 'type' => 'integer', 'format' => 'int32', 'example' => '95'],
],
],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B3137727-7D6E-488C-BA21-0E034C38A879'],
'Auctions' => [
'description' => '所有返回的商品描述信息。',
'type' => 'array',
'items' => [
'description' => '所有返回的商品描述信息。',
'type' => 'object',
'properties' => [
'ProductId' => ['description' => '商品ID。', 'type' => 'string', 'example' => '2092061_1'],
'PicName' => ['description' => '图片名称。', 'type' => 'string', 'example' => '2092061_1.jpg'],
'CategoryId' => ['description' => '图片类目。', 'type' => 'integer', 'format' => 'int32', 'example' => '8888888'],
'CustomContent' => ['description' => '用户自定义的内容。', 'type' => 'string', 'example' => 'zidingyi'],
'Score' => ['description' => '图片相似打分。取值范围:0~1。'."\n"
.'> 需要版本升级至V3.1.1方可使用。', 'type' => 'number', 'format' => 'float', 'example' => '1'],
'IntAttr' => ['description' => '整数类型属性。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
'IntAttr2' => ['description' => '整数类型属性。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
'StrAttr2' => ['description' => '字符串类型属性。', 'type' => 'string', 'example' => 'xxxx'],
'StrAttr' => ['description' => '字符串类型属性。', 'type' => 'string', 'example' => 'xxxx'],
'StrAttr3' => ['description' => '字符串类型属性。', 'type' => 'string', 'example' => 'xxxx'],
'StrAttr4' => ['description' => '字符串类型属性。', 'type' => 'string', 'example' => 'xxxx'],
'IntAttr3' => ['description' => '整数类型属性。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
'IntAttr4' => ['description' => '整数类型属性。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
],
],
],
'Code' => ['description' => '错误码。'."\n"
.'- 0:成功。'."\n"
.'- 非0:失败。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'PicInfo' => [
'description' => '所有的类目信息',
'type' => 'object',
'properties' => [
'AllCategories' => [
'description' => '系统支持的所有类目信息。',
'type' => 'array',
'items' => [
'description' => '系统支持的所有类目信息。',
'type' => 'object',
'properties' => [
'Name' => ['description' => '类目名称。', 'type' => 'string', 'example' => 'other'],
'Id' => ['description' => '类目ID。', 'type' => 'integer', 'format' => 'int32', 'example' => '88888888'],
],
],
],
],
],
'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'],
'AccessDeniedDetail' => [
'description' => '鉴权返回集合。',
'type' => 'object',
'properties' => [
'AuthAction' => ['description' => '鉴权请求Action。', 'type' => 'string', 'example' => 'xxx'],
'AuthPrincipalDisplayName' => ['description' => '鉴权主体信息。', 'type' => 'string', 'example' => '111'],
'AuthPrincipalOwnerId' => ['description' => '鉴权主体的主账号ID。', 'type' => 'string', 'example' => '222'],
'AuthPrincipalType' => ['description' => '鉴权主体类型。', 'type' => 'string', 'example' => 'SubUser'],
'EncodedDiagnosticMessage' => ['description' => '加密后的完整诊断信息。', 'type' => 'string', 'example' => 'xxxxxx'],
'NoPermissionType' => ['description' => 'ImplicitDeny:未命中任何策略。'."\n"
.'ExplicitDeny:明确命中Deny策略。', 'type' => 'string', 'example' => 'ImplicitDeny'],
'PolicyType' => ['description' => '引起无权限的策略类型。', 'type' => 'string', 'example' => 'PauseNotify'],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'BadRequest', 'errorMessage' => 'The request has invalid parameters.', 'description' => ''],
['errorCode' => 'InstanceStatusError', 'errorMessage' => 'Your instance is unavailable.', 'description' => ''],
['errorCode' => 'TimeoutForTransferImage', 'errorMessage' => 'Timeout after 5 seconds waiting for images transfer to complete.', 'description' => ''],
['errorCode' => 'InvalidInstance', 'errorMessage' => 'The specified instance name is invalid.', 'description' => '实例名错误'],
['errorCode' => 'NoCaretSeperator', 'errorMessage' => 'The body content is missing the ^ separator.', 'description' => '请求body缺少特定符号'],
['errorCode' => 'EmptyMeta', 'errorMessage' => 'The body content has an empty meta field.', 'description' => '请求body含有空的字段'],
['errorCode' => 'InvalidMetaItem', 'errorMessage' => 'The meta field is invalid.', 'description' => '无效的元信息字段'],
['errorCode' => 'NoPicList', 'errorMessage' => 'The body content is missing the pic_list parameter.', 'description' => '未指定pic_list字段'],
['errorCode' => 'InvalidPicList', 'errorMessage' => 'The specified pic_list parameter is invalid.', 'description' => '无效的pic_list字段'],
['errorCode' => 'NoSpecifiedPic', 'errorMessage' => 'he content of an image is not specified in the HTTP POST body.', 'description' => ''],
['errorCode' => 'NoSpecifiedSearchPic', 'errorMessage' => 'The search image is not specified.', 'description' => ''],
['errorCode' => 'OverflowMaxResultNum', 'errorMessage' => 'The specified number of total results exceeds the maximum of 500.', 'description' => '超过了最大的返回结果限制数500'],
['errorCode' => 'OverflowMaxReturnNum', 'errorMessage' => 'The specified number of results for each request exceeds the maximum of 100.', 'description' => '单次返回数超过限制值100'],
['errorCode' => 'InvalidStartParameter', 'errorMessage' => 'The specified parameter start is inavlid.', 'description' => ''],
['errorCode' => 'InvalidNumParameter', 'errorMessage' => 'The specified parameter num is invalid.', 'description' => '无效的字段num'],
['errorCode' => 'NoSpecifiedAddPic', 'errorMessage' => 'The image to insert is not specified.', 'description' => ''],
['errorCode' => 'NoSpecifiedItemId', 'errorMessage' => 'The item_id parameter is not specified.', 'description' => ''],
['errorCode' => 'InvalidIntAttr', 'errorMessage' => 'The specified int_attr field is invalid.', 'description' => '无效的int过滤字段'],
['errorCode' => 'InvalidFilterClause', 'errorMessage' => 'The specified filtering condition is invalid.', 'description' => '无效的过滤条件'],
['errorCode' => 'InstanceOverQuota', 'errorMessage' => 'The number of items exceeds the limit.', 'description' => '实例的图片数量超过限制值'],
['errorCode' => 'IncorrectOrientation', 'errorMessage' => 'The image contains incorrect rotation flags in the meta data.', 'description' => '图片包含不支持的旋转参数'],
['errorCode' => 'UnsupportedPicPixels', 'errorMessage' => 'The specified pixels is not supported.', 'description' => '图片像素值不支持'],
['errorCode' => 'SearchTimeout', 'errorMessage' => 'The request is timed out.', 'description' => ''],
['errorCode' => 'PicNotExist', 'errorMessage' => 'The search picture does not exist.', 'description' => ''],
['errorCode' => 'NoSpecifiedProductId', 'errorMessage' => 'The parameter ProductId no specified.', 'description' => ''],
['errorCode' => 'NoSpecifiedPicName', 'errorMessage' => 'The parameter PicName no specified.', 'description' => ''],
['errorCode' => 'NoSpecifiedPicContent', 'errorMessage' => 'The parameter PicContent no specified.', 'description' => ''],
['errorCode' => 'InvalidType', 'errorMessage' => 'The specified parameter Type is not valid.', 'description' => ''],
['errorCode' => 'InvalidProductId', 'errorMessage' => 'The specified parameter ProductId is not valid.', 'description' => ''],
['errorCode' => 'InvalidPicName', 'errorMessage' => 'The specified parameter PicName is not valid.', 'description' => ''],
['errorCode' => 'InvalidStrAttr', 'errorMessage' => 'The specified parameter StrAttr is not valid.', 'description' => '无效StrAttr'],
['errorCode' => 'InvalidCustomContent', 'errorMessage' => 'The specified parameter CustomContent is not valid.', 'description' => ''],
['errorCode' => 'InvalidPicContent', 'errorMessage' => 'The specified parameter PicContent length greater than 4 * 1024 * 1024.', 'description' => ''],
['errorCode' => 'InvalidPicUrl', 'errorMessage' => 'The search picture does not exist at the specific url.', 'description' => ''],
['errorCode' => 'InvalidInstanceName', 'errorMessage' => 'The parameter instanceName is not specified.', 'description' => ''],
['errorCode' => 'InvalidRequestId', 'errorMessage' => 'The parameter requestId is not specified.', 'description' => ''],
['errorCode' => 'InvalidRequestIdTooLarge', 'errorMessage' => 'The parameter requestId is too large.', 'description' => ''],
['errorCode' => 'InvalidRegion', 'errorMessage' => 'The specific region is illegal', 'description' => ''],
['errorCode' => 'InvalidIntAttr4', 'errorMessage' => 'The specified parameter IntAttr4 is not valid.', 'description' => '无效IntAttr4'],
['errorCode' => 'InvalidIntAttr3', 'errorMessage' => 'The specified parameter IntAttr3 is not valid.', 'description' => '无效IntAttr3'],
['errorCode' => 'InvalidIntAttr2', 'errorMessage' => 'The specified parameter IntAttr2 is not valid.', 'description' => '无效IntAttr2'],
['errorCode' => 'InvalidStrAttr4', 'errorMessage' => 'The specified parameter StrAttr4 is not valid.', 'description' => '无效StrAttr4'],
['errorCode' => 'InvalidStrAttr3', 'errorMessage' => 'The specified parameter StrAttr3 is not valid.', 'description' => '无效StrAttr3'],
['errorCode' => 'InvalidStrAttr2', 'errorMessage' => 'The specified parameter StrAttr2 is not valid.', 'description' => '无效StrAttr2'],
['errorCode' => 'InvalidText', 'errorMessage' => 'The specified parameter Text is not valid.', 'description' => '描述信息Text不能为null'],
['errorCode' => 'InvalidTextLength', 'errorMessage' => 'Invalid text clause.', 'description' => 'text字段长度必须在512内。'],
['errorCode' => 'UnsupportedOperationType', 'errorMessage' => 'The specified action is not supported.', 'description' => '内部错误:不支持的action'],
['errorCode' => 'UnsupportedInstanceType', 'errorMessage' => 'The instance type is not supported.', 'description' => '内部错误:不支持的实例类型'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation.', 'description' => '未授权的行为'],
['errorCode' => 'DeniedRequest', 'errorMessage' => 'Your request was denied due to instance flow control.', 'description' => '请求被限流'],
],
500 => [
['errorCode' => 'UnknownException', 'errorMessage' => 'An internal server error occurred.', 'description' => '未知异常'],
['errorCode' => 'NetworkException', 'errorMessage' => 'A network error occurred.', 'description' => '内部错误:请求网络异常'],
['errorCode' => 'RequestTimeout', 'errorMessage' => 'The request is timeout.', 'description' => ''],
['errorCode' => 'ExtractFeatureTimeout', 'errorMessage' => 'The request was timed out while extracting features.', 'description' => ''],
['errorCode' => 'AccessEngineFailed', 'errorMessage' => 'An error occurred while accessing the search engine.', 'description' => ''],
['errorCode' => 'InternalOssError', 'errorMessage' => 'An internal OAS error occurred.', 'description' => '内部错误:请求内部算法错误'],
['errorCode' => 'InternalSwiftError', 'errorMessage' => 'An internal SWIFT error occurred.', 'description' => '内部错误:请求内部消息队列错误'],
['errorCode' => 'InternalTableStoreError', 'errorMessage' => 'An internal Table Store error occurred.', 'description' => '内部错误:请求特征存储错误'],
['errorCode' => 'ConnectionDVException', 'errorMessage' => 'Failed to obtain collection.', 'description' => 'internalError'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '根据文本查询图片',
'summary' => '本文为您介绍SearchImageByText的语法及示例,用于根据文字查询图像搜索实例中的图片信息。',
'description' => '## 使用说明'."\n"
.'本接口用于根据文字查询图像搜索实例中的图片信息。只有服务类型为商品多模态搜索才能使用。'."\n"
.'> <props="china">如需了解更多产品详情和获取技术支持,请单击[在线咨询](https://www.aliyun.com/core/online-consult?from=aZgW6LJHr2)或通过钉钉群(35035130)联系我们。</props>'."\n"
."\n"
.'## QPS限制'."\n"
.'查询操作默认的最大访问频率可在控制台中查看,为您购买时所选择的访问频次(QPS),当前支持1QPS、5QPS、10QPS。'."\n"
."\n\n"
.'### SDK版本说明'."\n"
.'图像SDK版本升级到V3.1.1,可使用“多主体识别”、“相似性分数”功能。请参见[Java SDK](~~179188~~)。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'imagesearch:SearchImageByText',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ImageSearch', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Msg\\": \\"success\\",\\n \\"Head\\": {\\n \\"DocsFound\\": 10,\\n \\"DocsReturn\\": 10000,\\n \\"SearchTime\\": 95\\n },\\n \\"RequestId\\": \\"B3137727-7D6E-488C-BA21-0E034C38A879\\",\\n \\"Auctions\\": [\\n {\\n \\"ProductId\\": \\"2092061_1\\",\\n \\"PicName\\": \\"2092061_1.jpg\\",\\n \\"CategoryId\\": 8888888,\\n \\"CustomContent\\": \\"zidingyi\\",\\n \\"Score\\": 1,\\n \\"IntAttr\\": 2,\\n \\"IntAttr2\\": 2,\\n \\"StrAttr2\\": \\"xxxx\\",\\n \\"StrAttr\\": \\"xxxx\\",\\n \\"StrAttr3\\": \\"xxxx\\",\\n \\"StrAttr4\\": \\"xxxx\\",\\n \\"IntAttr3\\": 2,\\n \\"IntAttr4\\": 2\\n }\\n ],\\n \\"Code\\": 0,\\n \\"PicInfo\\": {\\n \\"AllCategories\\": [\\n {\\n \\"Name\\": \\"other\\",\\n \\"Id\\": 88888888\\n }\\n ]\\n },\\n \\"Success\\": true,\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"xxx\\",\\n \\"AuthPrincipalDisplayName\\": \\"111\\",\\n \\"AuthPrincipalOwnerId\\": \\"222\\",\\n \\"AuthPrincipalType\\": \\"SubUser\\",\\n \\"EncodedDiagnosticMessage\\": \\"xxxxxx\\",\\n \\"NoPermissionType\\": \\"ImplicitDeny\\",\\n \\"PolicyType\\": \\"PauseNotify\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<SearchImageByTextResponse>\\n <Msg>success</Msg>\\n <Head>\\n <DocsFound>10</DocsFound>\\n <DocsReturn>10000</DocsReturn>\\n <SearchTime>95</SearchTime>\\n </Head>\\n <RequestId>B3137727-7D6E-488C-BA21-0E034C38A879</RequestId>\\n <Auctions>\\n <ProductId>2092061_1</ProductId>\\n <PicName>2092061_1.jpg</PicName>\\n <CategoryId>8888888</CategoryId>\\n <CustomContent>zidingyi</CustomContent>\\n <Score>1</Score>\\n <IntAttr>2</IntAttr>\\n <IntAttr2>2</IntAttr2>\\n <StrAttr2>xxxx</StrAttr2>\\n <StrAttr>xxxx</StrAttr>\\n <StrAttr3>xxxx</StrAttr3>\\n <StrAttr4>xxxx</StrAttr4>\\n <IntAttr3>2</IntAttr3>\\n <IntAttr4>2</IntAttr4>\\n </Auctions>\\n <Code>0</Code>\\n <PicInfo>\\n <AllCategories>\\n <Name>other</Name>\\n <Id>88888888</Id>\\n </AllCategories>\\n </PicInfo>\\n <Success>true</Success>\\n</SearchImageByTextResponse>","errorExample":""}]',
],
'UpdateImage' => [
'summary' => '本文为您介绍UpdateImage接口的语法及示例,用于向图像搜索实例中修改图片信息。',
'methods' => ['post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREimagesearchAA7PKJ'],
],
'parameters' => [
[
'name' => 'InstanceName',
'in' => 'formData',
'schema' => ['description' => '图搜实例名称。最多支持20个字符。'."\n"
.'如果已经购买图搜实例可登录[图像搜索管控台](https://imagesearch.console.aliyun.com/)查看。'."\n"
.'如果没有购买图搜实例可参考[开通服务](~~179178~~)和[创建实例](~~66569~~)。'."\n"
.'>这里的实例名称并非实例ID,使用时请区分。', 'type' => 'string', 'required' => true, 'example' => 'demoinstance1'],
],
[
'name' => 'ProductId',
'in' => 'formData',
'schema' => ['description' => '商品ID,最多支持256个字符。'."\n"
."\n"
.'>一个商品可以有多张图片。根据实际情况自定义参数值。比如:上衣001号、裤子002号等。', 'type' => 'string', 'required' => true, 'example' => '2092061_1'],
],
[
'name' => 'PicName',
'in' => 'formData',
'schema' => ['description' => ' 图片名称,最多支持256个字符。'."\n"
.'> - ProductId和PicName唯一确定一张图片,且ProductId和PicName无法被修改。'."\n"
.'- 如果多次添加图片具有相同的ProductId和PicName,以最后一次添加为准,前面添加的图片将被覆盖。'."\n"
.'- 如果不填写PicName,则根据ProductId进行修改图片信息。'."\n"
.'- 如果填写PicName,则根据ProductId+PicName进行修改图片信息。'."\n"
."\n\n", 'type' => 'string', 'required' => false, 'example' => 'namexxx.jpg'],
],
[
'name' => 'CustomContent',
'in' => 'formData',
'schema' => ['description' => '用户自定义的内容,最多支持4096个字符。'."\n"
.'>调用"<props="china">[根据图片查询图片](https://help.aliyun.com/document_detail/202282.html)</props><props="intl">[根据图片查询图片](https://www.alibabacloud.com/help/zh/image-search/latest/updateimage)</props>"接口时会返回该字段。例如可添加图片的描述等文本。'."\n"
."\n\n", 'type' => 'string', 'required' => false, 'example' => 'zidingyi'],
],
[
'name' => 'IntAttr',
'in' => 'formData',
'schema' => ['description' => '整数类型属性,可用于查询时过滤,查询时会返回该字段。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2'],
],
[
'name' => 'StrAttr',
'in' => 'formData',
'schema' => ['description' => '字符串类型属性,最多支持128个字符。可用于查询时过滤,查询时会返回该字段。', 'type' => 'string', 'required' => false, 'example' => 'ss'],
],
[
'name' => 'IntAttr2',
'in' => 'formData',
'schema' => ['description' => '整数类型属性,可用于查询时过滤,查询时会返回该字段。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'],
],
[
'name' => 'StrAttr2',
'in' => 'formData',
'schema' => ['description' => '字符串类型属性,最多支持128个字符。可用于查询时过滤,查询时会返回该字段。', 'type' => 'string', 'required' => false, 'example' => 'test'],
],
[
'name' => 'IntAttr3',
'in' => 'query',
'schema' => ['description' => '整数类型属性,可用于查询时过滤,查询时会返回该字段。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '33'],
],
[
'name' => 'StrAttr3',
'in' => 'query',
'schema' => ['description' => '字符串类型属性,最多支持128个字符。可用于查询时过滤,查询时会返回该字段。', 'type' => 'string', 'required' => false, 'example' => 'ss'],
],
[
'name' => 'IntAttr4',
'in' => 'query',
'schema' => ['description' => '整数类型属性,可用于查询时过滤,查询时会返回该字段。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '33'],
],
[
'name' => 'StrAttr4',
'in' => 'query',
'schema' => ['description' => '字符串类型属性,最多支持128个字符。可用于查询时过滤,查询时会返回该字段。', 'type' => 'string', 'required' => false, 'example' => 'ss'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回对象。',
'type' => 'object',
'properties' => [
'Message' => ['title' => 'Id of the request', 'description' => '错误信息。', 'type' => 'string', 'example' => 'success'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'E0845DE6-52AF-4B50-9F15-51ED4044E6AB'],
'Code' => ['description' => '错误码。'."\n"
."\n"
.'- 0:成功。'."\n"
.'- 非0:失败。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'BadRequest', 'errorMessage' => 'The request has invalid parameters.', 'description' => ''],
['errorCode' => 'InstanceStatusError', 'errorMessage' => 'Your instance is unavailable.', 'description' => ''],
['errorCode' => 'InvalidInstance', 'errorMessage' => 'The specified instance name is invalid.', 'description' => '实例名错误'],
['errorCode' => 'NoCaretSeperator', 'errorMessage' => 'The body content is missing the ^ separator.', 'description' => '请求body缺少特定符号'],
['errorCode' => 'EmptyMeta', 'errorMessage' => 'The body content has an empty meta field.', 'description' => '请求body含有空的字段'],
['errorCode' => 'InvalidMetaItem', 'errorMessage' => 'The meta field is invalid.', 'description' => '无效的元信息字段'],
['errorCode' => 'NoPicList', 'errorMessage' => 'The body content is missing the pic_list parameter.', 'description' => '未指定pic_list字段'],
['errorCode' => 'InvalidPicList', 'errorMessage' => 'The specified pic_list parameter is invalid.', 'description' => '无效的pic_list字段'],
['errorCode' => 'NoSpecifiedPic', 'errorMessage' => 'The content of an image is not specified in the HTTP POST body.', 'description' => '图片未指定'],
['errorCode' => 'NoSpecifiedSearchPic', 'errorMessage' => 'The search image is not specified.', 'description' => ''],
['errorCode' => 'InvalidCategory', 'errorMessage' => 'The specified category is invalid.', 'description' => '无效的类目id'],
['errorCode' => 'OverflowMaxResultNum', 'errorMessage' => 'The specified number of total results exceeds the maximum of 500.', 'description' => '超过了最大的返回结果限制数500'],
['errorCode' => 'OverflowMaxReturnNum', 'errorMessage' => 'The specified number of results for each request exceeds the maximum of 100.', 'description' => '单次返回数超过限制值100'],
['errorCode' => 'InvalidStartParameter', 'errorMessage' => 'The specified parameter s is inavlid.', 'description' => ''],
['errorCode' => 'InvalidNumParameter', 'errorMessage' => 'The specified parameter n is invalid.', 'description' => ''],
['errorCode' => 'NoSpecifiedAddPic', 'errorMessage' => 'The image to insert is not specified.', 'description' => ''],
['errorCode' => 'NoSpecifiedItemId', 'errorMessage' => 'The item_id parameter is not specified.', 'description' => ''],
['errorCode' => 'InvalidIntAttr', 'errorMessage' => 'The specified int_attr field is invalid.', 'description' => '无效的int过滤字段'],
['errorCode' => 'UnsupportedPicFormat', 'errorMessage' => 'The specified image format is invalid.', 'description' => '无效的图片格式'],
['errorCode' => 'InvalidFilterClause', 'errorMessage' => 'The specified filtering condition is invalid.', 'description' => '无效的过滤条件'],
['errorCode' => 'InstanceOverQuota', 'errorMessage' => 'The number of items exceeds the limit.', 'description' => '实例的图片数量超过限制值'],
['errorCode' => 'IncorrectOrientation', 'errorMessage' => 'The image contains incorrect rotation flags in the meta data.', 'description' => '图片包含不支持的旋转参数'],
['errorCode' => 'UnsupportedPicPixels', 'errorMessage' => 'The specified pixels is not supported.', 'description' => '图片像素值不支持'],
['errorCode' => 'SearchTimeout', 'errorMessage' => 'The request is timed out.', 'description' => ''],
['errorCode' => 'PicNotExist', 'errorMessage' => 'The search picture does not exist.', 'description' => ''],
['errorCode' => 'NoSpecifiedProductId', 'errorMessage' => 'The parameter ProductId no specified.', 'description' => ''],
['errorCode' => 'NoSpecifiedPicName', 'errorMessage' => 'The parameter PicName no specified.', 'description' => ''],
['errorCode' => 'NoSpecifiedPicContent', 'errorMessage' => 'The parameter PicContent no specified.', 'description' => ''],
['errorCode' => 'InvalidType', 'errorMessage' => 'The specified parameter Type is not valid.', 'description' => ''],
['errorCode' => 'InvalidProductId', 'errorMessage' => 'The specified parameter ProductId is not valid.', 'description' => ''],
['errorCode' => 'InvalidPicName', 'errorMessage' => 'The specified parameter PicName is not valid.', 'description' => ''],
['errorCode' => 'InvalidStrAttr', 'errorMessage' => 'The specified parameter StrAttr is not valid.', 'description' => '无效StrAttr'],
['errorCode' => 'InvalidCustomContent', 'errorMessage' => 'The specified parameter CustomContent is not valid.', 'description' => ''],
['errorCode' => 'InvalidPicContent', 'errorMessage' => 'The specified parameter PicContent length greater than 4 * 1024 * 1024.', 'description' => ''],
['errorCode' => 'TimeoutForTransferImage', 'errorMessage' => 'Timeout after 5 seconds waiting for images transfer to complete.', 'description' => ''],
['errorCode' => 'InvalidIntAttr4', 'errorMessage' => 'The specified parameter IntAttr4 is not valid.', 'description' => '无效IntAttr4'],
['errorCode' => 'InvalidIntAttr3', 'errorMessage' => 'The specified parameter IntAttr3 is not valid.', 'description' => '无效IntAttr3'],
['errorCode' => 'InvalidIntAttr2', 'errorMessage' => 'The specified parameter IntAttr2 is not valid.', 'description' => '无效IntAttr2'],
['errorCode' => 'InvalidStrAttr4', 'errorMessage' => 'The specified parameter StrAttr4 is not valid.', 'description' => '无效StrAttr4'],
['errorCode' => 'InvalidStrAttr3', 'errorMessage' => 'The specified parameter StrAttr3 is not valid.', 'description' => '无效StrAttr3'],
['errorCode' => 'InvalidStrAttr2', 'errorMessage' => 'The specified parameter StrAttr2 is not valid.', 'description' => '无效StrAttr2'],
['errorCode' => 'UnsupportedInstanceType', 'errorMessage' => 'The instance type is not supported.', 'description' => '内部错误:不支持的实例类型'],
['errorCode' => 'UnsupportedOperationType', 'errorMessage' => 'The specified action is not supported.', 'description' => '内部错误:不支持的action'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation.', 'description' => '未授权的行为'],
['errorCode' => 'DeniedRequest', 'errorMessage' => 'Your request was denied due to instance flow control.', 'description' => '请求被限流'],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'An internal server error occurred.', 'description' => ''],
['errorCode' => 'NetworkException', 'errorMessage' => 'A network error occurred.', 'description' => '内部错误:请求网络异常'],
['errorCode' => 'RequestTimeout', 'errorMessage' => 'The request is timeout.', 'description' => ''],
['errorCode' => 'ExtractFeatureTimeout', 'errorMessage' => 'The request was timed out while extracting features.', 'description' => ''],
['errorCode' => 'AccessEngineFailed', 'errorMessage' => 'An error occurred while accessing the search engine.', 'description' => ''],
['errorCode' => 'InternalOssError', 'errorMessage' => 'An internal OAS error occurred.', 'description' => '内部错误:请求内部算法错误'],
['errorCode' => 'InternalSwiftError', 'errorMessage' => 'An internal SWIFT error occurred.', 'description' => '内部错误:请求内部消息队列错误'],
['errorCode' => 'InternalTableStoreError', 'errorMessage' => 'An internal Table Store error occurred.', 'description' => '内部错误:请求特征存储错误'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"E0845DE6-52AF-4B50-9F15-51ED4044E6AB\\",\\n \\"Code\\": 0,\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
'title' => '修改图片',
'description' => '## 使用说明'."\n"
.'本接口用于向图像搜索实例中根据商品ID和图片名称去修改图片信息。'."\n"
.'> - 实例有创建时间要求。'."\n"
.'<props="china">'."\n"
.'- 上海、杭州区域2021年6月份后创建的实例可用。其他区域正常使用。'."\n"
.'</props>'."\n"
.'<props="intl">'."\n"
.'- 新加坡区域2021年12月份后创建的实例可用。其他区域暂不可用。'."\n"
.'</props>'."\n"
.'- 如需了解更多产品详情和获取技术支持,请单击[在线咨询](https://www.aliyun.com/core/online-consult?from=aZgW6LJHr2)或通过钉钉群(35035130)联系我们。'."\n"
."\n\n"
.'## QPS限制'."\n"
.'修改操作默认的并发量为20,也就是每秒钟最多处理20个请求。'."\n"
."\n\n",
'extraInfo' => '## 错误码'."\n"
.'请参见[错误码](~~66619~~)。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateImage'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'imagesearch:UpdateImage',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ImageSearch', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
],
'endpoints' => [
['regionId' => 'ap-northeast-1', 'regionName' => '日本(东京)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'imagesearch.ap-northeast-1.aliyuncs.com', 'endpoint' => 'imagesearch.ap-northeast-1.aliyuncs.com', 'vpc' => 'imagesearch-vpc.ap-northeast-1.aliyuncs.com'],
['regionId' => 'ap-southeast-1', 'regionName' => '新加坡', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'imagesearch.ap-southeast-1.aliyuncs.com', 'endpoint' => 'imagesearch.ap-southeast-1.aliyuncs.com', 'vpc' => 'imagesearch-vpc.ap-southeast-1.aliyuncs.com'],
['regionId' => 'ap-southeast-2', 'regionName' => '澳大利亚(悉尼)已关停', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'imagesearch.ap-southeast-2.aliyuncs.com', 'endpoint' => 'imagesearch.ap-southeast-2.aliyuncs.com', 'vpc' => 'imagesearch-vpc.ap-southeast-2.aliyuncs.com'],
['regionId' => 'cn-beijing', 'regionName' => '华北2(北京)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'imagesearch.cn-beijing.aliyuncs.com', 'endpoint' => 'imagesearch.cn-beijing.aliyuncs.com', 'vpc' => 'imagesearch-vpc.cn-beijing.aliyuncs.com'],
['regionId' => 'cn-hangzhou', 'regionName' => '华东1(杭州)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'imagesearch.cn-hangzhou.aliyuncs.com', 'endpoint' => 'imagesearch.cn-hangzhou.aliyuncs.com', 'vpc' => 'imagesearch-vpc.cn-hangzhou.aliyuncs.com'],
['regionId' => 'cn-hongkong', 'regionName' => '中国香港', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'imagesearch.cn-hongkong.aliyuncs.com', 'endpoint' => 'imagesearch.cn-hongkong.aliyuncs.com', 'vpc' => 'imagesearch-vpc.cn-hongkong.aliyuncs.com'],
['regionId' => 'cn-shanghai', 'regionName' => '华东2(上海)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'imagesearch.cn-shanghai.aliyuncs.com', 'endpoint' => 'imagesearch.cn-shanghai.aliyuncs.com', 'vpc' => 'imagesearch-vpc.cn-shanghai.aliyuncs.com'],
['regionId' => 'cn-shenzhen', 'regionName' => '华南1(深圳)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'imagesearch.cn-shenzhen.aliyuncs.com', 'endpoint' => 'imagesearch.cn-shenzhen.aliyuncs.com', 'vpc' => 'imagesearch-vpc.cn-shenzhen.aliyuncs.com'],
['regionId' => 'eu-central-1', 'regionName' => '德国(法兰克福)', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'imagesearch.eu-central-1.aliyuncs.com', 'endpoint' => 'imagesearch.eu-central-1.aliyuncs.com', 'vpc' => 'imagesearch-vpc.eu-central-1.aliyuncs.com'],
['regionId' => 'ap-south-1', 'regionName' => '印度(孟买)已关停', 'areaId' => 'middleEast', 'areaName' => '中东', 'public' => 'imagesearch.ap-south-1.aliyuncs.com', 'endpoint' => 'imagesearch.ap-south-1.aliyuncs.com', 'vpc' => 'imagesearch-vpc.ap-south-1.aliyuncs.com'],
],
'errorCodes' => [
['code' => 'AccessEngineFailed', 'message' => 'An error occurred while accessing the search engine.', 'http_code' => 400, 'description' => '内部错误:请求引擎失败'],
['code' => 'ConnectionDVException', 'message' => 'Failed to obtain collection.', 'http_code' => 500, 'description' => 'internalError'],
['code' => 'Console.BadRequest', 'message' => 'The request has invalid parameters.', 'http_code' => 400, 'description' => '非法请求,请检查请求参数。'],
['code' => 'Console.CallServiceError', 'message' => 'An internal service error occurred.', 'http_code' => 500, 'description' => '访问内部服务错误'],
['code' => 'Console.InstanceNotFound', 'message' => 'The specified ImageSearch instance is not found.', 'http_code' => 400, 'description' => '查找不到实例,检查购买的实例ID是否正确。'],
['code' => 'Console.InstanceStatusError', 'message' => 'The current instance status does not support this operation.', 'http_code' => 409, 'description' => '实例状态错误,请检查实例状态'],
['code' => 'Console.InternalError', 'message' => 'The request processing has failed due to some unknown error.', 'http_code' => 500, 'description' => '服务器内部错误,请登录阿里云控制台提交工单。'],
['code' => 'Console.LoginError', 'message' => 'Check login failed.', 'http_code' => 401, 'description' => '登录失败,请检查用户名、密码、邮箱是否输入有误。'],
['code' => 'Console.MigrateCapacityError', 'message' => 'Migration instance specification error.', 'http_code' => 400, 'description' => '迁移的目标实例规格错误,目标实例规格必须大于等于源实例规格'],
['code' => 'Console.MigrateDocNumError', 'message' => 'Migration target instance doc quantity error.', 'http_code' => 400, 'description' => '目标实例的doc数量必须为0'],
['code' => 'Console.MigrateError', 'message' => 'An instance can only have one migration task.', 'http_code' => 400, 'description' => '实例只能存在一个迁移任务'],
['code' => 'Console.MigrateExistError', 'message' => 'Only one migration task can exist in an instance.', 'http_code' => 400, 'description' => '当前实例下只能存在一个迁移任务。'],
['code' => 'Console.MigrateTypeError', 'message' => 'Migration instance type error.', 'http_code' => 400, 'description' => '迁移的两个实例类型必须相同'],
['code' => 'Console.ModifyTokenTimesExceed', 'message' => 'You can only modify the token once every day.', 'http_code' => 400, 'description' => '用户当天的修改次数不能超过1次'],
['code' => 'Console.NoPermissionError', 'message' => 'You are not authorized to perform this operation.', 'http_code' => 403, 'description' => '你没有权限进行该操作'],
['code' => 'Console.NotAllowedModifyToken', 'message' => 'You are not allowed to modify token today.', 'http_code' => 403, 'description' => '今天不允许用户修改该token值'],
['code' => 'Console.OrderStatusError', 'message' => 'Current Order status not supported this opreate.', 'http_code' => 409, 'description' => '用户订单错误,请确认订单处于有效状态'],
['code' => 'Console.PidDescError', 'message' => 'The maximum character length of this PidDesc parameter is 32.', 'http_code' => 400, 'description' => 'PidDesc 这个字符串长度最长32位'],
['code' => 'Console.PidError', 'message' => 'The number of PID bindings of the current instance exceeds 50.', 'http_code' => 400, 'description' => '当前实例PID绑定数量超过50'],
['code' => 'Console.TaskAlreadyExist', 'message' => 'A task that is in progress already exists.', 'http_code' => 409, 'description' => '已经存在正在运行的任务。'],
['code' => 'DeniedRequest', 'message' => 'Your request was denied due to instance flow control.', 'http_code' => 403, 'description' => '请求被限流'],
['code' => 'EmptyMeta', 'message' => 'The body content has an empty meta field.', 'http_code' => 400, 'description' => '请求body含有空的字段'],
['code' => 'ExtractFeatureTimeout', 'message' => 'The request timed out while extracting features.', 'http_code' => 500, 'description' => '内部错误:提取特征超时'],
['code' => 'IncorrectOrientation', 'message' => 'The image contains incorrect rotation flags in the meta data.', 'http_code' => 400, 'description' => '图片包含不支持的旋转参数'],
['code' => 'InstanceOverQuota', 'message' => 'The number of items exceeds the limit.', 'http_code' => 400, 'description' => '实例的图片数量超过限制值'],
['code' => 'InstanceStatusError', 'message' => 'The current instance status does not support this operation.', 'http_code' => 400, 'description' => '实例状态不可用'],
['code' => 'InternalOssError', 'message' => 'An internal OAS error occurred.', 'http_code' => 500, 'description' => '内部错误:请求内部算法错误'],
['code' => 'InternalSwiftError', 'message' => 'An internal SWIFT error occurred.', 'http_code' => 500, 'description' => '内部错误:请求内部消息队列错误'],
['code' => 'InternalTableStoreError', 'message' => 'An internal Table Store error occurred.', 'http_code' => 500, 'description' => '内部错误:请求特征存储错误'],
['code' => 'InvalidCategory', 'message' => 'The specified category is invalid.', 'http_code' => 400, 'description' => '无效的类目id'],
['code' => 'InvalidCategoryId', 'message' => 'The specified CategoryId parameter is invalid.', 'http_code' => 400, 'description' => '无效CategoryId'],
['code' => 'InvalidCrop', 'message' => 'The specified Crop parameter is invalid.', 'http_code' => 400, 'description' => '无效Crop'],
['code' => 'InvalidCustomContent', 'message' => 'The specified CustomContent is invalid.', 'http_code' => 400, 'description' => '无效的自定义内容'],
['code' => 'InvalidFilterClause', 'message' => 'The specified filtering condition is invalid.', 'http_code' => 400, 'description' => '无效的过滤条件'],
['code' => 'InvalidInstance', 'message' => 'The specified instance name is invalid.', 'http_code' => 400, 'description' => '实例名错误'],
['code' => 'InvalidIntAttr', 'message' => 'The specified int_attr field is invalid.', 'http_code' => 400, 'description' => '无效的int过滤字段'],
['code' => 'InvalidIntAttr', 'message' => 'The specified parameter IntAttr is not valid.', 'http_code' => 400, 'description' => '无效IntAttr'],
['code' => 'InvalidIntAttr2', 'message' => 'The specified parameter IntAttr2 is not valid.', 'http_code' => 400, 'description' => '无效IntAttr2'],
['code' => 'InvalidIntAttr3', 'message' => 'The specified parameter IntAttr3 is not valid.', 'http_code' => 400, 'description' => '无效IntAttr3'],
['code' => 'InvalidIntAttr4', 'message' => 'The specified parameter IntAttr4 is not valid.', 'http_code' => 400, 'description' => '无效IntAttr4'],
['code' => 'InvalidMetaItem', 'message' => 'The meta field is invalid.', 'http_code' => 400, 'description' => '无效的元信息字段'],
['code' => 'InvalidNum', 'message' => 'The specified Num parameter is invalid.', 'http_code' => 400, 'description' => '无效num'],
['code' => 'InvalidNumParameter', 'message' => 'The specified parameter num is invalid.', 'http_code' => 400, 'description' => '无效的字段num'],
['code' => 'InvalidParameterReturnPicFormat', 'message' => 'The specified parameter returnPicFormat is invalid', 'http_code' => 400, 'description' => '入参ReturnPicFormat错误,仅支持png或jpg'],
['code' => 'InvalidParameterReturnPicType', 'message' => 'The specified parameter returnPicType is invalid', 'http_code' => 400, 'description' => '入参ReturnPicType错误,仅支持score_image或white_bk'],
['code' => 'InvalidParameterTitleIndex', 'message' => 'The specified parameter titleIndex is invalid.', 'http_code' => 400, 'description' => '无效的titleIndex参数,仅支持1,2,3.'],
['code' => 'InvalidPicContent', 'message' => 'The image size exceeds 4 MB.', 'http_code' => 400, 'description' => '图片大小超过4M'],
['code' => 'InvalidPicList', 'message' => 'The specified pic_list parameter is invalid.', 'http_code' => 400, 'description' => '无效的pic_list字段'],
['code' => 'InvalidPicName', 'message' => 'The specified PicName is invalid.', 'http_code' => 400, 'description' => '无效的图片名称'],
['code' => 'InvalidPicUrl', 'message' => 'The specified parameter PicUrl is not valid.', 'http_code' => 400, 'description' => '无效的PicUrl参数'],
['code' => 'InvalidPrimaryPicContent', 'message' => 'The specified parameter PrimaryPicContent is not valid.', 'http_code' => 400, 'description' => '无效的PrimaryPicContent参数'],
['code' => 'InvalidProductId', 'message' => 'The specified ProductId is invalid.', 'http_code' => 400, 'description' => '无效的商品id'],
['code' => 'InvalidProductId', 'message' => 'The parameter ProductId no specified.', 'http_code' => 400, 'description' => 'ProductId无效'],
['code' => 'InvalidSecondaryPicContent', 'message' => 'The specified parameter SecondaryPicContent is not valid.', 'http_code' => 400, 'description' => '无效的SecondaryPicContent参数'],
['code' => 'InvalidStart', 'message' => 'The specified Start parameter is invalid.', 'http_code' => 400, 'description' => '无效Start'],
['code' => 'InvalidStartParameter', 'message' => 'The specified parameter start is invalid.', 'http_code' => 400, 'description' => '无效的字段start'],
['code' => 'InvalidStrAttr', 'message' => 'The specified StrAttr is invalid.', 'http_code' => 400, 'description' => '无效的过滤值'],
['code' => 'InvalidStrAttr', 'message' => 'The specified parameter StrAttr is not valid.', 'http_code' => 400, 'description' => '无效StrAttr'],
['code' => 'InvalidStrAttr2', 'message' => 'The specified parameter StrAttr2 is not valid.', 'http_code' => 400, 'description' => '无效StrAttr2'],
['code' => 'InvalidStrAttr3', 'message' => 'The specified parameter StrAttr3 is not valid.', 'http_code' => 400, 'description' => '无效StrAttr3'],
['code' => 'InvalidStrAttr4', 'message' => 'The specified parameter StrAttr4 is not valid.', 'http_code' => 400, 'description' => '无效StrAttr4'],
['code' => 'InvalidText', 'message' => 'The specified parameter Text is not valid.', 'http_code' => 400, 'description' => '描述信息Text不能为null'],
['code' => 'InvalidTextLength', 'message' => 'Invalid text clause.', 'http_code' => 400, 'description' => 'text字段长度必须在512内。'],
['code' => 'InvalidType', 'message' => 'The specified Type is invalid.', 'http_code' => 400, 'description' => '不支持的参数类型'],
['code' => 'InvalidUserType', 'message' => 'The specified UserType parameter is invalid.', 'http_code' => 400, 'description' => '无效UserType'],
['code' => 'NeedRegisterBeforeInvoke', 'message' => 'Register for PID before invoking the service.', 'http_code' => 400, 'description' => '调用前需要先注册pid'],
['code' => 'NetworkException', 'message' => 'A network error occurred.', 'http_code' => 500, 'description' => '内部错误:请求网络异常'],
['code' => 'NoCaretSeperator', 'message' => 'The body content is missing the ^ separator.', 'http_code' => 400, 'description' => '请求body缺少特定符号'],
['code' => 'NoPermission', 'message' => 'You are not authorized to perform this operation.', 'http_code' => 403, 'description' => '未授权的行为'],
['code' => 'NoPicList', 'message' => 'The body content is missing the pic_list parameter.', 'http_code' => 400, 'description' => '未指定pic_list字段'],
['code' => 'NoSpecifiedAddPic', 'message' => 'You must specify an image.', 'http_code' => 400, 'description' => '未指定图片'],
['code' => 'NoSpecifiedItemId', 'message' => 'You must specify item_id.', 'http_code' => 400, 'description' => '未指定商品id'],
['code' => 'NoSpecifiedPic', 'message' => 'The content of an image is not specified in the HTTP POST body.', 'http_code' => 400, 'description' => '图片未指定'],
['code' => 'NoSpecifiedPicContent', 'message' => 'You must specify PicContent.', 'http_code' => 400, 'description' => '未指定图片内容'],
['code' => 'NoSpecifiedPicName', 'message' => 'You must specify PicName.', 'http_code' => 400, 'description' => '未指定图片名称'],
['code' => 'NoSpecifiedProductId', 'message' => 'You must specify ProductId.', 'http_code' => 400, 'description' => '未指定商品id'],
['code' => 'NoSpecifiedSearchPic', 'message' => 'You must specify a search image.', 'http_code' => 400, 'description' => '图片未指定'],
['code' => 'OverflowMaxResultNum', 'message' => 'The specified number of total results exceeds the maximum of 500.', 'http_code' => 400, 'description' => '超过了最大的返回结果限制数500'],
['code' => 'OverflowMaxReturnNum', 'message' => 'The specified number of results for each request exceeds the maximum of 100.', 'http_code' => 400, 'description' => '单次返回数超过限制值100'],
['code' => 'PicNotExist', 'message' => 'The specified image does not exist.', 'http_code' => 400, 'description' => '图片未指定'],
['code' => 'PictureError', 'message' => '[download] Img Download Failed.', 'http_code' => 500, 'description' => '图片下载失败,请检查图片'],
['code' => 'PidNotExist', 'message' => 'The specified Pid parameter does not exist.', 'http_code' => 400, 'description' => 'Pid不存在'],
['code' => 'RequestTimeout', 'message' => 'The request timed out.', 'http_code' => 500, 'description' => '内部错误:请求超时'],
['code' => 'SearchTimeout', 'message' => 'The request timed out.', 'http_code' => 400, 'description' => '请求超时'],
['code' => 'ServerInternalError', 'message' => 'An internal error occurred.', 'http_code' => 500, 'description' => '系统内部错误'],
['code' => 'TimeoutForTransferImage', 'message' => 'Image transfer timed out.', 'http_code' => 400, 'description' => '客户端图片传输超时'],
['code' => 'UnknownException', 'message' => 'An internal server error occurred.', 'http_code' => 500, 'description' => '未知异常'],
['code' => 'UnsupportedInstanceType', 'message' => 'The instance type is not supported.', 'http_code' => 500, 'description' => '内部错误:不支持的实例类型'],
['code' => 'UnsupportedOperationType', 'message' => 'The specified action is not supported.', 'http_code' => 500, 'description' => '内部错误:不支持的action'],
['code' => 'UnsupportedPicCategory', 'message' => 'The picture category is not supported.', 'http_code' => 400, 'description' => '图片对应的类目不支持,目前仅支持鞋子和衣服'],
['code' => 'UnsupportedPicFormat', 'message' => 'The specified image format is invalid.', 'http_code' => 400, 'description' => '无效的图片格式'],
['code' => 'UnsupportedPicPixels', 'message' => 'The specified pixels is not supported.', 'http_code' => 400, 'description' => '图片像素值不支持'],
['code' => 'UnsupportedPictureFormat', 'message' => 'The format of the specified picture is not supported.', 'http_code' => 400, 'description' => '用户图片格式不支持'],
['code' => 'UnsupportedInstanceType', 'message' => 'The instance type is not supported.', 'http_code' => 400, 'description' => '内部错误:不支持的实例类型'],
['code' => 'UnsupportedOperationType', 'message' => 'The specified action is not supported.', 'http_code' => 400, 'description' => '内部错误:不支持的action'],
['code' => 'PictureError', 'message' => '[download] Img Download Failed.', 'http_code' => 400, 'description' => '图片下载失败,请检查图片'],
['code' => 'Console.OssError', 'message' => 'OSS information error.', 'http_code' => 400, 'description' => 'oss 信息错误'],
],
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateImage'],
['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteImage'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SearchImageByPic'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SearchImageByName'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddImage'],
],
],
'ram' => [
'productCode' => 'ImageSearch',
'productName' => '图像搜索',
'ramCodes' => ['imagesearch'],
'ramLevel' => '资源级',
'ramConditions' => [],
'ramActions' => [
[
'apiName' => 'SearchImageByPic',
'description' => '根据图片查询图片',
'operationType' => 'get',
'ramAction' => [
'action' => 'imagesearch:SearchImageByPic',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ImageSearch', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DumpMetaList',
'description' => '查询元信息导出任务',
'operationType' => '',
'ramAction' => [
'action' => 'imagesearch:DumpMetaList',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ImageSearch', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'SearchImageByText',
'description' => '根据文本查询图片',
'operationType' => 'get',
'ramAction' => [
'action' => 'imagesearch:SearchImageByText',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ImageSearch', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'AddImage',
'description' => '新增图片',
'operationType' => 'create',
'ramAction' => [
'action' => 'imagesearch:AddImage',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ImageSearch', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'SearchImageByName',
'description' => '根据名称查询图片',
'operationType' => 'get',
'ramAction' => [
'action' => 'imagesearch:SearchImageByName',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ImageSearch', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'SearchImageByFilter',
'description' => '根据过滤条件查询图片',
'operationType' => 'get',
'ramAction' => [
'action' => 'imagesearch:SearchImageByFilter',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ImageSearch', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DumpMeta',
'description' => '元数据导出',
'operationType' => '',
'ramAction' => [
'action' => 'imagesearch:DumpMeta',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ImageSearch', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'UpdateImage',
'description' => '修改图片',
'operationType' => 'update',
'ramAction' => [
'action' => 'imagesearch:UpdateImage',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ImageSearch', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteImage',
'description' => '删除图片',
'operationType' => 'delete',
'ramAction' => [
'action' => 'imagesearch:DeleteImage',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ImageSearch', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CheckImageExists',
'description' => '检查图片',
'operationType' => 'get',
'ramAction' => [
'action' => 'imagesearch:CheckImageExists',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ImageSearch', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'IncreaseInstance',
'description' => '批量操作',
'operationType' => '',
'ramAction' => [
'action' => 'imagesearch:IncreaseInstance',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ImageSearch', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'Detail',
'description' => '查询实例状态',
'operationType' => '',
'ramAction' => [
'action' => 'imagesearch:Detail',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ImageSearch', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'IncreaseList',
'description' => '查询批量任务',
'operationType' => '',
'ramAction' => [
'action' => 'imagesearch:IncreaseList',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ImageSearch', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CompareSimilarByImage',
'description' => '相似度比较',
'operationType' => 'none',
'ramAction' => [
'action' => 'imagesearch:CompareSimilarByImage',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ImageSearch', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'resourceTypes' => [],
],
];
|