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
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
|
<?php return [
'version' => '1.0',
'info' => ['style' => 'ROA', 'product' => 'PAILangStudio', 'version' => '2024-07-10'],
'directories' => [
[
'children' => ['CreateRuntime', 'UpdateRuntime', 'GetRuntime', 'ListRuntimes', 'DeleteRuntime'],
'type' => 'directory',
'title' => 'Runtime',
],
[
'children' => ['UpdateDeployment', 'DeleteDeployment'],
'type' => 'directory',
'title' => 'Deployment tasks',
],
[
'children' => ['GetSnapshot', 'UpdateSnapshot', 'ListSnapshots'],
'type' => 'directory',
'title' => 'Snapshot management',
],
[
'children' => ['RetrieveKnowledgeBase', 'CreateKnowledgeBaseJob', 'GetKnowledgeBaseJob', 'UpdateKnowledgeBaseJob', 'DeleteKnowledgeBaseJob', 'ListKnowledgeBaseJobs', 'UpdateKnowledgeBaseChunk', 'ListKnowledgeBaseChunks'],
'type' => 'directory',
'title' => 'Knowledge base',
],
[
'children' => ['CreateDeployment', 'CreateKnowledgeBase', 'CreateSnapshot', 'DeleteKnowledgeBase', 'DeleteSnapshot', 'GetDeployment', 'GetKnowledgeBase', 'ListDeployments', 'ListKnowledgeBases', 'UpdateKnowledgeBase'],
'title' => 'Others',
'type' => 'directory',
],
],
'components' => [
'schemas' => [
'Connection' => [
'type' => 'object',
'properties' => [
'WorkspaceId' => ['type' => 'string'],
'Accessibility' => ['type' => 'string'],
'ConnectionId' => ['type' => 'string'],
'ConnectionType' => ['type' => 'string'],
'ConnectionName' => ['type' => 'string'],
'CustomType' => ['type' => 'string'],
'Description' => ['type' => 'string'],
'Configs' => [
'type' => 'object',
'additionalProperties' => ['type' => 'string'],
],
'Secrets' => [
'type' => 'object',
'additionalProperties' => ['type' => 'string'],
],
'GmtCreateTime' => ['type' => 'string'],
'GmtModifiedTime' => ['type' => 'string'],
'Creator' => ['type' => 'string'],
'ResourceMeta' => [
'type' => 'object',
'properties' => [
'InstanceName' => ['title' => '资源实例名称', 'description' => '资源实例名称', 'type' => 'string'],
'InstanceId' => ['title' => '资源实例ID', 'description' => '资源实例ID', 'type' => 'string'],
],
],
'Models' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Model' => ['title' => '模型名', 'description' => '模型名', 'type' => 'string'],
'ModelType' => ['title' => '模型类型', 'description' => '模型类型', 'type' => 'string'],
'DisplayName' => ['title' => '模型展示名称', 'description' => '模型展示名称', 'type' => 'string'],
'ToolCall' => ['title' => '是否支持ToolCall', 'description' => '是否支持ToolCall', 'type' => 'boolean'],
'SupportVision' => ['title' => '是否支持Vision', 'description' => '是否支持Vision', 'type' => 'boolean'],
'SupportReasoning' => ['title' => '是否支持Reasoning', 'description' => '是否支持Reasoning', 'type' => 'boolean'],
'SupportResponseSchema' => ['title' => '是否支持输出Schema', 'description' => '是否支持输出Schema', 'type' => 'boolean'],
'MaxModelLength' => ['title' => '最大上下文长度', 'description' => '最大上下文长度', 'type' => 'integer', 'format' => 'int32'],
],
],
],
],
],
'Deployment' => [
'description' => 'Deployment job details.',
'type' => 'object',
'properties' => [
'WorkspaceId' => ['description' => 'The workspace ID. For information about how to obtain a workspace ID, see [ListWorkspaces](~~449124~~).', 'type' => 'string', 'example' => '478***', 'title' => ''],
'Accessibility' => ['description' => 'Workspace visibility. Valid values:'."\n"
.'- PRIVATE: In this workspace, the resource is visible only to you and administrators.'."\n"
.'- PUBLIC: In this workspace, the resource is visible to all users.', 'type' => 'string', 'example' => 'PRIVATE', 'title' => ''],
'Creator' => ['description' => 'The creator ID.', 'type' => 'string', 'example' => '2680******4103', 'title' => ''],
'GmtCreateTime' => ['description' => 'Creation time.', 'type' => 'string', 'example' => '2025-09-24T07:33:53Z', 'title' => ''],
'GmtModifiedTime' => ['description' => 'Updated At.', 'type' => 'string', 'example' => '2025-09-24T08:58:35Z', 'title' => ''],
'DeploymentId' => ['description' => 'The ID of the deployment job.', 'type' => 'string', 'example' => 'dploy-asdf******1234', 'title' => ''],
'DeploymentStatus' => ['description' => 'Task status of the deployment. Valid values:'."\n"
.'* Creating: Creating.'."\n"
.'* Failed: Deployment failed.'."\n"
.'* Stopping: Stopping.'."\n"
.'* Waiting: Waiting.'."\n"
.'* Starting: Starting.'."\n"
.'* Running: Running.'."\n"
.'* Pending: Pending.'."\n"
.'* WaitForConfirm: Waiting for confirmation.'."\n"
.'* Canceled: Canceled.'."\n"
.'* Succeed: Succeeded.', 'type' => 'string', 'example' => 'Running', 'title' => ''],
'OperationType' => ['description' => 'Operation type. Valid values:'."\n"
.'* Create: Create a new service.'."\n"
.'* Update: Update an existing service.', 'type' => 'string', 'example' => 'Create', 'title' => ''],
'ResourceType' => ['description' => 'The type of resource to deploy. Valid values:'."\n"
.'* Flow: A workflow project'."\n"
.'* Code: A code-based project', 'type' => 'string', 'example' => 'Flow', 'title' => ''],
'ResourceId' => ['description' => 'Resource ID to be deployed.', 'type' => 'string', 'example' => 'flow-asdf******123', 'title' => ''],
'ResourceSnapshotId' => ['description' => 'Snapshot ID of the resource to be deployed. If this parameter is provided, the system deploys directly based on this snapshot. If not provided, the system first creates a new snapshot of the resource and then performs the deployment.', 'type' => 'string', 'example' => 'snap-asfg******123', 'title' => ''],
'ServiceName' => ['description' => 'Service name.', 'type' => 'string', 'example' => 'myservice01', 'title' => ''],
'Description' => ['description' => 'Service description.', 'type' => 'string', 'example' => 'This is description', 'title' => ''],
'WorkDir' => ['description' => 'OSS working directory for the service. It stores operational logs, conversation history, and other data.', 'type' => 'string', 'example' => 'oss://mybucket.oss-cn-hangzhou-internal.aliyuncs.com/workdir/', 'title' => ''],
'EnableTrace' => ['description' => 'Specifies whether to enable Tracing Analysis.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'ChatHistoryConfig' => [
'description' => 'Chat history configuration.',
'type' => 'object',
'properties' => [
'StorageType' => [
'title' => '存储类型',
'description' => 'The storage method. Valid values:'."\n"
.'* LOCAL: Chat history is stored in a local SQLite file and does not support multi-instance deployment.'."\n"
.'* OSS: Chat history is stored in a specific path under the service OSS workspace path.'."\n"
.'* RDS: Chat history is stored in an RDS table, and an RDS connection must be specified.',
'type' => 'string',
'example' => 'RDS',
'readOnly' => true,
'enum' => ['LOCAL', 'RDS', 'OSS'],
],
'ConnectionName' => ['title' => '连接名称', 'description' => 'The connection name. This parameter is required when the chat history storage type is RDS.', 'type' => 'string', 'example' => 'myconnection', 'readOnly' => true],
],
'title' => '',
'example' => '',
],
'ContentModerationConfig' => [
'description' => 'Content moderation configuration.',
'type' => 'object',
'properties' => [
'EnableInputModeration' => ['title' => '启用输入内容审查', 'description' => 'Specifies whether to enable security review for input.', 'type' => 'boolean', 'example' => 'true', 'readOnly' => true],
'EnableOutputModeration' => ['title' => '启用输出内容审查', 'description' => 'Specifies whether to enable content moderation for output.', 'type' => 'boolean', 'example' => 'true', 'readOnly' => true],
'StreamingModerationThreshold' => ['title' => '流式输出内容送审缓存大小', 'description' => 'The cache size for streaming output content submitted for moderation. The default value is 5.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'readOnly' => true],
],
'title' => '',
'example' => '',
],
'DeploymentConfig' => ['description' => 'Deployment configuration. For details, see the [deployment configuration](https://help.aliyun.com/zh/pai/user-guide/parameters-of-model-services) in PAI-EAS.', 'type' => 'string', 'example' => '{\\"metadata\\":{\\"name\\":\\"langstudio_2026******3848_jro7\\",\\"instance\\":1,\\"workspace_id\\":\\"285***\\",\\"enable_webservice\\":false},\\"cloud\\":{\\"computing\\":{\\"instances\\":[{\\"type\\":\\"ecs.g7.xlarge\\"}]},\\"networking\\":{\\"vpc_id\\":\\"vpc-bp1obprt******4bzo00d\\",\\"vswitch_id\\":\\"vsw-bp1p6i36k******pmfhw8\\",\\"security_group_id\\":\\"sg-bp1djud4******zecl5a\\"}}}', 'title' => ''],
'DeploymentStages' => [
'description' => 'Stage information of the deployment.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Stage' => ['title' => '阶段', 'description' => 'Deployment stage.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'readOnly' => true],
'StageName' => ['title' => '阶段名称', 'description' => 'Name of the deployment stage.', 'type' => 'string', 'example' => 'PrepareSnapshot', 'readOnly' => true],
'Description' => ['title' => '描述', 'description' => 'Description of the deployment stage.', 'type' => 'string', 'example' => 'Create snapshot for deployment', 'readOnly' => true],
'GmtStartTime' => ['title' => '开始时间', 'description' => 'Start Time.', 'type' => 'string', 'example' => '2025-09-23T10:25:38Z', 'readOnly' => true],
'GmtEndTime' => ['title' => '结束时间', 'description' => 'End time.', 'type' => 'string', 'example' => '2025-09-19T10:34:01Z', 'readOnly' => true],
'StageStatus' => ['title' => '阶段状态', 'description' => 'Status of the deployment stage. Valid values:'."\n"
.'* NotStarted: Not started.'."\n"
.'* WaitForConfirm: Waiting for confirmation.'."\n"
.'* Waiting: Waiting.'."\n"
.'* Creating: Creating.'."\n"
.'* Running: Running.', 'type' => 'string', 'example' => 'Running', 'readOnly' => true],
'ErrorMessage' => ['title' => '错误信息', 'description' => 'Error message.', 'type' => 'string', 'example' => 'This is error', 'readOnly' => true],
'StageInfo' => ['title' => '阶段信息', 'description' => 'Information about the deployment stage.', 'type' => 'string', 'example' => '{\\"SnapshotId\\":\\"snap-i8j29k******b0hotn\\"}', 'readOnly' => true],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'ErrorMessage' => ['description' => 'Error message.', 'type' => 'string', 'example' => 'This is error message', 'title' => ''],
'AutoApproval' => ['description' => 'Specifies whether to automatically skip the deployment confirmation step.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
'title' => '',
'example' => '',
],
'Flow' => [
'type' => 'object',
'properties' => [
'WorkspaceId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'Accessibility' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'Description' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'FlowId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'FlowName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'FlowStoragePath' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'FlowType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'GmtCreateTime' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'GmtModifiedTime' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'WorkDir' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'Creator' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'CreateFrom' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'FlowTemplateId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'Runtime' => [
'type' => 'object',
'properties' => [
'RuntimeId' => ['title' => '运行时ID', 'description' => '运行时ID', 'type' => 'string', 'readOnly' => true, 'example' => ''],
'RuntimeName' => ['title' => '运行时名称', 'description' => '运行时名称', 'type' => 'string', 'readOnly' => true, 'example' => ''],
'RuntimeType' => ['title' => '运行时类型', 'description' => '运行时类型', 'type' => 'string', 'readOnly' => true, 'example' => ''],
'RuntimeStatus' => ['title' => '运行时状态', 'description' => '运行时状态', 'type' => 'string', 'readOnly' => true, 'example' => ''],
'SupportSSEStream' => ['title' => '是否支持SSE', 'description' => '是否支持SSE', 'type' => 'boolean', 'readOnly' => true, 'example' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'Version' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'RuntimeId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'SourceUri' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'CodeModeRunInfo' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'FlowRun' => [
'type' => 'object',
'properties' => [
'WorkspaceId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'Accessibility' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'FlowId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'FlowName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'FlowRunId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'RunStatus' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'RunMode' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'NodeName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'Variant' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'Exception' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'RunResult' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'GmtCreateTime' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'GmtModifiedTime' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'GmtStartTime' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'GmtFinishTime' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'Duration' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''],
'Creator' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'RunName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'EcsSpec' => [
'type' => 'object',
'properties' => [
'InstanceType' => ['title' => '实例类型', 'description' => '实例类型', 'type' => 'string', 'readOnly' => true, 'example' => ''],
'GPUType' => ['title' => 'GPU类型', 'description' => 'GPU类型', 'type' => 'string', 'readOnly' => true, 'example' => ''],
'CPU' => ['title' => 'CPU信息', 'description' => 'CPU信息', 'type' => 'integer', 'format' => 'int32', 'readOnly' => true, 'example' => ''],
'GPU' => ['title' => 'GPU信息', 'description' => 'GPU信息', 'type' => 'integer', 'format' => 'int32', 'readOnly' => true, 'example' => ''],
'Memory' => ['title' => '内存信息', 'description' => '内存信息', 'type' => 'integer', 'format' => 'int32', 'readOnly' => true, 'example' => ''],
'SharedMemory' => ['title' => '共享内存', 'description' => '共享内存', 'type' => 'integer', 'format' => 'int32', 'readOnly' => true, 'example' => ''],
'PodCount' => ['title' => 'Pod数量', 'description' => 'Pod数量', 'type' => 'integer', 'format' => 'int32', 'readOnly' => true, 'example' => ''],
'GPUMemory' => ['title' => 'GPU显存', 'description' => 'GPU显存', 'type' => 'integer', 'format' => 'int32', 'readOnly' => true, 'example' => ''],
'GPUCorePercentage' => ['title' => 'GPU算力占比', 'description' => 'GPU算力占比', 'type' => 'integer', 'format' => 'int32', 'readOnly' => true, 'example' => ''],
'ExtraEphemeralStorage' => ['title' => '额外系统盘', 'description' => '额外系统盘', 'type' => 'integer', 'format' => 'int32', 'readOnly' => true, 'example' => ''],
'QuotaId' => ['title' => '资源配额ID', 'description' => '资源配额ID', 'type' => 'string', 'readOnly' => true, 'example' => ''],
'QuotaType' => ['title' => '资源配额类型', 'description' => '资源配额类型', 'type' => 'string', 'readOnly' => true, 'example' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'ResourceId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'DataSources' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'DatasetId' => ['title' => '数据集ID', 'description' => '数据集ID', 'type' => 'string', 'readOnly' => true, 'example' => ''],
'Uri' => ['title' => '统一资源识别码', 'description' => '统一资源识别码', 'type' => 'string', 'readOnly' => true, 'example' => ''],
'MountPath' => ['title' => '挂载路径', 'description' => '挂载路径', 'type' => 'string', 'readOnly' => true, 'example' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'description' => '',
'title' => '',
'example' => '',
],
'DataColumnMapping' => [
'type' => 'object',
'additionalProperties' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'description' => '',
'title' => '',
'example' => '',
],
'EvaluationConfigs' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'FlowSource' => [
'title' => '应用流来源',
'description' => '应用流来源',
'type' => 'object',
'properties' => [
'Id' => ['title' => 'ID', 'description' => 'ID', 'type' => 'string', 'readOnly' => true, 'example' => ''],
'Type' => ['title' => '类型', 'description' => '类型', 'type' => 'string', 'readOnly' => true, 'example' => ''],
'Name' => ['title' => '名称', 'description' => '名称', 'type' => 'string', 'readOnly' => true, 'example' => ''],
],
'readOnly' => true,
'example' => '',
],
'DataColumnMapping' => [
'title' => '映射配置',
'description' => '映射配置',
'type' => 'object',
'additionalProperties' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'readOnly' => true,
'example' => '',
],
'InputsOverrideConfig' => ['title' => '输入配置', 'description' => '输入配置', 'type' => 'string', 'readOnly' => true, 'example' => ''],
'Name' => ['title' => '评测名称', 'description' => '评测名称', 'type' => 'string', 'readOnly' => true, 'example' => ''],
'Type' => ['title' => '评测类型', 'description' => '评测类型', 'type' => 'string', 'readOnly' => true, 'example' => ''],
'Inputs' => ['title' => '评测输入', 'description' => '评测输入', 'type' => 'string', 'readOnly' => true, 'example' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'description' => '',
'title' => '',
'example' => '',
],
'UserVpc' => [
'type' => 'object',
'properties' => [
'VpcId' => ['title' => 'VPC ID', 'description' => 'VPC ID', 'type' => 'string', 'readOnly' => true, 'example' => ''],
'VSwitchId' => ['title' => '交换机ID', 'description' => '交换机ID', 'type' => 'string', 'readOnly' => true, 'example' => ''],
'SecurityGroupId' => ['title' => '安全组ID', 'description' => '安全组ID', 'type' => 'string', 'readOnly' => true, 'example' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'Envs' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['title' => '环境键', 'description' => '环境键', 'type' => 'string', 'readOnly' => true, 'example' => ''],
'Value' => ['title' => '环境值', 'description' => '环境值', 'type' => 'string', 'readOnly' => true, 'example' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'description' => '',
'title' => '',
'example' => '',
],
'Labels' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['title' => '标签键', 'description' => '标签键', 'type' => 'string', 'readOnly' => true, 'example' => ''],
'Value' => ['title' => '标签值', 'description' => '标签值', 'type' => 'string', 'readOnly' => true, 'example' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'description' => '',
'title' => '',
'example' => '',
],
'CredentialConfig' => [
'type' => 'object',
'properties' => [
'EnableCredentialInject' => ['title' => '是否启用Credential注入', 'description' => '是否启用Credential注入', 'type' => 'boolean', 'readOnly' => true, 'example' => ''],
'AliyunEnvRoleKey' => ['title' => 'AliyunEnvRoleKey', 'description' => 'AliyunEnvRoleKey', 'type' => 'string', 'readOnly' => true, 'example' => ''],
'CredentialConfigItems' => [
'title' => 'Credential配置项列表',
'description' => 'Credential配置项列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['title' => 'Key', 'description' => 'Key', 'type' => 'string', 'readOnly' => true, 'example' => ''],
'Type' => ['title' => 'Type', 'description' => 'Type', 'type' => 'string', 'readOnly' => true, 'example' => ''],
'Roles' => [
'title' => '角色列表',
'description' => '角色列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'AssumeRoleFor' => ['title' => 'AssumeRoleFor', 'description' => 'AssumeRoleFor', 'type' => 'string', 'readOnly' => true, 'example' => ''],
'RoleType' => ['title' => '角色类型', 'description' => '角色类型', 'type' => 'string', 'readOnly' => true, 'example' => ''],
'RoleArn' => ['title' => '角色名称', 'description' => '角色名称', 'type' => 'string', 'readOnly' => true, 'example' => ''],
],
'readOnly' => true,
'description' => '',
'title' => '',
'example' => '',
],
'readOnly' => true,
'example' => '',
],
],
'readOnly' => true,
'description' => '',
'title' => '',
'example' => '',
],
'readOnly' => true,
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'RunTimeout' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''],
'ChildRuns' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'FlowRunId' => ['title' => '应用流运行ID', 'description' => '应用流运行ID', 'type' => 'string', 'readOnly' => true, 'example' => ''],
'RunName' => ['title' => '运行名称', 'description' => '运行名称', 'type' => 'string', 'readOnly' => true, 'example' => ''],
'RunMode' => ['title' => '运行模式', 'description' => '运行模式', 'type' => 'string', 'readOnly' => true, 'example' => ''],
'RunStatus' => ['title' => '运行状态', 'description' => '运行状态', 'type' => 'string', 'readOnly' => true, 'example' => ''],
'GmtCreateTime' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'readOnly' => true, 'example' => ''],
'GmtModifiedTime' => ['title' => '修改时间', 'description' => '修改时间', 'type' => 'string', 'readOnly' => true, 'example' => ''],
'GmtStartTime' => ['title' => '开始时间', 'description' => '开始时间', 'type' => 'string', 'readOnly' => true, 'example' => ''],
'GmtFinishTime' => ['title' => '结束时间', 'description' => '结束时间', 'type' => 'string', 'readOnly' => true, 'example' => ''],
'Duration' => ['title' => '运行时长', 'description' => '运行时长', 'type' => 'integer', 'format' => 'int32', 'readOnly' => true, 'example' => ''],
'FlowSource' => [
'title' => '应用流来源',
'description' => '应用流来源',
'type' => 'object',
'properties' => [
'Id' => ['title' => 'ID', 'description' => 'ID', 'type' => 'string', 'readOnly' => true, 'example' => ''],
'Type' => ['title' => '类型', 'description' => '类型', 'type' => 'string', 'readOnly' => true, 'example' => ''],
'Name' => ['title' => '名称', 'description' => '名称', 'type' => 'string', 'readOnly' => true, 'example' => ''],
],
'readOnly' => true,
'example' => '',
],
'JobInfo' => [
'title' => '任务信息',
'description' => '任务信息',
'type' => 'object',
'properties' => [
'JobId' => ['title' => '任务ID', 'description' => '任务ID', 'type' => 'string', 'readOnly' => true, 'example' => ''],
],
'readOnly' => true,
'example' => '',
],
'RunResult' => ['title' => '运行结果', 'description' => '运行结果', 'type' => 'string', 'readOnly' => true, 'example' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'description' => '',
'title' => '',
'example' => '',
],
'NodeRunInfos' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'NodeName' => ['title' => '节点名称', 'description' => '节点名称', 'type' => 'string', 'readOnly' => true, 'example' => ''],
'Status' => ['title' => '节点状态', 'description' => '节点状态', 'type' => 'string', 'readOnly' => true, 'example' => ''],
'Inputs' => ['title' => '输入', 'description' => '输入', 'type' => 'string', 'readOnly' => true, 'example' => ''],
'Output' => ['title' => '输出', 'description' => '输出', 'type' => 'string', 'readOnly' => true, 'example' => ''],
'ErrorMessage' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'readOnly' => true, 'example' => ''],
'Duration' => ['title' => '耗时', 'description' => '耗时', 'type' => 'string', 'readOnly' => true, 'example' => ''],
'Stdout' => ['title' => '日志信息', 'description' => '日志信息', 'type' => 'string', 'readOnly' => true, 'example' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'description' => '',
'title' => '',
'example' => '',
],
'EvaluationWorkerCount' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'FlowTemplate' => [
'type' => 'object',
'properties' => [
'WorkspaceId' => ['type' => 'string'],
'Accessibility' => ['type' => 'string'],
'Description' => ['type' => 'string'],
'FlowStoragePath' => ['type' => 'string'],
'FlowTemplateId' => ['type' => 'string'],
'FlowType' => ['type' => 'string'],
'TemplateGroup' => ['type' => 'string'],
'TemplateName' => ['type' => 'string'],
'Url' => ['type' => 'string'],
'FlowFiles' => ['type' => 'string'],
'DisplayName' => ['type' => 'string'],
'DisplayNameI18N' => [
'type' => 'object',
'additionalProperties' => ['type' => 'string'],
],
'DescriptionI18N' => [
'type' => 'object',
'additionalProperties' => ['type' => 'string'],
],
'Version' => ['type' => 'string'],
'Locale' => ['type' => 'string'],
'ReferenceCount' => ['type' => 'integer', 'format' => 'int32'],
'AliyunDocumentId' => ['type' => 'string'],
'Labels' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['title' => '标签Key', 'description' => '标签Key', 'type' => 'string'],
'Value' => ['title' => '标签Value', 'description' => '标签Value', 'type' => 'string'],
],
],
],
],
],
'KnowledgeBase' => [
'description' => 'Knowledge base.',
'type' => 'object',
'properties' => [
'WorkspaceId' => ['description' => 'ID of the workspace where the knowledge base resides.', 'type' => 'string', 'example' => '478***', 'title' => ''],
'Accessibility' => ['description' => 'Workspace visibility. Possible values are:'."\n"
.'- PRIVATE: visible only to you and administrators within this workspace.'."\n"
.'- PUBLIC: visible to everyone within this workspace.', 'type' => 'string', 'example' => 'PRIVATE', 'title' => ''],
'GmtCreateTime' => ['description' => 'Knowledge base creation time (UTC).', 'type' => 'string', 'example' => '2024-12-15T14:46:23Z', 'title' => ''],
'GmtModifiedTime' => ['description' => 'The knowledge base modification time (UTC). ', 'type' => 'string', 'example' => '2025-12-18T19:32:58Z', 'title' => ''],
'Name' => ['description' => 'The knowledge base name. ', 'type' => 'string', 'example' => 'myName', 'title' => ''],
'KnowledgeBaseId' => ['description' => 'ID of the knowledge base.', 'type' => 'string', 'example' => 'd-nacr******sxd2', 'title' => ''],
'Description' => ['description' => 'Description of the knowledge base.', 'type' => 'string', 'example' => 'This is a description of the knowledge base.', 'title' => ''],
'KnowledgeBaseType' => ['description' => 'Type of the knowledge base.'."\n"
.'- TEXT: document.'."\n"
.'- STRUCTURED: structured data.'."\n"
.'- IMAGE: image.'."\n"
.'- VIDEO: video.', 'type' => 'string', 'example' => 'TEXT', 'title' => ''],
'DatasetId' => ['description' => 'The dataset ID corresponding to the knowledge base. ', 'type' => 'string', 'example' => 'd-lvb6****865w', 'title' => ''],
'DataSources' => [
'description' => 'Data sources.',
'type' => 'array',
'items' => [
'description' => 'Data sources.',
'type' => 'object',
'properties' => [
'Uri' => ['title' => '统一资源识别码', 'description' => 'Source file storage path.', 'type' => 'string', 'example' => 'oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/langstudio/source/', 'readOnly' => true],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'OutputDir' => ['description' => 'Storage path for output data.', 'type' => 'string', 'example' => 'oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/langstudio/output/', 'title' => ''],
'ChunkConfig' => [
'description' => 'File chunk configuration.',
'type' => 'object',
'properties' => [
'ChunkSize' => ['title' => '分块大小', 'description' => 'Chunk size.', 'type' => 'integer', 'format' => 'int32', 'example' => '1024', 'readOnly' => true],
'ChunkOverlap' => ['title' => '分块重叠大小', 'description' => 'Chunk overlap size.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'readOnly' => true],
'ChunkDuration' => ['title' => '分块时长', 'description' => 'Chunk duration, in seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'readOnly' => true],
'ChunkStrategy' => ['title' => '分块策略', 'description' => 'Chunking policy. The policy types are as follows:'."\n"
.'- Default: The system default chunking policy.'."\n"
.'- Asr: Chunk by audio content.', 'type' => 'string', 'example' => 'Default', 'readOnly' => true, 'default' => 'Default'],
],
'title' => '',
'example' => '',
],
'EmbeddingConfig' => [
'description' => 'Vector index configuration.',
'type' => 'object',
'properties' => [
'ConnectionName' => ['title' => 'Embedding连接名称', 'description' => 'Name of the index service connection.', 'type' => 'string', 'example' => 'myEmbeddingConn'],
'ConnectionId' => ['title' => 'Embedding连接ID', 'description' => 'ID of the index service connection.', 'type' => 'string', 'example' => 'conn-r3o7******38bh'],
'Model' => ['title' => '模型', 'description' => 'Model name.', 'type' => 'string', 'example' => 'text-embedding-v4'],
],
'title' => '',
'example' => '',
],
'VectorDBConfig' => [
'description' => 'Vector database configuration.',
'type' => 'object',
'properties' => [
'VectorDBType' => ['title' => 'VectorDB类型', 'description' => 'The vector database type. The following values are supported: '."\n"
.'- Elasticsearch '."\n"
.'- Milvus '."\n"
.'- Faiss ', 'type' => 'string', 'example' => 'Milvus'],
'ConnectionName' => ['title' => 'VectorDB连接名称', 'description' => 'Name of the vector database connection.', 'type' => 'string', 'example' => 'myConnName'],
'ConnectionId' => ['title' => 'Embedding连接ID', 'description' => 'ID of the vector database connection.', 'type' => 'string', 'example' => 'conn-v2wq****z7rg'],
'CollectionName' => ['title' => 'Collection名称', 'description' => 'Name of the table or collection in the vector database.', 'type' => 'string', 'example' => 'my_collection'],
],
'title' => '',
'example' => '',
],
'Creator' => ['description' => 'The User ID of the creator. ', 'type' => 'string', 'example' => '1247****1467', 'title' => ''],
'RuntimeId' => ['description' => 'Runtime ID.', 'type' => 'string', 'example' => 'rtime-78****d6', 'title' => ''],
'MetaDataConfig' => [
'description' => 'Metadata configuration.',
'type' => 'object',
'properties' => [
'CustomMetaData' => [
'title' => '自定义元数据',
'description' => 'Custom metadata.',
'type' => 'array',
'items' => [
'description' => 'Custom metadata.',
'type' => 'object',
'properties' => [
'Key' => ['title' => '元数据Key', 'description' => 'The metadata field name.', 'type' => 'string', 'example' => 'column1'],
'ValueType' => ['title' => '元数据Value类型', 'description' => 'The metadata field type.', 'type' => 'string', 'example' => 'String'],
'ReferenceCount' => ['title' => '引用次数', 'description' => 'The number of references.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'readOnly' => true],
'ValueCount' => ['title' => '值的个数', 'description' => 'The number of values.', 'type' => 'integer', 'format' => 'int32', 'example' => '8', 'readOnly' => true],
],
'title' => '',
'example' => '',
],
'example' => '',
],
],
'title' => '',
'example' => '',
],
'AutoUpdateConfig' => [
'description' => 'The auto update configuration for the knowledge base. ',
'type' => 'object',
'properties' => [
'Status' => ['title' => '知识库自动更新状态', 'description' => 'The toggle status of auto update for the knowledge base. '."\n"
.'- Enable: Auto update is enabled. '."\n"
.'- Disable: Auto update is disabled. ', 'type' => 'string', 'example' => 'Enable', 'default' => 'Disable'],
'ResourceId' => ['title' => '资源组ID', 'description' => 'The resource group ID. An empty value or "public-cluster" indicates public resources. ', 'type' => 'string', 'example' => 'quota87**45'],
'MaxRunningTimeInSeconds' => ['title' => '任务最大运行时间', 'description' => 'The maximum job runtime, in seconds. ', 'type' => 'integer', 'format' => 'int32', 'example' => '86400'],
'EmbeddingConfig' => [
'title' => 'Embedding配置',
'description' => 'The vector indexing configuration. ',
'type' => 'object',
'properties' => [
'BatchSize' => ['title' => 'Embedding分批大小', 'description' => 'The index batch size. Valid for document and structured data type knowledge bases. ', 'type' => 'integer', 'format' => 'int32', 'example' => '8'],
'Concurrency' => ['title' => 'Embedding并发数', 'description' => 'The index concurrency. Valid for image and video type knowledge bases.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '200', 'minimum' => '1', 'example' => '1'],
],
'example' => '',
],
'UserVpc' => ['title' => '用户VPC配置', 'description' => 'User VPC configuration. ', '$ref' => '#/components/schemas/UserVpc', 'example' => ''],
'EcsSpecs' => [
'title' => '运行资源配置',
'description' => 'List of runtime resource configurations. ',
'type' => 'array',
'items' => [
'description' => 'Runtime resource. ',
'type' => 'object',
'properties' => [
'Type' => ['title' => '节点类型', 'description' => 'File Type. Possible values are Head and Worker. ', 'type' => 'string', 'example' => 'Worker', 'default' => 'Worker'],
'InstanceType' => ['title' => '机型名称', 'description' => 'Instance type name. ', 'type' => 'string', 'example' => 'ecs.c6.large'],
'PodCount' => ['title' => '副本数量', 'description' => 'Number of replicas. ', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'GPUType' => ['title' => 'GPU类型', 'description' => 'GPU type. ', 'type' => 'string', 'example' => 'V100'],
'CPU' => ['title' => 'CPU核数', 'description' => 'Number of CPU cores. ', 'type' => 'integer', 'format' => 'int32', 'example' => '4'],
'GPU' => ['title' => 'GPU卡数', 'description' => 'Number of GPU cards. ', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'Memory' => ['title' => '内存大小', 'description' => 'Memory size, in GB. ', 'type' => 'integer', 'format' => 'int32', 'example' => '16'],
'SharedMemory' => ['title' => '共享内存容量', 'description' => 'Shared memory capacity, in GB. ', 'type' => 'integer', 'format' => 'int32', 'example' => '16'],
'Driver' => ['title' => '驱动版本', 'description' => 'Driver version. ', 'type' => 'string', 'example' => '550.127.08'],
],
'title' => '',
'example' => '',
],
'example' => '',
],
],
'title' => '',
'example' => '',
],
'VersionName' => ['description' => 'Knowledge base version. Default is v1.', 'type' => 'string', 'example' => 'v1', 'title' => ''],
'IndexColumnConfig' => [
'description' => 'Field configuration for columns. Valid only for structured data knowledge bases. ',
'type' => 'object',
'properties' => [
'EmbeddingColumns' => [
'title' => 'Embedding列',
'description' => 'Vector index columns. Fields in this list are vectorized and participate in retrieval. ',
'type' => 'array',
'items' => [
'description' => 'Vector index column. ',
'type' => 'object',
'properties' => [
'Key' => ['title' => '列Key', 'description' => 'Column name. ', 'type' => 'string', 'example' => 'column1', 'readOnly' => true],
],
'readOnly' => true,
'title' => '',
'example' => '',
],
'readOnly' => true,
'example' => '',
],
'ContentColumns' => [
'title' => '内容检索列',
'description' => 'Content filtering columns. Fields in this list support retrieval by keyword.',
'type' => 'array',
'items' => [
'description' => 'Content filtering columns.',
'type' => 'object',
'properties' => [
'Key' => ['title' => '列Key', 'description' => 'Column name.', 'type' => 'string', 'example' => 'column1', 'readOnly' => true],
],
'readOnly' => true,
'title' => '',
'example' => '',
],
'readOnly' => true,
'example' => '',
],
'ColumnDefinitions' => [
'title' => '所有列名',
'description' => 'All column names. ',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['title' => '列Key', 'description' => 'Column name.', 'type' => 'string', 'example' => 'column1', 'readOnly' => true],
],
'readOnly' => true,
'description' => '',
'title' => '',
'example' => '',
],
'readOnly' => true,
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'KnowledgeBaseFileChunk' => [
'description' => 'Knowledge base segment. ',
'type' => 'object',
'properties' => [
'Score' => ['description' => 'Relevance of the result to the query content. ', 'type' => 'number', 'format' => 'float', 'example' => '0.9832', 'title' => ''],
'ChunkId' => ['description' => 'Segment ID. ', 'type' => 'string', 'example' => '7fjs******90fs', 'title' => ''],
'ChunkStart' => ['description' => 'Start position of the segment. Returns the time in milliseconds from the start of file playback. ', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
'ChunkEnd' => ['description' => 'End position of the segment. Returns the time in milliseconds from the start of file playback. ', 'type' => 'integer', 'format' => 'int32', 'example' => '30000', 'title' => ''],
'ChunkSequence' => ['description' => 'Ordinal number of the segment within the file. ', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
'ChunkContent' => ['description' => 'Segment content. ', 'type' => 'string', 'example' => 'content of chunk', 'title' => ''],
'ChunkSize' => ['description' => 'Segment size. ', 'type' => 'integer', 'format' => 'int32', 'example' => '3452', 'title' => ''],
'ChunkStatus' => ['description' => 'Segment status. '."\n"
."\n"
.'- Enable: enabled. '."\n"
.'- Disable: disabled. ', 'type' => 'string', 'example' => 'Enable', 'title' => ''],
'DownloadUrl' => ['description' => 'Segment download URL. Returned for image and video files. ', 'type' => 'string', 'example' => 'https://cas-documents-service.oss-cn-shanghai.aliyuncs.com/5743962650c522fd54620fb9868d8c4c?Expires=1735092238&OSSAccessKeyId=LTAIgoNm******', 'title' => ''],
'ThumbnailUrl' => ['description' => 'Segment thumbnail. Returned for image and video files. ', 'type' => 'string', 'example' => 'https://cas-documents-service.oss-cn-shanghai.aliyuncs.com/5743962650c522fd54620fb9868d8c4c?Expires=1735092238&OSSAccessKeyId=LTAIgoNm******', 'title' => ''],
'ChunkAttachment' => [
'description' => 'Segment attachment. ',
'type' => 'array',
'items' => [
'description' => 'Attachment information. ',
'type' => 'object',
'properties' => [
'PlaceholderId' => ['description' => 'Placeholder ID. ', 'type' => 'string', 'example' => 'IMAGE_PLACEHOLDER_0', 'title' => ''],
'Type' => ['description' => 'Attachment type. ', 'type' => 'string', 'example' => 'image', 'title' => ''],
'Uri' => ['description' => 'Attachment URI. ', 'type' => 'string', 'example' => 'oss://mybucket/file1/img1.jpg', 'title' => ''],
'DownloadUrl' => ['description' => 'Attachment download URL. ', 'type' => 'string', 'example' => 'https://cas-documents-service.oss-cn-shanghai.aliyuncs.com/Batch_Upload_Monitor_Domain.xlsx?Expires=1737338736&OSSAccessKeyId=LTAIgoNm******', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'MetaData' => [
'description' => 'Original file information. ',
'type' => 'object',
'properties' => [
'FileName' => ['description' => 'File name. ', 'type' => 'string', 'example' => 'abc.txt', 'title' => ''],
'FileUri' => ['description' => 'File Path. ', 'type' => 'string', 'example' => 'oss://mybucket/path/abc.txt', 'title' => ''],
'FileMetaId' => ['description' => 'File metadata ID. ', 'type' => 'string', 'example' => 'sd8c******67ux', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'KnowledgeBaseJob' => [
'description' => 'Knowledge base job.',
'type' => 'object',
'properties' => [
'WorkspaceId' => ['description' => 'The workspace ID.', 'type' => 'string', 'example' => '478**', 'title' => ''],
'Accessibility' => ['description' => 'Workspace visibility. Possible values are:'."\n"
.'- PRIVATE: In this workspace, visible only to you and administrators.'."\n"
.'- PUBLIC: In this workspace, visible to everyone.', 'type' => 'string', 'example' => 'PRIVATE', 'title' => ''],
'Creator' => ['description' => 'The User ID of the creator.', 'type' => 'string', 'example' => '2003******4844', 'title' => ''],
'GmtCreateTime' => ['description' => 'Job creation time (UTC).', 'type' => 'string', 'example' => '2024-05-13T01:43:15Z', 'title' => ''],
'GmtModifiedTime' => ['description' => 'Job update time (UTC).', 'type' => 'string', 'example' => '2024-05-13T03:05:22Z', 'title' => ''],
'KnowledgeBaseId' => ['description' => 'The knowledge base ID.', 'type' => 'string', 'example' => 'd-ksicx823d', 'title' => ''],
'KnowledgeBaseJobId' => ['description' => 'The knowledge base job ID.', 'type' => 'string', 'example' => 'kbjob-9m******54', 'title' => ''],
'JobAction' => ['description' => 'Operation type of the job. '."\n"
.'- SyncIndex: Update knowledge base index', 'type' => 'string', 'example' => 'SyncIndex', 'title' => ''],
'Description' => ['description' => 'The description of the knowledge base job.', 'type' => 'string', 'example' => 'This is a description of the knowledge base job.', 'title' => ''],
'Status' => ['description' => 'The status of the knowledge base job.'."\n"
."\n"
.'- Running: The job is running.'."\n"
.'- Success: The job succeeded.'."\n"
.'- Failed: The job failed.', 'type' => 'string', 'example' => 'Running', 'title' => ''],
'ResourceId' => ['description' => 'Resource ID.', 'type' => 'string', 'example' => 'quota89**76', 'title' => ''],
'EcsSpecs' => [
'description' => 'Machine resources used for running the job.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Type' => ['title' => '节点类型', 'description' => 'Node type. Possible values are Head and Worker.', 'type' => 'string', 'example' => 'Worker', 'readOnly' => true, 'default' => 'Worker'],
'InstanceType' => ['title' => '机型名称', 'description' => 'Instance type name. ', 'type' => 'string', 'example' => 'ecs.c6.large', 'readOnly' => true],
'PodCount' => ['title' => '副本数量', 'description' => 'Number of replicas.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'readOnly' => true],
'CPU' => ['title' => 'CPU核数', 'description' => 'Number of CPU cores. ', 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'readOnly' => true],
'GPU' => ['title' => 'GPU卡数', 'description' => 'Number of GPU cards. ', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'readOnly' => true],
'Memory' => ['title' => '内存大小', 'description' => 'Memory size, in GB. ', 'type' => 'integer', 'format' => 'int32', 'example' => '16', 'readOnly' => true],
'SharedMemory' => ['title' => '共享内存容量', 'description' => 'Shared memory capacity, in GB. ', 'type' => 'integer', 'format' => 'int32', 'example' => '16', 'readOnly' => true],
'GPUType' => ['title' => 'GPU类型', 'description' => 'GPU type. ', 'type' => 'string', 'example' => 'V100', 'readOnly' => true],
'Driver' => ['title' => '驱动版本', 'description' => 'Driver version. ', 'type' => 'string', 'example' => '550.127.08', 'readOnly' => true],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'UserVpc' => [
'description' => 'VPC information for resource execution.',
'type' => 'object',
'properties' => [
'VpcId' => ['title' => 'VPC ID', 'description' => 'VPC ID。', 'type' => 'string', 'example' => 'vpc-wz90****5v23'],
'VSwitchId' => ['title' => '交换机ID', 'description' => 'vSwitch ID.', 'type' => 'string', 'example' => 'vsw-wz9r****ng10'],
'SecurityGroupId' => ['title' => '安全组ID', 'description' => 'Security group ID.', 'type' => 'string', 'example' => 'sg-wz91****e10e'],
],
'title' => '',
'example' => '',
],
'MaxRunningTimeInSeconds' => ['description' => 'Maximum job runtime, in seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '86400', 'title' => ''],
'GmtFinishTime' => ['description' => 'The end time of the job (UTC).', 'type' => 'string', 'example' => '2024-05-13T04:03:27Z', 'title' => ''],
'ErrorMessage' => ['description' => 'Job abnormal information.', 'type' => 'string', 'example' => 'Failed to update knwoledge base index, pipelineRunId: flow-9p8f****4t9z', 'title' => ''],
'PipelineRunInfo' => [
'description' => 'Workflow run information.',
'type' => 'object',
'properties' => [
'PipelineRunId' => ['title' => 'PaiFlow工作流运行ID', 'description' => 'PaiFlow workflow run ID', 'type' => 'string', 'example' => 'flow-fi8z******g4gy', 'readOnly' => true],
],
'title' => '',
'example' => '',
],
'KnowledgeBaseJobResult' => [
'description' => 'Task result.',
'type' => 'object',
'properties' => [
'TotalFileCount' => ['title' => '总处理文件数', 'description' => 'Total number of files processed.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'AddChunkCount' => ['title' => '增加Chunk数量', 'description' => 'Total number of shards increased.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'DeleteChunkCount' => ['title' => '删除Chunk数量', 'description' => 'Total number of shards deleted.', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
],
'title' => '',
'example' => '',
],
'EmbeddingConfig' => [
'description' => 'Index configuration.',
'type' => 'object',
'properties' => [
'BatchSize' => ['title' => 'Embedding分批大小', 'description' => 'Index batch size. Valid for document and structured data type knowledge bases.', 'type' => 'integer', 'format' => 'int32', 'example' => '8', 'readOnly' => true],
'Concurrency' => ['title' => 'Embedding并发数', 'description' => 'Index concurrency. Valid for image and video type knowledge bases.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '200', 'minimum' => '1', 'example' => '1', 'readOnly' => true],
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'Runtime' => [
'description' => 'Runtime details.',
'type' => 'object',
'properties' => [
'WorkspaceId' => ['description' => 'Workspace ID. For information about how to obtain a workspace ID, see [ListWorkspaces](~~449124~~). ', 'type' => 'string', 'example' => '478***', 'title' => ''],
'RuntimeId' => ['description' => 'Runtime ID. ', 'type' => 'string', 'example' => 'rtime-apje******beaz', 'title' => ''],
'RuntimeName' => ['description' => 'The Name of the runtime. ', 'type' => 'string', 'example' => 'dev01', 'title' => ''],
'RuntimeType' => ['description' => 'Runtime type. ', 'type' => 'string', 'example' => 'DSW', 'title' => ''],
'RuntimeStatus' => ['description' => 'Runtime status. Valid values:'."\n"
.'* Creating: Creation in progress'."\n"
.'* SaveFailed: Failed to save image'."\n"
.'* Stopped: Stopped'."\n"
.'* Failed: Failed'."\n"
.'* ResourceAllocating: Resource allocation in progress'."\n"
.'* Stopping: Stopping in progress'."\n"
.'* Updating: Update in progress'."\n"
.'* Saving: Image saving in progress'."\n"
.'* Queuing: Queuing'."\n"
.'* Recovering: Instance recovery in progress'."\n"
.'* Starting: Creation in progress'."\n"
.'* Running: Running'."\n"
.'* Saved: Image saved successfully'."\n"
.'* Deleting: Deletion in progress'."\n"
.'* EnvPreparing: Environment preparation in progress', 'type' => 'string', 'example' => 'Running', 'title' => ''],
'GmtCreateTime' => ['description' => 'Creation Time. ', 'type' => 'string', 'example' => '2025-09-24T07:33:53Z', 'title' => ''],
'GmtModifiedTime' => ['description' => 'Updated At.', 'type' => 'string', 'example' => '2025-09-24T08:24:36Z', 'title' => ''],
'Creator' => ['description' => 'Creator ID.', 'type' => 'string', 'example' => '2680******4103', 'title' => ''],
'Accessibility' => ['description' => 'Workspace visibility. Possible values:'."\n"
.'- PRIVATE: In this workspace, visible only to you and administrators.'."\n"
.'- PUBLIC: In this workspace, visible to everyone.', 'type' => 'string', 'example' => 'PRIVATE', 'title' => ''],
'EcsSpec' => [
'description' => 'ECS resource configuration ',
'type' => 'object',
'properties' => [
'InstanceType' => ['title' => '实例类型', 'description' => 'Instance type. ', 'type' => 'string', 'example' => 'ecs.c6.large', 'readOnly' => true],
'GPUType' => ['title' => 'GPU类型', 'description' => 'GPU type. Valid values: '."\n"
.'* V100 '."\n"
.'* A100 '."\n"
.'* T4 '."\n"
.'* A10 '."\n"
.'* P100 ', 'type' => 'string', 'example' => 'V100', 'readOnly' => true],
'CPU' => ['title' => 'CPU数量', 'description' => 'Number of CPUs. ', 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'readOnly' => true],
'GPU' => ['title' => 'GPU数量', 'description' => 'Number of GPUs. ', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'readOnly' => true],
'Memory' => ['title' => '内存信息', 'description' => 'Memory size, in GB. ', 'type' => 'integer', 'format' => 'int32', 'example' => '8', 'readOnly' => true],
'SharedMemory' => ['title' => '共享内存', 'description' => 'Shared memory size, in GB. ', 'type' => 'integer', 'format' => 'int32', 'example' => '8', 'readOnly' => true],
'Driver' => ['title' => '驱动版本', 'description' => 'GPU driver version. ', 'type' => 'string', 'example' => '535.161.08', 'readOnly' => true],
],
'title' => '',
'example' => '',
],
'ResourceId' => ['description' => 'Resource quota ID. ', 'type' => 'string', 'example' => 'quota18******zv9', 'title' => ''],
'UserVpc' => [
'description' => 'User VPC configuration.',
'type' => 'object',
'properties' => [
'VpcId' => ['title' => 'VPC ID', 'description' => 'Virtual private cloud (VPC) ID.', 'type' => 'string', 'example' => 'vpc-wz90****5v23', 'readOnly' => true],
'VSwitchId' => ['title' => '交换机ID', 'description' => 'vSwitch ID.', 'type' => 'string', 'example' => 'vsw-wz9r****ng10', 'readOnly' => true],
'SecurityGroupId' => ['title' => '安全组ID', 'description' => 'Security group ID.', 'type' => 'string', 'example' => 'sg-wz9i****1129', 'readOnly' => true],
'DefaultRoute' => ['title' => '默认路由', 'description' => 'Default route.', 'type' => 'string', 'example' => 'eth0', 'readOnly' => true],
'ExtendedCIDRs' => [
'title' => '扩展网段',
'description' => 'Extended CIDR blocks.',
'type' => 'array',
'items' => ['description' => 'Extended CIDR block.', 'type' => 'string', 'example' => '172.16.1.0/24', 'readOnly' => true, 'title' => ''],
'readOnly' => true,
'example' => '',
],
],
'title' => '',
'example' => '',
],
'Envs' => [
'description' => 'Environment variables. ',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['title' => '环境键', 'description' => 'Environment key. ', 'type' => 'string', 'example' => 'testKey01', 'readOnly' => true],
'Value' => ['title' => '环境值', 'description' => 'The environment value.', 'type' => 'string', 'example' => 'testValue01', 'readOnly' => true],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'Labels' => [
'description' => 'Labels. ',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['title' => '标签键', 'description' => 'Tag key. ', 'type' => 'string', 'example' => 'testKey01', 'readOnly' => true],
'Value' => ['title' => '标签值', 'description' => 'Tag value. ', 'type' => 'string', 'example' => 'testValue01', 'readOnly' => true],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'DataSources' => [
'description' => 'Mounted data sources.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'DatasetId' => ['title' => '数据集ID', 'description' => 'Dataset ID. Specify either this parameter or Uri.', 'type' => 'string', 'example' => 'd-umns******zij4szhc', 'readOnly' => true],
'Uri' => ['title' => '统一资源识别码', 'description' => 'OSS path of the data source. Specify either this parameter or DatasetId.', 'type' => 'string', 'example' => 'oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/langstudio/source/', 'readOnly' => true],
'MountPath' => ['title' => '挂载路径', 'description' => 'Mount path.', 'type' => 'string', 'example' => '/mnt/data', 'readOnly' => true],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'RunTimeout' => ['description' => 'Timeout in seconds for a single test run executed on the runtime.', 'type' => 'integer', 'format' => 'int32', 'example' => '180', 'title' => ''],
'CredentialConfig' => [
'description' => 'Credential configuration.',
'type' => 'object',
'properties' => [
'EnableCredentialInject' => ['title' => '是否启用Credential注入', 'description' => 'Whether to enable credential injection.', 'type' => 'boolean', 'example' => 'true', 'readOnly' => true],
'AliyunEnvRoleKey' => ['title' => 'AliyunEnvRoleKey', 'description' => 'Environment variable role key.', 'type' => 'string', 'example' => '0', 'readOnly' => true],
'CredentialConfigItems' => [
'title' => 'Credential配置项列表',
'description' => 'List of credential configuration items.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['title' => 'Key', 'description' => 'The key that identifies the configuration. ', 'type' => 'string', 'example' => '0', 'readOnly' => true],
'Type' => ['title' => 'Type', 'description' => 'Configuration type. Valid values include:'."\n"
.'* Role: Role assumption'."\n"
.'* RoleChain: Role chain assumption', 'type' => 'string', 'example' => 'Role', 'readOnly' => true],
'Roles' => [
'title' => '角色列表',
'description' => 'List of configured roles.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'AssumeRoleFor' => ['title' => 'AssumeRoleFor', 'description' => 'The entity that assumes the role. ', 'type' => 'string', 'example' => '1095******785714', 'readOnly' => true],
'RoleType' => ['title' => '角色类型', 'description' => 'The type of the role to assume. Valid values include: '."\n"
.'* service: assumed by a service '."\n"
.'* user: assumed by a regular user Account ', 'type' => 'string', 'example' => 'service', 'readOnly' => true],
'RoleArn' => ['title' => '角色名称', 'description' => 'The role ARN. ', 'type' => 'string', 'example' => 'acs:ram::1095******785714:role/testrole', 'readOnly' => true],
],
'readOnly' => true,
'description' => '',
'title' => '',
'example' => '',
],
'readOnly' => true,
'example' => '',
],
],
'readOnly' => true,
'description' => '',
'title' => '',
'example' => '',
],
'readOnly' => true,
'example' => '',
],
],
'title' => '',
'example' => '',
],
'WorkDir' => ['description' => 'OSS path of the working directory. ', 'type' => 'string', 'example' => 'oss://mybucket.oss-cn-hangzhou-internal.aliyuncs.com/workdir/', 'title' => ''],
'Version' => ['description' => 'Runtime image version. ', 'type' => 'string', 'example' => '2.0.0', 'title' => ''],
'RuntimeLog' => ['description' => 'Runtime log.', 'type' => 'string', 'example' => 'oss://mybucket.oss-cn-hangzhou-internal.aliyuncs.com/workdir/runtime/1.log', 'title' => ''],
'AutoUpdateImage' => ['description' => 'Indicates whether to automatically update the image. When a new image version is available, the system automatically updates the runtime image during off-peak hours. ', 'type' => 'boolean', 'example' => 'True', 'title' => ''],
],
'title' => '',
'example' => '',
],
'Snapshot' => [
'description' => 'Details of the snapshot.',
'type' => 'object',
'properties' => [
'WorkspaceId' => ['description' => 'The workspace ID. For information about how to obtain the workspace ID, see [ListWorkspaces](~~449124~~).', 'type' => 'string', 'example' => '478**', 'title' => ''],
'Accessibility' => ['description' => 'The visibility of the snapshot. Valid values:'."\n"
."\n"
.'- `PRIVATE`: The snapshot is visible only to its creator and administrators in the workspace.'."\n"
."\n"
.'- `PUBLIC`: The snapshot is visible to everyone in the workspace.', 'type' => 'string', 'example' => 'PRIVATE', 'title' => ''],
'Creator' => ['description' => 'The creator ID.', 'type' => 'string', 'example' => '2680******4103', 'title' => ''],
'GmtCreateTime' => ['description' => 'The time the snapshot was created.', 'type' => 'string', 'example' => '2025-09-24T07:33:53Z', 'title' => ''],
'GmtModifiedTime' => ['description' => 'The time the snapshot was last modified.', 'type' => 'string', 'example' => '2025-09-24T08:58:35Z', 'title' => ''],
'SnapshotId' => ['description' => 'The snapshot ID.', 'type' => 'string', 'example' => 'snap-qhn3******b369c0vo', 'title' => ''],
'SnapshotName' => ['description' => 'The snapshot name.', 'type' => 'string', 'example' => 'name01', 'title' => ''],
'Description' => ['description' => 'The snapshot description.', 'type' => 'string', 'example' => 'This is description', 'title' => ''],
'SnapshotResourceType' => ['description' => 'The type of resource the snapshot captures. Valid values:'."\n"
."\n"
.'- `Flow`: A workflow.', 'type' => 'string', 'example' => 'Flow', 'title' => ''],
'SnapshotResourceId' => ['description' => 'The ID of the source resource for the snapshot.', 'type' => 'string', 'example' => 'flow-6rymo******m7j0z4p', 'title' => ''],
'CreationType' => ['description' => 'The creation type of the snapshot. Valid values:'."\n"
."\n"
.'- `ManualCreated`: The snapshot was created manually.'."\n"
."\n"
.'- `DeploymentAutoCreated`: The snapshot was automatically created by a deployment service.'."\n"
."\n"
.'- `EvaluationAutoCreated`: The snapshot was automatically created by an evaluation task.', 'type' => 'string', 'example' => 'ManualCreated', 'title' => ''],
'SnapshotStoragePath' => ['description' => 'The OSS path to the snapshot\'s source files.', 'type' => 'string', 'example' => 'oss://mybucket.oss-cn-hangzhou.aliyuncs.com/workdir/snapshot/snap-1234/src', 'title' => ''],
'WorkDir' => ['description' => 'The OSS working directory where the snapshot is stored.', 'type' => 'string', 'example' => 'oss://mybucket.oss-cn-hangzhou-internal.aliyuncs.com/workdir/', 'title' => ''],
'SnapshotUrl' => ['description' => 'The download URL for the snapshot.', 'type' => 'string', 'example' => 'https://path/to/snapshot/zipfile', 'title' => ''],
'SnapshotStatus' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'ErrorMessage' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
'title' => '',
'example' => '',
],
'UserVpc' => [
'description' => 'User VPC information.',
'type' => 'object',
'properties' => [
'VpcId' => ['title' => '用户VPC的ID', 'description' => 'The ID of the user\'s VPC', 'type' => 'string', 'example' => 'vpc-m5ec******44cn'],
'VSwitchId' => ['title' => '用户交换机的ID', 'description' => 'The ID of the user\'s vSwitch', 'type' => 'string', 'example' => 'vsw-hp32******z9qo'],
'SecurityGroupId' => ['title' => '用户安全组的ID', 'description' => 'The ID of the user\'s security group', 'type' => 'string', 'example' => 'sg-bp1f******iy9h'],
],
'title' => '',
'example' => '',
],
],
],
'apis' => [
'CreateDeployment' => [
'summary' => 'Create a deployment job.',
'path' => '/api/v1/langstudio/deployments',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATURElearnBVWJJN'],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => 'Request body. ',
'type' => 'object',
'properties' => [
'WorkspaceId' => ['description' => 'Workspace ID. For information about how to obtain a workspace ID, see [ListWorkspaces](~~449124~~).', 'type' => 'string', 'required' => false, 'example' => '478**', 'title' => ''],
'Accessibility' => [
'description' => 'Workspace visibility. Valid values: '."\n"
.'- PRIVATE: The service is visible only to you and administrators within this workspace. '."\n"
.'- PUBLIC: The service is visible to all users within this workspace. ',
'type' => 'string',
'required' => false,
'example' => 'PRIVATE',
'default' => 'PUBLIC',
'enum' => ['PUBLIC', 'PRIVATE'],
'title' => '',
],
'ResourceType' => ['description' => 'The resource type to deploy. Valid values:'."\n"
.'* Flow: A pipeline project'."\n"
.'* Code: A code project', 'type' => 'string', 'required' => false, 'example' => 'Flow', 'title' => ''],
'ResourceId' => ['description' => 'The ID of the resource to deploy.', 'type' => 'string', 'required' => false, 'example' => 'flow-asdf******123', 'title' => ''],
'ResourceSnapshotId' => ['description' => 'The snapshot ID of the resource to deploy. If this parameter is provided, the system deploys directly based on this snapshot. If this parameter is not provided, the system creates a new snapshot of the resource and then executes the deployment.', 'type' => 'string', 'required' => false, 'example' => 'snap-asfg******123', 'title' => ''],
'ServiceName' => ['description' => 'Service name. Format requirements:'."\n"
.'* Supports lowercase letters, digits, and underscores'."\n"
.'* Must start with a letter'."\n"
.'* Length must be 1 to 45 characters', 'type' => 'string', 'required' => false, 'example' => 'myservice01', 'title' => ''],
'Description' => ['description' => 'Service description. ', 'type' => 'string', 'required' => false, 'example' => 'This is description', 'title' => ''],
'EnableTrace' => ['description' => 'Indicates whether to enable Tracing Analysis. ', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
'ChatHistoryConfig' => [
'description' => 'Chat history configuration. ',
'type' => 'object',
'properties' => [
'StorageType' => [
'title' => 'Storage Type ',
'description' => 'Storage class. Valid values: '."\n"
.'* LOCAL: Chat history is stored in a local SQLite file. This option does not support multi-instance deployment. '."\n"
.'* OSS: Chat history is stored under a specific path within the service\'s OSS workspace path. '."\n"
.'* RDS: Chat history is stored in an RDS table, and an RDS connection must be specified. ',
'type' => 'string',
'required' => false,
'example' => 'RDS',
'readOnly' => true,
'enum' => ['LOCAL', 'RDS', 'OSS'],
],
'ConnectionName' => ['title' => 'Connection Name ', 'description' => 'Connection name. This parameter is required when the chat history storage type is RDS. ', 'type' => 'string', 'required' => false, 'example' => 'rdsconnection', 'readOnly' => true],
],
'required' => false,
'title' => '',
'example' => '',
],
'WorkDir' => ['description' => 'The OSS working directory for the service. It is used to store the service\'s runtime logs, conversation history, and other data.', 'type' => 'string', 'required' => false, 'example' => 'oss://mybucket.oss-cn-hangzhou-internal.aliyuncs.com/workdir/', 'title' => ''],
'ContentModerationConfig' => [
'description' => 'Content moderation configuration.',
'type' => 'object',
'properties' => [
'EnableInputModeration' => ['title' => 'Enable input content moderation', 'description' => 'Whether to enable security review for input.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'readOnly' => true],
'EnableOutputModeration' => ['title' => 'Enable output content moderation', 'description' => 'Whether to enable content moderation for output.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'readOnly' => true],
'StreamingModerationThreshold' => ['title' => 'Streaming output content moderation cache size', 'description' => 'The cache size for streaming output content submitted for moderation. Default value: 5.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5', 'readOnly' => true],
],
'required' => false,
'title' => '',
'example' => '',
],
'DeploymentConfig' => ['description' => 'Deployment configuration. For details, see [Deployment Configuration](https://help.aliyun.com/zh/pai/user-guide/parameters-of-model-services) in PAI-EAS.', 'type' => 'string', 'required' => false, 'example' => '{\\"metadata\\":{\\"name\\":\\"langstudio_2026******3848_jro7\\",\\"instance\\":1,\\"workspace_id\\":\\"285***\\",\\"enable_webservice\\":false},\\"cloud\\":{\\"computing\\":{\\"instances\\":[{\\"type\\":\\"ecs.g7.xlarge\\"}]},\\"networking\\":{\\"vpc_id\\":\\"vpc-bp1obprt******4bzo00d\\",\\"vswitch_id\\":\\"vsw-bp1p6i36k******pmfhw8\\",\\"security_group_id\\":\\"sg-bp1djud4******zecl5a\\"}}}', 'title' => ''],
'AutoApproval' => ['description' => 'Indicates whether to automatically skip the deployment confirmation step. ', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Return Result. ',
'type' => 'object',
'properties' => [
'DeploymentId' => ['description' => 'Deployment record ID. '."\n", 'type' => 'string', 'example' => 'dploy-asdf******1234', 'title' => ''],
'RequestId' => ['title' => 'Request ID ', 'description' => 'Request ID ', 'type' => 'string', 'example' => '963BD7F9-0C02-5594-9550-BCC6DD43E3C0'],
],
'title' => '',
'example' => '',
],
],
],
'title' => 'Create Deployment Job ',
'description' => '请确保在使用该接口前,已充分了解PAI-EAS产品的收费方式和[价格](https://help.aliyun.com/zh/pai/billing-of-eas)。',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'pailangstudio:CreateDeployment',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DeploymentId\\": \\"dploy-asdf******1234\\",\\n \\"RequestId\\": \\"963BD7F9-0C02-5594-9550-BCC6DD43E3C0\\"\\n}","type":"json"}]',
],
'CreateKnowledgeBase' => [
'summary' => 'Create a knowledge base.',
'path' => '/api/v1/langstudio/knowledgebases',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATURElearnBVWJJN'],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => 'The request body.'."\n",
'type' => 'object',
'properties' => [
'WorkspaceId' => ['description' => 'The ID of the workspace. For more information about how to obtain the ID of a workspace, see [ListWorkspaces](~~449124~~).'."\n", 'type' => 'string', 'required' => true, 'example' => '478**', 'title' => ''],
'Accessibility' => [
'description' => 'The visibility of the workspace.'."\n"
."\n"
.'* PRIVATE: The workspace is visible only to you and the administrator of the workspace.'."\n"
.'* PUBLIC: The model is visible to all users in the workspace.'."\n",
'type' => 'string',
'required' => false,
'example' => 'PUBLIC',
'default' => 'PUBLIC',
'enum' => ['PUBLIC', 'PRIVATE'],
'title' => '',
],
'Name' => ['description' => 'The name of the knowledge base. The name must meet the following requirements:'."\n"
."\n"
.'* Can contain letters, numbers, or underscores (\\_).'."\n"
.'* Starts with a letter.'."\n"
.'* Length is 1 to 127 characters.'."\n", 'type' => 'string', 'required' => true, 'example' => 'myName', 'title' => ''],
'Description' => ['description' => 'Custom description of the knowledge base.'."\n", 'type' => 'string', 'required' => false, 'example' => 'This is a description of the knowledge base.', 'title' => ''],
'KnowledgeBaseType' => [
'description' => 'The type of the knowledge base. Specifies whether to disable the instance protection period. Default value: false. Valid values:'."\n"
."\n"
.'* TEXT: Document.'."\n"
.'* STRUCTURED: Structured data.'."\n"
.'* IMAGE: Picture.'."\n"
.'* VIDEO: Video.'."\n",
'type' => 'string',
'required' => true,
'enumValueTitles' => ['STRUCTURED' => 'STRUCTURED', 'IMAGE' => 'IMAGE', 'VIDEO' => 'VIDEO', 'TEXT' => 'TEXT'],
'example' => 'TEXT',
'title' => '',
],
'OutputDir' => ['description' => 'Storage path for output data.'."\n", 'type' => 'string', 'required' => true, 'example' => 'oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/langstudio/output/', 'title' => ''],
'DataSources' => [
'description' => 'Data source.'."\n",
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Uri' => ['title' => '', 'description' => 'Source file storage path.'."\n", 'type' => 'string', 'required' => false, 'example' => 'oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/langstudio/source/', 'readOnly' => true],
],
'required' => false,
'description' => '',
'title' => '',
'example' => '',
],
'required' => true,
'title' => '',
'example' => '',
],
'ChunkConfig' => [
'description' => 'File slicing configuration.'."\n",
'type' => 'object',
'properties' => [
'ChunkSize' => ['title' => '', 'description' => 'Chunk size'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1024', 'readOnly' => true],
'ChunkOverlap' => ['title' => '', 'description' => 'Chunk overlap size'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '200', 'readOnly' => true],
'ChunkDuration' => ['title' => '', 'description' => 'Chunk duration, in seconds.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'readOnly' => true],
'ChunkStrategy' => ['title' => '', 'description' => 'Chunking strategy. Supported strategies are as follows:'."\n"
."\n"
.'* Default. System default slicing strategy.'."\n"
.'* Asr. Split by audio content; valid for video knowledge bases.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Default', 'readOnly' => true, 'default' => 'Default'],
],
'required' => true,
'title' => '',
'example' => '',
],
'EmbeddingConfig' => [
'description' => 'Vector index configuration.'."\n",
'type' => 'object',
'properties' => [
'ConnectionId' => ['title' => '', 'description' => 'Index service connection ID. For more information about how to obtain the connection ID, see [ListConnections](~~2922801~~). The connection types supported by each type of knowledge base are as follows:'."\n"
."\n"
.'* Documents: BaiLian LLM Service, General Embedding Model Service, AI Search Open Platform Model Service.'."\n"
.'* Structured Data: BaiLian LLM Service, General Embedding Model Service, AI Search Open Platform Model Service.'."\n"
.'* Images: BaiLian LLM Service, General Multimodal Embedding Model Service.'."\n"
.'* Videos: BaiLian LLM Service.'."\n", 'type' => 'string', 'required' => true, 'example' => 'conn-r3o7******38bh', 'readOnly' => true],
'Model' => ['title' => '', 'description' => 'Model name. Specifically, when selecting the BaiLian LLM Service, the models supported by each type of knowledge base are as follows:'."\n"
."\n"
.'* Documents: text-embedding-v1, text-embedding-v2, text-embedding-v3, text-embedding-v4'."\n"
.'* Structured Data: text-embedding-v1, text-embedding-v2, text-embedding-v3, text-embedding-v4'."\n"
.'* Images: multimodal-embedding-v1'."\n"
.'* Videos: qwen2.5-vl-embedding'."\n", 'type' => 'string', 'required' => true, 'example' => 'text-embedding-v4', 'readOnly' => true],
],
'required' => true,
'title' => '',
'example' => '',
],
'VectorDBConfig' => [
'description' => 'Vector store configuration.'."\n",
'type' => 'object',
'properties' => [
'VectorDBType' => [
'title' => '',
'description' => 'Vector database type. Supports the following values:'."\n"
."\n"
.'* Elasticsearch'."\n"
.'* Milvus'."\n"
.'* Faiss (only supported for document and structured data knowledge bases)'."\n",
'type' => 'string',
'required' => true,
'enumValueTitles' => ['Elasticsearch' => 'Elasticsearch', 'Faiss' => 'Faiss', 'Milvus' => 'Milvus'],
'example' => 'Milvus',
'readOnly' => true,
],
'ConnectionId' => ['title' => '', 'description' => 'Vector database connection ID. For more information about how to obtain the connection ID, see [ListConnections](~~2922801~~).'."\n", 'type' => 'string', 'required' => false, 'example' => 'conn-7y5y******jja7', 'readOnly' => true],
'CollectionName' => ['title' => '', 'description' => 'Vector database table or collection name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'my_collection', 'readOnly' => true],
],
'required' => true,
'title' => '',
'example' => '',
],
'RuntimeId' => ['description' => 'Runtime ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rtime-apje******beaz', 'title' => ''],
'MetaDataConfig' => [
'description' => 'The metadata configurations.'."\n",
'type' => 'object',
'properties' => [
'CustomMetaData' => [
'title' => '',
'description' => 'Custom metadata.'."\n",
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['title' => '', 'description' => 'Metadata field name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'author'],
'ValueType' => ['title' => '', 'description' => 'Metadata field type. Currently, only the String class type is supported.'."\n", 'type' => 'string', 'required' => false, 'example' => 'String'],
],
'required' => false,
'description' => '',
'title' => '',
'example' => '',
],
'required' => false,
'example' => '',
],
],
'required' => false,
'title' => '',
'example' => '',
],
'IndexColumnConfig' => [
'description' => 'Structured knowledge base field column configuration.'."\n",
'type' => 'object',
'properties' => [
'EmbeddingColumns' => [
'title' => '',
'description' => 'Vector retrieval column. The fields in this list will be vectorized and participate in retrieval.'."\n",
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['title' => '', 'description' => 'Column name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'column1', 'readOnly' => true],
],
'required' => false,
'readOnly' => true,
'description' => '',
'title' => '',
'example' => '',
],
'required' => false,
'readOnly' => true,
'example' => '',
],
'ContentColumns' => [
'title' => '',
'description' => 'Content filtering column. The fields in this list support keyword-based retrieval.'."\n",
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['title' => '', 'description' => 'Column name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'column1', 'readOnly' => true],
],
'required' => false,
'readOnly' => true,
'description' => '',
'title' => '',
'example' => '',
],
'required' => false,
'readOnly' => true,
'example' => '',
],
'ColumnDefinitions' => [
'title' => '',
'description' => 'All column names.'."\n",
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['title' => '', 'description' => 'The column name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'column1', 'readOnly' => true],
],
'required' => false,
'readOnly' => true,
'description' => '',
'title' => '',
'example' => '',
],
'required' => false,
'readOnly' => true,
'example' => '',
],
],
'required' => false,
'title' => '',
'example' => '',
],
],
'required' => false,
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'WorkspaceId' => ['description' => 'The workspace ID of the knowledge base.'."\n", 'type' => 'string', 'example' => '478**', 'title' => ''],
'KnowledgeBaseId' => ['description' => 'Knowledge base ID.'."\n", 'type' => 'string', 'example' => 'd-ksicx823d', 'title' => ''],
'RequestId' => ['title' => '', 'description' => 'Request ID'."\n", 'type' => 'string', 'example' => '48E6392E-C3C9-5212-9FAD-13256ABD9AF6'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'CreateKnowledgeBase',
'changeSet' => [
['createdAt' => '2026-01-08T03:49:32.000Z', 'description' => 'Response parameters changed'],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'pailangstudio:CreateKnowledgeBase',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"WorkspaceId\\": \\"478**\\",\\n \\"KnowledgeBaseId\\": \\"d-ksicx823d\\",\\n \\"RequestId\\": \\"48E6392E-C3C9-5212-9FAD-13256ABD9AF6\\"\\n}","type":"json"}]',
],
'CreateKnowledgeBaseJob' => [
'summary' => 'Create a Knowledge Base Task.',
'path' => '/api/v1/langstudio/knowledgebases/{KnowledgeBaseId}/knowledgebasejobs',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATURElearnBVWJJN'],
],
'parameters' => [
[
'name' => 'KnowledgeBaseId',
'in' => 'path',
'schema' => ['description' => 'The ID of the Knowledge Base.'."\n", 'type' => 'string', 'required' => false, 'example' => 'd-ksicx823d', 'title' => ''],
],
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => 'The request body.'."\n",
'type' => 'object',
'properties' => [
'WorkspaceId' => ['description' => 'The ID of the workspace. For information on how to obtain the workspace ID, see ListWorkspaces.[](~~449124~~)'."\n", 'type' => 'string', 'required' => true, 'example' => '478**', 'title' => ''],
'Accessibility' => [
'description' => 'Workspace visibility. Possible values are:'."\n"
."\n"
.'* PRIVATE: In this workspace, it is visible only to you and the administrator.'."\n"
.'* PUBLIC: This workspace is visible to all users.'."\n",
'type' => 'string',
'required' => false,
'example' => 'PUBLIC',
'default' => 'PUBLIC',
'enum' => ['PUBLIC', 'PRIVATE'],
'title' => '',
],
'Description' => ['description' => 'Knowledge base task description.'."\n", 'type' => 'string', 'required' => false, 'example' => 'This is a description of the knowledge base job.', 'title' => ''],
'JobAction' => ['description' => 'The type of the task operation.'."\n"
."\n"
.'* SyncIndex: updates the knowledge base index'."\n", 'type' => 'string', 'required' => false, 'example' => 'SyncIndex', 'title' => ''],
'MaxRunningTimeInSeconds' => ['description' => 'The maximum running time for the task, in seconds.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '86400', 'title' => ''],
'ResourceId' => ['description' => 'The resource group ID. This field being empty or public-cluster indicates a public resource.'."\n", 'type' => 'string', 'required' => false, 'example' => 'quota89**76', 'title' => ''],
'EcsSpecs' => [
'description' => 'Task Run Resource Configuration List Documentation and structured Knowledge Base contain only one Element and the Type is Worker. Images and Videos Knowledge Base contain two Elements and the Types are Head and Worker.'."\n",
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Type' => ['title' => '', 'description' => 'The type of the node. Possible values are Head and Worker.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Worker', 'readOnly' => true, 'default' => 'Worker'],
'InstanceType' => ['title' => '', 'description' => 'The name of the instance type. Use of public resources must be filled in.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ecs.c6.large', 'readOnly' => true],
'PodCount' => ['title' => '', 'description' => 'The number of replicas.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'readOnly' => true],
'CPU' => ['title' => '', 'description' => 'The number of CPU cores. You must specify the resource quota to use.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'readOnly' => true],
'GPU' => ['title' => '', 'description' => 'The number of GPU cards. You must specify the resource quota to use.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'readOnly' => true],
'Memory' => ['title' => '', 'description' => 'The memory size, in GB. You must specify the resource quota to use.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '8', 'readOnly' => true],
'SharedMemory' => ['title' => '', 'description' => 'The Shared Memory Capacity. Unit: GB. You must specify the resource quota to use.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '16', 'readOnly' => true],
'GPUType' => ['title' => '', 'description' => 'GPU Class'."\n", 'type' => 'string', 'required' => false, 'example' => '16', 'readOnly' => true],
'Driver' => ['title' => '', 'description' => 'The version of the GPU driver.'."\n", 'type' => 'string', 'required' => false, 'example' => '535.161.08', 'readOnly' => true],
],
'required' => false,
'description' => '',
'title' => '',
'example' => '',
],
'required' => false,
'title' => '',
'example' => '',
],
'UserVpc' => [
'description' => 'Task Run VPC Info.'."\n",
'type' => 'object',
'properties' => [
'VpcId' => ['title' => 'VPC ID', 'description' => 'VPC ID'."\n", 'type' => 'string', 'required' => false, 'example' => 'vpc-wz90****5v23', 'readOnly' => true],
'VSwitchId' => ['title' => '', 'description' => 'The vSwitch IDs.'."\n", 'type' => 'string', 'required' => false, 'example' => 'vsw-wz9r****ng10', 'readOnly' => true],
'SecurityGroupId' => ['title' => '', 'description' => 'The ID of a security group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'sg-wz9i****1129', 'readOnly' => true],
],
'required' => false,
'title' => '',
'example' => '',
],
'EmbeddingConfig' => [
'description' => 'Index Configuration.'."\n",
'type' => 'object',
'properties' => [
'BatchSize' => ['title' => '', 'description' => 'Index batch size. The knowledge base for documentation and structured data types is effective.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '8', 'readOnly' => true],
'Concurrency' => ['title' => '', 'description' => 'Index concurrency. Image and video type knowledge base is valid.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '200', 'minimum' => '1', 'example' => '1', 'readOnly' => true],
],
'required' => false,
'title' => '',
'example' => '',
],
],
'required' => false,
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'KnowledgeBaseJobId' => ['description' => 'Knowledge Base Task ID.'."\n", 'type' => 'string', 'example' => 'kbjob-9mn******1z54', 'title' => ''],
'RequestId' => ['title' => '', 'description' => 'Request ID.'."\n", 'type' => 'string', 'example' => '963BD7F9-0C02-5594-9550-BCC6DD43E3C0'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'CreateKnowledgeBaseJob',
'changeSet' => [
['createdAt' => '2026-01-08T03:49:32.000Z', 'description' => 'Response parameters changed'],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'pailangstudio:CreateKnowledgeBaseJob',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"KnowledgeBaseJobId\\": \\"kbjob-9mn******1z54\\",\\n \\"RequestId\\": \\"963BD7F9-0C02-5594-9550-BCC6DD43E3C0\\"\\n}","type":"json"}]',
],
'CreateRuntime' => [
'path' => '/api/v1/langstudio/runtimes',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATURElearnBVWJJN'],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => 'Request body.',
'type' => 'object',
'properties' => [
'Accessibility' => [
'description' => 'Workspace visibility. Valid values:'."\n"
."\n"
.'- PRIVATE: Visible only to you and administrators in this workspace.'."\n"
."\n"
.'- PUBLIC: Visible to everyone in this workspace.',
'type' => 'string',
'example' => 'PRIVATE',
'default' => 'PUBLIC',
'enum' => ['PUBLIC', 'PRIVATE'],
'required' => false,
'title' => '',
],
'WorkspaceId' => ['description' => 'Workspace ID. For more information about how to obtain a workspace ID, see [ListWorkspaces](~~449124~~).', 'type' => 'string', 'required' => false, 'example' => '174***', 'title' => ''],
'RuntimeName' => ['description' => 'Runtime name. Requirements:'."\n"
."\n"
.'- Can contain only letters, digits, and underscores (\\_).'."\n"
."\n"
.'- Must start with a letter.'."\n"
."\n"
.'- Must be 1 to 256 characters long.', 'type' => 'string', 'required' => false, 'example' => 'dev01', 'title' => ''],
'RuntimeType' => [
'description' => 'Runtime type. Valid value:'."\n"
."\n"
.'- DSW: PAI-DSW instance.',
'type' => 'string',
'example' => 'DSW',
'default' => 'DSW',
'enum' => ['DSW'],
'required' => false,
'title' => '',
],
'EcsSpec' => [
'description' => 'ECS resource configuration.',
'type' => 'object',
'properties' => [
'InstanceType' => ['description' => 'Instance type.', 'type' => 'string', 'readOnly' => true, 'title' => '', 'required' => false, 'example' => 'ecs.c6.large'],
'GPUType' => ['description' => 'GPU type. Valid values:'."\n"
."\n"
.'- V100'."\n"
."\n"
.'- A100'."\n"
."\n"
.'- T4'."\n"
."\n"
.'- A10'."\n"
."\n"
.'- P100', 'type' => 'string', 'readOnly' => true, 'title' => '', 'required' => false, 'example' => 'V100'],
'CPU' => ['description' => 'Number of CPUs.', 'type' => 'integer', 'format' => 'int32', 'readOnly' => true, 'title' => '', 'required' => false, 'example' => '4'],
'GPU' => ['description' => 'Number of GPUs.', 'type' => 'integer', 'format' => 'int32', 'readOnly' => true, 'title' => '', 'required' => false, 'example' => '0'],
'Memory' => ['description' => 'Memory size in GB.', 'type' => 'integer', 'format' => 'int32', 'readOnly' => true, 'title' => '', 'required' => false, 'example' => '8'],
'SharedMemory' => ['description' => 'Shared memory in GB.', 'type' => 'integer', 'format' => 'int32', 'readOnly' => true, 'title' => '', 'required' => false, 'example' => '8'],
'Driver' => ['description' => 'GPU driver version.', 'type' => 'string', 'readOnly' => true, 'title' => '', 'required' => false, 'example' => '535.161.08'],
],
'required' => false,
'title' => '',
'example' => '',
],
'ResourceId' => ['description' => 'Resource quota ID.', 'type' => 'string', 'required' => false, 'example' => 'quota18******zv9', 'title' => ''],
'UserVpc' => [
'description' => 'User VPC configuration.',
'type' => 'object',
'properties' => [
'VpcId' => ['title' => 'VPC ID', 'description' => 'VPC ID.', 'type' => 'string', 'readOnly' => true, 'required' => false, 'example' => 'vpc-wz90****5v23'],
'VSwitchId' => ['description' => 'vSwitch ID.', 'type' => 'string', 'readOnly' => true, 'title' => '', 'required' => false, 'example' => 'vsw-wz9r****ng10'],
'SecurityGroupId' => ['description' => 'Security group ID.', 'type' => 'string', 'readOnly' => true, 'title' => '', 'required' => false, 'example' => 'sg-wz9i****1129'],
'DefaultRoute' => ['description' => 'Default route.', 'type' => 'string', 'readOnly' => true, 'title' => '', 'required' => false, 'example' => 'eth0'],
'ExtendedCIDRs' => [
'title' => '',
'description' => 'Extended CIDR blocks.',
'type' => 'array',
'items' => ['description' => 'Extended CIDR block.', 'type' => 'string', 'readOnly' => true, 'required' => false, 'example' => '172.16.1.0/24', 'title' => ''],
'required' => false,
'readOnly' => true,
'example' => '',
],
],
'required' => false,
'title' => '',
'example' => '',
],
'Envs' => [
'description' => 'Environment variables.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['description' => 'Environment key.', 'type' => 'string', 'readOnly' => true, 'title' => '', 'required' => false, 'example' => 'testKey1'],
'Value' => ['description' => 'Environment value.', 'type' => 'string', 'readOnly' => true, 'title' => '', 'required' => false, 'example' => 'testValue1'],
],
'required' => false,
'description' => '',
'title' => '',
'example' => '',
],
'required' => false,
'title' => '',
'example' => '',
],
'Labels' => [
'description' => 'Labels.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['description' => 'Tag key.', 'type' => 'string', 'readOnly' => true, 'title' => '', 'required' => false, 'example' => 'testKey1'],
'Value' => ['description' => 'Tag value.', 'type' => 'string', 'readOnly' => true, 'title' => '', 'required' => false, 'example' => 'testValue1'],
],
'required' => false,
'description' => '',
'title' => '',
'example' => '',
],
'required' => false,
'title' => '',
'example' => '',
],
'DataSources' => [
'description' => 'Mounted data sources.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'DatasetId' => ['description' => 'Dataset ID. Specify either this or Uri.', 'type' => 'string', 'readOnly' => true, 'title' => '', 'required' => false, 'example' => 'd-umns******zij4szhc'],
'Uri' => ['description' => 'OSS path of the data source. Specify either this or DatasetId.', 'type' => 'string', 'readOnly' => true, 'title' => '', 'required' => false, 'example' => 'oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/langstudio/source/'],
'MountPath' => ['description' => 'Mount path.', 'type' => 'string', 'readOnly' => true, 'title' => '', 'required' => false, 'example' => '/mnt/data'],
],
'required' => false,
'description' => '',
'title' => '',
'example' => '',
],
'required' => false,
'title' => '',
'example' => '',
],
'CredentialConfig' => [
'description' => 'Credential configuration.',
'type' => 'object',
'properties' => [
'EnableCredentialInject' => ['description' => 'Whether to enable credential injection.', 'type' => 'boolean', 'readOnly' => true, 'title' => '', 'required' => false, 'example' => 'true'],
'AliyunEnvRoleKey' => ['title' => 'AliyunEnvRoleKey', 'description' => 'Environment variable role key.', 'type' => 'string', 'readOnly' => true, 'required' => false, 'example' => '0'],
'CredentialConfigItems' => [
'title' => '',
'description' => 'List of credential configurations.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['title' => 'Key', 'description' => 'Key that identifies the configuration.', 'type' => 'string', 'readOnly' => true, 'required' => false, 'example' => '0'],
'Type' => ['title' => 'Type', 'description' => 'Configuration type. Valid values:'."\n"
."\n"
.'- Role: Role assumption'."\n"
."\n"
.'- RoleChain: Role chain assumption', 'type' => 'string', 'readOnly' => true, 'required' => false, 'example' => 'Role'],
'Roles' => [
'title' => '',
'description' => 'List of configured roles.',
'type' => 'array',
'items' => [
'description' => 'Role information.',
'type' => 'object',
'properties' => [
'AssumeRoleFor' => ['title' => 'AssumeRoleFor', 'description' => 'Entity that assumes the role.', 'type' => 'string', 'readOnly' => true, 'required' => false, 'example' => '1095******785714'],
'RoleType' => ['description' => 'Type of assumed role. Valid values:'."\n"
."\n"
.'- service: Assumed by a service'."\n"
."\n"
.'- user: Assumed by a regular user account', 'type' => 'string', 'readOnly' => true, 'title' => '', 'required' => false, 'example' => 'service'],
'RoleArn' => ['description' => 'Role ARN.', 'type' => 'string', 'readOnly' => true, 'title' => '', 'required' => false, 'example' => 'acs:ram::1095******785714:role/testrole'],
],
'required' => false,
'readOnly' => true,
'title' => '',
'example' => '',
],
'required' => false,
'readOnly' => true,
'example' => '',
],
],
'required' => false,
'readOnly' => true,
'description' => '',
'title' => '',
'example' => '',
],
'required' => false,
'readOnly' => true,
'example' => '',
],
],
'required' => false,
'title' => '',
'example' => '',
],
'RunTimeout' => ['description' => 'Timeout for a single test run on the runtime, in seconds.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '180', 'title' => ''],
'WorkDir' => ['description' => 'OSS path of the working directory.', 'type' => 'string', 'required' => false, 'example' => 'oss://mybucket.oss-cn-hangzhou-internal.aliyuncs.com/workdir/', 'title' => ''],
'AutoUpdateImage' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Response.',
'type' => 'object',
'properties' => [
'RuntimeId' => ['description' => 'Runtime ID.', 'type' => 'string', 'example' => 'rtime-apje******beaz', 'title' => ''],
'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '963BD7F9-0C02-5594-9550-BCC6DD43E3C0', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'title' => 'CreateRuntime',
'summary' => 'Creates a runtime.',
'description' => 'Before using this API, make sure you fully understand the billing method and [pricing](https://help.aliyun.com/zh/pai/dsw-billing-description?spm=a2c4g.11186623.help-menu-30347.d_1_1_3.fb4453d9l200bE) for PAI-DSW.',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'pailangstudio:CreateRuntime',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RuntimeId\\": \\"rtime-apje******beaz\\",\\n \\"RequestId\\": \\"963BD7F9-0C02-5594-9550-BCC6DD43E3C0\\"\\n}","type":"json"}]',
],
'CreateSnapshot' => [
'summary' => 'Create a snapshot.',
'path' => '/api/v1/langstudio/snapshots',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATURElearnBVWJJN'],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => 'Request body.',
'type' => 'object',
'properties' => [
'Accessibility' => [
'description' => 'Workspace visibility. Valid values:'."\n"
.'- PRIVATE: Visible only to you and administrators in this workspace.'."\n"
.'- PUBLIC: Visible to everyone in this workspace.',
'type' => 'string',
'required' => false,
'example' => 'PRIVATE',
'default' => 'PUBLIC',
'enum' => ['PUBLIC', 'PRIVATE'],
'title' => '',
],
'CreationType' => [
'description' => 'Snapshot creation type. Valid values:'."\n"
.'* ManualCreated: manual creation'."\n"
.'* DeploymentAutoCreated: automatic creation by service deployment'."\n"
.'* EvaluationAutoCreated: automatic creation by evaluation job',
'type' => 'string',
'required' => false,
'example' => 'ManualCreated',
'enum' => ['ManualCreated', 'DeploymentAutoCreated', 'EvaluationAutoCreated'],
'title' => '',
],
'SnapshotName' => ['description' => 'Snapshot name. Requirements:'."\n"
.'* Can contain only letters, digits, and underscores (_)'."\n"
.'* Must start with a letter'."\n"
.'* Length must be 1 to 256 characters', 'type' => 'string', 'required' => false, 'example' => 'snapshot01', 'title' => ''],
'Description' => ['description' => 'Description of the snapshot.', 'type' => 'string', 'required' => false, 'example' => 'This is description', 'title' => ''],
'WorkDir' => ['description' => 'OSS working directory for storing the snapshot.', 'type' => 'string', 'required' => false, 'example' => 'oss://mybucket.oss-cn-hangzhou.aliyuncs.com/workdir', 'title' => ''],
'WorkspaceId' => ['description' => 'Workspace ID. For information about how to obtain a workspace ID, see [ListWorkspaces](~~449124~~).', 'type' => 'string', 'required' => false, 'example' => '174***', 'title' => ''],
'SnapshotResourceType' => [
'description' => 'Snapshot resource type. Valid values:'."\n"
.'* Flow: pipeline',
'type' => 'string',
'required' => false,
'example' => 'Flow',
'enum' => ['Flow'],
'title' => '',
],
'SnapshotResourceId' => ['description' => 'Snapshot resource ID.', 'type' => 'string', 'required' => false, 'example' => 'flow-asfg******123', 'title' => ''],
'SourceStoragePath' => ['description' => 'Create a snapshot from source files under the specified OSS folder.', 'type' => 'string', 'required' => false, 'example' => 'oss://mybucket.oss-cn-hangzhou.aliyuncs.com/path/to/snapshot/source', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Return Result.',
'type' => 'object',
'properties' => [
'SnapshotId' => ['description' => 'Snapshot ID.', 'type' => 'string', 'example' => 'snap-asfg******123', 'title' => ''],
'RequestId' => ['title' => 'Request ID', 'description' => 'Request ID', 'type' => 'string', 'example' => '963BD7F9-0C02-5594-9550-BCC6DD43E3C0'],
],
'title' => '',
'example' => '',
],
],
],
'title' => 'Create Snapshot',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'pailangstudio:CreateSnapshot',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"SnapshotId\\": \\"snap-asfg******123\\",\\n \\"RequestId\\": \\"963BD7F9-0C02-5594-9550-BCC6DD43E3C0\\"\\n}","type":"json"}]',
],
'DeleteDeployment' => [
'summary' => 'Delete a deployment job.',
'path' => '/api/v1/langstudio/deployments/{DeploymentId}',
'methods' => ['delete'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATURElearnBVWJJN'],
],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'query',
'schema' => ['description' => 'Workspace ID. For information about how to obtain a workspace ID, see [ListWorkspaces](~~449124~~). ', 'type' => 'string', 'required' => false, 'example' => '478***', 'title' => ''],
],
[
'name' => 'DeploymentId',
'in' => 'path',
'schema' => ['description' => 'Deployment job ID. ', 'type' => 'string', 'required' => false, 'example' => 'dploy-asdf******1234', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Return Result. ',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Request ID ', 'description' => 'Request ID. ', 'type' => 'string', 'example' => '963BD7F9-0C02-5594-9550-BCC6DD43E3C0'],
],
'title' => '',
'example' => '',
],
],
],
'title' => 'Delete Deployment Job ',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'pailangstudio:DeleteDeployment',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"963BD7F9-0C02-5594-9550-BCC6DD43E3C0\\"\\n}","type":"json"}]',
],
'DeleteKnowledgeBase' => [
'summary' => 'Delete knowledge base.',
'path' => '/api/v1/langstudio/knowledgebases/{KnowledgeBaseId}',
'methods' => ['delete'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATURElearnBVWJJN'],
],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'query',
'schema' => ['description' => 'The ID of the workspace.'."\n", 'type' => 'string', 'required' => true, 'example' => '478***', 'title' => ''],
],
[
'name' => 'KnowledgeBaseId',
'in' => 'path',
'schema' => ['description' => 'The ID of the Knowledge Base.'."\n", 'type' => 'string', 'required' => true, 'example' => 'd-nacr******sxd2', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'Request ID'."\n", 'type' => 'string', 'example' => 'C25324E3-18E6-50D8-9026-16D74AAEEB26'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'DeleteKnowledgeBase',
'changeSet' => [
['createdAt' => '2026-01-08T03:49:32.000Z', 'description' => 'Response parameters changed'],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'pailangstudio:DeleteKnowledgeBase',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C25324E3-18E6-50D8-9026-16D74AAEEB26\\"\\n}","type":"json"}]',
],
'DeleteKnowledgeBaseJob' => [
'summary' => 'Deletes a knowledge base task.',
'path' => '/api/v1/langstudio/knowledgebases/{KnowledgeBaseId}/knowledgebasejobs/{KnowledgeBaseJobId}',
'methods' => ['delete'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATURElearnBVWJJN'],
],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'query',
'schema' => ['description' => 'The ID of the workspace where the knowledge base resides.', 'type' => 'string', 'required' => true, 'example' => '478***', 'title' => ''],
],
[
'name' => 'KnowledgeBaseId',
'in' => 'path',
'schema' => ['description' => 'The ID of the knowledge base.', 'type' => 'string', 'required' => true, 'example' => 'd-nacr******sxd2', 'title' => ''],
],
[
'name' => 'KnowledgeBaseJobId',
'in' => 'path',
'schema' => ['description' => 'The ID of the knowledge base task.', 'type' => 'string', 'required' => true, 'example' => 'kbjob-9m******54', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '48E6392E-C3C9-5212-9FAD-13256ABD9AF6'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"48E6392E-C3C9-5212-9FAD-13256ABD9AF6\\"\\n}","type":"json"}]',
'title' => 'Delete a knowledge base task',
'changeSet' => [
['createdAt' => '2026-01-08T03:49:32.000Z', 'description' => 'Response parameters changed'],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'pailangstudio:DeleteKnowledgeBaseJob',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'DeleteRuntime' => [
'summary' => 'Delete a runtime.',
'path' => '/api/v1/langstudio/runtimes/{RuntimeId}',
'methods' => ['delete'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATURElearnBVWJJN'],
],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'query',
'schema' => ['description' => 'The ID of the DataWorks workspace. You can call [ListWorkspaces](~~449124~~) to obtain the workspace ID.'."\n", 'type' => 'string', 'required' => false, 'example' => '478**', 'title' => ''],
],
[
'name' => 'RuntimeId',
'in' => 'path',
'schema' => ['description' => 'Runtime ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rtime-apje******beaz', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The information returned.'."\n",
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The Request ID.'."\n", 'type' => 'string', 'example' => '963BD7F9-0C02-5594-9550-BCC6DD43E3C0'],
],
'title' => '',
'example' => '',
],
],
],
'title' => 'DeleteRuntime',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'pailangstudio:DeleteRuntime',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"963BD7F9-0C02-5594-9550-BCC6DD43E3C0\\"\\n}","type":"json"}]',
],
'DeleteSnapshot' => [
'summary' => 'Delete a snapshot.',
'path' => '/api/v1/langstudio/snapshots/{SnapshotId}',
'methods' => ['delete'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATURElearnBVWJJN'],
],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'query',
'schema' => ['description' => 'Workspace ID. For information about how to obtain a workspace ID, see [ListWorkspaces](~~449124~~).', 'type' => 'string', 'required' => false, 'example' => '478***', 'title' => ''],
],
[
'name' => 'SnapshotId',
'in' => 'path',
'schema' => ['description' => 'Snapshot ID.', 'type' => 'string', 'required' => false, 'example' => 'snap-asfg******123', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Return Result.',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Request ID', 'description' => 'Request ID', 'type' => 'string', 'example' => '963BD7F9-0C02-5594-9550-BCC6DD43E3C0'],
],
'title' => '',
'example' => '',
],
],
],
'title' => 'Delete Snapshot',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'pailangstudio:DeleteSnapshot',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"963BD7F9-0C02-5594-9550-BCC6DD43E3C0\\"\\n}","type":"json"}]',
],
'GetDeployment' => [
'summary' => 'Retrieve the details of a deployment job.',
'path' => '/api/v1/langstudio/deployments/{DeploymentId}',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATURElearnBVWJJN'],
],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'query',
'schema' => ['description' => 'Workspace ID. For information about how to obtain a workspace ID, see [ListWorkspaces](~~449124~~). ', 'type' => 'string', 'required' => false, 'example' => '478***', 'title' => ''],
],
[
'name' => 'DeploymentId',
'in' => 'path',
'schema' => ['description' => 'Deployment task ID. ', 'type' => 'string', 'required' => false, 'example' => 'dploy-asdf******1234', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Return Result. ',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Request ID ', 'description' => 'The request ID. ', 'type' => 'string', 'example' => '963BD7F9-0C02-5594-9550-BCC6DD43E3C0'],
'WorkspaceId' => ['description' => 'The workspace ID. ', 'type' => 'string', 'example' => '478***', 'title' => ''],
'Accessibility' => ['description' => 'The workspace visibility. Valid values: '."\n"
.'- PRIVATE: The resource is visible only to you and administrators in this workspace. '."\n"
.'- PUBLIC: The resource is visible to all users in this workspace. ', 'type' => 'string', 'example' => 'PRIVATE', 'title' => ''],
'Creator' => ['description' => 'Creator ID. ', 'type' => 'string', 'example' => '2003******4844', 'title' => ''],
'GmtCreateTime' => ['description' => 'Creation Time. ', 'type' => 'string', 'example' => '2025-09-24T07:33:53Z', 'title' => ''],
'GmtModifiedTime' => ['description' => 'Updated At. ', 'type' => 'string', 'example' => '2025-09-24T08:58:35Z', 'title' => ''],
'DeploymentId' => ['description' => 'The ID of the deployment job. ', 'type' => 'string', 'example' => 'dploy-asdf******1234', 'title' => ''],
'DeploymentStatus' => ['description' => 'Task Status. Valid values: '."\n"
.'* Creating: Creating. '."\n"
.'* Failed: Deployment failed. '."\n"
.'* Stopping: Stopping. '."\n"
.'* Waiting: Waiting. '."\n"
.'* Starting: Starting. '."\n"
.'* Running: Running. '."\n"
.'* Pending: Pending. '."\n"
.'* WaitForConfirm: Waiting for confirmation. '."\n"
.'* Canceled: Canceled. '."\n"
.'* Succeed: Succeeded. ', 'type' => 'string', 'example' => 'Succeed', 'title' => ''],
'OperationType' => ['description' => 'Operation Type. Valid values: '."\n"
.'* Create: Create a new service. '."\n"
.'* Update: Update an existing service. ', 'type' => 'string', 'example' => 'Create', 'title' => ''],
'ResourceType' => ['description' => 'The resource type to be deployed. Valid values: '."\n"
.'* Flow: A pipeline project '."\n"
.'* Code: A Code project', 'type' => 'string', 'example' => 'Flow', 'title' => ''],
'ResourceId' => ['description' => 'The ID of the resource to be deployed. ', 'type' => 'string', 'example' => 'flow-asdf******123', 'title' => ''],
'ResourceSnapshotId' => ['description' => 'The snapshot ID of the resource to be deployed. If this parameter is provided, the system deploys directly based on this snapshot. If not provided, the system creates a new snapshot of the resource before deployment. ', 'type' => 'string', 'example' => 'snap-asfg******123', 'title' => ''],
'ServiceName' => ['description' => 'Service Name. Format requirements: '."\n"
.'* Supports lowercase letters, digits, and underscores. '."\n"
.'* Must start with a letter. '."\n"
.'* Length must be 1–45 characters. ', 'type' => 'string', 'example' => 'myservice01', 'title' => ''],
'Description' => ['description' => 'The service description. ', 'type' => 'string', 'example' => 'This is description', 'title' => ''],
'WorkDir' => ['description' => 'The OSS working directory for the service. It stores runtime logs, conversation history, and other data. ', 'type' => 'string', 'example' => 'oss://mybucket.oss-cn-hangzhou-internal.aliyuncs.com/workdir/', 'title' => ''],
'EnableTrace' => ['description' => 'Indicates whether Tracing Analysis is enabled. ', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'ChatHistoryConfig' => [
'description' => 'Chat history configuration. ',
'type' => 'object',
'properties' => [
'StorageType' => [
'title' => 'Storage Type ',
'description' => 'The storage class. Valid values: '."\n"
.'* LOCAL: Chat history is stored in a local SQLite file. This option does not support multi-instance deployment. '."\n"
.'* OSS: Chat history is stored in a specific path under the service OSS workspace path. '."\n"
.'* RDS: Chat history is stored in an RDS Table, and an RDS connection must be specified. ',
'type' => 'string',
'example' => 'RDS',
'readOnly' => true,
'enum' => ['LOCAL', 'RDS', 'OSS'],
],
'ConnectionName' => ['title' => 'Connection Name ', 'description' => 'The connection name. This parameter is required when the chat history storage type is RDS. ', 'type' => 'string', 'example' => 'rdsconnection', 'readOnly' => true],
],
'title' => '',
'example' => '',
],
'ContentModerationConfig' => [
'description' => 'Content moderation configuration. ',
'type' => 'object',
'properties' => [
'EnableInputModeration' => ['title' => 'Enable input content moderation ', 'description' => 'Indicates whether to enable security review for input. ', 'type' => 'boolean', 'example' => 'true', 'readOnly' => true],
'EnableOutputModeration' => ['title' => 'Enable output content moderation ', 'description' => 'Indicates whether to enable content moderation for output. ', 'type' => 'boolean', 'example' => 'true', 'readOnly' => true],
'StreamingModerationThreshold' => ['title' => 'Cache size for streaming output content submitted for moderation ', 'description' => 'Cache size for streaming output content submitted for moderation. The default value is 5. ', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'readOnly' => true],
],
'title' => '',
'example' => '',
],
'DeploymentConfig' => ['description' => 'Deployment configuration. For details, see [Deployment Configuration](https://help.aliyun.com/zh/pai/user-guide/parameters-of-model-services) in PAI-EAS documentation. ', 'type' => 'string', 'example' => '{\\"metadata\\":{\\"name\\":\\"langstudio_2026******3848_jro7\\",\\"instance\\":1,\\"workspace_id\\":\\"285***\\",\\"enable_webservice\\":false},\\"cloud\\":{\\"computing\\":{\\"instances\\":[{\\"type\\":\\"ecs.g7.xlarge\\"}]},\\"networking\\":{\\"vpc_id\\":\\"vpc-bp1obprt******4bzo00d\\",\\"vswitch_id\\":\\"vsw-bp1p6i36k******pmfhw8\\",\\"security_group_id\\":\\"sg-bp1djud4******zecl5a\\"}}}', 'title' => ''],
'DeploymentStages' => [
'description' => 'Stage information of the deployment. ',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Stage' => ['title' => 'Stage ', 'description' => 'Deployment stage. ', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'readOnly' => true],
'StageName' => ['title' => 'Stage Name ', 'description' => 'Deployment stage name. ', 'type' => 'string', 'example' => 'PrepareSnapshot', 'readOnly' => true],
'Description' => ['title' => 'Description ', 'description' => 'Deployment stage description. ', 'type' => 'string', 'example' => 'Create snapshot for deployment', 'readOnly' => true],
'GmtStartTime' => ['title' => 'Start Time ', 'description' => 'Start Time. ', 'type' => 'string', 'example' => '2025-09-23T10:25:38+08:00', 'readOnly' => true],
'GmtEndTime' => ['title' => 'End Time', 'description' => 'End time. ', 'type' => 'string', 'example' => '2025-09-23T10:35:38+08:00', 'readOnly' => true],
'StageStatus' => ['title' => 'Stage Status ', 'description' => 'Deployment stage status. Valid values: '."\n"
.'* NotStarted: Not started. '."\n"
.'* WaitForConfirm: Waiting for confirmation. '."\n"
.'* Waiting: Waiting. '."\n"
.'* Creating: Creating. '."\n"
.'* Running: Running. '."\n"
.'* Succeed: Succeeded. '."\n"
.'* Failed: Failed. '."\n"
.'* Canceled: Canceled. ', 'type' => 'string', 'example' => 'Running', 'readOnly' => true],
'ErrorMessage' => ['title' => 'Error Message ', 'description' => 'Error message. ', 'type' => 'string', 'example' => 'This is error', 'readOnly' => true],
'StageInfo' => ['title' => 'Stage Information ', 'description' => 'Deployment stage information. ', 'type' => 'string', 'example' => '{\\"SnapshotId\\":\\"snap-i8j29kw8nubqb0hotn\\"}', 'readOnly' => true],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'ErrorMessage' => ['description' => 'Error message. ', 'type' => 'string', 'example' => 'This is error message', 'title' => ''],
'AutoApproval' => ['description' => 'Indicates whether deployment confirmation is automatically skipped. ', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'title' => 'Get Deployment Task Details ',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'pailangstudio:GetDeployment',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"963BD7F9-0C02-5594-9550-BCC6DD43E3C0\\",\\n \\"WorkspaceId\\": \\"478***\\",\\n \\"Accessibility\\": \\"PRIVATE\\",\\n \\"Creator\\": \\"2003******4844\\",\\n \\"GmtCreateTime\\": \\"2025-09-24T07:33:53Z\\",\\n \\"GmtModifiedTime\\": \\"2025-09-24T08:58:35Z\\",\\n \\"DeploymentId\\": \\"dploy-asdf******1234\\",\\n \\"DeploymentStatus\\": \\"Succeed\\",\\n \\"OperationType\\": \\"Create\\",\\n \\"ResourceType\\": \\"Flow\\",\\n \\"ResourceId\\": \\"flow-asdf******123\\",\\n \\"ResourceSnapshotId\\": \\"snap-asfg******123\\",\\n \\"ServiceName\\": \\"myservice01\\",\\n \\"Description\\": \\"This is description\\",\\n \\"WorkDir\\": \\"oss://mybucket.oss-cn-hangzhou-internal.aliyuncs.com/workdir/\\",\\n \\"EnableTrace\\": true,\\n \\"ChatHistoryConfig\\": {\\n \\"StorageType\\": \\"RDS\\",\\n \\"ConnectionName\\": \\"rdsconnection\\"\\n },\\n \\"ContentModerationConfig\\": {\\n \\"EnableInputModeration\\": true,\\n \\"EnableOutputModeration\\": true,\\n \\"StreamingModerationThreshold\\": 5\\n },\\n \\"DeploymentConfig\\": \\"{\\\\\\\\\\\\\\"metadata\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"langstudio_2026******3848_jro7\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"instance\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"workspace_id\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"285***\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"enable_webservice\\\\\\\\\\\\\\":false},\\\\\\\\\\\\\\"cloud\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"computing\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"instances\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"ecs.g7.xlarge\\\\\\\\\\\\\\"}]},\\\\\\\\\\\\\\"networking\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"vpc_id\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"vpc-bp1obprt******4bzo00d\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"vswitch_id\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"vsw-bp1p6i36k******pmfhw8\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"security_group_id\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"sg-bp1djud4******zecl5a\\\\\\\\\\\\\\"}}}\\",\\n \\"DeploymentStages\\": [\\n {\\n \\"Stage\\": 1,\\n \\"StageName\\": \\"PrepareSnapshot\\",\\n \\"Description\\": \\"Create snapshot for deployment\\",\\n \\"GmtStartTime\\": \\"2025-09-23T10:25:38+08:00\\",\\n \\"GmtEndTime\\": \\"2025-09-23T10:35:38+08:00\\",\\n \\"StageStatus\\": \\"Running\\",\\n \\"ErrorMessage\\": \\"This is error\\",\\n \\"StageInfo\\": \\"{\\\\\\\\\\\\\\"SnapshotId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"snap-i8j29kw8nubqb0hotn\\\\\\\\\\\\\\"}\\"\\n }\\n ],\\n \\"ErrorMessage\\": \\"This is error message\\",\\n \\"AutoApproval\\": true\\n}","type":"json"}]',
],
'GetKnowledgeBase' => [
'summary' => 'Get knowledge base.',
'path' => '/api/v1/langstudio/knowledgebases/{KnowledgeBaseId}',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATURElearnBVWJJN'],
],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'query',
'schema' => ['description' => 'The ID of the DataWorks workspace. You can call [ListWorkspaces](~~449124~~) to obtain the workspace ID.'."\n", 'type' => 'string', 'required' => true, 'example' => '478**', 'title' => ''],
],
[
'name' => 'KnowledgeBaseId',
'in' => 'path',
'schema' => ['description' => 'Knowledge Base ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'd-ksicx823d', 'title' => ''],
],
[
'name' => 'VersionName',
'in' => 'query',
'schema' => ['description' => 'Knowledge Base Version. Default is v1.'."\n", 'type' => 'string', 'required' => false, 'example' => 'v1', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '963BD7F9-0C02-5594-9550-BCC6DD43E3C0'],
'WorkspaceId' => ['description' => 'The ID of the workspace where the knowledge base resides.'."\n", 'type' => 'string', 'example' => '478**', 'title' => ''],
'Accessibility' => ['description' => 'Workspace visibility, possible values are:'."\n"
."\n"
.'* PRIVATE: In this workspace, visible only to you and administrators.'."\n"
.'* PUBLIC: In this workspace, visible to everyone.'."\n", 'type' => 'string', 'example' => 'PRIVATE', 'title' => ''],
'GmtCreateTime' => ['description' => 'Knowledge base creation time (UTC).'."\n", 'type' => 'string', 'example' => '2024-12-15T14:46:23Z', 'title' => ''],
'GmtModifiedTime' => ['description' => 'Knowledge base modification time (UTC).'."\n", 'type' => 'string', 'example' => '2025-12-18T19:32:58Z', 'title' => ''],
'Name' => ['description' => 'Knowledge base name.'."\n", 'type' => 'string', 'example' => 'myName', 'title' => ''],
'KnowledgeBaseId' => ['description' => 'Knowledge base ID.'."\n", 'type' => 'string', 'example' => 'd-ksicx823d', 'title' => ''],
'Description' => ['description' => 'Knowledge base description.'."\n", 'type' => 'string', 'example' => 'This is a description of the knowledge base.', 'title' => ''],
'KnowledgeBaseType' => ['description' => 'Knowledge base type.'."\n"
."\n"
.'* TEXT: Document.'."\n"
.'* STRUCTURED: Structured data.'."\n"
.'* IMAGE: Picture.'."\n"
.'* VIDEO: Video.'."\n", 'type' => 'string', 'example' => 'TEXT', 'title' => ''],
'DatasetId' => ['description' => 'The ID of the dataset corresponding to the knowledge base.'."\n", 'type' => 'string', 'example' => 'd-cupbwkk5us9xpjz870', 'title' => ''],
'DataSources' => [
'description' => 'Data source.'."\n",
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Uri' => ['title' => '', 'description' => 'Storage path for the source file.'."\n", 'type' => 'string', 'example' => 'oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/langstudio/source/', 'readOnly' => true],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'OutputDir' => ['description' => 'Storage path for the output data.'."\n", 'type' => 'string', 'example' => 'oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/langstudio/output/', 'title' => ''],
'ChunkConfig' => [
'description' => 'File slicing configuration.'."\n",
'type' => 'object',
'properties' => [
'ChunkSize' => ['title' => '', 'description' => 'Chunk size.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1024', 'readOnly' => true],
'ChunkOverlap' => ['title' => '', 'description' => 'Chunk overlap size.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'readOnly' => true],
'ChunkDuration' => ['title' => '', 'description' => 'Chunk duration in seconds.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'readOnly' => true],
'ChunkStrategy' => ['title' => '', 'description' => 'Chunking strategy. Strategy types are as follows:'."\n"
."\n"
.'* Default. System default slicing strategy.'."\n"
.'* ASR. Split by audio content; valid for video knowledge bases.'."\n", 'type' => 'string', 'example' => 'Default', 'readOnly' => true, 'default' => 'Default'],
],
'title' => '',
'example' => '',
],
'EmbeddingConfig' => [
'description' => 'Vector index configuration.'."\n",
'type' => 'object',
'properties' => [
'ConnectionName' => ['title' => '', 'description' => 'Index service connection name.'."\n", 'type' => 'string', 'example' => 'myEmbeddingConn'],
'ConnectionId' => ['title' => '', 'description' => 'Index service connection ID.'."\n", 'type' => 'string', 'example' => 'conn-r3o7******38bh'],
'Model' => ['title' => '', 'description' => 'Model name.'."\n", 'type' => 'string', 'example' => 'text-embedding-v4'],
],
'title' => '',
'example' => '',
],
'VectorDBConfig' => [
'description' => 'Vector database configuration.'."\n",
'type' => 'object',
'properties' => [
'VectorDBType' => ['title' => '', 'description' => 'Vector database type. Supported values are as follows:'."\n"
."\n"
.'* Elasticsearch'."\n"
.'* Milvus'."\n"
.'* Faiss'."\n", 'type' => 'string', 'example' => 'Milvus'],
'ConnectionName' => ['title' => '', 'description' => 'Vector database connection name.'."\n", 'type' => 'string', 'example' => 'myVectorConn'],
'ConnectionId' => ['title' => '', 'description' => 'Vector database connection ID.'."\n", 'type' => 'string', 'example' => 'conn-7y5y******jja7'],
'CollectionName' => ['title' => '', 'description' => 'Vector database table or collection name.'."\n", 'type' => 'string', 'example' => 'my_collection'],
],
'title' => '',
'example' => '',
],
'Creator' => ['description' => 'Creator user ID.'."\n", 'type' => 'string', 'example' => '2485765****023475', 'title' => ''],
'RuntimeId' => ['description' => 'Runtime ID.'."\n", 'type' => 'string', 'example' => 'rtime-apje******beaz', 'title' => ''],
'MetaDataConfig' => [
'description' => 'Metadata configuration.'."\n",
'type' => 'object',
'properties' => [
'CustomMetaData' => [
'title' => '',
'description' => 'Custom metadata.'."\n",
'type' => 'array',
'items' => [
'description' => 'Custom metadata.'."\n",
'type' => 'object',
'properties' => [
'Key' => ['title' => '', 'description' => 'Metadata field name.'."\n", 'type' => 'string', 'example' => 'author'],
'ValueType' => ['title' => '', 'description' => 'Metadata field type.'."\n", 'type' => 'string', 'example' => 'String'],
'ReferenceCount' => ['title' => '', 'description' => 'The number of references to the permission policy.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'readOnly' => true],
'ValueCount' => ['title' => '', 'description' => 'Number of values.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'readOnly' => true],
],
'title' => '',
'example' => '',
],
'example' => '',
],
],
'title' => '',
'example' => '',
],
'AutoUpdateConfig' => [
'description' => 'Knowledge base auto-update configuration.'."\n",
'type' => 'object',
'properties' => [
'Status' => [
'title' => '',
'description' => 'Knowledge base auto-update switch status.'."\n"
."\n"
.'* Enable: Turn on auto-update.'."\n"
.'* Disable: Turn off auto-update.'."\n",
'type' => 'string',
'enumValueTitles' => ['Enable' => 'Enable', 'Disable' => 'Disable'],
'example' => 'Enable',
'default' => 'Disable',
],
'ResourceId' => ['title' => '', 'description' => 'Resource group ID. Empty or \'public-cluster\' indicates public resources.'."\n", 'type' => 'string', 'example' => 'quota89**76'],
'MaxRunningTimeInSeconds' => ['title' => '', 'description' => 'Maximum task running time, in seconds.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '86400'],
'EmbeddingConfig' => [
'title' => '',
'description' => 'Vector index configuration.'."\n",
'type' => 'object',
'properties' => [
'BatchSize' => ['title' => '', 'description' => 'Index batch size. Document and structured data type knowledge base is valid.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '8'],
'Concurrency' => ['title' => '', 'description' => 'Index concurrency count. Image and video type knowledge base is valid.'."\n", 'type' => 'integer', 'format' => 'int32', 'maximum' => '200', 'minimum' => '1', 'example' => '1'],
],
'example' => '',
],
'UserVpc' => ['title' => '', 'description' => 'User VPC configuration.'."\n", '$ref' => '#/components/schemas/UserVpc', 'example' => ''],
'EcsSpecs' => [
'title' => '',
'description' => 'Runtime resource configuration list.'."\n",
'type' => 'array',
'items' => [
'description' => 'Runtime resource.'."\n",
'type' => 'object',
'properties' => [
'Type' => ['title' => '', 'description' => 'Node type. Possible values are Head and Worker.'."\n", 'type' => 'string', 'example' => 'Worker', 'default' => 'Worker'],
'InstanceType' => ['title' => '', 'description' => 'Model name.'."\n", 'type' => 'string', 'example' => 'ecs.c6.large'],
'PodCount' => ['title' => '', 'description' => 'Number of replicas.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'GPUType' => ['title' => '', 'description' => 'The GPU type.'."\n", 'type' => 'string', 'example' => 'V100'],
'CPU' => ['title' => '', 'description' => 'The number of vCPU cores.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '4'],
'GPU' => ['title' => '', 'description' => 'The number of GPUs.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'Memory' => ['title' => '', 'description' => 'The memory size. Unit: GB.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '16'],
'SharedMemory' => ['title' => '', 'description' => 'The shared memory size. Unit: GB.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '16'],
'Driver' => ['title' => '', 'description' => 'The version of the GPU driver.'."\n", 'type' => 'string', 'example' => '550.127.08'],
],
'title' => '',
'example' => '',
],
'example' => '',
],
],
'title' => '',
'example' => '',
],
'VersionName' => ['description' => 'Knowledge base version. Default is v1.'."\n", 'type' => 'string', 'example' => 'v1', 'title' => ''],
'IndexColumnConfig' => [
'description' => 'Column field configuration. The structured data type knowledge base is effective.'."\n",
'type' => 'object',
'properties' => [
'EmbeddingColumns' => [
'title' => '',
'description' => 'Vector index column. The fields in this list will be vectorized and participate in retrieval.'."\n",
'type' => 'array',
'items' => [
'description' => 'Vector retrieval column.'."\n",
'type' => 'object',
'properties' => [
'Key' => ['title' => '', 'description' => 'Column name.'."\n", 'type' => 'string', 'example' => 'column1', 'readOnly' => true],
],
'readOnly' => true,
'title' => '',
'example' => '',
],
'readOnly' => true,
'example' => '',
],
'ContentColumns' => [
'title' => '',
'description' => 'Content filtering column. The fields in this list support keyword-based retrieval.'."\n",
'type' => 'array',
'items' => [
'description' => 'Content filtering column.'."\n",
'type' => 'object',
'properties' => [
'Key' => ['title' => '', 'description' => 'Column name.'."\n", 'type' => 'string', 'example' => 'column1', 'readOnly' => true],
],
'readOnly' => true,
'title' => '',
'example' => '',
],
'readOnly' => true,
'example' => '',
],
'ColumnDefinitions' => [
'title' => '',
'description' => 'All column names.'."\n",
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['title' => '', 'description' => 'The column name.'."\n", 'type' => 'string', 'example' => 'column1', 'readOnly' => true],
],
'readOnly' => true,
'description' => '',
'title' => '',
'example' => '',
],
'readOnly' => true,
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'GetKnowledgeBase',
'changeSet' => [
['createdAt' => '2026-01-08T03:49:33.000Z', 'description' => 'Response parameters changed'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'pailangstudio:GetKnowledgeBase',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"963BD7F9-0C02-5594-9550-BCC6DD43E3C0\\",\\n \\"WorkspaceId\\": \\"478**\\",\\n \\"Accessibility\\": \\"PRIVATE\\",\\n \\"GmtCreateTime\\": \\"2024-12-15T14:46:23Z\\",\\n \\"GmtModifiedTime\\": \\"2025-12-18T19:32:58Z\\",\\n \\"Name\\": \\"myName\\",\\n \\"KnowledgeBaseId\\": \\"d-ksicx823d\\",\\n \\"Description\\": \\"This is a description of the knowledge base.\\",\\n \\"KnowledgeBaseType\\": \\"TEXT\\",\\n \\"DatasetId\\": \\"d-cupbwkk5us9xpjz870\\",\\n \\"DataSources\\": [\\n {\\n \\"Uri\\": \\"oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/langstudio/source/\\"\\n }\\n ],\\n \\"OutputDir\\": \\"oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/langstudio/output/\\",\\n \\"ChunkConfig\\": {\\n \\"ChunkSize\\": 1024,\\n \\"ChunkOverlap\\": 200,\\n \\"ChunkDuration\\": 30,\\n \\"ChunkStrategy\\": \\"Default\\"\\n },\\n \\"EmbeddingConfig\\": {\\n \\"ConnectionName\\": \\"myEmbeddingConn\\",\\n \\"ConnectionId\\": \\"conn-r3o7******38bh\\",\\n \\"Model\\": \\"text-embedding-v4\\"\\n },\\n \\"VectorDBConfig\\": {\\n \\"VectorDBType\\": \\"Milvus\\",\\n \\"ConnectionName\\": \\"myVectorConn\\",\\n \\"ConnectionId\\": \\"conn-7y5y******jja7\\",\\n \\"CollectionName\\": \\"my_collection\\"\\n },\\n \\"Creator\\": \\"2485765****023475\\",\\n \\"RuntimeId\\": \\"rtime-apje******beaz\\",\\n \\"MetaDataConfig\\": {\\n \\"CustomMetaData\\": [\\n {\\n \\"Key\\": \\"author\\",\\n \\"ValueType\\": \\"String\\",\\n \\"ReferenceCount\\": 5,\\n \\"ValueCount\\": 3\\n }\\n ]\\n },\\n \\"AutoUpdateConfig\\": {\\n \\"Status\\": \\"Enable\\",\\n \\"ResourceId\\": \\"quota89**76\\",\\n \\"MaxRunningTimeInSeconds\\": 86400,\\n \\"EmbeddingConfig\\": {\\n \\"BatchSize\\": 8,\\n \\"Concurrency\\": 1\\n },\\n \\"UserVpc\\": {\\n \\"VpcId\\": \\"vpc-m5ec******44cn\\",\\n \\"VSwitchId\\": \\"vsw-hp32******z9qo\\",\\n \\"SecurityGroupId\\": \\"sg-bp1f******iy9h\\"\\n },\\n \\"EcsSpecs\\": [\\n {\\n \\"Type\\": \\"Worker\\",\\n \\"InstanceType\\": \\"ecs.c6.large\\",\\n \\"PodCount\\": 1,\\n \\"GPUType\\": \\"V100\\",\\n \\"CPU\\": 4,\\n \\"GPU\\": 1,\\n \\"Memory\\": 16,\\n \\"SharedMemory\\": 16,\\n \\"Driver\\": \\"550.127.08\\"\\n }\\n ]\\n },\\n \\"VersionName\\": \\"v1\\",\\n \\"IndexColumnConfig\\": {\\n \\"EmbeddingColumns\\": [\\n {\\n \\"Key\\": \\"column1\\"\\n }\\n ],\\n \\"ContentColumns\\": [\\n {\\n \\"Key\\": \\"column1\\"\\n }\\n ],\\n \\"ColumnDefinitions\\": [\\n {\\n \\"Key\\": \\"column1\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'GetKnowledgeBaseJob' => [
'summary' => 'Retrieve a knowledge base job.',
'path' => '/api/v1/langstudio/knowledgebases/{KnowledgeBaseId}/knowledgebasejobs/{KnowledgeBaseJobId}',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATURElearnBVWJJN'],
],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'query',
'schema' => ['description' => 'Knowledge Base Workspace ID.'."\n", 'type' => 'string', 'required' => true, 'example' => '478***', 'title' => ''],
],
[
'name' => 'KnowledgeBaseId',
'in' => 'path',
'schema' => ['description' => 'Knowledge Base ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'd-nacr******sxd2', 'title' => ''],
],
[
'name' => 'KnowledgeBaseJobId',
'in' => 'path',
'schema' => ['description' => 'Knowledge Base Task ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'kbjob-9m******54', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'Request ID.'."\n", 'type' => 'string', 'example' => 'C25324E3-18E6-50D8-9026-16D74AAEEB26'],
'WorkspaceId' => ['description' => 'Knowledge Base workspace ID.'."\n", 'type' => 'string', 'example' => '478***', 'title' => ''],
'Accessibility' => ['description' => 'Workspace visibility, possible values are:'."\n"
."\n"
.'* PRIVATE: In this workspace, it is only visible to you and the administrators.'."\n"
.'* PUBLIC: In this workspace, visible to everyone.'."\n", 'type' => 'string', 'example' => 'PUBLIC', 'title' => ''],
'Creator' => ['description' => 'Creator User ID.'."\n", 'type' => 'string', 'example' => '2003******4844', 'title' => ''],
'GmtCreateTime' => ['description' => 'Task creation time (UTC).'."\n", 'type' => 'string', 'example' => '2025-09-24T07:33:53Z', 'title' => ''],
'GmtModifiedTime' => ['description' => 'Task Update Time (UTC).'."\n", 'type' => 'string', 'example' => '2025-09-24T08:58:35Z', 'title' => ''],
'KnowledgeBaseId' => ['description' => 'Knowledge Base ID.'."\n", 'type' => 'string', 'example' => 'd-nacr******sxd2', 'title' => ''],
'KnowledgeBaseJobId' => ['description' => 'Knowledge Base Task ID.'."\n", 'type' => 'string', 'example' => 'kbjob-9m******54', 'title' => ''],
'JobAction' => ['description' => 'Task Operation Type.'."\n"
."\n"
.'* SyncIndex: Update Knowledge Base Index'."\n", 'type' => 'string', 'example' => 'UpdateScheduleConfig', 'title' => ''],
'Description' => ['description' => 'Knowledge Base Task Description.'."\n", 'type' => 'string', 'example' => 'This is a description of the knowledge base job.', 'title' => ''],
'Status' => ['description' => 'Knowledge Base Task Status'."\n"
."\n"
.'* Running: The instance is in operation.'."\n"
.'* Success: Run successfully.'."\n"
.'* Failed: Run failed.'."\n", 'type' => 'string', 'example' => 'discovering', 'title' => ''],
'ResourceId' => ['description' => 'The resource group ID. Empty or public-cluster indicates public resource.'."\n", 'type' => 'string', 'example' => 'quota89**76', 'title' => ''],
'EcsSpecs' => [
'description' => 'Run Resource Configuration List'."\n",
'type' => 'array',
'items' => [
'description' => 'Run Resource Configuration List'."\n",
'type' => 'object',
'properties' => [
'Type' => ['title' => '', 'description' => 'Node type. Possible values are Head and Worker.'."\n", 'type' => 'string', 'example' => 'Worker', 'readOnly' => true, 'default' => 'Worker'],
'InstanceType' => ['title' => '', 'description' => 'Model name.'."\n", 'type' => 'string', 'example' => 'ecs.c6.large', 'readOnly' => true],
'PodCount' => ['title' => '', 'description' => 'Number of copies.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'readOnly' => true],
'CPU' => ['title' => '', 'description' => 'The number of CPU cores.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'readOnly' => true],
'GPU' => ['title' => '', 'description' => 'The number of GPU cards.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'readOnly' => true],
'Memory' => ['title' => '', 'description' => 'Memory size, in GB.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '16', 'readOnly' => true],
'SharedMemory' => ['title' => '', 'description' => 'Shared memory capacity, in units of GB.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '16', 'readOnly' => true],
'GPUType' => ['title' => '', 'description' => 'GPU Class.'."\n", 'type' => 'string', 'example' => 'V100', 'readOnly' => true],
'Driver' => ['title' => '', 'description' => 'Driver Version.'."\n", 'type' => 'string', 'example' => '550.127.08', 'readOnly' => true],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'UserVpc' => [
'description' => 'Task Run VPC Info.'."\n",
'type' => 'object',
'properties' => [
'VpcId' => ['title' => 'VPC ID', 'description' => 'VPC ID.'."\n", 'type' => 'string', 'example' => 'vpc-wz90****5v23'],
'VSwitchId' => ['title' => '', 'description' => 'Switch ID.'."\n", 'type' => 'string', 'example' => 'vsw-wz9r****ng10'],
'SecurityGroupId' => ['title' => '', 'description' => 'Security Group ID.'."\n", 'type' => 'string', 'example' => 'sg-wz91****e10e'],
],
'title' => '',
'example' => '',
],
'MaxRunningTimeInSeconds' => ['description' => 'Maximum task running time, in seconds.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '86400', 'title' => ''],
'GmtFinishTime' => ['description' => 'Task end time (UTC).'."\n", 'type' => 'string', 'example' => '2025-02-08T15:45:12Z', 'title' => ''],
'ErrorMessage' => ['description' => 'Task error info.'."\n", 'type' => 'string', 'example' => 'Failed to update knwoledge base index, pipelineRunId: flow-9p8f****4t9z', 'title' => ''],
'PipelineRunInfo' => [
'description' => 'Workflow Run Info.'."\n",
'type' => 'object',
'properties' => [
'PipelineRunId' => ['title' => '', 'description' => 'PaiFlow Workflow Run ID'."\n", 'type' => 'string', 'example' => 'flow-fi8z******g4gy', 'readOnly' => true],
],
'title' => '',
'example' => '',
],
'KnowledgeBaseJobResult' => [
'description' => 'Task Result.'."\n",
'type' => 'object',
'properties' => [
'TotalFileCount' => ['title' => '', 'description' => 'Total Number of Processed Files'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'AddChunkCount' => ['title' => '', 'description' => 'Increase the number of Chunks'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'DeleteChunkCount' => ['title' => '', 'description' => 'Delete Chunk Quantity'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
],
'title' => '',
'example' => '',
],
'EmbeddingConfig' => [
'description' => 'Index Configuration.'."\n",
'type' => 'object',
'properties' => [
'BatchSize' => ['title' => '', 'description' => 'Index batch size. Documentation and structured data types knowledge base is effective.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'readOnly' => true],
'Concurrency' => ['title' => '', 'description' => 'Index concurrency. Image and Video Type Knowledge Base is valid.'."\n", 'type' => 'integer', 'format' => 'int32', 'maximum' => '200', 'minimum' => '1', 'example' => '2', 'readOnly' => true],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C25324E3-18E6-50D8-9026-16D74AAEEB26\\",\\n \\"WorkspaceId\\": \\"478***\\",\\n \\"Accessibility\\": \\"PUBLIC\\",\\n \\"Creator\\": \\"2003******4844\\",\\n \\"GmtCreateTime\\": \\"2025-09-24T07:33:53Z\\",\\n \\"GmtModifiedTime\\": \\"2025-09-24T08:58:35Z\\",\\n \\"KnowledgeBaseId\\": \\"d-nacr******sxd2\\",\\n \\"KnowledgeBaseJobId\\": \\"kbjob-9m******54\\",\\n \\"JobAction\\": \\"UpdateScheduleConfig\\",\\n \\"Description\\": \\"This is a description of the knowledge base job.\\",\\n \\"Status\\": \\"discovering\\",\\n \\"ResourceId\\": \\"quota89**76\\",\\n \\"EcsSpecs\\": [\\n {\\n \\"Type\\": \\"Worker\\",\\n \\"InstanceType\\": \\"ecs.c6.large\\",\\n \\"PodCount\\": 1,\\n \\"CPU\\": 4,\\n \\"GPU\\": 1,\\n \\"Memory\\": 16,\\n \\"SharedMemory\\": 16,\\n \\"GPUType\\": \\"V100\\",\\n \\"Driver\\": \\"550.127.08\\"\\n }\\n ],\\n \\"UserVpc\\": {\\n \\"VpcId\\": \\"vpc-wz90****5v23\\",\\n \\"VSwitchId\\": \\"vsw-wz9r****ng10\\",\\n \\"SecurityGroupId\\": \\"sg-wz91****e10e\\"\\n },\\n \\"MaxRunningTimeInSeconds\\": 86400,\\n \\"GmtFinishTime\\": \\"2025-02-08T15:45:12Z\\",\\n \\"ErrorMessage\\": \\"Failed to update knwoledge base index, pipelineRunId: flow-9p8f****4t9z\\",\\n \\"PipelineRunInfo\\": {\\n \\"PipelineRunId\\": \\"flow-fi8z******g4gy\\"\\n },\\n \\"KnowledgeBaseJobResult\\": {\\n \\"TotalFileCount\\": 1,\\n \\"AddChunkCount\\": 10,\\n \\"DeleteChunkCount\\": 2\\n },\\n \\"EmbeddingConfig\\": {\\n \\"BatchSize\\": 10,\\n \\"Concurrency\\": 2\\n }\\n}","type":"json"}]',
'title' => 'Retrieve Knowledge Base Job',
'changeSet' => [
['createdAt' => '2026-01-08T03:49:32.000Z', 'description' => 'Response parameters changed'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'pailangstudio:GetKnowledgeBaseJob',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'translator' => 'machine',
],
'GetRuntime' => [
'path' => '/api/v1/langstudio/runtimes/{RuntimeId}',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATURElearnBVWJJN'],
],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'query',
'schema' => ['description' => 'The ID of the workspace. To get this ID, see [ListWorkspaces](~~449124~~).', 'type' => 'string', 'required' => false, 'example' => '478***', 'title' => ''],
],
[
'name' => 'RuntimeId',
'in' => 'path',
'schema' => ['description' => 'The ID of the runtime to retrieve.', 'type' => 'string', 'required' => false, 'example' => 'rtime-apje******beaz', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The returned data.',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '963BD7F9-0C02-5594-9550-BCC6DD43E3C0', 'title' => ''],
'WorkspaceId' => ['description' => 'The workspace ID.', 'type' => 'string', 'example' => '478***', 'title' => ''],
'RuntimeId' => ['description' => 'The runtime ID.', 'type' => 'string', 'example' => 'rtime-apje******beaz', 'title' => ''],
'RuntimeName' => ['description' => 'The runtime name.', 'type' => 'string', 'example' => 'dev01', 'title' => ''],
'RuntimeType' => ['description' => 'The runtime type.', 'type' => 'string', 'example' => 'DSW', 'title' => ''],
'RuntimeStatus' => ['description' => 'The status of the runtime. Valid values:'."\n"
."\n"
.'- `Creating`: The runtime is being created.'."\n"
."\n"
.'- `SaveFailed`: The image failed to save.'."\n"
."\n"
.'- `Stopped`: The runtime is stopped.'."\n"
."\n"
.'- `Failed`: The runtime failed.'."\n"
."\n"
.'- `ResourceAllocating`: Resources are being allocated.'."\n"
."\n"
.'- `Stopping`: The runtime is stopping.'."\n"
."\n"
.'- `Updating`: The runtime is updating.'."\n"
."\n"
.'- `Saving`: The image is being saved.'."\n"
."\n"
.'- `Queuing`: The task is queued.'."\n"
."\n"
.'- `Recovering`: The instance is recovering.'."\n"
."\n"
.'- `Starting`: The runtime is starting.'."\n"
."\n"
.'- `Running`: The runtime is running.'."\n"
."\n"
.'- `Saved`: The image is saved.'."\n"
."\n"
.'- `Deleting`: The runtime is being deleted.'."\n"
."\n"
.'- `EnvPreparing`: The environment is being prepared.', 'type' => 'string', 'example' => 'Running', 'title' => ''],
'GmtCreateTime' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2025-09-24T07:33:53Z', 'title' => ''],
'GmtModifiedTime' => ['description' => 'The last modified time.', 'type' => 'string', 'example' => '2025-09-24T08:24:36Z', 'title' => ''],
'Creator' => ['description' => 'The creator ID.', 'type' => 'string', 'example' => '2680******4103', 'title' => ''],
'Accessibility' => ['description' => 'The workspace visibility.', 'type' => 'string', 'example' => 'PRIVATE', 'title' => ''],
'EcsSpec' => [
'description' => 'The ECS resource configuration.',
'type' => 'object',
'properties' => [
'InstanceType' => ['description' => 'The instance type.', 'type' => 'string', 'readOnly' => true, 'title' => '', 'example' => 'ecs.c6.large'],
'GPUType' => ['description' => 'The GPU type.', 'type' => 'string', 'readOnly' => true, 'title' => '', 'example' => 'V100'],
'CPU' => ['description' => 'The number of CPUs.', 'type' => 'integer', 'format' => 'int32', 'readOnly' => true, 'title' => '', 'example' => '4'],
'GPU' => ['description' => 'The number of GPUs.', 'type' => 'integer', 'format' => 'int32', 'readOnly' => true, 'title' => '', 'example' => '0'],
'Memory' => ['description' => 'The memory size, in GB.', 'type' => 'integer', 'format' => 'int32', 'readOnly' => true, 'title' => '', 'example' => '8'],
'SharedMemory' => ['description' => 'The shared memory size, in GB.', 'type' => 'integer', 'format' => 'int32', 'readOnly' => true, 'title' => '', 'example' => '8'],
'Driver' => ['description' => 'The GPU driver version.', 'type' => 'string', 'readOnly' => true, 'title' => '', 'example' => '535.161.08'],
],
'title' => '',
'example' => '',
],
'ResourceId' => ['description' => 'The resource quota ID.', 'type' => 'string', 'example' => 'quota18******zv9', 'title' => ''],
'UserVpc' => [
'description' => 'The user VPC configuration.',
'type' => 'object',
'properties' => [
'VpcId' => ['title' => 'VPC ID', 'description' => 'The VPC ID.', 'type' => 'string', 'readOnly' => true, 'example' => 'vpc-wz90****5v23'],
'VSwitchId' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'readOnly' => true, 'title' => '', 'example' => 'vsw-wz9r****ng10'],
'SecurityGroupId' => ['description' => 'The security group ID.', 'type' => 'string', 'readOnly' => true, 'title' => '', 'example' => 'sg-wz9i****1129'],
'DefaultRoute' => ['description' => 'The default route.', 'type' => 'string', 'readOnly' => true, 'title' => '', 'example' => 'eth0'],
'ExtendedCIDRs' => [
'title' => '',
'description' => 'The extended CIDR blocks.',
'type' => 'array',
'items' => ['description' => 'An extended CIDR block.', 'type' => 'string', 'readOnly' => true, 'example' => '172.16.1.0/24', 'title' => ''],
'readOnly' => true,
'example' => '',
],
],
'title' => '',
'example' => '',
],
'Envs' => [
'description' => 'The environment variables.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['description' => 'The environment variable key.', 'type' => 'string', 'readOnly' => true, 'title' => '', 'example' => 'testKey1'],
'Value' => ['description' => 'The environment variable value.', 'type' => 'string', 'readOnly' => true, 'title' => '', 'example' => 'testValue1'],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'Labels' => [
'description' => 'The labels.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['description' => 'The label key.', 'type' => 'string', 'readOnly' => true, 'title' => '', 'example' => 'testKey1'],
'Value' => ['description' => 'The label value.', 'type' => 'string', 'readOnly' => true, 'title' => '', 'example' => 'testValue1'],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'DataSources' => [
'description' => 'The mounted data sources.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'DatasetId' => ['description' => 'The dataset ID. Specify either this parameter or `Uri`.', 'type' => 'string', 'readOnly' => true, 'title' => '', 'example' => 'd-umns******zij4szhc'],
'Uri' => ['description' => 'The OSS path to the data source. Specify either this parameter or `DatasetId`.', 'type' => 'string', 'readOnly' => true, 'title' => '', 'example' => 'oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/langstudio/source/'],
'MountPath' => ['description' => 'The mount path.', 'type' => 'string', 'readOnly' => true, 'title' => '', 'example' => '/mnt/data'],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'RunTimeout' => ['description' => 'The timeout period, in seconds, for a single test run.', 'type' => 'integer', 'format' => 'int32', 'example' => '180', 'title' => ''],
'CredentialConfig' => [
'description' => 'The credential configuration.',
'type' => 'object',
'properties' => [
'EnableCredentialInject' => ['description' => 'Indicates whether credential injection is enabled.', 'type' => 'boolean', 'readOnly' => true, 'title' => '', 'example' => 'true'],
'AliyunEnvRoleKey' => ['title' => 'AliyunEnvRoleKey', 'description' => 'The environment variable role key.', 'type' => 'string', 'readOnly' => true, 'example' => '0'],
'CredentialConfigItems' => [
'title' => '',
'description' => 'The credential configurations.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['title' => 'Key', 'description' => 'The key that identifies the configuration.', 'type' => 'string', 'readOnly' => true, 'example' => '0'],
'Type' => ['title' => 'Type', 'description' => 'The configuration type. Valid values:'."\n"
."\n"
.'- `Role`: Assumes a single role.'."\n"
."\n"
.'- `RoleChain`: Assumes a chain of roles.', 'type' => 'string', 'readOnly' => true, 'example' => 'Role'],
'Roles' => [
'title' => '',
'description' => 'The roles in the configuration.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'AssumeRoleFor' => ['title' => 'AssumeRoleFor', 'description' => 'The principal that assumes the role.', 'type' => 'string', 'readOnly' => true, 'example' => '1095******785714'],
'RoleType' => ['description' => 'The type of role to assume. Valid values:'."\n"
."\n"
.'- `service`: The role is assumed by a service.'."\n"
."\n"
.'- `user`: The role is assumed by a RAM user.', 'type' => 'string', 'readOnly' => true, 'title' => '', 'example' => 'service'],
'RoleArn' => ['description' => 'The role ARN.', 'type' => 'string', 'readOnly' => true, 'title' => '', 'example' => 'acs:ram::1095******785714:role/testrole'],
],
'readOnly' => true,
'description' => '',
'title' => '',
'example' => '',
],
'readOnly' => true,
'example' => '',
],
],
'readOnly' => true,
'description' => '',
'title' => '',
'example' => '',
],
'readOnly' => true,
'example' => '',
],
],
'title' => '',
'example' => '',
],
'WorkDir' => ['description' => 'The OSS path to the working directory.', 'type' => 'string', 'example' => 'oss://mybucket.oss-cn-hangzhou-internal.aliyuncs.com/workdir/', 'title' => ''],
'Version' => ['description' => 'The runtime image version.', 'type' => 'string', 'example' => '2.0.0', 'title' => ''],
'RuntimeLog' => ['description' => 'The runtime log.', 'type' => 'string', 'example' => 'oss://path/to/log/file', 'title' => ''],
'AutoUpdateImage' => ['description' => 'Indicates whether to automatically update the image.', 'type' => 'boolean', 'title' => '', 'example' => ''],
],
'title' => '',
'example' => '',
],
],
],
'title' => 'GetRuntime',
'summary' => 'Get runtime details.',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'pailangstudio:GetRuntime',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"963BD7F9-0C02-5594-9550-BCC6DD43E3C0\\",\\n \\"WorkspaceId\\": \\"478***\\",\\n \\"RuntimeId\\": \\"rtime-apje******beaz\\",\\n \\"RuntimeName\\": \\"dev01\\",\\n \\"RuntimeType\\": \\"DSW\\",\\n \\"RuntimeStatus\\": \\"Running\\",\\n \\"GmtCreateTime\\": \\"2025-09-24T07:33:53Z\\",\\n \\"GmtModifiedTime\\": \\"2025-09-24T08:24:36Z\\",\\n \\"Creator\\": \\"2680******4103\\",\\n \\"Accessibility\\": \\"PRIVATE\\",\\n \\"EcsSpec\\": {\\n \\"InstanceType\\": \\"ecs.c6.large\\",\\n \\"GPUType\\": \\"V100\\",\\n \\"CPU\\": 4,\\n \\"GPU\\": 0,\\n \\"Memory\\": 8,\\n \\"SharedMemory\\": 8,\\n \\"Driver\\": \\"535.161.08\\"\\n },\\n \\"ResourceId\\": \\"quota18******zv9\\",\\n \\"UserVpc\\": {\\n \\"VpcId\\": \\"vpc-wz90****5v23\\",\\n \\"VSwitchId\\": \\"vsw-wz9r****ng10\\",\\n \\"SecurityGroupId\\": \\"sg-wz9i****1129\\",\\n \\"DefaultRoute\\": \\"eth0\\",\\n \\"ExtendedCIDRs\\": [\\n \\"172.16.1.0/24\\"\\n ]\\n },\\n \\"Envs\\": [\\n {\\n \\"Key\\": \\"testKey1\\",\\n \\"Value\\": \\"testValue1\\"\\n }\\n ],\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"testKey1\\",\\n \\"Value\\": \\"testValue1\\"\\n }\\n ],\\n \\"DataSources\\": [\\n {\\n \\"DatasetId\\": \\"d-umns******zij4szhc\\",\\n \\"Uri\\": \\"oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/langstudio/source/\\",\\n \\"MountPath\\": \\"/mnt/data\\"\\n }\\n ],\\n \\"RunTimeout\\": 180,\\n \\"CredentialConfig\\": {\\n \\"EnableCredentialInject\\": true,\\n \\"AliyunEnvRoleKey\\": \\"0\\",\\n \\"CredentialConfigItems\\": [\\n {\\n \\"Key\\": \\"0\\",\\n \\"Type\\": \\"Role\\",\\n \\"Roles\\": [\\n {\\n \\"AssumeRoleFor\\": \\"1095******785714\\",\\n \\"RoleType\\": \\"service\\",\\n \\"RoleArn\\": \\"acs:ram::1095******785714:role/testrole\\"\\n }\\n ]\\n }\\n ]\\n },\\n \\"WorkDir\\": \\"oss://mybucket.oss-cn-hangzhou-internal.aliyuncs.com/workdir/\\",\\n \\"Version\\": \\"2.0.0\\",\\n \\"RuntimeLog\\": \\"oss://path/to/log/file\\",\\n \\"AutoUpdateImage\\": false\\n}","type":"json"}]',
],
'GetSnapshot' => [
'path' => '/api/v1/langstudio/snapshots/{SnapshotId}',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATURElearnBVWJJN'],
],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'query',
'schema' => ['description' => 'The workspace ID. To obtain a workspace ID, see [ListWorkspaces](~~449124~~).', 'type' => 'string', 'required' => false, 'example' => '478***', 'title' => ''],
],
[
'name' => 'SnapshotId',
'in' => 'path',
'schema' => ['description' => 'The snapshot ID.', 'type' => 'string', 'required' => false, 'example' => 'snap-asfg******123', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response body.',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Request ID', 'description' => 'The request ID.', 'type' => 'string', 'example' => '963BD7F9-0C02-5594-9550-BCC6DD43E3C0'],
'WorkspaceId' => ['description' => 'The workspace ID. To obtain a workspace ID, see [ListWorkspaces](~~449124~~).', 'type' => 'string', 'example' => '478**', 'title' => ''],
'Accessibility' => ['description' => 'The visibility of the snapshot. Valid values:'."\n"
."\n"
.'- PRIVATE: The snapshot is visible only to you and administrators.'."\n"
."\n"
.'- PUBLIC: The snapshot is visible to all users.', 'type' => 'string', 'example' => 'PRIVATE', 'title' => ''],
'Creator' => ['description' => 'The ID of the user who created the snapshot.', 'type' => 'string', 'example' => '2680******4103', 'title' => ''],
'GmtCreateTime' => ['description' => 'The time the snapshot was created.', 'type' => 'string', 'example' => '2025-09-24T07:33:53Z', 'title' => ''],
'GmtModifiedTime' => ['description' => 'The time the snapshot was last modified.', 'type' => 'string', 'example' => '2025-09-24T08:58:35Z', 'title' => ''],
'SnapshotId' => ['description' => 'The ID of the snapshot.', 'type' => 'string', 'example' => 'snap-asfg******123', 'title' => ''],
'SnapshotName' => ['description' => 'The name of the snapshot.', 'type' => 'string', 'example' => 'snapshot01', 'title' => ''],
'Description' => ['description' => 'A description of the snapshot.', 'type' => 'string', 'example' => 'This is description', 'title' => ''],
'SnapshotResourceType' => ['description' => 'The resource type of the snapshot. Valid value:'."\n"
."\n"
.'- Flow: A workflow.', 'type' => 'string', 'example' => 'Flow', 'title' => ''],
'SnapshotResourceId' => ['description' => 'The ID of the snapshot resource.', 'type' => 'string', 'example' => 'flow-asfg******1234', 'title' => ''],
'CreationType' => ['description' => 'The creation type of the snapshot. Valid values:'."\n"
."\n"
.'- ManualCreated: The snapshot was created manually.'."\n"
."\n"
.'- DeploymentAutoCreated: The snapshot was created automatically by a deployment service.'."\n"
."\n"
.'- EvaluationAutoCreated: The snapshot was created automatically by an evaluation task.', 'type' => 'string', 'example' => 'ManualCreated', 'title' => ''],
'SnapshotStoragePath' => ['description' => 'The OSS path to the snapshot\'s source file.', 'type' => 'string', 'example' => 'oss://mybucket.oss-cn-hangzhou.aliyuncs.com/workdir/snapshot/snap-1234/src', 'title' => ''],
'WorkDir' => ['description' => 'The OSS working directory for the snapshot.', 'type' => 'string', 'example' => 'oss://mybucket.oss-cn-hangzhou-internal.aliyuncs.com/workdir/', 'title' => ''],
'SnapshotUrl' => ['description' => 'The download URL for the snapshot.', 'type' => 'string', 'example' => 'https://path/to/snapshot/zipfile', 'title' => ''],
'SnapshotStatus' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'ErrorMessage' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
'title' => '',
'example' => '',
],
],
],
'title' => 'Get Snapshot Details',
'summary' => 'Retrieves the details of a snapshot.',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'pailangstudio:GetSnapshot',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"963BD7F9-0C02-5594-9550-BCC6DD43E3C0\\",\\n \\"WorkspaceId\\": \\"478**\\",\\n \\"Accessibility\\": \\"PRIVATE\\",\\n \\"Creator\\": \\"2680******4103\\",\\n \\"GmtCreateTime\\": \\"2025-09-24T07:33:53Z\\",\\n \\"GmtModifiedTime\\": \\"2025-09-24T08:58:35Z\\",\\n \\"SnapshotId\\": \\"snap-asfg******123\\",\\n \\"SnapshotName\\": \\"snapshot01\\",\\n \\"Description\\": \\"This is description\\",\\n \\"SnapshotResourceType\\": \\"Flow\\",\\n \\"SnapshotResourceId\\": \\"flow-asfg******1234\\",\\n \\"CreationType\\": \\"ManualCreated\\",\\n \\"SnapshotStoragePath\\": \\"oss://mybucket.oss-cn-hangzhou.aliyuncs.com/workdir/snapshot/snap-1234/src\\",\\n \\"WorkDir\\": \\"oss://mybucket.oss-cn-hangzhou-internal.aliyuncs.com/workdir/\\",\\n \\"SnapshotUrl\\": \\"https://path/to/snapshot/zipfile\\",\\n \\"SnapshotStatus\\": \\"\\",\\n \\"ErrorMessage\\": \\"\\"\\n}","type":"json"}]',
],
'ListDeployments' => [
'summary' => 'Retrieve a list of deployment jobs.',
'path' => '/api/v1/langstudio/deployments',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATURElearnBVWJJN'],
],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'query',
'schema' => ['description' => 'Workspace ID. For information about how to obtain a workspace ID, see [ListWorkspaces](~~449124~~). ', 'type' => 'string', 'required' => false, 'example' => '478***', 'title' => ''],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => 'Pagination cursor used to retrieve the next page of results. '."\n"
."\n"
.'* Leave empty for the first request. '."\n"
.'* For subsequent requests, pass the NextToken value returned in the previous response. ', 'type' => 'string', 'required' => false, 'example' => '10', 'title' => ''],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => 'Maximum number of records allowed to be returned in this request. ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''],
],
[
'name' => 'SortBy',
'in' => 'query',
'schema' => ['description' => 'Field used for sorting in paged queries. The default field is GmtCreateTime. Valid values are as follows: '."\n"
."\n"
.'* GmtCreateTime (default): sort by creation time. '."\n"
.'* GmtModifiedTime: sort by updated time. ', 'type' => 'string', 'required' => false, 'example' => 'GmtCreateTime', 'title' => ''],
],
[
'name' => 'Order',
'in' => 'query',
'schema' => ['description' => 'Sorting order. '."\n"
."\n"
.'- ASC: ascending. '."\n"
.'- DESC: descending. ', 'type' => 'string', 'required' => false, 'example' => 'DESC', 'title' => ''],
],
[
'name' => 'DeploymentId',
'in' => 'query',
'schema' => ['description' => 'Deployment job ID. ', 'type' => 'string', 'required' => false, 'example' => 'dploy-asdf******1234', 'title' => ''],
],
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => ['description' => 'The resource type to be deployed. Valid values: '."\n"
.'* Flow: A project of the pipeline pattern '."\n"
.'* Code: A project of the Code pattern ', 'type' => 'string', 'required' => false, 'example' => 'Flow', 'title' => ''],
],
[
'name' => 'ResourceId',
'in' => 'query',
'schema' => ['description' => 'The resource ID to be deployed. ', 'type' => 'string', 'required' => false, 'example' => 'flow-asdf******123', 'title' => ''],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => 'The page number of the current page in a paged query. ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'Number of items displayed per page. Default value is 10. ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''],
],
[
'name' => 'Creator',
'in' => 'query',
'schema' => ['description' => 'The creator ID. ', 'type' => 'string', 'required' => false, 'example' => '2680******4103', 'title' => ''],
],
[
'name' => 'ResourceSnapshotId',
'in' => 'query',
'schema' => ['description' => 'The snapshot ID of the resource to be deployed. If this parameter is provided, the system deploys directly based on this snapshot. If it is not provided, the system first creates a new snapshot for the resource and then executes the deployment. ', 'type' => 'string', 'required' => false, 'example' => 'snap-asfg******123', 'title' => ''],
],
[
'name' => 'ServiceName',
'in' => 'query',
'schema' => ['description' => 'The service name. Fuzzy search by service name is supported. ', 'type' => 'string', 'required' => false, 'example' => 'myservice01', 'title' => ''],
],
[
'name' => 'DeploymentStatus',
'in' => 'query',
'schema' => ['description' => 'The deployment job status. To query multiple statuses simultaneously, separate them with commas. ', 'type' => 'string', 'required' => false, 'example' => 'Creating,Running', 'title' => ''],
],
[
'name' => 'OperationType',
'in' => 'query',
'schema' => ['description' => 'The operation type. Valid values: '."\n"
.'* Create: Create a service. '."\n"
.'* Update: Update an existing service. ', 'type' => 'string', 'required' => false, 'example' => 'Create', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Return Result. ',
'type' => 'object',
'properties' => [
'Deployments' => [
'description' => 'List of deployment jobs. ',
'type' => 'array',
'items' => ['description' => 'Details of a deployment job. ', '$ref' => '#/components/schemas/Deployment', 'title' => '', 'example' => ''],
'title' => '',
'example' => '',
],
'MaxResults' => ['title' => 'Maximum Number of Results Returned per Request ', 'description' => 'Maximum number of records allowed to be returned in this request. ', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'NextToken' => ['title' => 'Next Request Token ', 'description' => 'Pagination cursor for the next request. ', 'type' => 'string', 'example' => '10'],
'TotalCount' => ['title' => 'Total Count ', 'description' => 'Total quantity. ', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
'RequestId' => ['title' => 'Request ID ', 'description' => 'Request ID. ', 'type' => 'string', 'example' => '963BD7F9-0C02-5594-9550-BCC6DD43E3C0'],
],
'title' => '',
'example' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Deployments\\": [\\n {\\n \\"WorkspaceId\\": \\"478***\\",\\n \\"Accessibility\\": \\"PRIVATE\\",\\n \\"Creator\\": \\"2680******4103\\",\\n \\"GmtCreateTime\\": \\"2025-09-24T07:33:53Z\\",\\n \\"GmtModifiedTime\\": \\"2025-09-24T08:58:35Z\\",\\n \\"DeploymentId\\": \\"dploy-asdf******1234\\",\\n \\"DeploymentStatus\\": \\"Running\\",\\n \\"OperationType\\": \\"Create\\",\\n \\"ResourceType\\": \\"Flow\\",\\n \\"ResourceId\\": \\"flow-asdf******123\\",\\n \\"ResourceSnapshotId\\": \\"snap-asfg******123\\",\\n \\"ServiceName\\": \\"myservice01\\",\\n \\"Description\\": \\"This is description\\",\\n \\"WorkDir\\": \\"oss://mybucket.oss-cn-hangzhou-internal.aliyuncs.com/workdir/\\",\\n \\"EnableTrace\\": true,\\n \\"ChatHistoryConfig\\": {\\n \\"StorageType\\": \\"RDS\\",\\n \\"ConnectionName\\": \\"myconnection\\"\\n },\\n \\"ContentModerationConfig\\": {\\n \\"EnableInputModeration\\": true,\\n \\"EnableOutputModeration\\": true,\\n \\"StreamingModerationThreshold\\": 5\\n },\\n \\"DeploymentConfig\\": \\"{\\\\\\\\\\\\\\"metadata\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"langstudio_2026******3848_jro7\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"instance\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"workspace_id\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"285***\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"enable_webservice\\\\\\\\\\\\\\":false},\\\\\\\\\\\\\\"cloud\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"computing\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"instances\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"ecs.g7.xlarge\\\\\\\\\\\\\\"}]},\\\\\\\\\\\\\\"networking\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"vpc_id\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"vpc-bp1obprt******4bzo00d\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"vswitch_id\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"vsw-bp1p6i36k******pmfhw8\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"security_group_id\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"sg-bp1djud4******zecl5a\\\\\\\\\\\\\\"}}}\\",\\n \\"DeploymentStages\\": [\\n {\\n \\"Stage\\": 1,\\n \\"StageName\\": \\"PrepareSnapshot\\",\\n \\"Description\\": \\"Create snapshot for deployment\\",\\n \\"GmtStartTime\\": \\"2025-09-23T10:25:38Z\\",\\n \\"GmtEndTime\\": \\"2025-09-19T10:34:01Z\\",\\n \\"StageStatus\\": \\"Running\\",\\n \\"ErrorMessage\\": \\"This is error\\",\\n \\"StageInfo\\": \\"{\\\\\\\\\\\\\\"SnapshotId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"snap-i8j29k******b0hotn\\\\\\\\\\\\\\"}\\"\\n }\\n ],\\n \\"ErrorMessage\\": \\"This is error message\\",\\n \\"AutoApproval\\": true\\n }\\n ],\\n \\"MaxResults\\": 10,\\n \\"NextToken\\": \\"10\\",\\n \\"TotalCount\\": 100,\\n \\"RequestId\\": \\"963BD7F9-0C02-5594-9550-BCC6DD43E3C0\\"\\n}","type":"json"}]',
'title' => 'Retrieve a List of Deployment Jobs ',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'pailangstudio:ListDeployments',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'ListKnowledgeBaseChunks' => [
'summary' => 'Retrieve the knowledge base segment list.',
'path' => '/api/v1/langstudio/knowledgebases/{KnowledgeBaseId}/knowledgebasechunks',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATURElearnBVWJJN'],
],
'parameters' => [
[
'name' => 'KnowledgeBaseId',
'in' => 'path',
'schema' => ['title' => '', 'description' => 'Knowledge base ID. ', 'type' => 'string', 'required' => true, 'example' => 'd-ab****89'],
],
[
'name' => 'VersionName',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Knowledge base version. The default is v1. ', 'type' => 'string', 'required' => false, 'example' => 'v1'],
],
[
'name' => 'MetaData',
'in' => 'query',
'schema' => [
'title' => '',
'description' => 'Original file information. If empty, the entire knowledge base version is traversed. ',
'type' => 'object',
'properties' => [
'FileUri' => ['title' => '', 'description' => 'File URI. If FileMetaId is also provided, this parameter value is ignored. ', 'type' => 'string', 'required' => false, 'example' => 'oss://mybucketpath/file1.txt', 'readOnly' => true],
'FileMetaId' => ['title' => '', 'description' => 'File metadata ID. ', 'type' => 'string', 'required' => false, 'example' => 'xd8e****79du', 'readOnly' => true],
],
'required' => false,
'example' => '1',
],
],
[
'name' => 'ChunkStatus',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Segment status. '."\n"
.'- Enable: Valid. '."\n"
.'- Disable: Invalid. ', 'type' => 'string', 'required' => false, 'example' => 'Enable'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Current page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Number of items per page. ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'KnowledgeBaseChunks' => [
'title' => '',
'description' => 'Segment list.',
'type' => 'array',
'items' => [
'title' => '',
'description' => 'Segment details.',
'type' => 'object',
'properties' => [
'KnowledgeBaseChunkId' => ['title' => '', 'description' => 'Segment ID.', 'type' => 'string', 'example' => '123e4567-e89b-12d3-a456-426655440000'],
'KnowledgeBaseId' => ['title' => '', 'description' => 'Knowledge base ID.', 'type' => 'string', 'example' => 'd-ix****o9'],
'VersionName' => ['title' => '', 'description' => 'Knowledge base version. ', 'type' => 'string', 'example' => 'v1'],
'ChunkStart' => ['title' => '', 'description' => 'Segment start position. Returns the number of milliseconds from the start of file playback.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'ChunkEnd' => ['title' => '', 'description' => 'Segment end position. Returns the number of milliseconds from the start of file playback.', 'type' => 'integer', 'format' => 'int32', 'example' => '30000'],
'ChunkSequence' => ['title' => '', 'description' => 'Ordinal number of the segment within the file.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'ChunkContent' => ['title' => '', 'description' => 'Segment content.', 'type' => 'string', 'example' => 'content'],
'ChunkSize' => ['title' => '', 'description' => 'Segment size.', 'type' => 'integer', 'format' => 'int32', 'example' => '1873'],
'ChunkStatus' => ['title' => '', 'description' => 'Segment status. '."\n"
.'- Enable: enabled. '."\n"
.'- Disable: disabled. ', 'type' => 'string', 'example' => 'Enable'],
'DownloadUrl' => ['title' => '', 'description' => 'Download URL of the segment. Returned for image and video files. ', 'type' => 'string', 'example' => 'https://mybucket.oss-cn-shanghai.aliyuncs.com/...'],
'ThumbnailUrl' => ['title' => '', 'description' => 'Thumbnail of the segment. Returned for image and video files.', 'type' => 'string', 'example' => 'https://mybucket.oss-cn-shanghai.aliyuncs.com/...'],
'ChunkAttachment' => [
'title' => '',
'description' => 'List of segment attachments.',
'type' => 'array',
'items' => [
'title' => '',
'description' => 'Segment attachment.',
'type' => 'object',
'properties' => [
'PlaceholderId' => ['title' => '', 'description' => 'Placeholder ID.', 'type' => 'string', 'example' => 'IMAGE_PLACEHOLDER_0', 'readOnly' => true],
'Type' => ['title' => '', 'description' => 'Attachment type.', 'type' => 'string', 'example' => 'image', 'readOnly' => true],
'Uri' => ['title' => '', 'description' => 'Attachment path.', 'type' => 'string', 'example' => 'oss://mybucket/path/file.txt', 'readOnly' => true],
'DownloadUrl' => ['title' => '', 'description' => 'Download URL.', 'type' => 'string', 'example' => 'https://mybucket.oss-cn-shanghai.aliyuncs.com/...', 'readOnly' => true],
],
'example' => '',
],
'example' => '',
],
'MetaData' => [
'title' => '',
'description' => 'Original file information.',
'type' => 'object',
'properties' => [
'FileName' => ['title' => '', 'description' => 'File name. ', 'type' => 'string', 'example' => 'file1.txt', 'readOnly' => true],
'FileUri' => ['title' => '', 'description' => 'File path.', 'type' => 'string', 'example' => 'oss://mybucketpath/file1.txt', 'readOnly' => true],
'FileMetaId' => ['title' => '', 'description' => 'File metadata ID. ', 'type' => 'string', 'example' => 'xd8e****79du', 'readOnly' => true],
],
'example' => '',
],
],
'example' => '',
],
'example' => '',
],
'MaxResults' => ['title' => '', 'description' => 'Maximum number of records allowed to be returned in this request. ', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'TotalCount' => ['title' => '', 'description' => 'Total number of segments.', 'type' => 'integer', 'format' => 'int32', 'example' => '25'],
'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => '963BD7F9-0C02-5594-9550-BCC6DD43E3C0'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'ListKnowledgeBaseChunks',
'changeSet' => [],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"KnowledgeBaseChunks\\": [\\n {\\n \\"KnowledgeBaseChunkId\\": \\"123e4567-e89b-12d3-a456-426655440000\\",\\n \\"KnowledgeBaseId\\": \\"d-ix****o9\\",\\n \\"VersionName\\": \\"v1\\",\\n \\"ChunkStart\\": 0,\\n \\"ChunkEnd\\": 30000,\\n \\"ChunkSequence\\": 1,\\n \\"ChunkContent\\": \\"content\\",\\n \\"ChunkSize\\": 1873,\\n \\"ChunkStatus\\": \\"Enable\\",\\n \\"DownloadUrl\\": \\"https://mybucket.oss-cn-shanghai.aliyuncs.com/...\\",\\n \\"ThumbnailUrl\\": \\"https://mybucket.oss-cn-shanghai.aliyuncs.com/...\\",\\n \\"ChunkAttachment\\": [\\n {\\n \\"PlaceholderId\\": \\"IMAGE_PLACEHOLDER_0\\",\\n \\"Type\\": \\"image\\",\\n \\"Uri\\": \\"oss://mybucket/path/file.txt\\",\\n \\"DownloadUrl\\": \\"https://mybucket.oss-cn-shanghai.aliyuncs.com/...\\"\\n }\\n ],\\n \\"MetaData\\": {\\n \\"FileName\\": \\"file1.txt\\",\\n \\"FileUri\\": \\"oss://mybucketpath/file1.txt\\",\\n \\"FileMetaId\\": \\"xd8e****79du\\"\\n }\\n }\\n ],\\n \\"MaxResults\\": 10,\\n \\"TotalCount\\": 25,\\n \\"RequestId\\": \\"963BD7F9-0C02-5594-9550-BCC6DD43E3C0\\"\\n}","type":"json"}]',
],
'ListKnowledgeBaseJobs' => [
'summary' => 'Get the Knowledge Base task list.',
'path' => '/api/v1/langstudio/knowledgebases/{KnowledgeBaseId}/knowledgebasejobs',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATURElearnBVWJJN'],
],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'query',
'schema' => ['description' => '知识库所在工作空间ID。', 'type' => 'string', 'required' => false, 'example' => '478**', 'title' => ''],
],
[
'name' => 'KnowledgeBaseId',
'in' => 'path',
'schema' => ['description' => '知识库ID。', 'type' => 'string', 'required' => false, 'example' => 'd-ksicx823d', 'title' => ''],
],
[
'name' => 'KnowledgeBaseJobId',
'in' => 'query',
'schema' => ['description' => '知识库任务ID。', 'type' => 'string', 'required' => false, 'example' => 'kbjob-9m******54', 'title' => ''],
],
[
'name' => 'Status',
'in' => 'query',
'schema' => ['description' => '知识库任务状态。'."\n"
.'- Running: 运行中。'."\n"
.'- Success: 运行成功。'."\n"
.'- Failed: 运行失败。', 'type' => 'string', 'required' => false, 'example' => 'Running', 'title' => ''],
],
[
'name' => 'JobAction',
'in' => 'query',
'schema' => ['description' => '任务操作类型。'."\n"
.'- SyncIndex:更新知识库索引', 'type' => 'string', 'required' => false, 'example' => 'SyncIndex', 'title' => ''],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => '用来标记当前开始读取的位置,置空表示从头开始。', 'type' => 'string', 'required' => false, 'example' => '10', 'title' => ''],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => '使用 NextToken 方式查询时,每次最多返回的结果数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''],
],
[
'name' => 'SortBy',
'in' => 'query',
'schema' => ['description' => '排序字段。目前只支持GmtCreateTime。', 'type' => 'string', 'required' => false, 'example' => 'GmtCreateTime', 'title' => ''],
],
[
'name' => 'Order',
'in' => 'query',
'schema' => ['description' => '排序方式。'."\n"
."\n"
.'- ASC:升序。'."\n"
.'- DESC:降序。', 'type' => 'string', 'required' => false, 'example' => 'DESC', 'title' => ''],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '当前页数。 取值范围:大于0。 默认值:1。如果同时传入MaxResults,则使用NextToken查询方式,忽略此字段值。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '每页查询的数量。如果同时传入 MaxResults,则以 MaxResults 数量为准。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'KnowledgeBaseJobs' => [
'description' => '知识库任务列表。',
'type' => 'array',
'items' => ['description' => '知识库任务详情。', '$ref' => '#/components/schemas/KnowledgeBaseJob', 'title' => '', 'example' => ''],
'title' => '',
'example' => '',
],
'MaxResults' => ['title' => '请求最大返回结果数', 'description' => '本次请求允许返回的最大记录条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
'NextToken' => ['title' => '下次请求令牌', 'description' => '返回下一次查询开始的位置。为空表示已经获取了全部数据。', 'type' => 'string', 'example' => '20'],
'TotalCount' => ['title' => '总量', 'description' => '总记录条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '32'],
'RequestId' => ['title' => '请求ID', 'description' => '请求ID。', 'type' => 'string', 'example' => '963BD7F9-0C02-5594-9550-BCC6DD43E3C0'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'ListKnowledgeBaseJobs',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'pailangstudio:ListKnowledgeBaseJobs',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'ListKnowledgeBases' => [
'summary' => 'Queries a list of knowledge bases.',
'path' => '/api/v1/langstudio/knowledgebases',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATURElearnBVWJJN'],
],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'query',
'schema' => ['description' => 'The ID of the DataWorks workspace. You can call [ListWorkspaces](~~449124~~) to obtain the workspace ID.'."\n", 'type' => 'string', 'required' => false, 'example' => '478***', 'title' => ''],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => ['description' => 'The name of the knowledge base.'."\n", 'type' => 'string', 'required' => false, 'example' => 'myName', 'title' => ''],
],
[
'name' => 'KnowledgeBaseId',
'in' => 'query',
'schema' => ['description' => 'Knowledge Base ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'd-nacr******sxd2', 'title' => ''],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => 'Used to mark the current starting position for reading; leaving it empty means starting from the beginning.'."\n", 'type' => 'string', 'required' => false, 'example' => '10', 'title' => ''],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => 'When querying using NextToken, the maximum number of results returned each time.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''],
],
[
'name' => 'SortBy',
'in' => 'query',
'schema' => ['description' => 'Sorting field. Currently, only GmtCreateTime is supported.'."\n", 'type' => 'string', 'required' => false, 'example' => 'GmtCreateTime', 'title' => ''],
],
[
'name' => 'Order',
'in' => 'query',
'schema' => ['description' => 'The order in which you want to sort the queried instances.'."\n"
."\n"
.'* ASC: ascending order.'."\n"
.'* DESC: descending order.'."\n", 'type' => 'string', 'required' => false, 'example' => 'DESC', 'title' => ''],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => 'Current page number. Value range: greater than 0. Default value: 1. If MaxResults is passed in at the same time, the NextToken query method will be used, and this field value will be ignored.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'The number of queries per page. If MaxResults is passed in at the same time, the quantity will be based on MaxResults.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''],
],
[
'name' => 'Creator',
'in' => 'query',
'schema' => ['description' => 'Creator user ID.'."\n", 'type' => 'string', 'required' => false, 'example' => '2680******4103', 'title' => ''],
],
[
'name' => 'KnowledgeBaseType',
'in' => 'query',
'schema' => ['description' => 'The type of the knowledge base.'."\n"
."\n"
.'* TEXT: Document.'."\n"
.'* STRUCTURED: Structured data.'."\n"
.'* IMAGE: Image.'."\n"
.'* VIDEO: Video.'."\n", 'type' => 'string', 'required' => false, 'example' => 'TEXT', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'KnowledgeBases' => [
'description' => 'Knowledge base list.'."\n",
'type' => 'array',
'items' => ['description' => 'Knowledge base details.'."\n", '$ref' => '#/components/schemas/KnowledgeBase', 'title' => '', 'example' => ''],
'title' => '',
'example' => '',
],
'MaxResults' => ['title' => '', 'description' => 'The maximum number of records allowed to be returned by this request.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
'NextToken' => ['title' => '', 'description' => 'Returns the position from which the next query starts. Empty indicates that all data has been retrieved.'."\n", 'type' => 'string', 'example' => '20'],
'TotalCount' => ['title' => '', 'description' => 'Total number of records.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '51'],
'RequestId' => ['title' => '', 'description' => 'Request ID.'."\n", 'type' => 'string', 'example' => '35686626-8D83-5ADE-B400-08A6613A6057'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"KnowledgeBases\\": [\\n {\\n \\"WorkspaceId\\": \\"478***\\",\\n \\"Accessibility\\": \\"PRIVATE\\",\\n \\"GmtCreateTime\\": \\"2024-12-15T14:46:23Z\\",\\n \\"GmtModifiedTime\\": \\"2025-12-18T19:32:58Z\\",\\n \\"Name\\": \\"myName\\",\\n \\"KnowledgeBaseId\\": \\"d-nacr******sxd2\\",\\n \\"Description\\": \\"This is a description of the knowledge base.\\",\\n \\"KnowledgeBaseType\\": \\"TEXT\\",\\n \\"DatasetId\\": \\"d-lvb6****865w\\",\\n \\"DataSources\\": [\\n {\\n \\"Uri\\": \\"oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/langstudio/source/\\"\\n }\\n ],\\n \\"OutputDir\\": \\"oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/langstudio/output/\\",\\n \\"ChunkConfig\\": {\\n \\"ChunkSize\\": 1024,\\n \\"ChunkOverlap\\": 200,\\n \\"ChunkDuration\\": 20,\\n \\"ChunkStrategy\\": \\"Default\\"\\n },\\n \\"EmbeddingConfig\\": {\\n \\"ConnectionName\\": \\"myEmbeddingConn\\",\\n \\"ConnectionId\\": \\"conn-r3o7******38bh\\",\\n \\"Model\\": \\"text-embedding-v4\\"\\n },\\n \\"VectorDBConfig\\": {\\n \\"VectorDBType\\": \\"Milvus\\",\\n \\"ConnectionName\\": \\"myConnName\\",\\n \\"ConnectionId\\": \\"conn-v2wq****z7rg\\",\\n \\"CollectionName\\": \\"my_collection\\"\\n },\\n \\"Creator\\": \\"1247****1467\\",\\n \\"RuntimeId\\": \\"rtime-78****d6\\",\\n \\"MetaDataConfig\\": {\\n \\"CustomMetaData\\": [\\n {\\n \\"Key\\": \\"column1\\",\\n \\"ValueType\\": \\"String\\",\\n \\"ReferenceCount\\": 3,\\n \\"ValueCount\\": 8\\n }\\n ]\\n },\\n \\"AutoUpdateConfig\\": {\\n \\"Status\\": \\"Enable\\",\\n \\"ResourceId\\": \\"quota87**45\\",\\n \\"MaxRunningTimeInSeconds\\": 86400,\\n \\"EmbeddingConfig\\": {\\n \\"BatchSize\\": 8,\\n \\"Concurrency\\": 1\\n },\\n \\"UserVpc\\": {\\n \\"VpcId\\": \\"vpc-m5ec******44cn\\",\\n \\"VSwitchId\\": \\"vsw-hp32******z9qo\\",\\n \\"SecurityGroupId\\": \\"sg-bp1f******iy9h\\"\\n },\\n \\"EcsSpecs\\": [\\n {\\n \\"Type\\": \\"Worker\\",\\n \\"InstanceType\\": \\"ecs.c6.large\\",\\n \\"PodCount\\": 1,\\n \\"GPUType\\": \\"V100\\",\\n \\"CPU\\": 4,\\n \\"GPU\\": 1,\\n \\"Memory\\": 16,\\n \\"SharedMemory\\": 16,\\n \\"Driver\\": \\"550.127.08\\"\\n }\\n ]\\n },\\n \\"VersionName\\": \\"v1\\",\\n \\"IndexColumnConfig\\": {\\n \\"EmbeddingColumns\\": [\\n {\\n \\"Key\\": \\"column1\\"\\n }\\n ],\\n \\"ContentColumns\\": [\\n {\\n \\"Key\\": \\"column1\\"\\n }\\n ],\\n \\"ColumnDefinitions\\": [\\n {\\n \\"Key\\": \\"column1\\"\\n }\\n ]\\n }\\n }\\n ],\\n \\"MaxResults\\": 20,\\n \\"NextToken\\": \\"20\\",\\n \\"TotalCount\\": 51,\\n \\"RequestId\\": \\"35686626-8D83-5ADE-B400-08A6613A6057\\"\\n}","type":"json"}]',
'title' => 'ListKnowledgeBases',
'changeSet' => [
['createdAt' => '2026-01-08T03:49:33.000Z', 'description' => 'Response parameters changed'],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'pailangstudio:ListKnowledgeBases',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'ListRuntimes' => [
'summary' => 'Retrieve the runtime list.',
'path' => '/api/v1/langstudio/runtimes',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATURElearnBVWJJN'],
],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'query',
'schema' => ['description' => 'The ID of the DataWorks workspace. You can call [ListWorkspaces](~~449124~~) to obtain the workspace ID.'."\n", 'type' => 'string', 'required' => false, 'example' => '478**', 'title' => ''],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => 'The pagination token. The pagination token used in the next request to retrieve a new page of results.'."\n"
."\n"
.'* This value is left empty during the first request.'."\n"
.'* The `NextToken` value returned by the previous response passed in subsequent requests.'."\n", 'type' => 'string', 'required' => false, 'example' => '""', 'title' => ''],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => 'The maximum number of records allowed to be returned by this request.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => 'The page number in a paged query.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'The number of entries per page. Default value: 10.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''],
],
[
'name' => 'RuntimeName',
'in' => 'query',
'schema' => ['description' => 'The name of the runtime. Supports fuzzy search by name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'dev01', 'title' => ''],
],
[
'name' => 'RuntimeId',
'in' => 'query',
'schema' => ['description' => 'Runtime ID. Supports exact search by runtime ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rtime-apje******beaz', 'title' => ''],
],
[
'name' => 'WorkDir',
'in' => 'query',
'schema' => ['description' => 'The OSS path of the working directory.'."\n", 'type' => 'string', 'required' => false, 'example' => 'oss://mybucket.oss-cn-hangzhou-internal.aliyuncs.com/workdir/', 'title' => ''],
],
[
'name' => 'RuntimeStatus',
'in' => 'query',
'schema' => [
'description' => 'Runtime status. Valid values:'."\n"
."\n"
.'* Creating: The data cache is being created.'."\n"
.'* SaveFailed: Failed to save the runtime image.'."\n"
.'* Stopped: The file system is stopped.'."\n"
.'* Failed: Failed'."\n"
.'* ResourceAllocating: Resource allocation in progress'."\n"
.'* Stopping: Stopping in progress'."\n"
.'* Updating: Updating in progress'."\n"
.'* Saving: Saving the runtime image in progress'."\n"
.'* Queuing: Queuing in progress'."\n"
.'* Recovering: The instance is recovering.'."\n"
.'* Starting: The instance is being created.'."\n"
.'* Running: The gateway is running.'."\n"
.'* Saved: The runtime image is saved.'."\n"
.'* Deleting: The mount target is being deleted.'."\n"
.'* EnvPreparing: Preparing environment.'."\n",
'type' => 'string',
'required' => false,
'example' => 'Running',
'enumValueTitles' => [
'Creating' => '创建中', 'SaveFailed' => '镜像保存失败', 'Stopped' => '已停止', 'Failed' => '失败', 'ResourceAllocating' => '资源分配中', 'Stopping' => '停止中', 'Updating' => '更新中', 'Saving' => '镜像保存中', 'Queuing' => '排队中', 'Recovering' => '实例恢复中',
'Starting' => '创建中', 'Running' => '运行中', 'Saved' => '镜像保存成功', 'Deleting' => '删除中', 'EnvPreparing' => '环境准备中',
],
'title' => '',
],
],
[
'name' => 'Creator',
'in' => 'query',
'schema' => ['description' => 'The creator ID.'."\n", 'type' => 'string', 'required' => false, 'example' => '2485765****023475', 'title' => ''],
],
[
'name' => 'SortBy',
'in' => 'query',
'schema' => [
'description' => 'The field used to sort the results in paged queries. Default value: GmtCreateTime. Valid values are as follows:'."\n"
."\n"
.'* GmtCreateTime (default value): Sort by the time when created.'."\n"
.'* GmtModifiedTime: Sorted by modification time.'."\n"
.'* Creator: The ID of the creator.'."\n"
.'* WorkDir: the working path.'."\n"
.'* RuntimeName: the runtime parameter.'."\n"
.'* Status: the status of the runtime.'."\n",
'type' => 'string',
'required' => false,
'example' => 'GmtCreateTime',
'enumValueTitles' => ['Status' => '运行时状态', 'RuntimeName' => '运行时名称', 'Creator' => '创建者 ID', 'WorkDir' => '工作路径', 'GmtCreateTime' => '按创建时间', 'GmtModifiedTime' => '按修改时间'],
'title' => '',
],
],
[
'name' => 'Order',
'in' => 'query',
'schema' => [
'description' => 'The sorting method.'."\n"
."\n"
.'* ASC: ascending order.'."\n"
.'* DESC: Descending order.'."\n",
'type' => 'string',
'required' => false,
'example' => 'DESC',
'enumValueTitles' => ['ASC' => '升序', 'DESC' => '降序'],
'title' => '',
],
],
[
'name' => 'Version',
'in' => 'query',
'schema' => ['description' => 'Version'."\n", 'type' => 'string', 'required' => false, 'example' => '1.0', 'title' => ''],
],
[
'name' => 'Accessibility',
'in' => 'query',
'schema' => [
'enumValueTitles' => ['PUBLIC' => 'Visible within workspace ', 'PRIVATE' => 'Visible to creator '],
'description' => 'Visibility. ',
'title' => 'Visibility ',
'type' => 'string',
'example' => 'PRIVATE',
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response data.'."\n",
'type' => 'object',
'properties' => [
'Runtimes' => [
'description' => 'The list of runtimes.'."\n",
'type' => 'array',
'items' => ['description' => 'The details of the runtime.'."\n", '$ref' => '#/components/schemas/Runtime', 'title' => '', 'example' => ''],
'title' => '',
'example' => '',
],
'MaxResults' => ['title' => '', 'description' => 'The maximum number of returned results for a request.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'NextToken' => ['title' => '', 'description' => 'The next request token.'."\n", 'type' => 'string', 'example' => '11'],
'TotalCount' => ['title' => '', 'description' => 'The total number of runtime.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '25'],
'RequestId' => ['title' => '', 'description' => 'Request ID.'."\n", 'type' => 'string', 'example' => '963BD7F9-0C02-5594-9550-BCC6DD43E3C0'],
],
'title' => '',
'example' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Runtimes\\": [\\n {\\n \\"WorkspaceId\\": \\"478***\\",\\n \\"RuntimeId\\": \\"rtime-apje******beaz\\",\\n \\"RuntimeName\\": \\"dev01\\",\\n \\"RuntimeType\\": \\"DSW\\",\\n \\"RuntimeStatus\\": \\"Running\\",\\n \\"GmtCreateTime\\": \\"2025-09-24T07:33:53Z\\",\\n \\"GmtModifiedTime\\": \\"2025-09-24T08:24:36Z\\",\\n \\"Creator\\": \\"2680******4103\\",\\n \\"Accessibility\\": \\"PRIVATE\\",\\n \\"EcsSpec\\": {\\n \\"InstanceType\\": \\"ecs.c6.large\\",\\n \\"GPUType\\": \\"V100\\",\\n \\"CPU\\": 4,\\n \\"GPU\\": 0,\\n \\"Memory\\": 8,\\n \\"SharedMemory\\": 8,\\n \\"Driver\\": \\"535.161.08\\"\\n },\\n \\"ResourceId\\": \\"quota18******zv9\\",\\n \\"UserVpc\\": {\\n \\"VpcId\\": \\"vpc-wz90****5v23\\",\\n \\"VSwitchId\\": \\"vsw-wz9r****ng10\\",\\n \\"SecurityGroupId\\": \\"sg-wz9i****1129\\",\\n \\"DefaultRoute\\": \\"eth0\\",\\n \\"ExtendedCIDRs\\": [\\n \\"172.16.1.0/24\\"\\n ]\\n },\\n \\"Envs\\": [\\n {\\n \\"Key\\": \\"testKey01\\",\\n \\"Value\\": \\"testValue01\\"\\n }\\n ],\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"testKey01\\",\\n \\"Value\\": \\"testValue01\\"\\n }\\n ],\\n \\"DataSources\\": [\\n {\\n \\"DatasetId\\": \\"d-umns******zij4szhc\\",\\n \\"Uri\\": \\"oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/langstudio/source/\\",\\n \\"MountPath\\": \\"/mnt/data\\"\\n }\\n ],\\n \\"RunTimeout\\": 180,\\n \\"CredentialConfig\\": {\\n \\"EnableCredentialInject\\": true,\\n \\"AliyunEnvRoleKey\\": \\"0\\",\\n \\"CredentialConfigItems\\": [\\n {\\n \\"Key\\": \\"0\\",\\n \\"Type\\": \\"Role\\",\\n \\"Roles\\": [\\n {\\n \\"AssumeRoleFor\\": \\"1095******785714\\",\\n \\"RoleType\\": \\"service\\",\\n \\"RoleArn\\": \\"acs:ram::1095******785714:role/testrole\\"\\n }\\n ]\\n }\\n ]\\n },\\n \\"WorkDir\\": \\"oss://mybucket.oss-cn-hangzhou-internal.aliyuncs.com/workdir/\\",\\n \\"Version\\": \\"2.0.0\\",\\n \\"RuntimeLog\\": \\"oss://mybucket.oss-cn-hangzhou-internal.aliyuncs.com/workdir/runtime/1.log\\",\\n \\"AutoUpdateImage\\": false\\n }\\n ],\\n \\"MaxResults\\": 10,\\n \\"NextToken\\": \\"11\\",\\n \\"TotalCount\\": 25,\\n \\"RequestId\\": \\"963BD7F9-0C02-5594-9550-BCC6DD43E3C0\\"\\n}","type":"json"}]',
'title' => 'Retrieve Runtime List',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'pailangstudio:ListRuntimes',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'translator' => 'machine',
],
'ListSnapshots' => [
'summary' => 'Lists snapshots.',
'path' => '/api/v1/langstudio/snapshots',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATURElearnBVWJJN'],
],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'query',
'schema' => ['description' => 'The workspace ID. To find the workspace ID, see [ListWorkspaces](~~449124~~).', 'type' => 'string', 'required' => false, 'example' => '478**', 'title' => ''],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => 'The pagination token used to retrieve the next page of results.'."\n"
."\n"
.'- For the first request, leave this parameter empty.'."\n"
."\n"
.'- For subsequent requests, set this parameter to the `NextToken` value from the previous response.', 'type' => 'string', 'required' => false, 'example' => '10', 'title' => ''],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => 'The maximum number of items to return for this request.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''],
],
[
'name' => 'SortBy',
'in' => 'query',
'schema' => ['description' => 'The field to sort the results by. Defaults to `GmtCreateTime`. Valid values:'."\n"
."\n"
.'- `GmtCreateTime` (default): Sorts by creation time.'."\n"
."\n"
.'- `GmtModifiedTime`: Sorts by modification time.', 'type' => 'string', 'required' => false, 'example' => 'GmtCreateTime', 'title' => ''],
],
[
'name' => 'Order',
'in' => 'query',
'schema' => ['description' => 'The sort order.'."\n"
."\n"
.'- `ASC`: Ascending order.'."\n"
."\n"
.'- `DESC`: Descending order.', 'type' => 'string', 'required' => false, 'example' => 'DESC', 'title' => ''],
],
[
'name' => 'SnapshotId',
'in' => 'query',
'schema' => ['description' => 'The snapshot ID.', 'type' => 'string', 'required' => false, 'example' => 'snap-asfg******123', 'title' => ''],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'The number of items to return per page. Default: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''],
],
[
'name' => 'SnapshotResourceType',
'in' => 'query',
'schema' => [
'description' => 'The type of the snapshot resource. Valid value:'."\n"
."\n"
.'- `Flow`: A workflow.',
'type' => 'string',
'enum' => ['Flow'],
'required' => false,
'example' => 'Flow',
'title' => '',
],
],
[
'name' => 'SnapshotResourceId',
'in' => 'query',
'schema' => ['description' => 'The ID of the snapshot resource.', 'type' => 'string', 'required' => false, 'example' => 'flow-asfg******1234', 'title' => ''],
],
[
'name' => 'Creator',
'in' => 'query',
'schema' => ['description' => 'The creator ID.', 'type' => 'string', 'required' => false, 'example' => '2003******4844', 'title' => ''],
],
[
'name' => 'CreationType',
'in' => 'query',
'schema' => ['description' => 'The creation type of the snapshot. To specify multiple types, separate the values with a comma (,).', 'type' => 'string', 'required' => false, 'example' => 'ManualCreated,DeploymentAutoCreated', 'title' => ''],
],
[
'name' => 'SnapshotStatus',
'in' => 'query',
'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
[
'name' => 'Accessibility',
'in' => 'query',
'schema' => ['type' => 'string', 'example' => 'PRIVATE', 'title' => '', 'description' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The data returned.',
'type' => 'object',
'properties' => [
'Snapshots' => [
'description' => 'The list of snapshots.',
'type' => 'array',
'items' => ['description' => 'The snapshot details.', '$ref' => '#/components/schemas/Snapshot', 'title' => '', 'example' => ''],
'title' => '',
'example' => '',
],
'MaxResults' => ['title' => 'Maximum Number of Results Returned per Request', 'description' => 'The maximum number of items returned per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'NextToken' => ['title' => 'Next Request Token', 'description' => 'The pagination token to retrieve the next page of results. This value is empty if there are no more results.', 'type' => 'string', 'example' => '11'],
'TotalCount' => ['title' => 'Total Quantity', 'description' => 'The total number of snapshots.', 'type' => 'integer', 'format' => 'int32', 'example' => '25'],
'RequestId' => ['title' => 'Request ID', 'description' => 'The request ID.', 'type' => 'string', 'example' => '963BD7F9-0C02-5594-9550-BCC6DD43E3C0'],
],
'title' => '',
'example' => '',
],
],
],
'title' => 'Retrieve Snapshot List',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'pailangstudio:ListSnapshots',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Snapshots\\": [\\n {\\n \\"WorkspaceId\\": \\"478**\\",\\n \\"Accessibility\\": \\"PRIVATE\\",\\n \\"Creator\\": \\"2680******4103\\",\\n \\"GmtCreateTime\\": \\"2025-09-24T07:33:53Z\\",\\n \\"GmtModifiedTime\\": \\"2025-09-24T08:58:35Z\\",\\n \\"SnapshotId\\": \\"snap-qhn3******b369c0vo\\",\\n \\"SnapshotName\\": \\"name01\\",\\n \\"Description\\": \\"This is description\\",\\n \\"SnapshotResourceType\\": \\"Flow\\",\\n \\"SnapshotResourceId\\": \\"flow-6rymo******m7j0z4p\\",\\n \\"CreationType\\": \\"ManualCreated\\",\\n \\"SnapshotStoragePath\\": \\"oss://mybucket.oss-cn-hangzhou.aliyuncs.com/workdir/snapshot/snap-1234/src\\",\\n \\"WorkDir\\": \\"oss://mybucket.oss-cn-hangzhou-internal.aliyuncs.com/workdir/\\",\\n \\"SnapshotUrl\\": \\"https://path/to/snapshot/zipfile\\",\\n \\"SnapshotStatus\\": \\"\\",\\n \\"ErrorMessage\\": \\"\\"\\n }\\n ],\\n \\"MaxResults\\": 10,\\n \\"NextToken\\": \\"11\\",\\n \\"TotalCount\\": 25,\\n \\"RequestId\\": \\"963BD7F9-0C02-5594-9550-BCC6DD43E3C0\\"\\n}","type":"json"}]',
],
'RetrieveKnowledgeBase' => [
'summary' => 'Retrieves a knowledge base.',
'path' => '/api/v1/langstudio/knowledgebases/{KnowledgeBaseId}/action/retrieve',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATURElearnBVWJJN'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'KnowledgeBaseId',
'in' => 'path',
'schema' => ['description' => 'The knowledge base ID.', 'type' => 'string', 'required' => false, 'example' => 'd-ksicx823d', 'title' => ''],
],
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => 'The request body.',
'type' => 'object',
'properties' => [
'WorkspaceId' => ['description' => 'The ID of the workspace where the knowledge base resides.', 'type' => 'string', 'required' => true, 'example' => '174***', 'title' => ''],
'Query' => ['description' => 'The query content for retrieval.', 'type' => 'string', 'required' => true, 'example' => 'red car', 'title' => ''],
'TopK' => ['description' => 'The number of top-ranked results to return.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5', 'title' => ''],
'ScoreThreshold' => ['description' => 'The similarity score threshold. This is a floating-point value. Valid values: 0 to 1.', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '0.5', 'title' => ''],
'MetaDataFilterConditions' => ['description' => 'Optional. The metadata filter conditions for retrieval. The value is a JSON string. The JSON fields are defined as follows:'."\n"
."\n"
.'- FilterCondition: the logical relationship. Valid values: and, or.'."\n"
.'- MetaDataFilters: the filter conditions. Multiple conditions are processed based on the logical relationship specified by FilterCondition. Key specifies the metadata key. Value specifies the metadata value. Operator specifies the operator. Valid values: ==, !=, contains. The contains operator supports only the file_name field.', 'type' => 'string', 'required' => false, 'example' => '{'."\n"
.' "FilterCondition": "and", '."\n"
.' "MetaDataFilters": ['."\n"
.' {'."\n"
.' "Key": "key1", '."\n"
.' "Value": "value1", '."\n"
.' "Operator": "=="'."\n"
.' },'."\n"
.' {'."\n"
.' "Key": "key2", '."\n"
.' "Value": "value2", '."\n"
.' "Operator": "!="'."\n"
.' },'."\n"
.' {'."\n"
.' "Key": "file_name", '."\n"
.' "Value": "prefix", '."\n"
.' "Operator": "contains"'."\n"
.' }'."\n"
.' ]'."\n"
.'}', 'title' => ''],
'QueryMode' => [
'description' => 'The retrieval mode.'."\n"
."\n"
.'- dense: semantic retrieval.'."\n"
.'- hybrid: hybrid retrieval.',
'enumValueTitles' => ['hybrid' => 'hybrid', 'dense' => 'dense'],
'type' => 'string',
'required' => false,
'example' => 'dense',
'title' => '',
],
'VersionName' => ['description' => 'The knowledge base version. Default value: v1.', 'type' => 'string', 'required' => false, 'example' => 'v1', 'title' => ''],
'RerankConfig' => ['description' => 'Optional. The rerank configuration. The value is a JSON string. The JSON fields are defined as follows:'."\n"
."\n"
.'- ConnectionId: the model service connection ID.'."\n"
."\n"
.'- Model: the model name. If the connection type is Bailian, the supported model is gte-rerank-v2.'."\n"
."\n"
.'- TopK: the number of top-ranked results to return.', 'type' => 'string', 'required' => false, 'example' => '{'."\n"
.' "ConnectionId":"conn-xxx",'."\n"
.' "Model": "qwen-max",'."\n"
.' "TopK": 5'."\n"
.'}', 'title' => ''],
'RewriteConfig' => ['description' => 'Optional. The rewrite configuration. The value is a JSON string. The JSON fields are defined as follows:'."\n"
."\n"
.'- ConnectionId: the model service connection ID.'."\n"
."\n"
.'- Model: the model name. Models supported by Bailian connections include qwen3-max, qwen-plus, and qwen-flash.'."\n"
."\n"
.'- Temprature: controls the randomness of the content generated by the large language model. A higher value produces more random results. Valid values: 0 to 2.0.'."\n"
."\n"
.'- TopP: the probability threshold for nucleus sampling during generation. Valid values: 0 to 1.0.'."\n"
."\n"
.'- PresensePenalty: the presence penalty. Valid values: -2.0 to 2.0.'."\n"
."\n"
.'- FrequencyPenalty: the frequency penalty. Valid values: -2.0 to 2.0.'."\n"
."\n"
.'- Seed: the random number seed. Valid values: 0 to 2147483647.'."\n"
."\n"
.'- MaxTokens: controls the maximum length of the model-generated output.'."\n"
."\n"
.'- Stop: the list of stop sequences. The model stops generating output when any sequence in the list is encountered. A maximum of 4 sequences are supported.'."\n"
."\n"
.'- EnableThingking: specifies whether to enable reasoning.', 'type' => 'string', 'required' => false, 'example' => '{'."\n"
.' "ConnectionId":"conn-xxx",'."\n"
.' "Model": "qwen-max",'."\n"
.' "Temperature": 0.7,'."\n"
.' "TopP": 0.9,'."\n"
.' "PresencePenalty": 0.5,'."\n"
.' "FrequencyPenalty": 0.5,'."\n"
.' "Seed": 0,'."\n"
.' "MaxTokens": 1024,'."\n"
.' "Stop": [],'."\n"
.' "EnableThinking": true'."\n"
.'}', 'title' => ''],
'HybridStrategyConfig' => ['description' => 'Optional. The hybrid retrieval strategy configuration. The value is a JSON string. The JSON fields are defined as follows:'."\n"
."\n"
.'- Strategy: the hybrid retrieval strategy. Valid values: rrf (reciprocal rank fusion) and weighted (weighted fusion).'."\n"
."\n"
.'- RRFK: the smoothing parameter for reciprocal rank fusion. Valid values: 1 to 100.'."\n"
."\n"
.'- Weight: the weight for the weighted strategy. This value indicates the contribution ratio of vector semantic retrieval to the final score. Valid values: 0 to 1.0.', 'type' => 'string', 'required' => false, 'example' => '{'."\n"
.' "Strategy": "rrf",'."\n"
.' "RRFK":60,'."\n"
.' "Weight": 0.5'."\n"
.'}', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'KnowledgeBaseFileChunks' => [
'description' => 'The list of knowledge base chunks.',
'type' => 'array',
'items' => ['description' => 'The details of a knowledge base chunk.', '$ref' => '#/components/schemas/KnowledgeBaseFileChunk', 'title' => '', 'example' => ''],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"KnowledgeBaseFileChunks\\": [\\n {\\n \\"Score\\": 0.9832,\\n \\"ChunkId\\": \\"7fjs******90fs\\",\\n \\"ChunkStart\\": 0,\\n \\"ChunkEnd\\": 30000,\\n \\"ChunkSequence\\": 0,\\n \\"ChunkContent\\": \\"content of chunk\\",\\n \\"ChunkSize\\": 3452,\\n \\"ChunkStatus\\": \\"Enable\\",\\n \\"DownloadUrl\\": \\"https://cas-documents-service.oss-cn-shanghai.aliyuncs.com/5743962650c522fd54620fb9868d8c4c?Expires=1735092238&OSSAccessKeyId=LTAIgoNm******\\",\\n \\"ThumbnailUrl\\": \\"https://cas-documents-service.oss-cn-shanghai.aliyuncs.com/5743962650c522fd54620fb9868d8c4c?Expires=1735092238&OSSAccessKeyId=LTAIgoNm******\\",\\n \\"ChunkAttachment\\": [\\n {\\n \\"PlaceholderId\\": \\"IMAGE_PLACEHOLDER_0\\",\\n \\"Type\\": \\"image\\",\\n \\"Uri\\": \\"oss://mybucket/file1/img1.jpg\\",\\n \\"DownloadUrl\\": \\"https://cas-documents-service.oss-cn-shanghai.aliyuncs.com/Batch_Upload_Monitor_Domain.xlsx?Expires=1737338736&OSSAccessKeyId=LTAIgoNm******\\"\\n }\\n ],\\n \\"MetaData\\": {\\n \\"FileName\\": \\"abc.txt\\",\\n \\"FileUri\\": \\"oss://mybucket/path/abc.txt\\",\\n \\"FileMetaId\\": \\"sd8c******67ux\\"\\n }\\n }\\n ]\\n}","type":"json"}]',
'title' => 'Retrieve knowledge base',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'pailangstudio:RetrieveKnowledgeBase',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'UpdateDeployment' => [
'summary' => 'Update a deployment job.',
'path' => '/api/v1/langstudio/deployments/{DeploymentId}',
'methods' => ['put'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATURElearnBVWJJN'],
],
'parameters' => [
[
'name' => 'DeploymentId',
'in' => 'path',
'schema' => ['description' => 'Deployment job ID. ', 'type' => 'string', 'required' => false, 'example' => 'dploy-asdf******1234', 'title' => ''],
],
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => 'Request body. ',
'type' => 'object',
'properties' => [
'Description' => ['description' => 'Deployment description. ', 'type' => 'string', 'required' => false, 'example' => 'This is a description of deployment', 'title' => ''],
'WorkspaceId' => ['description' => 'Workspace ID. For information about how to obtain a workspace ID, see [ListWorkspaces](~~449124~~). ', 'type' => 'string', 'required' => false, 'example' => '174***', 'title' => ''],
'DeploymentConfig' => ['description' => 'Service Configuration for deployment. For more information, see the [deployment configuration](https://help.aliyun.com/zh/pai/user-guide/parameters-of-model-services) of PAI-EAS. ', 'type' => 'string', 'required' => false, 'example' => '{\\"metadata\\":{\\"name\\":\\"langstudio_2026******3848_jro7\\",\\"instance\\":1,\\"workspace_id\\":\\"285***\\",\\"enable_webservice\\":false},\\"cloud\\":{\\"computing\\":{\\"instances\\":[{\\"type\\":\\"ecs.g7.xlarge\\"}]},\\"networking\\":{\\"vpc_id\\":\\"vpc-bp1obprt******4bzo00d\\",\\"vswitch_id\\":\\"vsw-bp1p6i36k******pmfhw8\\",\\"security_group_id\\":\\"sg-bp1djud4******zecl5a\\"}}}', 'title' => ''],
'StageAction' => ['description' => 'Deployment stage operation information. The JSON format is as follows: '."\n"
.'{"Stage":3,"Action":"Confirm"}. Valid values for Action are: '."\n"
.'* Confirm: confirm. '."\n"
.'* Cancel: cancel. ', 'type' => 'string', 'required' => false, 'example' => '{\\"Stage\\":3,\\"Action\\":\\"Confirm\\"}', 'title' => ''],
'AutoApproval' => ['description' => 'Indicates whether to automatically skip the deployment confirmation step. ', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Return Result. ',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Request ID ', 'description' => 'Request ID. ', 'type' => 'string', 'example' => '963BD7F9-0C02-5594-9550-BCC6DD43E3C0'],
],
'title' => '',
'example' => '',
],
],
],
'title' => 'Update Deployment Job ',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'pailangstudio:UpdateDeployment',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"963BD7F9-0C02-5594-9550-BCC6DD43E3C0\\"\\n}","type":"json"}]',
],
'UpdateKnowledgeBase' => [
'summary' => 'Update Knowledge Base.',
'path' => '/api/v1/langstudio/knowledgebases/{KnowledgeBaseId}',
'methods' => ['put'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATURElearnBVWJJN'],
],
'parameters' => [
[
'name' => 'KnowledgeBaseId',
'in' => 'path',
'schema' => ['description' => 'Knowledge Base ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'd-nacr******sxd2', 'title' => ''],
],
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => 'The request body.'."\n",
'type' => 'object',
'properties' => [
'WorkspaceId' => ['description' => 'The ID of the workspace.'."\n", 'type' => 'string', 'required' => true, 'example' => '285773', 'title' => ''],
'Description' => ['description' => 'Knowledge base description.'."\n", 'type' => 'string', 'required' => false, 'example' => 'This is a description of the knowledge base.', 'title' => ''],
'RuntimeId' => ['description' => 'Runtime ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rtime-231x****tmo4', 'title' => ''],
'BindRuntime' => ['description' => 'Whether to bind at runtime.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
'MetaDataConfig' => [
'description' => 'Metadata Configuration.'."\n",
'type' => 'object',
'properties' => [
'CustomMetaData' => [
'title' => '',
'description' => 'Custom metadata.'."\n",
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['title' => '', 'description' => 'Metadata Field Name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'author'],
'ValueType' => ['title' => '', 'description' => 'Metadata Field Type Currently, only the String class type is supported.'."\n", 'type' => 'string', 'required' => false, 'example' => 'String'],
],
'required' => false,
'description' => '',
'title' => '',
'example' => '',
],
'required' => false,
'example' => '',
],
],
'required' => false,
'title' => '',
'example' => '',
],
'AutoUpdateConfig' => [
'description' => 'Knowledge Base Automatic Update Configuration.'."\n",
'type' => 'object',
'properties' => [
'Status' => ['title' => '', 'description' => 'Knowledge Base Automatic Update Switch Status'."\n"
."\n"
.'* Enable: Turn on automatic updates.'."\n"
.'* Disable: Turn off automatic updates.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Enable', 'default' => 'Disable'],
'ResourceId' => ['title' => '', 'description' => 'Resource Group ID. Empty or public-cluster indicates public resource.'."\n", 'type' => 'string', 'required' => false, 'example' => 'quota89**76'],
'MaxRunningTimeInSeconds' => ['title' => '', 'description' => 'Maximum task running time, in seconds.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '86400'],
'EmbeddingConfig' => [
'title' => '',
'description' => 'Vector Index Configuration.'."\n",
'type' => 'object',
'properties' => [
'BatchSize' => ['title' => '', 'description' => 'Index batch size. Documentation and structured data type Knowledge Base are effective.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '8'],
'Concurrency' => ['title' => '', 'description' => 'Index concurrency. Image and Video Type Knowledge Base is valid.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '200', 'minimum' => '1', 'example' => '1'],
],
'required' => false,
'example' => '',
],
'UserVpc' => ['title' => '', 'description' => 'User VPC Configuration.'."\n", 'required' => false, '$ref' => '#/components/schemas/UserVpc', 'example' => ''],
'EcsSpecs' => [
'title' => '',
'description' => 'Run Resource Configuration List Documentation and structured knowledge base contain only one element and the **Type** is Worker. images and videos knowledge base contain two elements and the **Types** are Head and Worker.'."\n",
'type' => 'array',
'items' => [
'description' => 'Run Resource.'."\n",
'type' => 'object',
'properties' => [
'Type' => ['title' => '', 'description' => 'Node type. Possible values are Head and Worker.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Worker', 'default' => 'Worker'],
'InstanceType' => ['title' => '', 'description' => 'Model name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ecs.c6.large'],
'PodCount' => ['title' => '', 'description' => 'The number of replicas.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
'GPUType' => ['title' => '', 'description' => 'The GPU Class.'."\n", 'type' => 'string', 'required' => false, 'example' => 'V100'],
'CPU' => ['title' => '', 'description' => 'The number of CPU cores.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '4'],
'GPU' => ['title' => '', 'description' => 'The number of GPU cards.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
'Memory' => ['title' => '', 'description' => 'Memory size, in GB.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '16'],
'SharedMemory' => ['title' => '', 'description' => 'Shared memory capacity, in units of GB.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '16'],
'Driver' => ['title' => '', 'description' => 'Driver Version.'."\n", 'type' => 'string', 'required' => false, 'example' => '550.127.08'],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => false,
'example' => '',
],
],
'required' => false,
'title' => '',
'example' => '',
],
],
'required' => false,
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response body.'."\n",
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'Request ID.'."\n", 'type' => 'string', 'example' => '48E6392E-C3C9-5212-9FAD-13256ABD9AF6'],
],
'title' => '',
'example' => '',
],
],
],
'title' => 'UpdateKnowledgeBase',
'changeSet' => [
['createdAt' => '2026-01-08T03:49:32.000Z', 'description' => 'Response parameters changed'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'pailangstudio:UpdateKnowledgeBase',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"48E6392E-C3C9-5212-9FAD-13256ABD9AF6\\"\\n}","type":"json"}]',
],
'UpdateKnowledgeBaseChunk' => [
'summary' => 'Update Knowledge Base Chunk',
'path' => '/api/v1/langstudio/knowledgebases/{KnowledgeBaseId}/knowledgebasechunks/{KnowledgeBaseChunkId}',
'methods' => ['put'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATURElearnBVWJJN'],
],
'parameters' => [
[
'name' => 'KnowledgeBaseId',
'in' => 'path',
'schema' => ['title' => '知识库ID', 'description' => 'Knowledge Base ID.', 'type' => 'string', 'required' => true, 'example' => 'd-ab****89'],
],
[
'name' => 'KnowledgeBaseChunkId',
'in' => 'path',
'schema' => ['title' => '切片ID', 'description' => 'Knowledge Base Chunk ID.', 'type' => 'string', 'required' => true, 'example' => '123e4567-e89b-12d3-a456-426655440000'],
],
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => '请求体',
'description' => 'Request body.',
'type' => 'object',
'properties' => [
'ChunkStatus' => ['title' => '切片状态', 'description' => 'Chunk status.'."\n"
."\n"
.'- Enable: Enabled.'."\n"
.'- Disable: Disabled.', 'type' => 'string', 'required' => false, 'example' => 'Enable'],
'ChunkContent' => ['title' => '切片内容', 'description' => 'Chunk content.', 'type' => 'string', 'required' => false, 'example' => 'content'],
],
'required' => false,
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '请求ID', 'description' => 'Request ID', 'type' => 'string', 'example' => '963BD7F9-0C02-5594-9550-BCC6DD43E3C0'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Update Knowledge Base Chunk',
'changeSet' => [],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"963BD7F9-0C02-5594-9550-BCC6DD43E3C0\\"\\n}","type":"json"}]',
'translator' => 'machine',
],
'UpdateKnowledgeBaseJob' => [
'summary' => 'Update Knowledge Base Task.',
'path' => '/api/v1/langstudio/knowledgebases/{KnowledgeBaseId}/knowledgebasejobs/{KnowledgeBaseJobId}',
'methods' => ['put'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATURElearnBVWJJN'],
],
'parameters' => [
[
'name' => 'KnowledgeBaseId',
'in' => 'path',
'schema' => ['description' => 'Knowledge Base ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'd-nacr******sxd2', 'title' => ''],
],
[
'name' => 'KnowledgeBaseJobId',
'in' => 'path',
'schema' => ['description' => 'Knowledge Base Task ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'kbjob-9m******54', 'title' => ''],
],
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => 'Request body.'."\n",
'type' => 'object',
'properties' => [
'WorkspaceId' => ['description' => 'Workspace ID where the knowledge course is located.'."\n", 'type' => 'string', 'required' => true, 'example' => '285***', 'title' => ''],
'Description' => ['description' => 'Knowledge base task description.'."\n", 'type' => 'string', 'required' => false, 'example' => 'This is a description of the knowledge base job.', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'Request ID.'."\n", 'type' => 'string', 'example' => '35686626-8D83-5ADE-B400-08A6613A6057'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'UpdateKnowledgeBaseJob',
'changeSet' => [
['createdAt' => '2026-01-08T03:49:32.000Z', 'description' => 'Response parameters changed'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'pailangstudio:UpdateKnowledgeBaseJob',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"35686626-8D83-5ADE-B400-08A6613A6057\\"\\n}","type":"json"}]',
],
'UpdateRuntime' => [
'summary' => 'Updates a runtime.',
'path' => '/api/v1/langstudio/runtimes/{RuntimeId}',
'methods' => ['put'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATURElearnBVWJJN'],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => 'The request body.',
'type' => 'object',
'properties' => [
'WorkspaceId' => ['description' => 'The workspace ID. To obtain the workspace ID, see [ListWorkspaces](~~449124~~).', 'type' => 'string', 'required' => false, 'example' => '478**', 'title' => ''],
'RunTimeout' => ['description' => 'The timeout, in seconds, for a single test run on the runtime.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '180', 'title' => ''],
'Version' => ['description' => 'The runtime image version.', 'type' => 'string', 'required' => false, 'example' => '2.0.0', 'title' => ''],
'Action' => ['description' => 'The runtime action. Valid values:'."\n"
."\n"
.'- Start: Starts the runtime.'."\n"
."\n"
.'- Stop: Stops the runtime.', 'type' => 'string', 'required' => false, 'example' => 'Start', 'title' => ''],
'AutoUpdateImage' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
],
[
'name' => 'RuntimeId',
'in' => 'path',
'schema' => ['description' => 'The runtime ID.', 'type' => 'string', 'required' => false, 'example' => 'rtime-apje******beaz', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '963BD7F9-0C02-5594-9550-BCC6DD43E3C0', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'title' => 'UpdateRuntime',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'pailangstudio:UpdateRuntime',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"963BD7F9-0C02-5594-9550-BCC6DD43E3C0\\"\\n}","type":"json"}]',
],
'UpdateSnapshot' => [
'summary' => 'Update a snapshot.',
'path' => '/api/v1/langstudio/snapshots/{SnapshotId}',
'methods' => ['put'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATURElearnBVWJJN'],
],
'parameters' => [
[
'name' => 'SnapshotId',
'in' => 'path',
'schema' => ['description' => 'The snapshot ID.', 'type' => 'string', 'required' => false, 'example' => 'snap-asfg******123', 'title' => ''],
],
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => 'The request body.',
'type' => 'object',
'properties' => [
'Description' => ['description' => 'The snapshot description.', 'type' => 'string', 'required' => false, 'example' => 'This is description', 'title' => ''],
'WorkspaceId' => ['description' => 'The workspace ID. For information about how to obtain a workspace ID, see [ListWorkspaces](~~449124~~).', 'type' => 'string', 'required' => false, 'example' => '478**', 'title' => ''],
'SnapshotName' => ['description' => 'The snapshot name. The format requirements are as follows:'."\n"
.'* It can contain only letters, digits, and underscores (_).'."\n"
.'* It must start with a letter.'."\n"
.'* It must be 1 to 256 characters in length.', 'type' => 'string', 'required' => false, 'example' => 'snapshot02', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Return Result.',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Request ID', 'description' => 'The request ID.', 'type' => 'string', 'example' => '963BD7F9-0C02-5594-9550-BCC6DD43E3C0'],
],
'title' => '',
'example' => '',
],
],
],
'title' => 'Update Snapshot',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'pailangstudio:UpdateSnapshot',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"963BD7F9-0C02-5594-9550-BCC6DD43E3C0\\"\\n}","type":"json"}]',
],
],
'endpoints' => [
['regionId' => 'ap-northeast-1', 'regionName' => 'Japan (Tokyo)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'pailangstudio.ap-northeast-1.aliyuncs.com', 'endpoint' => 'pailangstudio.ap-northeast-1.aliyuncs.com', 'vpc' => 'pailangstudio-vpc.ap-northeast-1.aliyuncs.com'],
['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'pailangstudio.ap-southeast-1.aliyuncs.com', 'endpoint' => 'pailangstudio.ap-southeast-1.aliyuncs.com', 'vpc' => 'pailangstudio-vpc.ap-southeast-1.aliyuncs.com'],
['regionId' => 'ap-southeast-5', 'regionName' => 'Indonesia (Jakarta)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'pailangstudio.ap-southeast-5.aliyuncs.com', 'endpoint' => 'pailangstudio.ap-southeast-5.aliyuncs.com', 'vpc' => 'pailangstudio-vpc.ap-southeast-5.aliyuncs.com'],
['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'pailangstudio.cn-beijing.aliyuncs.com', 'endpoint' => 'pailangstudio.cn-beijing.aliyuncs.com', 'vpc' => 'pailangstudio-vpc.cn-beijing.aliyuncs.com'],
['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'pailangstudio.cn-hangzhou.aliyuncs.com', 'endpoint' => 'pailangstudio.cn-hangzhou.aliyuncs.com', 'vpc' => 'pailangstudio-vpc.cn-hangzhou.aliyuncs.com'],
['regionId' => 'cn-hongkong', 'regionName' => 'China (Hong Kong)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'pailangstudio.cn-hongkong.aliyuncs.com', 'endpoint' => 'pailangstudio.cn-hongkong.aliyuncs.com', 'vpc' => 'pailangstudio-vpc.cn-hongkong.aliyuncs.com'],
['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'pailangstudio.cn-shanghai.aliyuncs.com', 'endpoint' => 'pailangstudio.cn-shanghai.aliyuncs.com', 'vpc' => 'pailangstudio-vpc.cn-shanghai.aliyuncs.com'],
['regionId' => 'cn-shenzhen', 'regionName' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'pailangstudio.cn-shenzhen.aliyuncs.com', 'endpoint' => 'pailangstudio.cn-shenzhen.aliyuncs.com', 'vpc' => 'pailangstudio-vpc.cn-shenzhen.aliyuncs.com'],
['regionId' => 'cn-wulanchabu', 'regionName' => 'China (Ulanqab)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'pailangstudio.cn-wulanchabu.aliyuncs.com', 'endpoint' => 'pailangstudio.cn-wulanchabu.aliyuncs.com', 'vpc' => 'pailangstudio-vpc.cn-wulanchabu.aliyuncs.com'],
['regionId' => 'us-east-1', 'regionName' => 'US (Virginia)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'pailangstudio.us-east-1.aliyuncs.com', 'endpoint' => 'pailangstudio.us-east-1.aliyuncs.com', 'vpc' => 'pailangstudio-vpc.us-east-1.aliyuncs.com'],
['regionId' => 'eu-central-1', 'regionName' => 'Germany (Frankfurt)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'pailangstudio.eu-central-1.aliyuncs.com', 'endpoint' => 'pailangstudio.eu-central-1.aliyuncs.com', 'vpc' => 'pailangstudio-vpc.eu-central-1.aliyuncs.com'],
],
'errorCodes' => [],
'changeSet' => [
[
'apis' => [
['description' => 'Response parameters changed', 'api' => 'CreateKnowledgeBase'],
['description' => 'Response parameters changed', 'api' => 'CreateKnowledgeBaseJob'],
['description' => 'Response parameters changed', 'api' => 'DeleteKnowledgeBase'],
['description' => 'Response parameters changed', 'api' => 'DeleteKnowledgeBaseJob'],
['description' => 'Response parameters changed', 'api' => 'GetKnowledgeBase'],
['description' => 'Response parameters changed', 'api' => 'GetKnowledgeBaseJob'],
['description' => 'Response parameters changed', 'api' => 'ListKnowledgeBaseJobs'],
['description' => 'Response parameters changed', 'api' => 'ListKnowledgeBases'],
['description' => 'Response parameters changed', 'api' => 'UpdateKnowledgeBase'],
['description' => 'Response parameters changed', 'api' => 'UpdateKnowledgeBaseJob'],
],
'createdAt' => '2026-01-08T03:49:48.000Z',
'description' => '',
],
],
'ram' => [
'productCode' => 'PAILangStudio',
'productName' => 'Platform for AI',
'ramCodes' => ['pailangstudio'],
'ramLevel' => 'OPERATION',
'ramConditions' => [],
'ramActions' => [
[
'apiName' => 'GetKnowledgeBaseJob',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'pailangstudio:GetKnowledgeBaseJob',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListKnowledgeBases',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'pailangstudio:ListKnowledgeBases',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'UpdateSnapshot',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'pailangstudio:UpdateSnapshot',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetKnowledgeBase',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'pailangstudio:GetKnowledgeBase',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetDeployment',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'pailangstudio:GetDeployment',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteRuntime',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'pailangstudio:DeleteRuntime',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateKnowledgeBaseJob',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'pailangstudio:CreateKnowledgeBaseJob',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListDeployments',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'pailangstudio:ListDeployments',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetSnapshot',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'pailangstudio:GetSnapshot',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateSnapshot',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'pailangstudio:CreateSnapshot',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListRuntimes',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'pailangstudio:ListRuntimes',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateKnowledgeBase',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'pailangstudio:CreateKnowledgeBase',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteSnapshot',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'pailangstudio:DeleteSnapshot',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteKnowledgeBaseJob',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'pailangstudio:DeleteKnowledgeBaseJob',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteKnowledgeBase',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'pailangstudio:DeleteKnowledgeBase',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListKnowledgeBaseJobs',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'pailangstudio:ListKnowledgeBaseJobs',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteDeployment',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'pailangstudio:DeleteDeployment',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateRuntime',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'pailangstudio:CreateRuntime',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateDeployment',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'pailangstudio:CreateDeployment',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'UpdateKnowledgeBaseJob',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'pailangstudio:UpdateKnowledgeBaseJob',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'UpdateRuntime',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'pailangstudio:UpdateRuntime',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'RetrieveKnowledgeBase',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'pailangstudio:RetrieveKnowledgeBase',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListSnapshots',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'pailangstudio:ListSnapshots',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'UpdateKnowledgeBase',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'pailangstudio:UpdateKnowledgeBase',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetRuntime',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'pailangstudio:GetRuntime',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'UpdateDeployment',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'pailangstudio:UpdateDeployment',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListKnowledgeBaseChunks',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'pailangstudio:ListKnowledgeBaseChunks',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'resourceTypes' => [],
],
];
|