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
|
<?php return [
'version' => '1.0',
'info' => ['style' => 'ROA', 'product' => 'ContactCenterAI', 'version' => '2024-06-03'],
'directories' => [
'RunCompletion',
'RunCompletionMessage',
'AnalyzeConversation',
'GetTaskResult',
'CreateTask',
'AnalyzeImage',
'GeneralAnalyzeImage',
[
'children' => ['CreateVocab', 'UpdateVocab', 'ListVocab', 'DeleteVocab', 'GetVocab'],
'type' => 'directory',
'title' => '热词管理',
'id' => 335503,
],
[
'children' => ['AnalyzeAudioSync'],
'type' => 'directory',
'title' => '不推荐或白名单开放',
'id' => 335509,
],
],
'components' => [
'schemas' => [],
],
'apis' => [
'AnalyzeAudioSync' => [
'summary' => '对进行语音文件进行实时对话分析。应用调用支持 HTTPS 调用来完成客户的响应。',
'path' => '/{workspaceId}/ccai/app/{appId}/analyzeAudioSync',
'methods' => ['post'],
'schemes' => ['https', 'sse'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json', 'application/octet-stream'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'workspaceId',
'in' => 'path',
'schema' => ['description' => '业务空间Id', 'type' => 'string', 'required' => true, 'example' => 'llm-ik******RVYCKzt'."\n"],
],
[
'name' => 'appId',
'in' => 'path',
'schema' => ['description' => '应用id', 'type' => 'string', 'required' => true, 'example' => 'a070a49c681f4a95a0f0*********35c'],
],
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => '请求体',
'type' => 'object',
'properties' => [
'modelCode' => ['description' => '模型code', 'type' => 'string', 'required' => false, 'example' => 'tyxmTurbo'],
'fields' => [
'description' => '字段结构信息',
'type' => 'array',
'items' => [
'description' => '字段结构信息',
'type' => 'object',
'properties' => [
'code' => ['description' => '字段编码', 'type' => 'string', 'required' => false, 'example' => 'phoneNumber'."\n"],
'name' => ['description' => '字段名称', 'type' => 'string', 'required' => false, 'example' => '来电原因类型'."\n"],
'desc' => ['description' => '字段描述', 'type' => 'string', 'required' => false, 'example' => '用户来电咨询的原因分类,主要有投诉、咨询、政策建议等。'."\n"],
'enumValues' => [
'description' => '枚举值列表',
'type' => 'array',
'items' => [
'description' => '枚举值列表',
'type' => 'object',
'properties' => [
'desc' => ['description' => '枚举描述', 'type' => 'string', 'required' => false, 'example' => '客户有新的需求/新的场景,客服跟进沟通需求细节'."\n"],
'enumValue' => ['description' => '枚举值', 'type' => 'string', 'required' => false, 'example' => '新业务拓展'."\n"],
],
'required' => false,
],
'required' => false,
],
],
'required' => false,
],
'required' => false,
],
'resultTypes' => [
'description' => '任务类型',
'type' => 'array',
'items' => ['description' => 'summary-对话摘要,title-标题生成、fields-字段信息抽取、keywords -关键字抽取,service_inspection-服务质检、question_solution-问题和解决方案、questions_and_answer-QA抽取、custom_prompt-自定义指令', 'type' => 'string', 'required' => true, 'example' => 'summary'],
'required' => false,
],
'serviceInspection' => [
'description' => '服务质检结构信息',
'type' => 'object',
'properties' => [
'inspectionContents' => [
'description' => '质检项列表',
'type' => 'array',
'items' => [
'description' => '质检项结构',
'type' => 'object',
'properties' => [
'content' => ['description' => '质检项描述', 'type' => 'string', 'required' => false, 'example' => '客服在服务客户过程中,基于已有的服务标准是否存在过度承诺的行为,如:最快到货时间是12小时,无法给客户承诺更快的到货时间。'],
'title' => ['description' => '质检名称', 'type' => 'string', 'required' => false, 'example' => '客服是否过度承诺'."\n"],
],
'required' => false,
],
'required' => false,
],
'inspectionIntroduction' => ['description' => '服务质检场景详细介绍及描述', 'type' => 'string', 'required' => false, 'example' => '请检测客服是否存在服务不当的行为,包括:过度承诺、故意套取客户隐私信息等'],
'sceneIntroduction' => ['description' => '服务质检场景', 'type' => 'string', 'required' => false, 'example' => '保险销售场景'."\n"],
],
'required' => false,
],
'templateIds' => [
'description' => '模版id',
'type' => 'array',
'items' => ['description' => '模版id,模版id和指令任务类型同时存在时,优先使用模版id', 'type' => 'string', 'required' => false, 'example' => '34'],
'required' => false,
],
'categoryTags' => [
'description' => '标签分类列表',
'type' => 'array',
'items' => [
'description' => '标签分类列表',
'type' => 'object',
'properties' => [
'tagName' => ['description' => '标签名称', 'type' => 'string', 'required' => false, 'example' => '客服过度承诺'],
'tagDesc' => ['description' => '标签描述', 'type' => 'string', 'required' => false, 'example' => '客服在服务客户过程中,基于已有的服务标准是否存在过度承诺的行为'],
],
'required' => false,
],
'required' => false,
],
'customPrompt' => ['description' => '自定义指令', 'type' => 'string', 'required' => false, 'example' => '对通话内容进行总结'],
'transcription' => [
'description' => '语音类型执行参数',
'type' => 'object',
'properties' => [
'autoSplit' => ['description' => '多数情况下适用于单轨录音,取值:0、1,是否自动分轨,1 为自动分轨,0 为不分轨;默认:1;若指定为 1,则表示上传的音频为单轨;自动分轨会额外占用处理时间。若录音为双轨录音,该参数必须传 0。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
'clientChannel' => ['description' => '适用于双轨录音,指定客户角色的轨道编号,取值:0、1,默认 1,即第 1 轨为客户;通常音轨都是从 0 开始编号,2 个轨就是 0,1;具体 0 是客服还是客户,需要您自行确认。**若使用此参数,请务必传入 autoSplit 参数,值为 0。**单轨文件忽略此参数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
'serviceChannel' => ['description' => '适用于双轨录音,指定客服角色的轨道编号,取值:0、1,默认 0,即第 0 轨为客服;通常音轨都是从 0 开始编号,2 个轨就是 0,1;具体 0 是客服还是客户,需要您自行确认。**若使用此参数,请务必传入 autoSplit 参数,值为 0。**若单轨文件忽略此参数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
'fileName' => ['description' => '文件名。', 'type' => 'string', 'required' => true, 'example' => 'sss.mp3'],
'voiceFileUrl' => ['description' => '文件地址', 'type' => 'string', 'required' => true, 'example' => 'http://1111.com/sss.mp3'],
'serviceChannelKeywords' => [
'description' => '客服通话关键字列表',
'type' => 'array',
'items' => ['description' => '多数情况下适用于单轨录音,设置一组客服可能说的关键词列表(请确保选择那些区别性比较高的关键词),通过对转写文本从上到下逐句分析,当一句话命中某一个关键词时,则判定该句的角色为客服,则另一个角色就是客户。', 'type' => 'string', 'required' => false, 'example' => '你好'],
'required' => false,
],
'asrModelCode' => ['description' => '语音转写模型,取值 nls (小模型),paraformer(大模型)', 'type' => 'string', 'required' => false, 'example' => 'nls'],
'vocabularyId' => ['description' => '语音热词id', 'type' => 'string', 'required' => false, 'example' => 'esnvknv*****skdnvjksd'],
'level' => ['description' => '语音转写优先级', 'type' => 'string', 'required' => false, 'example' => 'low'],
],
'required' => false,
],
'variables' => [
'description' => '变量列表',
'type' => 'array',
'items' => [
'description' => '变量列表',
'type' => 'object',
'properties' => [
'variableCode' => ['description' => '变量code', 'type' => 'string', 'required' => false, 'example' => 'name'],
'variableValue' => ['description' => '变量值', 'type' => 'string', 'required' => false, 'example' => '张三'],
],
'required' => false,
],
'required' => false,
],
'responseFormatType' => ['description' => '输出结果格式化类型,jsonObject-json结构,text-原始字符串', 'type' => 'string', 'required' => false, 'example' => 'jsonObject'],
'stream' => ['description' => '是否流式返回结果,流式返回-true,全量返回-false', 'type' => 'boolean', 'required' => true, 'example' => 'false'],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'requestId' => ['title' => 'Id of the request', 'description' => '请求id', 'type' => 'string', 'example' => '968A8634-FA2C-5381-9B3E-*******F'],
'finishReason' => ['description' => '如果是流式输出,正在生成时为null,生成结束时如果由于停止token导致则为stop。', 'type' => 'string', 'example' => 'stop'],
'success' => ['description' => '请求是否成功', 'type' => 'boolean', 'example' => 'True'],
'text' => ['description' => '应用返回的结果。', 'type' => 'string', 'example' => '这段对话似乎是客服与客户之间关于一个服务或产品的讨论,但具体内容难以明确理解,因为对话中的言语比较零散和抽象。'],
'inputTokens' => ['description' => '输入Token数量', 'type' => 'string', 'example' => '1000'],
'outputTokens' => ['description' => '输出Token数量', 'type' => 'string', 'example' => '2000'],
'totalTokens' => ['description' => 'Tokens总量', 'type' => 'string', 'example' => '3000'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'CCAI.InvalidParam.NotExist', 'errorMessage' => 'The specified parameter %s is not valid.', 'description' => '请求API的参数不存在'],
['errorCode' => 'CCAI.ParamInvalid.IllegalParamValue', 'errorMessage' => 'The parameter value of the request API is illegal %s.', 'description' => '请求API的参数不合法'],
['errorCode' => 'CCAI.Throttling.Qpm', 'errorMessage' => 'Trigger QPM flow restriction. Please purchase higher QPM for paid API. If free API has special requirements, please contact us through DingTalk group (62730018475).', 'description' => '触发QPM限流,付费API请购买更高QPM,免费API如有特殊需求,请通过钉钉群(62730018475)联系我们。'."\n"],
['errorCode' => 'CCAI.Throttling.Qps', 'errorMessage' => 'Trigger current QPS limit, pay API please buy higher QPS, the free API if you have special requirements, please contact us through the DingTalk group (62730018475).', 'description' => '触发限流,付费API请购买更高QPS,免费API如有特殊需求,请通过钉钉群(62730018475)联系我们。'."\n"],
],
403 => [
['errorCode' => 'CCAI.IllegalPermission.NoAuth', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => '该用户未被授权可操作指定资源'],
['errorCode' => 'CCAI.ParamNotfound.MissParam', 'errorMessage' => 'Parameter verification failed, The specified parameter %s is missing.', 'description' => '参数校验失败,指定参数缺失。'],
['errorCode' => 'CCAI.TenantPermission.NoAuth', 'errorMessage' => 'The current account does not have the permission to specify the business space. Please authorize the business space permission.', 'description' => '当前账号没有指定业务空间的权限,请进行业务空间权限授权。'],
],
500 => [
['errorCode' => 'CCAI.InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '系统内部错误,请稍后重试'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"968A8634-FA2C-5381-9B3E-*******F\\",\\n \\"finishReason\\": \\"stop\\",\\n \\"success\\": true,\\n \\"text\\": \\"这段对话似乎是客服与客户之间关于一个服务或产品的讨论,但具体内容难以明确理解,因为对话中的言语比较零散和抽象。\\",\\n \\"inputTokens\\": \\"1000\\",\\n \\"outputTokens\\": \\"2000\\",\\n \\"totalTokens\\": \\"3000\\"\\n}","type":"json"}]',
'title' => '语音文件实时分析',
'description' => '请确保在使用该接口前,已充分了解通义晓蜜CCAI-对话分析AIO产品的收费方式和价格。'."\n"
."\n"
.'## 前提条件'."\n"
."\n"
.'- 1.已开通通义晓蜜CCAI-对话分析AIO服务。'."\n"
.'- 2.已创建应用:应用中心完成通义晓蜜CCAI-对话分析AIO应用创建,并获取到APP-ID和WORKSPACE-ID:[获取APP-ID和WORKSPACE-ID](https://help.aliyun.com/zh/model-studio/developer-reference/obtain-api-key-app-id-and-workspace-id?spm=openapi-amp.newDocPublishment.0.0.3491281fOQZK5f)。'."\n"
."\n"
.'## 注意事项'."\n"
."\n"
.'- 1.超过3分钟的音频请使用离线任务分析。'."\n"
.'- 2.目前支持双轨录音文件,并且需要指定声轨对应的角色。',
'requestParamsDescription' => '## 接口请求示例'."\n"
.'```java'."\n"
."\n"
.'import com.alibaba.fastjson.JSONObject;'."\n"
.'import com.aliyun.contactcenterai20240603.Client;'."\n"
.'import com.aliyun.contactcenterai20240603.models.AnalyzeAudioSyncRequest;'."\n"
.'import com.aliyun.contactcenterai20240603.models.AnalyzeAudioSyncResponse;'."\n"
."\n"
.'import com.aliyun.teaopenapi.models.Config;'."\n"
."\n"
.'import java.util.ArrayList;'."\n"
.'import java.util.List;'."\n"
."\n"
.'public class CCAiTask {'."\n"
."\n"
.' public static void main(String[] args) throws Exception {'."\n"
.' String accessKeyId = "YOUR_ACCESS_KEY_ID";'."\n"
.' String accessKeySecret = "YOUR_ACCESS_KEY_SECRET";'."\n"
.' String workspaceId = "YOUR_WORKSPACEID";'."\n"
.' String appId = "YOUR_APPID";'."\n"
."\n"
.' Config config = new Config();'."\n"
.' config.setAccessKeyId(accessKeyId).setAccessKeySecret(accessKeySecret).setEndpoint("contactcenterai.cn-shanghai.aliyuncs.com")'."\n"
.' .setRegionId("cn-shanghai").setProtocol("HTTPS");'."\n"
."\n"
.' Client client = new Client(config);'."\n"
."\n"
.' AnalyzeAudioSyncRequest request = new AnalyzeAudioSyncRequest();'."\n"
.' request.setStream(false);'."\n"
."\n"
.' request.setModelCode("tyxmPlus");'."\n"
."\n"
.' List<String> typeList = new ArrayList<>();'."\n"
.' typeList.add("summary");'."\n"
.' request.setResultTypes(typeList);'."\n"
."\n"
.' AnalyzeAudioSyncRequest.AnalyzeAudioSyncRequestTranscription transcription = new AnalyzeAudioSyncRequest.AnalyzeAudioSyncRequestTranscription();'."\n"
.' transcription.setFileName("out**.wav");'."\n"
.' transcription.setVoiceFileUrl("https://age***.com/out**.wav");'."\n"
.' transcription.setServiceChannel(1);'."\n"
.' transcription.setClientChannel(0);'."\n"
."\n"
.' request.setTranscription(transcription);'."\n"
."\n"
.' AnalyzeAudioSyncResponse response = client.analyzeAudioSync(workspaceId, appId, request);'."\n"
.' System.out.println(JSONObject.toJSONString(response));'."\n"
.' }'."\n"
.' '."\n"
.'}'."\n"
."\n"
.'```',
'changeSet' => [],
],
'AnalyzeConversation' => [
'summary' => '获取对话摘要、标题生成、关键词、字段信息抽取、问题及解决方案、服务质检、代办事项、满意度、情绪检测、QA抽取、用户画像、标签分类等对话分析结果,应用调用支持 HTTP 调用来完成客户的响应。',
'path' => '/{workspaceId}/ccai/app/{appId}/analyze_conversation',
'methods' => ['post'],
'schemes' => ['https', 'sse'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/octet-stream', 'application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'workspaceId',
'in' => 'path',
'schema' => ['description' => '工作空间ID', 'type' => 'string', 'required' => true, 'example' => 'llm-368******3ifum'],
],
[
'name' => 'appId',
'in' => 'path',
'schema' => ['description' => '应用id。', 'type' => 'string', 'required' => true, 'example' => 'a070a49c681f4a95a0f0*********35c'],
],
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => '请求体。',
'type' => 'object',
'properties' => [
'categoryTags' => [
'description' => '标签分类列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'tagDesc' => ['description' => '标签描述', 'type' => 'string', 'required' => false, 'example' => '客服在服务客户过程中,基于已有的服务标准是否存在过度承诺的行为'],
'tagName' => ['description' => '标签名称', 'type' => 'string', 'required' => false, 'example' => '客服过度承诺'],
],
'required' => false,
'description' => '',
],
'required' => false,
],
'dialogue' => [
'description' => '对话内容列表',
'type' => 'object',
'properties' => [
'sentences' => [
'description' => '对话内容',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'role' => [
'description' => '通话角色:'."\n"
."\n"
.'- user-客户'."\n"
."\n"
.'- agent-客服'."\n"
."\n"
.'- system-系统消息',
'type' => 'string',
'required' => true,
'example' => 'user',
'enum' => ['user', 'agent', 'system'],
],
'text' => ['description' => '对话文本', 'type' => 'string', 'required' => true, 'example' => '请问怎么申请新卡'."\n"],
],
'required' => true,
'description' => '',
],
'required' => true,
],
'sessionId' => ['description' => '客服会话sessionId', 'type' => 'string', 'required' => false, 'example' => 'session-01'],
],
'required' => false,
],
'examples' => [
'description' => '指令示例列表',
'type' => 'array',
'items' => [
'description' => '指令示例',
'type' => 'object',
'properties' => [
'output' => ['description' => '输出示例', 'type' => 'string', 'required' => true, 'example' => '问题描述:询问2.2更新时间,处理方案:已告知'],
'sentences' => [
'description' => '对话内容示例列表',
'type' => 'array',
'items' => [
'description' => '对话内容示例',
'type' => 'object',
'properties' => [
'chatId' => ['description' => '每一轮对话id', 'type' => 'string', 'required' => false, 'example' => 'chat-01'],
'role' => [
'description' => '通话角色:'."\n"
."\n"
.'- user-客户'."\n"
."\n"
.'- agent-客服'."\n"
."\n"
.'- system-系统消息',
'type' => 'string',
'required' => true,
'example' => 'user',
'enum' => ['user', 'agent', 'system'],
],
'text' => ['description' => '对话文本', 'type' => 'string', 'required' => true, 'example' => '什么时候更新'],
],
'required' => true,
],
'required' => true,
],
],
'required' => true,
],
'required' => false,
],
'fields' => [
'description' => '信息抽取时,需要抽取的字段列表',
'type' => 'array',
'items' => [
'description' => '字段结构信息',
'type' => 'object',
'properties' => [
'code' => ['description' => '字段编码', 'type' => 'string', 'required' => false, 'example' => 'phoneNumber'."\n"],
'desc' => ['description' => '字段描述', 'type' => 'string', 'required' => true, 'example' => '用户来电咨询的原因分类,主要有投诉、咨询、政策建议等。'."\n"],
'enumValues' => [
'description' => '枚举值列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'desc' => ['description' => '枚举描述', 'type' => 'string', 'required' => true, 'example' => '客户有新的需求/新的场景,客服跟进沟通需求细节'."\n"],
'enumValue' => ['description' => '枚举值', 'type' => 'string', 'required' => true, 'example' => '新业务拓展'."\n"],
],
'required' => true,
'description' => '',
],
'required' => false,
],
'name' => ['description' => '字段名称', 'type' => 'string', 'required' => true, 'example' => '来电原因类型'."\n"],
],
'required' => true,
],
'required' => false,
],
'modelCode' => [
'description' => '模型code',
'type' => 'string',
'required' => false,
'example' => 'tyxmTurbo',
'default' => 'tyxmTurbo',
'enum' => ['tyxmTurbo', 'tyxmPlus'],
],
'resultTypes' => [
'description' => '指令任务类型',
'type' => 'array',
'items' => [
'description' => 'summary-对话摘要,title-标题生成、fields-字段信息抽取、keywords -关键字抽取,service_inspection-服务质检、question_solution-问题和解决方案、actions-代办事项、satisfaction-满意度、emotion_detection-情绪检测、questions_and_answer-QA抽取、user_profile-用户画像、category_tag-标签分类、custom_prompt-自定义指令',
'type' => 'string',
'required' => true,
'example' => 'summary',
'enum' => ['summary', 'title', 'fields', 'keywords', 'service_inspection', 'question_solution', 'questions_and_answer', 'user_profile', 'category_tag', 'emotion_detection', 'satisfaction', 'actions', 'service_finish', 'label_classification', 'analysis_image', 'custom_prompt', 'dianxiao_summary'],
],
'required' => true,
],
'sceneName' => ['description' => '场景名称', 'type' => 'string', 'required' => false, 'example' => '阿里云工单质检场景'."\n"],
'serviceInspection' => [
'description' => '服务质检结构信息',
'type' => 'object',
'properties' => [
'inspectionContents' => [
'description' => '服务质检维度结构列表',
'type' => 'array',
'items' => [
'description' => '服务质检维度结构',
'type' => 'object',
'properties' => [
'content' => ['description' => '服务质检维度描述', 'type' => 'string', 'required' => true, 'example' => '客服在服务客户过程中,基于已有的服务标准是否存在过度承诺的行为,如:最快到货时间是12小时,无法给客户承诺更快的到货时间。'],
'title' => ['description' => '服务质检维度名称', 'type' => 'string', 'required' => true, 'example' => '客服是否过度承诺'."\n"],
],
'required' => true,
],
'required' => true,
],
'inspectionIntroduction' => ['description' => '服务质检场景详细介绍及描述', 'type' => 'string', 'required' => true, 'example' => '请检测客服是否存在服务不当的行为,包括:过度承诺、故意套取客户隐私信息等'],
'sceneIntroduction' => ['description' => '服务质检场景', 'type' => 'string', 'required' => true, 'example' => '保险销售场景'."\n"],
],
'required' => false,
],
'stream' => ['description' => '必填。是否流式:true,流式返回答案;false,全量返回答案。', 'type' => 'boolean', 'required' => true, 'example' => 'false'],
'userProfiles' => [
'description' => '用户画像列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'name' => ['description' => '名称', 'type' => 'string', 'required' => false, 'example' => 'sex'],
'value' => ['description' => '描述', 'type' => 'string', 'required' => false, 'example' => '表示客户的性别,从列表[“男”, “女”]中选择一个值'],
],
'required' => false,
'description' => '',
],
'required' => false,
],
'timeConstraintList' => [
'description' => '时间约束,用于告诉大模型在做分析时,需要关注或限定在哪些时间范围内',
'type' => 'array',
'items' => ['description' => '时间信息', 'type' => 'string', 'required' => false, 'example' => '2026年1月'],
'required' => false,
],
'sourceCallerUid' => ['description' => '不用填', 'type' => 'string', 'required' => false, 'example' => 'null'],
'customPrompt' => ['description' => '自定义指令,指令中必须包含${dialogue}', 'type' => 'string', 'required' => false, 'example' => '对通话内容进行总结${dialogue}'],
'responseFormatType' => ['description' => '输出结果格式化类型,jsonObject-json结构,text-原始字符串', 'type' => 'string', 'required' => false, 'example' => 'jsonObject'],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'errorCode' => ['description' => '错误码', 'type' => 'string', 'example' => 'success'],
'errorInfo' => ['description' => '错误信息', 'type' => 'string', 'example' => 'success'],
'finishReason' => ['description' => '如果是流式输出,正在生成时为null,生成结束时如果由于停止token导致则为stop。', 'type' => 'string', 'example' => 'stop'],
'requestId' => ['title' => 'Id of the request', 'description' => '系统生成的标志本次请求的唯一性ID', 'type' => 'string', 'example' => '968A8634-FA2C-5381-9B3E-C552DED7E8BF'],
'success' => ['description' => '请求是否成功', 'type' => 'boolean', 'example' => 'True'],
'text' => ['description' => '应用返回的结果。', 'type' => 'string', 'example' => '这段对话似乎是客服与客户之间关于一个服务或产品的讨论,但具体内容难以明确理解,因为对话中的言语比较零散和抽象。'],
'inputTokens' => ['description' => '输入Token数量', 'type' => 'string', 'example' => '238'],
'outputTokens' => ['description' => '输出Token数量', 'type' => 'string', 'example' => '458'],
'totalTokens' => ['description' => 'Tokens总量', 'type' => 'string', 'example' => '696'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'CCAI.Throttling.Qps', 'errorMessage' => 'Trigger current QPS limit, pay API please buy higher QPS, the free API if you have special requirements, please contact us through the DingTalk group (62730018475).', 'description' => '触发限流,付费API请购买更高QPS,免费API如有特殊需求,请通过钉钉群(62730018475)联系我们。'."\n"],
['errorCode' => 'CCAI.Throttling.Qpm', 'errorMessage' => 'Trigger QPM flow restriction. Please purchase higher QPM for paid API. If free API has special requirements, please contact us through DingTalk group (62730018475).', 'description' => '触发QPM限流,付费API请购买更高QPM,免费API如有特殊需求,请通过钉钉群(62730018475)联系我们。'."\n"],
['errorCode' => 'CCAI.InvalidParam.NotExist', 'errorMessage' => 'The specified parameter %s is not valid.', 'description' => '请求API的参数不存在'],
['errorCode' => 'CCAI.ParamInvalid.IllegalParamValue', 'errorMessage' => 'The parameter value of the request API is illegal %s.', 'description' => '请求API的参数不合法'],
],
403 => [
['errorCode' => 'CCAI.TenantPermission.NoAuth', 'errorMessage' => 'The current account does not have the permission to specify the business space. Please authorize the business space permission.', 'description' => '当前账号没有指定业务空间的权限,请进行业务空间权限授权。'],
['errorCode' => 'CCAI.ParamNotfound.MissParam', 'errorMessage' => 'Parameter verification failed, The specified parameter %s is missing.', 'description' => '参数校验失败,指定参数缺失。'],
['errorCode' => 'CCAI.IllegalPermission.NoAuth', 'errorMessage' => 'User not authorized to operate on the specified resource %s .', 'description' => '该用户未被授权可操作指定资源'],
],
500 => [
['errorCode' => 'CCAI.InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '系统内部错误,请稍后重试'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"errorCode\\": \\"success\\",\\n \\"errorInfo\\": \\"success\\",\\n \\"finishReason\\": \\"stop\\",\\n \\"requestId\\": \\"968A8634-FA2C-5381-9B3E-C552DED7E8BF\\",\\n \\"success\\": true,\\n \\"text\\": \\"这段对话似乎是客服与客户之间关于一个服务或产品的讨论,但具体内容难以明确理解,因为对话中的言语比较零散和抽象。\\",\\n \\"inputTokens\\": \\"238\\",\\n \\"outputTokens\\": \\"458\\",\\n \\"totalTokens\\": \\"696\\"\\n}","type":"json"}]',
'title' => '通过任务类型调用通义晓蜜CCAI-对话分析AIO应用',
'description' => '请确保在使用该接口前,已充分了解通义晓蜜CCAI-对话分析AIO产品的收费方式和价格。'."\n"
."\n"
.'前提条件'."\n"
."\n"
.'1. 已开通通义晓蜜CCAI-对话分析AIO服务。'."\n"
.'2. 已创建应用:应用中心完成通义晓蜜CCAI-对话分析AIO应用创建,并获取到APP-ID和WORKSPACE-ID:获取[APP-ID和WORKSPACE-ID](https://help.aliyun.com/zh/model-studio/developer-reference/get-app-id-and-workspace?spm=openapi-amp.newDocPublishment.0.0.41df281fWNMfrx)。',
'changeSet' => [
['createdAt' => '2025-04-16T02:21:39.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-03-05T01:49:58.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2024-12-20T02:54:56.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2024-12-05T02:01:27.000Z', 'description' => '错误码发生变更、请求参数发生变更'],
['createdAt' => '2024-11-22T08:11:18.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2024-11-13T10:57:56.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2024-09-24T02:47:12.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2024-08-19T08:06:31.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '30', 'countWindow' => 2, 'regionId' => '*', 'api' => 'AnalyzeConversation'],
],
],
],
'AnalyzeImage' => [
'summary' => '通过通义晓蜜CCAI-对话分析AIO应用进行图片内容分析。具体包括以下场景:水印检测。应用调用支持 HTTP 调用来完成客户的响应。',
'path' => '/{workspaceId}/ccai/app/{appId}/analyzeImage',
'methods' => ['post'],
'schemes' => ['https', 'sse'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json', 'application/octet-stream'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'workspaceId',
'in' => 'path',
'schema' => ['description' => '工作空间ID', 'type' => 'string', 'required' => false, 'example' => 'llm-ik******RVYCKzt'."\n"],
],
[
'name' => 'appId',
'in' => 'path',
'schema' => ['description' => '应用id。', 'type' => 'string', 'required' => false, 'example' => 'a070a49c681f4a95a0f0*********35c'],
],
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => '请求体。',
'type' => 'object',
'properties' => [
'stream' => ['description' => '必填。是否流式:true,流式返回答案;false,全量返回答案。', 'type' => 'boolean', 'required' => true, 'example' => 'false'],
'imageUrls' => [
'description' => '图片地址列表',
'type' => 'array',
'items' => ['description' => '图片地址列表', 'type' => 'string', 'required' => false, 'example' => 'https://img.123.com/1.jppg'],
'required' => false,
],
'resultTypes' => [
'description' => '任务类型列表',
'type' => 'array',
'items' => [
'description' => 'watermark-图片水印分析',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['watermark' => 'watermark'],
'example' => 'watermark',
'enum' => ['watermark'],
],
'required' => false,
],
'responseFormatType' => ['type' => 'string', 'required' => false, 'description' => ''],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'requestId' => ['title' => 'Id of the request', 'description' => '请求id', 'type' => 'string', 'example' => '9*****-AE0D-5EE3-B1AF-48632CB0831C'],
'success' => ['description' => '请求是否成功', 'type' => 'boolean', 'example' => 'True'],
'text' => ['description' => '应用返回的结果。', 'type' => 'string', 'example' => '[{\\"num\\":\\"1\\",\\"isHit\\":\\"false\\",\\"remarks\\":\\"无水印\\"}]'],
'finishReason' => ['description' => '如果是流式输出,正在生成时为null,生成结束时如果由于停止token导致则为stop。', 'type' => 'string', 'example' => 'stop'],
'inputTokens' => ['description' => '输入Token数量', 'type' => 'string', 'example' => '1000'],
'outputTokens' => ['description' => '输出Token数量', 'type' => 'string', 'example' => '2000'],
'totalTokens' => ['description' => 'Tokens总量', 'type' => 'string', 'example' => '3000'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'CCAI.InvalidParam.NotExist', 'errorMessage' => 'The specified parameter %s is not valid.', 'description' => '请求API的参数不存在'],
['errorCode' => 'CCAI.ParamInvalid.IllegalParamValue', 'errorMessage' => 'The parameter value of the request API is illegal %s.', 'description' => '请求API的参数不合法'],
['errorCode' => 'CCAI.Throttling.Qpm', 'errorMessage' => 'Trigger QPM flow restriction. Please purchase higher QPM for paid API. If free API has special requirements, please contact us through DingTalk group (62730018475).', 'description' => '触发QPM限流,付费API请购买更高QPM,免费API如有特殊需求,请通过钉钉群(62730018475)联系我们。'."\n"],
['errorCode' => 'CCAI.Throttling.Qps', 'errorMessage' => 'Trigger current QPS limit, pay API please buy higher QPS, the free API if you have special requirements, please contact us through the DingTalk group (62730018475).', 'description' => '触发限流,付费API请购买更高QPS,免费API如有特殊需求,请通过钉钉群(62730018475)联系我们。'."\n"],
],
403 => [
['errorCode' => 'CCAI.IllegalPermission.NoAuth', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => '该用户未被授权可操作指定资源'],
['errorCode' => 'CCAI.ParamNotfound.MissParam', 'errorMessage' => 'Parameter verification failed, The specified parameter %s is missing.', 'description' => '参数校验失败,指定参数缺失。'],
['errorCode' => 'CCAI.TenantPermission.NoAuth', 'errorMessage' => 'The current account does not have the permission to specify the business space. Please authorize the business space permission.', 'description' => '当前账号没有指定业务空间的权限,请进行业务空间权限授权。'],
],
500 => [
['errorCode' => 'CCAI.InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '系统内部错误,请稍后重试'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"9*****-AE0D-5EE3-B1AF-48632CB0831C\\",\\n \\"success\\": true,\\n \\"text\\": \\"[{\\\\\\\\\\\\\\"num\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"isHit\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"false\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"remarks\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"无水印\\\\\\\\\\\\\\"}]\\",\\n \\"finishReason\\": \\"stop\\",\\n \\"inputTokens\\": \\"1000\\",\\n \\"outputTokens\\": \\"2000\\",\\n \\"totalTokens\\": \\"3000\\"\\n}","type":"json"}]',
'title' => '图片内容分析',
'description' => '请确保在使用该接口前,已充分了解通义晓蜜CCAI-对话分析AIO产品的收费方式和价格。'."\n"
."\n"
.'前提条件'."\n"
."\n"
.'1. 已开通通义晓蜜CCAI-对话分析AIO服务。'."\n"
.'2. 已创建应用:应用中心完成通义晓蜜CCAI-对话分析AIO应用创建,并获取到APP-ID和WORKSPACE-ID:[获取APP-ID和WORKSPACE-ID](https://help.aliyun.com/zh/model-studio/developer-reference/obtain-api-key-app-id-and-workspace-id?spm=openapi-amp.newDocPublishment.0.0.2eb8281f6Dxglg)。',
'changeSet' => [
['createdAt' => '2025-04-16T02:21:39.000Z', 'description' => '请求参数发生变更'],
],
],
'CreateTask' => [
'summary' => '通过创建离线异步任务,进行对话分析。应用调用支持 HTTP 调用来完成客户的响应。',
'path' => '/{workspaceId}/ccai/app/{appId}/createTask',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'workspaceId',
'in' => 'path',
'schema' => ['description' => '业务空间ID', 'type' => 'string', 'required' => false, 'example' => 'llm-ik******RVYCKzt'."\n"],
],
[
'name' => 'appId',
'in' => 'path',
'schema' => ['description' => '应用ID', 'type' => 'string', 'required' => false, 'example' => 'a070a49c681f4a95a0f0*********35c'],
],
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => '请求Body',
'type' => 'object',
'properties' => [
'dialogue' => [
'description' => '对话内容列表',
'type' => 'object',
'properties' => [
'sentences' => [
'description' => '对话内容',
'type' => 'array',
'items' => [
'description' => '对话内容',
'type' => 'object',
'properties' => [
'role' => [
'description' => '通话角色'."\n"
."\n"
.'- user:客户'."\n"
.'- agent:客服'."\n"
.'- system:系统消息',
'type' => 'string',
'required' => true,
'example' => 'user',
'enum' => ['agent', 'user', 'system'],
],
'text' => ['description' => '对话文本', 'type' => 'string', 'required' => true, 'example' => '请问怎么申请新卡'."\n"],
],
'required' => false,
],
'required' => true,
],
'sessionId' => ['description' => '客服会话sessionId', 'type' => 'string', 'required' => false, 'example' => 'session-01'],
],
'required' => false,
],
'examples' => [
'description' => '指令示例',
'type' => 'object',
'properties' => [
'output' => ['description' => '输出示例', 'type' => 'string', 'required' => false, 'example' => '问题描述:询问2.2更新时间,处理方案:已告知'],
'sentences' => [
'description' => '对话内容示例',
'type' => 'array',
'items' => [
'description' => '对话内容示例',
'type' => 'object',
'properties' => [
'role' => ['description' => '通话角色'."\n"
."\n"
.'- user:客户'."\n"
.'- agent:客服'."\n"
.'- system:系统消息', 'type' => 'string', 'required' => true, 'example' => 'user'],
'text' => ['description' => '对话文本', 'type' => 'string', 'required' => true, 'example' => '什么时候更新'],
],
'required' => true,
],
'required' => true,
'docRequired' => false,
],
],
'required' => false,
],
'fields' => [
'description' => '字段结构信息',
'type' => 'array',
'items' => [
'description' => '字段结构信息',
'type' => 'object',
'properties' => [
'code' => ['description' => '字段编码', 'type' => 'string', 'required' => false, 'example' => 'phoneNumber'."\n"],
'desc' => ['description' => '字段描述', 'type' => 'string', 'required' => true, 'example' => '用户来电咨询的原因分类,主要有投诉、咨询、政策建议等。'."\n"],
'enumValues' => [
'description' => '枚举值列表',
'type' => 'array',
'items' => [
'description' => '枚举值列表',
'type' => 'object',
'properties' => [
'desc' => ['description' => '枚举描述', 'type' => 'string', 'required' => true, 'example' => '客户有新的需求/新的场景,客服跟进沟通需求细节'."\n"],
'enumValue' => ['description' => '枚举值', 'type' => 'string', 'required' => true, 'example' => '新业务拓展'."\n"],
],
'required' => true,
],
'required' => false,
],
'name' => ['description' => '字段名称', 'type' => 'string', 'required' => true, 'example' => '来电原因类型'."\n"],
],
'required' => true,
],
'required' => false,
],
'modelCode' => [
'description' => '模型code',
'type' => 'string',
'required' => true,
'example' => 'tyxmTurbo',
'enum' => ['tyxmTurbo', 'tyxmPlus'],
],
'resultTypes' => [
'description' => '大模型处理类型',
'type' => 'array',
'items' => [
'description' => 'summary-对话摘要,title-标题生成、fields-字段信息抽取、keywords -关键字抽取,service_inspection-服务质检、question_solution-问题和解决方案、questions_and_answer-QA抽取、custom_prompt-自定义指令',
'type' => 'string',
'required' => true,
'example' => 'summary',
'enum' => ['summary', 'title', 'fields', 'keywords', 'service_inspection', 'question_solution', 'custom_prompt', 'category_tag', 'questions_and_answer', 'service_finish', 'actions', 'satisfaction', 'emotion_detection'],
],
'required' => false,
],
'serviceInspection' => [
'description' => '服务质检结构信息',
'type' => 'object',
'properties' => [
'inspectionContents' => [
'description' => '服务质检维度结构',
'type' => 'array',
'items' => [
'description' => '服务质检维度结构',
'type' => 'object',
'properties' => [
'content' => ['description' => '服务质检维度描述', 'type' => 'string', 'required' => true, 'example' => '客服在服务客户过程中,基于已有的服务标准是否存在过度承诺的行为,如:最快到货时间是12小时,无法给客户承诺更快的到货时间。'],
'title' => ['description' => '服务质检维度名称', 'type' => 'string', 'required' => true, 'example' => '客服是否过度承诺'."\n"],
],
'required' => true,
],
'required' => true,
],
'inspectionIntroduction' => ['description' => '服务质检场景详细介绍及描述', 'type' => 'string', 'required' => true, 'example' => '请检测客服是否存在服务不当的行为,包括:过度承诺、故意套取客户隐私信息等'],
'sceneIntroduction' => ['description' => '服务质检场景', 'type' => 'string', 'required' => true, 'example' => '保险销售场景'."\n"],
],
'required' => false,
],
'taskType' => [
'description' => '任务类型 audio -语音文件 ,text - 文本',
'type' => 'string',
'required' => true,
'example' => 'text',
'enum' => ['audio', 'text'],
],
'templateIds' => [
'description' => '模版id列表',
'type' => 'array',
'items' => ['description' => '模版id,模版id和指令任务类型同时存在时,优先使用模版id', 'type' => 'string', 'required' => true, 'example' => '34'],
'required' => false,
],
'transcription' => [
'description' => '语音类型执行参数',
'type' => 'object',
'properties' => [
'autoSplit' => ['description' => '单轨音频自动区分通话人,取值:0 为自动识别,取值:1 为不自动识别;默认:1;备注:只适用于8k采样率音频文件', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
'clientChannel' => ['description' => '适用于双轨录音,指定客户角色的轨道编号,取值:0、1,默认 1,即第 1 轨为客户;通常音轨都是从 0 开始编号,2 个轨就是 0,1;具体 0 是客服还是客户,需要您自行确认。**若使用此参数,请务必传入 autoSplit 参数,值为 0。**单轨文件忽略此参数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
'fileName' => ['description' => '文件名。', 'type' => 'string', 'required' => true, 'example' => 'sss.mp3'],
'serviceChannel' => ['description' => '适用于双轨录音,指定客服角色的轨道编号,取值:0、1,默认 0,即第 0 轨为客服;通常音轨都是从 0 开始编号,2 个轨就是 0,1;具体 0 是客服还是客户,需要您自行确认。**若使用此参数,请务必传入 autoSplit 参数,值为 0。**若单轨文件忽略此参数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
'serviceChannelKeywords' => [
'description' => '多数情况下适用于单轨录音,设置一组客服可能说的关键词列表(请确保选择那些区别性比较高的关键词),通过对转写文本从上到下逐句分析,当一句话命中某一个关键词时,则判定该句的角色为客服,则另一个角色就是客户。',
'type' => 'array',
'items' => ['description' => '多数情况下适用于单轨录音,设置一组客服可能说的关键词列表(请确保选择那些区别性比较高的关键词),通过对转写文本从上到下逐句分析,当一句话命中某一个关键词时,则判定该句的角色为客服,则另一个角色就是客户。', 'type' => 'string', 'required' => false, 'example' => '你好'],
'required' => false,
],
'voiceFileUrl' => ['description' => '文件地址', 'type' => 'string', 'required' => true, 'example' => 'http://1111.com/sss.mp3'],
'asrModelCode' => [
'description' => '语音转写模型,取值 asr (小模型),paraformer(大模型)',
'type' => 'string',
'required' => false,
'example' => 'asr',
'enum' => ['asr', 'paraformer'],
],
'level' => [
'description' => '语音转写优先级',
'type' => 'string',
'required' => false,
'example' => 'low',
'enum' => ['low', 'middle', 'high'],
],
'vocabularyId' => ['description' => '语音热词id', 'type' => 'string', 'required' => false, 'example' => 'esnvknv*****skdnvjksd'],
'roleIdentification' => ['description' => '自动识别通话角色,true 为自动识别,false为不自动识别。默认:false', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
'languageHints' => ['description' => '识别语言,默认值为中文普通话,其他支持的语种和方言请联系客服', 'type' => 'string', 'required' => false, 'example' => 'zh'],
],
'required' => false,
],
'customPrompt' => ['description' => '自定义指令', 'type' => 'string', 'required' => false, 'example' => '对通话内容进行总结'],
'variables' => [
'description' => '变量列表',
'type' => 'array',
'items' => [
'description' => '变量列表',
'type' => 'object',
'properties' => [
'variableCode' => ['description' => '变量code', 'type' => 'string', 'required' => false, 'example' => 'name'],
'variableValue' => ['description' => '变量值', 'type' => 'string', 'required' => false, 'example' => '张三'],
],
'required' => false,
],
'required' => false,
],
'categoryTags' => [
'description' => '标签分类列表',
'type' => 'array',
'items' => [
'description' => '标签分类列表',
'type' => 'object',
'properties' => [
'tagName' => ['description' => '标签名称', 'type' => 'string', 'required' => false, 'example' => '客服过度承诺'],
'tagDesc' => ['description' => '标签描述', 'type' => 'string', 'required' => false, 'example' => '客服在服务客户过程中,基于已有的服务标准是否存在过度承诺的行为'],
],
'required' => false,
],
'required' => false,
],
'responseFormatType' => ['description' => '输出结果格式化类型,jsonObject-json结构,text-原始字符串', 'type' => 'string', 'required' => false, 'example' => 'jsonObject'],
'callBackUrl' => ['description' => '任务完成后回调参数', 'type' => 'string', 'required' => false, 'example' => '123.456.com/callback'],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'data' => [
'description' => '数据',
'type' => 'object',
'properties' => [
'taskId' => ['description' => '任务ID。', 'type' => 'string', 'example' => '20240905-********-93E9-5D45-B4EF-045743A34071'],
],
],
'requestId' => ['title' => 'Id of the request', 'description' => '请求id', 'type' => 'string', 'example' => '9F1DB065-AE0D-5EE3-B1AF-48632CB0831C'],
'success' => ['description' => '是否成功', 'type' => 'string', 'example' => 'True'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'CCAI.InvalidParam.NotExist', 'errorMessage' => 'The specified parameter %s is not valid.', 'description' => '请求API的参数不存在'],
['errorCode' => 'CCAI.ParamInvalid.IllegalParamValue', 'errorMessage' => 'The parameter value of the request API is illegal %s.', 'description' => '请求API的参数不合法'],
['errorCode' => 'CCAI.Throttling.Qpm', 'errorMessage' => 'Trigger QPM flow restriction. Please purchase higher QPM for paid API. If free API has special requirements, please contact us through DingTalk group (62730018475).', 'description' => '触发QPM限流,付费API请购买更高QPM,免费API如有特殊需求,请通过钉钉群(62730018475)联系我们。'."\n"],
['errorCode' => 'CCAI.Throttling.Qps', 'errorMessage' => 'Trigger current QPS limit, pay API please buy higher QPS, the free API if you have special requirements, please contact us through the DingTalk group (62730018475).', 'description' => '触发限流,付费API请购买更高QPS,免费API如有特殊需求,请通过钉钉群(62730018475)联系我们。'."\n"],
],
403 => [
['errorCode' => 'CCAI.IllegalPermission.NoAuth', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => '该用户未被授权可操作指定资源'],
['errorCode' => 'CCAI.ParamNotfound.MissParam', 'errorMessage' => 'Parameter verification failed, The specified parameter %s is missing.', 'description' => '参数校验失败,指定参数缺失。'],
['errorCode' => 'CCAI.TenantPermission.NoAuth', 'errorMessage' => 'The current account does not have the permission to specify the business space. Please authorize the business space permission.', 'description' => '当前账号没有指定业务空间的权限,请进行业务空间权限授权。'],
],
429 => [
['errorCode' => 'Ccai.Throttling.Qps', 'errorMessage' => 'Trigger current QPS limit, pay API please buy higher QPS, free API if you have special requirements, please contact us through the DingTalk group (62730018475).', 'description' => '无效错误码,后续下线'],
],
500 => [
['errorCode' => 'CCAI.InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '系统内部错误,请稍后重试'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": {\\n \\"taskId\\": \\"20240905-********-93E9-5D45-B4EF-045743A34071\\"\\n },\\n \\"requestId\\": \\"9F1DB065-AE0D-5EE3-B1AF-48632CB0831C\\",\\n \\"success\\": \\"True\\"\\n}","type":"json"}]',
'title' => '通过上传离线任务数据进行通义晓蜜CCAI-对话分析',
'description' => '请确保在使用该接口前,已充分了解通义晓蜜CCAI-对话分析AIO产品的收费方式和价格。'."\n"
."\n"
.'## 前提条件'."\n"
."\n"
.'- 1.已开通通义晓蜜CCAI-对话分析AIO服务。'."\n"
.'- 2.已创建应用:应用中心完成通义晓蜜CCAI-对话分析AIO应用创建,并获取到APP-ID和WORKSPACE-ID:[获取APP-ID和WORKSPACE-ID](https://help.aliyun.com/zh/model-studio/developer-reference/obtain-api-key-app-id-and-workspace-id?spm=openapi-amp.newDocPublishment.0.0.3491281fOQZK5f)。'."\n"
."\n"
.'## 注意事项'."\n"
."\n"
.'- 1.目前任务数据在服务端保存时间为90天。'."\n"
.'- 2.对话内容字数限制为2万字,超过部分会自动截断。'."\n"
.'- 3.音频文件建议使用8k采样率,使用其他采样率会影响最终效果。',
'requestParamsDescription' => '## 语音识别参数说明'."\n"
."\n"
.'上传语音文件时,需要通过 serviceChannel 或 clientChannel 设置不同角色的音轨,后台服务通过音轨来识别角色。或是通过 serviceChannelKeywords 设置客服通话中的关键字,后台服务通过客服通话中的关键字来识别角色。'."\n"
."\n"
.'## 回调参数说明'."\n"
.'假设调用方传入的回调地址是:http://aliyun.com/callback,那么回调时的完整 URL 为http://aliyun.com/callback?taskId=xxx×tamp=xxx&taskType=xxx&signature=xxx&&success=xxx,其中:'."\n"
."\n"
.'- taskId:为任务 ID'."\n"
.'- timestamp:为调用时的时间戳,单位:毫秒 '."\n"
.'- taskType:为任务类型 '."\n"
.'- success:为是否成功'."\n"
.'- signature:为签名,调用方可用来判断请求是否来自阿里云;计算说明:将taskId=xxx×tamp=xxx&aliUid=xxx进行 md5+base64 加密,注意顺序;调用方接到回调后,taskId 和 timestamp 可以从回调 URL 中获取,aliUid 即为阿里云主账号 ID。通过计算来比对自己计算出的 signature,与 URL 中的 signature 是否一致,详见下方 Java 代码示例。'."\n"
."\n"
.'```java'."\n"
.'import java.net.URLEncoder;'."\n"
.'import java.security.MessageDigest;'."\n"
.'import java.security.NoSuchAlgorithmException;'."\n"
.'import java.nio.charset.StandardCharsets;'."\n"
.'import org.apache.commons.codec.binary.Base64;'."\n"
."\n"
.'public class Sample {'."\n"
."\n"
.' public static void signature() {'."\n"
.' long timestamp = System.currentTimeMillis();'."\n"
.' String taskId = "xxx";'."\n"
.' String aliUid = "xxx";'."\n"
.' // 将 taskId=xxx×tamp=xxx&aliUid=xxx 进行 md5 + base64 加密,放在 signature 字段'."\n"
.' String signature;'."\n"
.' try {'."\n"
.' signature = URLEncoder.encode(md5Base64("taskId=" + taskId + "×tamp=" + timestamp + "&aliUid=" + aliUid), "utf-8");'."\n"
.' System.out.println(signature);'."\n"
.' } catch (Exception e) {'."\n"
.' e.printStackTrace();'."\n"
.' }'."\n"
.' }'."\n"
."\n"
.' public static String md5Base64(String str) throws NoSuchAlgorithmException {'."\n"
.' //string 编码必须为 utf-8'."\n"
.' byte[] utfBytes = str.getBytes(StandardCharsets.UTF_8);'."\n"
.' MessageDigest mdTemp = MessageDigest.getInstance("MD5");'."\n"
.' mdTemp.update(utfBytes);'."\n"
.' byte[] md5Bytes = mdTemp.digest();'."\n"
.' return Base64.encodeBase64String(md5Bytes);'."\n"
.' }'."\n"
.'}'."\n"
."\n"
.'```',
'changeSet' => [
['createdAt' => '2025-07-25T09:33:48.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-06-20T07:54:42.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-05-27T09:09:34.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-05-06T09:49:02.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-04-16T02:21:39.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-04-01T02:08:31.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-02-25T02:52:45.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-02-20T10:52:12.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-01-16T08:47:12.000Z', 'description' => '请求参数发生变更'],
],
],
'CreateVocab' => [
'summary' => '将一组语音热词上传到服务端,并获取返回热词ID。',
'path' => '/vocab/createVocab',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => '请求Body',
'type' => 'object',
'properties' => [
'workspaceId' => ['description' => '业务空间ID', 'type' => 'string', 'required' => true, 'example' => 'llm-9****me1'],
'name' => ['description' => '名称', 'type' => 'string', 'required' => true, 'example' => '词表1'],
'description' => ['description' => '版本描述', 'type' => 'string', 'required' => false, 'example' => '销售词表'],
'audioModelCode' => ['description' => '语音转写模型', 'type' => 'string', 'required' => false, 'example' => 'nls'],
'wordWeightList' => [
'description' => '热词组',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'weight' => ['description' => '权重值', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '2'],
'word' => ['description' => '单词', 'type' => 'string', 'required' => true, 'example' => '大树'],
],
'required' => true,
'description' => '',
],
'required' => true,
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'requestId' => ['title' => 'Id of the request', 'description' => '请求id', 'type' => 'string', 'example' => '968A8634-FA2C-5381-9B3E-*******F'],
'success' => ['description' => '调用是否成功', 'type' => 'string', 'example' => 'True'],
'data' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'vocabularyId' => ['description' => '热词id', 'type' => 'string', 'example' => 'f3d82*******7'],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'CCAI.InvalidParam.NotExist', 'errorMessage' => 'The specified parameter %s is not valid.', 'description' => '请求API的参数不存在'],
['errorCode' => 'CCAI.ParamInvalid.IllegalParamValue', 'errorMessage' => 'The parameter value of the request API is illegal %s.', 'description' => '请求API的参数不合法'],
['errorCode' => 'CCAI.Throttling.Qpm', 'errorMessage' => 'Trigger QPM flow restriction. Please purchase higher QPM for paid API. If free API has special requirements, please contact us through DingTalk group (62730018475).', 'description' => '触发QPM限流,付费API请购买更高QPM,免费API如有特殊需求,请通过钉钉群(62730018475)联系我们。'."\n"],
['errorCode' => 'CCAI.Throttling.Qps', 'errorMessage' => 'Trigger current QPS limit, pay API please buy higher QPS, the free API if you have special requirements, please contact us through the DingTalk group (62730018475).', 'description' => '触发限流,付费API请购买更高QPS,免费API如有特殊需求,请通过钉钉群(62730018475)联系我们。'."\n"],
],
403 => [
['errorCode' => 'CCAI.IllegalPermission.NoAuth', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => '该用户未被授权可操作指定资源'],
['errorCode' => 'CCAI.ParamNotfound.MissParam', 'errorMessage' => 'Parameter verification failed, The specified parameter %s is missing.', 'description' => '参数校验失败,指定参数缺失。'],
['errorCode' => 'CCAI.TenantPermission.NoAuth', 'errorMessage' => 'The current account does not have the permission to specify the business space. Please authorize the business space permission.', 'description' => '当前账号没有指定业务空间的权限,请进行业务空间权限授权。'],
],
500 => [
['errorCode' => 'CCAI.InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '系统内部错误,请稍后重试'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"968A8634-FA2C-5381-9B3E-*******F\\",\\n \\"success\\": \\"True\\",\\n \\"data\\": {\\n \\"vocabularyId\\": \\"f3d82*******7\\"\\n }\\n}","type":"json"}]',
'title' => '创建热词',
'description' => '请确保在使用该接口前,已充分了解通义晓蜜CCAI-对话分析AIO产品的收费方式和价格。'."\n"
."\n"
.'前提条件'."\n"
."\n"
.'- 已开通通义晓蜜CCAI-对话分析AIO服务。'."\n"
.'- 已创建应用:应用中心完成通义晓蜜CCAI-对话分析AIO应用创建,并获取到APP-ID和WORKSPACE-ID:[获取APP-ID和WORKSPACE-ID](https://help.aliyun.com/zh/model-studio/developer-reference/obtain-api-key-app-id-and-workspace-id?spm=openapi-amp.newDocPublishment.0.0.39e3281fMO5qOX)。',
'requestParamsDescription' => '## 请求入参限制'."\n"
."\n"
.'- 默认最多创建10个词表。'."\n"
."\n"
.'- 每个词表最多添加500个词,每个词语最长10个字。'."\n"
."\n"
.'- 业务专属热词必须为UTF-8编码,不能包含标点、特殊字符。'."\n"
."\n"
.'- 业务专属词对应的权重取值范围为[-6,5]之间的整数。'."\n"
."\n"
.'- 取值大于0增大该词语被识别的概率,小于0减小该词语被识别的概率。'."\n"
."\n"
.'- 取值为-6:表示尽量不要识别出该词语。'."\n"
."\n"
.'- 取值为2:常用值。'."\n"
."\n"
.'- 如果效果不明显可以适当增加权重,但是当权重较大时可能会引起负面效果,导致其他词语识别不准确。'."\n"
."\n"
.'## 接口请求示例'."\n"
.'```java'."\n"
.'import com.alibaba.fastjson.JSONObject;'."\n"
.'import com.aliyun.contactcenterai20240603.Client;'."\n"
.'import com.aliyun.contactcenterai20240603.models.CreateVocabRequest;'."\n"
.'import com.aliyun.contactcenterai20240603.models.CreateVocabResponse;'."\n"
.'import com.aliyun.teaopenapi.models.Config;'."\n"
."\n"
.'import java.util.ArrayList;'."\n"
.'import java.util.List;'."\n"
."\n"
.'public class Vocab {'."\n"
."\n"
.' private static String accessKeyId = "YOUR_ACCESS_KEY_ID";'."\n"
."\n"
.' private static String accessKeySecret = "YOUR_ACCESS_KEY_SECRET";'."\n"
."\n"
.' private static String workspaceId = "YOUR_WORKSPACE_ID";'."\n"
."\n"
.' private static Config config = new Config();'."\n"
."\n"
.' static {'."\n"
.' config.setAccessKeyId(accessKeyId).setAccessKeySecret(accessKeySecret).setEndpoint("contactcenterai.cn-shanghai.aliyuncs.com")'."\n"
.' .setReadTimeout(30000).setConnectTimeout(300000).setRegionId("cn-shanghai").setProtocol("HTTPS");'."\n"
.' }'."\n"
."\n"
.' public static void main(String[] args) throws Exception {'."\n"
.' Client client = new Client(config);'."\n"
."\n"
.' CreateVocabRequest request = new CreateVocabRequest();'."\n"
.' request.setName("销售词表");'."\n"
.' request.setDescription("东北一区销售业务专用");'."\n"
.' request.setWorkspaceId(workspaceId);'."\n"
."\n"
.' List<CreateVocabRequest.CreateVocabRequestWordWeightList> wordWeightList = new ArrayList<>();'."\n"
.' CreateVocabRequest.CreateVocabRequestWordWeightList word1 = new CreateVocabRequest.CreateVocabRequestWordWeightList();'."\n"
.' word1.setWord("儿童");'."\n"
.' word1.setWeight(3);'."\n"
.' wordWeightList.add(word1);'."\n"
."\n"
.' CreateVocabRequest.CreateVocabRequestWordWeightList word2 = new CreateVocabRequest.CreateVocabRequestWordWeightList();'."\n"
.' word2.setWord("金属");'."\n"
.' word2.setWeight(3);'."\n"
.' wordWeightList.add(word2);'."\n"
."\n"
.' request.setWordWeightList(wordWeightList);'."\n"
."\n"
.' CreateVocabResponse response = client.createVocab(request);'."\n"
.' System.out.println(JSONObject.toJSONString(response));'."\n"
.' }'."\n"
.'}'."\n"
."\n"
.'```',
'changeSet' => [
['createdAt' => '2025-03-26T09:32:54.000Z', 'description' => '请求参数发生变更'],
],
],
'DeleteVocab' => [
'summary' => '根据词表的ID删除对应的词表。',
'path' => '/vocab/deleteVocab',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => '请求Body',
'type' => 'object',
'properties' => [
'vocabularyId' => ['description' => '热词id', 'type' => 'string', 'required' => true, 'example' => 'ern*******rve'],
'workspaceId' => ['description' => '业务空间ID', 'type' => 'string', 'required' => true, 'example' => 'llm-0*****jlg8s'],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'requestId' => ['title' => 'Id of the request', 'description' => '请求id', 'type' => 'string', 'example' => '968A8634-FA2C-5381-9B3E-*******F'],
'success' => ['description' => '请求是否成功', 'type' => 'string', 'example' => 'true'],
'data' => ['description' => '返回数据', 'type' => 'string', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'CCAI.InvalidParam.NotExist', 'errorMessage' => 'The specified parameter %s is not valid.', 'description' => '请求API的参数不存在'],
['errorCode' => 'CCAI.ParamInvalid.IllegalParamValue', 'errorMessage' => 'The parameter value of the request API is illegal %s.', 'description' => '请求API的参数不合法'],
['errorCode' => 'CCAI.Throttling.Qpm', 'errorMessage' => 'Trigger QPM flow restriction. Please purchase higher QPM for paid API. If free API has special requirements, please contact us through DingTalk group (62730018475).', 'description' => '触发QPM限流,付费API请购买更高QPM,免费API如有特殊需求,请通过钉钉群(62730018475)联系我们。'."\n"],
['errorCode' => 'CCAI.Throttling.Qps', 'errorMessage' => 'Trigger current QPS limit, pay API please buy higher QPS, the free API if you have special requirements, please contact us through the DingTalk group (62730018475).', 'description' => '触发限流,付费API请购买更高QPS,免费API如有特殊需求,请通过钉钉群(62730018475)联系我们。'."\n"],
],
403 => [
['errorCode' => 'CCAI.IllegalPermission.NoAuth', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => '该用户未被授权可操作指定资源'],
['errorCode' => 'CCAI.ParamNotfound.MissParam', 'errorMessage' => 'Parameter verification failed, The specified parameter %s is missing.', 'description' => '参数校验失败,指定参数缺失。'],
['errorCode' => 'CCAI.TenantPermission.NoAuth', 'errorMessage' => 'The current account does not have the permission to specify the business space. Please authorize the business space permission.', 'description' => '当前账号没有指定业务空间的权限,请进行业务空间权限授权。'],
],
500 => [
['errorCode' => 'CCAI.InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '系统内部错误,请稍后重试'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"968A8634-FA2C-5381-9B3E-*******F\\",\\n \\"success\\": \\"true\\",\\n \\"data\\": \\"true\\"\\n}","type":"json"}]',
'title' => '删除热词',
'description' => '请确保在使用该接口前,已充分了解通义晓蜜CCAI-对话分析AIO产品的收费方式和价格。'."\n"
."\n"
.'前提条件'."\n"
."\n"
.'- 已开通通义晓蜜CCAI-对话分析AIO服务。'."\n"
.'- 已创建应用:应用中心完成通义晓蜜CCAI-对话分析AIO应用创建,并获取到APP-ID和WORKSPACE-ID:[获取APP-ID和WORKSPACE-ID](https://help.aliyun.com/zh/model-studio/developer-reference/obtain-api-key-app-id-and-workspace-id?spm=openapi-amp.newDocPublishment.0.0.39e3281fMO5qOX)。',
'requestParamsDescription' => '## 请求代码示例'."\n"
.'```java'."\n"
."\n"
.'import com.alibaba.fastjson.JSONObject;'."\n"
.'import com.aliyun.contactcenterai20240603.Client;'."\n"
.'import com.aliyun.contactcenterai20240603.models.*;'."\n"
.'import com.aliyun.teaopenapi.models.Config;'."\n"
."\n"
.'import java.util.ArrayList;'."\n"
.'import java.util.List;'."\n"
."\n"
.'public class Vocab {'."\n"
."\n"
.' private static String accessKeyId = "YOUR_ACCESS_KEY_ID";'."\n"
.' private static String accessKeySecret = "YOUR_ACCESS_KEY_SECRET";'."\n"
."\n\n"
.' private static String workspaceId = "YOUR_WORKSPACE_ID";'."\n"
."\n"
.' private static Config config = new Config();'."\n"
."\n"
.' static {'."\n"
.' config.setAccessKeyId(accessKeyId).setAccessKeySecret(accessKeySecret).setEndpoint("contactcenterai.cn-shanghai.aliyuncs.com")'."\n"
.' .setReadTimeout(30000).setConnectTimeout(300000).setRegionId("cn-shanghai").setProtocol("HTTPS");'."\n"
.' }'."\n"
."\n"
.' public static void main(String[] args) throws Exception {'."\n"
.' Client client = new Client(config);'."\n"
."\n"
.' DeleteVocabRequest request = new DeleteVocabRequest();'."\n"
.' request.setVocabularyId("81a3*********2d7c8");'."\n"
.' request.setWorkspaceId(workspaceId);'."\n"
."\n"
.' DeleteVocabResponse response = client.deleteVocab(request);'."\n"
.' System.out.println(JSONObject.toJSONString(response));'."\n"
.' }'."\n"
.'}'."\n"
."\n"
.'```',
'changeSet' => [],
],
'GeneralAnalyzeImage' => [
'summary' => '通用图片分析。',
'path' => '/{workspaceId}/ccai/app/{appId}/generalanalyzeImage',
'methods' => ['post'],
'schemes' => ['https', 'sse'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json', 'application/octet-stream'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid'],
'parameters' => [
[
'name' => 'workspaceId',
'in' => 'path',
'schema' => ['description' => '工作空间ID', 'type' => 'string', 'required' => false, 'example' => 'llm-ik******RVYCKzt'."\n"],
],
[
'name' => 'appId',
'in' => 'path',
'schema' => ['description' => '应用id。', 'type' => 'string', 'required' => false, 'example' => 'a070a49c681f4a95a0f0*********35c'],
],
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => '请求体。',
'type' => 'object',
'properties' => [
'stream' => ['description' => '必填。是否流式:true,流式返回答案;false,全量返回答案。', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'true'],
'imageUrls' => [
'description' => '图片地址列表',
'type' => 'array',
'items' => ['description' => '图片地址列表', 'type' => 'string', 'required' => false, 'example' => 'https://img.123.com/1.jppg'],
'required' => true,
],
'customPrompt' => ['description' => '自定义指令', 'type' => 'string', 'required' => false, 'example' => 'Analyze the content in the image'],
'templateIds' => [
'description' => '模版id,模版id和customPrompt同时存在时,优先使用模版id',
'type' => 'array',
'items' => ['description' => '模版id,模版id和指令任务类型同时存在时,优先使用模版id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '34'],
'required' => false,
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '2D718325-92F9-5588-803B-C4A69A5F0AE1'],
'success' => ['description' => '请求是否成功', 'type' => 'boolean', 'example' => 'True'],
'text' => ['description' => '应用返回的结果。', 'type' => 'string', 'example' => '这张图片中没有可识别的文本内容。因此,无法进行OCR(光学字符识别)。如果你有其他需求或问题,请告诉我'],
'finishReason' => ['description' => '如果是流式输出,正在生成时为null,生成结束时如果由于停止token导致则为stop。', 'type' => 'string', 'example' => 'stop'],
'inputTokens' => ['description' => '输入Token数量', 'type' => 'integer', 'format' => 'int32', 'example' => '1000'],
'outputTokens' => ['description' => '输出Token数量', 'type' => 'integer', 'format' => 'int32', 'example' => '2000'],
'totalTokens' => ['description' => 'Tokens总量', 'type' => 'integer', 'format' => 'int32', 'example' => '3000'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'CCAI.InvalidParam.NotExist', 'errorMessage' => 'The specified parameter %s is not valid.', 'description' => '请求API的参数不存在'],
['errorCode' => 'CCAI.ParamInvalid.IllegalParamValue', 'errorMessage' => 'The parameter value of the request API is illegal %s.', 'description' => '请求API的参数不合法'],
['errorCode' => 'CCAI.Throttling.Qpm', 'errorMessage' => 'Trigger QPM flow restriction. Please purchase higher QPM for paid API. If free API has special requirements, please contact us through DingTalk group (62730018475).', 'description' => '触发QPM限流,付费API请购买更高QPM,免费API如有特殊需求,请通过钉钉群(62730018475)联系我们。'."\n"],
['errorCode' => 'CCAI.Throttling.Qps', 'errorMessage' => 'Trigger current QPS limit, pay API please buy higher QPS, the free API if you have special requirements, please contact us through the DingTalk group (62730018475).', 'description' => '触发限流,付费API请购买更高QPS,免费API如有特殊需求,请通过钉钉群(62730018475)联系我们。'."\n"],
],
403 => [
['errorCode' => 'CCAI.ParamNotfound.MissParam', 'errorMessage' => 'Parameter verification failed, The specified parameter %s is missing.', 'description' => '参数校验失败,指定参数缺失。'],
['errorCode' => 'CCAI.TenantPermission.NoAuth', 'errorMessage' => 'The current account does not have the permission to specify the business space. Please authorize the business space permission.', 'description' => '当前账号没有指定业务空间的权限,请进行业务空间权限授权。'],
['errorCode' => 'CCAI.IllegalPermission.NoAuth', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => '该用户未被授权可操作指定资源'],
],
500 => [
['errorCode' => 'CCAI.InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '系统内部错误,请稍后重试'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2D718325-92F9-5588-803B-C4A69A5F0AE1\\",\\n \\"success\\": true,\\n \\"text\\": \\"这张图片中没有可识别的文本内容。因此,无法进行OCR(光学字符识别)。如果你有其他需求或问题,请告诉我\\",\\n \\"finishReason\\": \\"stop\\",\\n \\"inputTokens\\": 1000,\\n \\"outputTokens\\": 2000,\\n \\"totalTokens\\": 3000\\n}","type":"json"}]',
'title' => '通用图片分析',
'changeSet' => [],
],
'GetTaskResult' => [
'summary' => '通过任务ID获取离线任务对话分析结果。应用调用支持 HTTPS调用来完成客户的响应。',
'path' => '/ccai/app/getTaskResult',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['multipart/form-data'],
'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'taskId',
'in' => 'query',
'schema' => ['description' => '任务ID', 'type' => 'string', 'required' => false, 'example' => '20240905-********-93E9-5D45-B4EF-045743A34071'."\n"],
],
[
'name' => 'requiredFieldList',
'in' => 'query',
'style' => 'simple',
'schema' => [
'description' => '可选字段列表',
'type' => 'array',
'items' => [
'description' => '可选字段值',
'type' => 'string',
'required' => false,
'example' => 'asr_result',
'enum' => ['asr_result', 'debug', 'rag_result'],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'data' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'taskId' => ['description' => '任务ID。', 'type' => 'string', 'example' => '20240905-********-93E9-5D45-B4EF-045743A34071'."\n"],
'text' => ['description' => '应用返回的结果。', 'type' => 'string', 'example' => '对话中没有发现客服故意套取客户隐私信息的行为'],
'taskErrorMessage' => ['description' => '任务失败信息', 'type' => 'string', 'example' => '异常'],
'taskStatus' => ['description' => '任务状态。QUEUE-排队中,FINISH-已完成,ERROR-任务出错', 'type' => 'string', 'example' => 'FINISH'],
'asrResult' => [
'description' => 'ASR识别结果列表',
'type' => 'array',
'items' => [
'description' => 'ASR识别结果',
'type' => 'object',
'properties' => [
'begin' => ['description' => '该句的起始时间偏移,单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '80'],
'emotionValue' => ['description' => '情绪能量值,取值为音量分贝值/10。取值范围:[1,10]。值越高情绪越强烈。', 'type' => 'integer', 'format' => 'int32', 'example' => '5'],
'end' => ['description' => '该句的结束时间偏移,单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '8480'],
'role' => ['description' => '该句所属音轨ID。', 'type' => 'string', 'example' => '0'],
'speechRate' => ['description' => '本句的平均语速。'."\n"
."\n"
.'若识别语言为中文,则单位为:字数/分钟。'."\n"
."\n"
.'若识别语言为英文,则单位为:单词数/分钟。', 'type' => 'integer', 'format' => 'int32', 'example' => '342'],
'words' => ['description' => '该句的识别文本结果。', 'type' => 'string', 'example' => 'Hello'],
'roleName' => ['description' => '角色名称', 'type' => 'string', 'example' => '客户'],
],
],
],
'extra' => ['description' => '可选的补充内容', 'type' => 'string', 'example' => '{"roleConfig":{"role1Name":"客户","role2Name":"客服"}}'],
'ragStatus' => ['description' => 'rag执行状态', 'type' => 'string', 'example' => 'SUCCESS'],
'ragResult' => ['description' => 'rag召回结果', 'type' => 'string', 'example' => '召回内容'],
'usage' => [
'description' => '使用量',
'type' => 'object',
'properties' => [
'rag' => [
'description' => 'rag使用详情',
'type' => 'object',
'properties' => [
'dialogSummary' => [
'description' => '会话摘要',
'type' => 'object',
'properties' => [
'inputTokens' => ['description' => '输入Token数量', 'type' => 'integer', 'format' => 'int32', 'example' => '520'],
'outputTokens' => ['description' => '输出Token数量', 'type' => 'integer', 'format' => 'int32', 'example' => '664'],
'invokeCount' => ['description' => '调用次数', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
],
],
'adaptive' => [
'description' => 'rag智能调用',
'type' => 'object',
'properties' => [
'inputTokens' => ['description' => '输入Token数量', 'type' => 'integer', 'format' => 'int32', 'example' => '482'],
'outputTokens' => ['description' => '输出Token数量', 'type' => 'integer', 'format' => 'int32', 'example' => '789'],
'invokeCount' => ['description' => '调用次数', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
],
],
],
],
],
],
'ragErrorMessage' => ['description' => 'rag执行错误异常message', 'type' => 'string', 'example' => '非法参数:[无有效知识库]'],
],
],
'requestId' => ['title' => 'Id of the request', 'description' => '请求id', 'type' => 'string', 'example' => '968A8634-FA2C-5381-9B3E-C552DED7E8BF'],
'success' => ['description' => '请求是否成功', 'type' => 'string', 'example' => 'True'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'CCAI.InvalidParam.NotExist', 'errorMessage' => 'The specified parameter %s is not valid.', 'description' => '请求API的参数不存在'],
['errorCode' => 'CCAI.ParamInvalid.IllegalParamValue', 'errorMessage' => 'The parameter value of the request API is illegal %s.', 'description' => '请求API的参数不合法'],
['errorCode' => 'CCAI.Throttling.Qpm', 'errorMessage' => 'Trigger QPM flow restriction. Please purchase higher QPM for paid API. If free API has special requirements, please contact us through DingTalk group (62730018475).', 'description' => '触发QPM限流,付费API请购买更高QPM,免费API如有特殊需求,请通过钉钉群(62730018475)联系我们。'."\n"],
['errorCode' => 'CCAI.Throttling.Qps', 'errorMessage' => 'Trigger current QPS limit, pay API please buy higher QPS, the free API if you have special requirements, please contact us through the DingTalk group (62730018475).', 'description' => '触发限流,付费API请购买更高QPS,免费API如有特殊需求,请通过钉钉群(62730018475)联系我们。'."\n"],
],
403 => [
['errorCode' => 'CCAI.ParamNotfound.MissParam', 'errorMessage' => 'Parameter verification failed, The specified parameter %s is missing.', 'description' => '参数校验失败,指定参数缺失。'],
['errorCode' => 'CCAI.TenantPermission.NoAuth', 'errorMessage' => 'The current account does not have the permission to specify the business space. Please authorize the business space permission.', 'description' => '当前账号没有指定业务空间的权限,请进行业务空间权限授权。'],
['errorCode' => 'CCAI.IllegalPermission.NoAuth', 'errorMessage' => 'User not authorized to operate on the specified resource %s .', 'description' => '该用户未被授权可操作指定资源'],
],
429 => [
['errorCode' => 'Ccai.Throttling.Qps', 'errorMessage' => 'Trigger current QPS limit, pay API please buy higher QPS, free API if you have special requirements, please contact us through the DingTalk group (62730018475).', 'description' => '无效错误码,后续下线'],
],
500 => [
['errorCode' => 'CCAI.InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '系统内部错误,请稍后重试'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": {\\n \\"taskId\\": \\"20240905-********-93E9-5D45-B4EF-045743A34071\\\\n\\",\\n \\"text\\": \\"对话中没有发现客服故意套取客户隐私信息的行为\\",\\n \\"taskErrorMessage\\": \\"异常\\",\\n \\"taskStatus\\": \\"FINISH\\",\\n \\"asrResult\\": [\\n {\\n \\"begin\\": 80,\\n \\"emotionValue\\": 5,\\n \\"end\\": 8480,\\n \\"role\\": \\"0\\",\\n \\"speechRate\\": 342,\\n \\"words\\": \\"Hello\\",\\n \\"roleName\\": \\"客户\\"\\n }\\n ],\\n \\"extra\\": \\"{\\\\\\"roleConfig\\\\\\":{\\\\\\"role1Name\\\\\\":\\\\\\"客户\\\\\\",\\\\\\"role2Name\\\\\\":\\\\\\"客服\\\\\\"}}\\",\\n \\"ragStatus\\": \\"SUCCESS\\",\\n \\"ragResult\\": \\"召回内容\\",\\n \\"usage\\": {\\n \\"rag\\": {\\n \\"dialogSummary\\": {\\n \\"inputTokens\\": 520,\\n \\"outputTokens\\": 664,\\n \\"invokeCount\\": 1\\n },\\n \\"adaptive\\": {\\n \\"inputTokens\\": 482,\\n \\"outputTokens\\": 789,\\n \\"invokeCount\\": 1\\n }\\n }\\n },\\n \\"ragErrorMessage\\": \\"非法参数:[无有效知识库]\\"\\n },\\n \\"requestId\\": \\"968A8634-FA2C-5381-9B3E-C552DED7E8BF\\",\\n \\"success\\": \\"True\\"\\n}","type":"json"}]',
'title' => '通过任务ID获取离线任务分析结果',
'description' => '请确保在使用该接口前,已充分了解通义晓蜜CCAI-对话分析AIO产品的收费方式和价格。'."\n"
."\n"
.'前提条件'."\n"
.'1. 已开通通义晓蜜CCAI-对话分析AIO服务。'."\n"
.'2. 已创建应用:应用中心完成通义晓蜜CCAI-对话分析AIO应用创建,并获取到APP-ID和WORKSPACE-ID:[获取APP-ID和WORKSPACE-ID](https://help.aliyun.com/zh/model-studio/developer-reference/obtain-api-key-app-id-and-workspace-id?spm=openapi-amp.newDocPublishment.0.0.310f281ffuUD8V)。',
'changeSet' => [
['createdAt' => '2025-06-11T09:04:52.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2025-01-16T08:47:12.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
['createdAt' => '2024-12-05T02:01:27.000Z', 'description' => '错误码发生变更、请求参数发生变更、响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTaskResult'],
],
],
],
'GetVocab' => [
'summary' => '根据词表的ID获取对应的词表信息。',
'path' => '/vocab/getVocab',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => '请求Body',
'type' => 'object',
'properties' => [
'vocabularyId' => ['description' => '热词id', 'type' => 'string', 'required' => true, 'example' => 'dhbf***rbrdb'],
'workspaceId' => ['description' => '工作空间ID', 'type' => 'string', 'required' => true, 'example' => 'llm-9864***1'],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'requestId' => ['title' => 'Id of the request', 'description' => '请求id', 'type' => 'string', 'example' => '968A8634-FA2C-5381-9B3E-*******F'],
'success' => ['description' => '请求是否成功', 'type' => 'string', 'example' => 'true'],
'data' => [
'description' => '返回数据',
'type' => 'object',
'properties' => [
'vocabularyId' => ['description' => '热词id', 'type' => 'string', 'example' => 'rrbe***jrvrdd'],
'name' => ['description' => '名称', 'type' => 'string', 'example' => '热词1'],
'description' => ['description' => '描述', 'type' => 'string', 'example' => '销售热词'],
'audioModelCode' => ['description' => '语音转写模型', 'type' => 'string', 'example' => 'nls'],
'wordWeightList' => [
'description' => '热词组',
'type' => 'array',
'items' => [
'description' => '热词组',
'type' => 'object',
'properties' => [
'word' => ['description' => '单词', 'type' => 'string', 'example' => '儿童'],
'weight' => ['description' => '权重', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'CCAI.InvalidParam.NotExist', 'errorMessage' => 'The specified parameter %s is not valid.', 'description' => '请求API的参数不存在'],
['errorCode' => 'CCAI.ParamInvalid.IllegalParamValue', 'errorMessage' => 'The parameter value of the request API is illegal %s.', 'description' => '请求API的参数不合法'],
['errorCode' => 'CCAI.Throttling.Qpm', 'errorMessage' => 'Trigger QPM flow restriction. Please purchase higher QPM for paid API. If free API has special requirements, please contact us through DingTalk group (62730018475).', 'description' => '触发QPM限流,付费API请购买更高QPM,免费API如有特殊需求,请通过钉钉群(62730018475)联系我们。'."\n"],
['errorCode' => 'CCAI.Throttling.Qps', 'errorMessage' => 'Trigger current QPS limit, pay API please buy higher QPS, the free API if you have special requirements, please contact us through the DingTalk group (62730018475).', 'description' => '触发限流,付费API请购买更高QPS,免费API如有特殊需求,请通过钉钉群(62730018475)联系我们。'."\n"],
],
403 => [
['errorCode' => 'CCAI.IllegalPermission.NoAuth', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => '该用户未被授权可操作指定资源'],
['errorCode' => 'CCAI.ParamNotfound.MissParam', 'errorMessage' => 'Parameter verification failed, The specified parameter %s is missing.', 'description' => '参数校验失败,指定参数缺失。'],
['errorCode' => 'CCAI.TenantPermission.NoAuth', 'errorMessage' => 'The current account does not have the permission to specify the business space. Please authorize the business space permission.', 'description' => '当前账号没有指定业务空间的权限,请进行业务空间权限授权。'],
],
500 => [
['errorCode' => 'CCAI.InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '系统内部错误,请稍后重试'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"968A8634-FA2C-5381-9B3E-*******F\\",\\n \\"success\\": \\"true\\",\\n \\"data\\": {\\n \\"vocabularyId\\": \\"rrbe***jrvrdd\\",\\n \\"name\\": \\"热词1\\",\\n \\"description\\": \\"销售热词\\",\\n \\"audioModelCode\\": \\"nls\\",\\n \\"wordWeightList\\": [\\n {\\n \\"word\\": \\"儿童\\",\\n \\"weight\\": 1\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '获取热词',
'description' => '请确保在使用该接口前,已充分了解通义晓蜜CCAI-对话分析AIO产品的收费方式和价格。'."\n"
."\n"
.'前提条件'."\n"
."\n"
.'- 已开通通义晓蜜CCAI-对话分析AIO服务。'."\n"
.'- 已创建应用:应用中心完成通义晓蜜CCAI-对话分析AIO应用创建,并获取到APP-ID和WORKSPACE-ID:[获取APP-ID和WORKSPACE-ID](https://help.aliyun.com/zh/model-studio/developer-reference/obtain-api-key-app-id-and-workspace-id?spm=openapi-amp.newDocPublishment.0.0.39e3281fMO5qOX)。',
'requestParamsDescription' => '## 请求代码示例'."\n"
.'```java'."\n"
."\n"
.'import com.alibaba.fastjson.JSONObject;'."\n"
.'import com.aliyun.contactcenterai20240603.Client;'."\n"
.'import com.aliyun.contactcenterai20240603.models.CreateVocabRequest;'."\n"
.'import com.aliyun.contactcenterai20240603.models.CreateVocabResponse;'."\n"
.'import com.aliyun.contactcenterai20240603.models.GetVocabRequest;'."\n"
.'import com.aliyun.contactcenterai20240603.models.GetVocabResponse;'."\n"
.'import com.aliyun.teaopenapi.models.Config;'."\n"
."\n"
.'import java.util.ArrayList;'."\n"
.'import java.util.List;'."\n"
."\n"
.'public class Vocab {'."\n"
."\n"
.' private static String accessKeyId = "YOUR_ACCESS_KEY_ID";'."\n"
.' private static String accessKeySecret = "YOUR_ACCESS_KEY_SECRET";'."\n"
."\n\n"
.' private static String workspaceId = "YOUR_WORKSPACE_ID";'."\n"
."\n"
.' private static Config config = new Config();'."\n"
."\n"
.' static {'."\n"
.' config.setAccessKeyId(accessKeyId).setAccessKeySecret(accessKeySecret).setEndpoint("contactcenterai.cn-shanghai.aliyuncs.com")'."\n"
.' .setReadTimeout(30000).setConnectTimeout(300000).setRegionId("cn-shanghai").setProtocol("HTTPS");'."\n"
.' }'."\n"
."\n"
.' public static void main(String[] args) throws Exception {'."\n"
.' Client client = new Client(config);'."\n"
."\n"
.' GetVocabRequest request = new GetVocabRequest();'."\n"
.' request.setVocabularyId("1a3188**********7d2e");'."\n"
.' request.setWorkspaceId(workspaceId);'."\n"
."\n"
.' GetVocabResponse response = client.getVocab(request);'."\n"
.' System.out.println(JSONObject.toJSONString(response));'."\n"
.' }'."\n"
.'}'."\n"
."\n"
.'```',
'changeSet' => [],
],
'ListVocab' => [
'summary' => '列举指定业务空间下的热词列表信息。',
'path' => '/vocab/listVocab',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => '请求Body',
'type' => 'object',
'properties' => [
'workspaceId' => ['description' => '业务空间ID', 'type' => 'string', 'required' => true, 'example' => 'llm-jhfr****8v'],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'requestId' => ['title' => 'Id of the request', 'description' => '请求id', 'type' => 'string', 'example' => '968A8634-FA2C-5381-9B3E-*******F'],
'success' => ['description' => '请求是否成功', 'type' => 'string', 'example' => 'true'],
'data' => [
'description' => '返回数据',
'type' => 'array',
'items' => [
'description' => '返回数据',
'type' => 'object',
'properties' => [
'vocabularyId' => ['description' => '热词id', 'type' => 'string', 'example' => 'dv*****erverve'],
'name' => ['description' => '名称', 'type' => 'string', 'example' => '热词1'],
'description' => ['description' => '描述', 'type' => 'string', 'example' => '销售热词'],
'audioModelCode' => ['description' => '语音转写模型', 'type' => 'string', 'example' => 'nls'],
'wordWeightList' => [
'description' => '热词组',
'type' => 'array',
'items' => [
'description' => '热词组',
'type' => 'object',
'properties' => [
'word' => ['description' => '单词', 'type' => 'string', 'example' => '儿童'],
'weight' => ['description' => '权重', 'type' => 'integer', 'format' => 'int32', 'example' => '3'],
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'CCAI.InvalidParam.NotExist', 'errorMessage' => 'The specified parameter %s is not valid.', 'description' => '请求API的参数不存在'],
['errorCode' => 'CCAI.ParamInvalid.IllegalParamValue', 'errorMessage' => 'The parameter value of the request API is illegal %s.', 'description' => '请求API的参数不合法'],
['errorCode' => 'CCAI.Throttling.Qpm', 'errorMessage' => 'Trigger QPM flow restriction. Please purchase higher QPM for paid API. If free API has special requirements, please contact us through DingTalk group (62730018475).', 'description' => '触发QPM限流,付费API请购买更高QPM,免费API如有特殊需求,请通过钉钉群(62730018475)联系我们。'."\n"],
['errorCode' => 'CCAI.Throttling.Qps', 'errorMessage' => 'Trigger current QPS limit, pay API please buy higher QPS, the free API if you have special requirements, please contact us through the DingTalk group (62730018475).', 'description' => '触发限流,付费API请购买更高QPS,免费API如有特殊需求,请通过钉钉群(62730018475)联系我们。'."\n"],
],
403 => [
['errorCode' => 'CCAI.IllegalPermission.NoAuth', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => '该用户未被授权可操作指定资源'],
['errorCode' => 'CCAI.ParamNotfound.MissParam', 'errorMessage' => 'Parameter verification failed, The specified parameter %s is missing.', 'description' => '参数校验失败,指定参数缺失。'],
['errorCode' => 'CCAI.TenantPermission.NoAuth', 'errorMessage' => 'The current account does not have the permission to specify the business space. Please authorize the business space permission.', 'description' => '当前账号没有指定业务空间的权限,请进行业务空间权限授权。'],
],
500 => [
['errorCode' => 'CCAI.InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '系统内部错误,请稍后重试'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"968A8634-FA2C-5381-9B3E-*******F\\",\\n \\"success\\": \\"true\\",\\n \\"data\\": [\\n {\\n \\"vocabularyId\\": \\"dv*****erverve\\",\\n \\"name\\": \\"热词1\\",\\n \\"description\\": \\"销售热词\\",\\n \\"audioModelCode\\": \\"nls\\",\\n \\"wordWeightList\\": [\\n {\\n \\"word\\": \\"儿童\\",\\n \\"weight\\": 3\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]',
'title' => '获取热词列表',
'description' => '请确保在使用该接口前,已充分了解通义晓蜜CCAI-对话分析AIO产品的收费方式和价格。'."\n"
."\n"
.'前提条件'."\n"
."\n"
.'- 已开通通义晓蜜CCAI-对话分析AIO服务。'."\n"
.'- 已创建应用:应用中心完成通义晓蜜CCAI-对话分析AIO应用创建,并获取到APP-ID和WORKSPACE-ID:[获取APP-ID和WORKSPACE-ID](https://help.aliyun.com/zh/model-studio/developer-reference/obtain-api-key-app-id-and-workspace-id?spm=openapi-amp.newDocPublishment.0.0.39e3281fMO5qOX)。',
'requestParamsDescription' => '## 请求代码示例'."\n"
.'```java'."\n"
."\n"
.'import com.alibaba.fastjson.JSONObject;'."\n"
.'import com.aliyun.contactcenterai20240603.Client;'."\n"
.'import com.aliyun.contactcenterai20240603.models.*;'."\n"
.'import com.aliyun.teaopenapi.models.Config;'."\n"
."\n"
.'import java.util.ArrayList;'."\n"
.'import java.util.List;'."\n"
."\n"
.'public class Vocab {'."\n"
."\n"
.' private static String accessKeyId = "YOUR_ACCESS_KEY_ID";'."\n"
.' private static String accessKeySecret = "YOUR_ACCESS_KEY_SECRET";'."\n"
."\n\n"
.' private static String workspaceId = "YOUR_WORKSPACE_ID";'."\n"
."\n"
.' private static Config config = new Config();'."\n"
."\n"
.' static {'."\n"
.' config.setAccessKeyId(accessKeyId).setAccessKeySecret(accessKeySecret).setEndpoint("contactcenterai.cn-shanghai.aliyuncs.com")'."\n"
.' .setReadTimeout(30000).setConnectTimeout(300000).setRegionId("cn-shanghai").setProtocol("HTTPS");'."\n"
.' }'."\n"
."\n"
.' public static void main(String[] args) throws Exception {'."\n"
.' Client client = new Client(config);'."\n"
."\n"
.' ListVocabRequest request = new ListVocabRequest();'."\n"
."\n"
.' request.setWorkspaceId(workspaceId);'."\n"
."\n"
.' ListVocabResponse response = client.listVocab(request);'."\n"
.' System.out.println(JSONObject.toJSONString(response));'."\n"
.' }'."\n"
.'}'."\n"
."\n"
.'```',
'changeSet' => [],
],
'RunCompletion' => [
'summary' => '支持调用通义晓蜜CCAI-对话分析AIO应用获取对话摘要、关键信息抽取、质检结果、对话分析结果,应用调用支持 HTTP 调用来完成客户的响应,目前提供普通 HTTP 和 HTTP SSE 两种协议,您可根据自己的需求自行选择。',
'path' => '/{workspaceId}/ccai/app/{appId}/completion',
'methods' => ['post'],
'schemes' => ['http', 'https', 'sse'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json', 'application/octet-stream'],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'workspaceId',
'in' => 'path',
'schema' => ['description' => '子业务空间标识', 'type' => 'string', 'required' => true, 'example' => 'llm-ik******RVYCKzt'."\n"],
],
[
'name' => 'appId',
'in' => 'path',
'schema' => ['description' => '应用ID', 'type' => 'string', 'required' => true, 'example' => '097d65c9c7004f8dad2b454850ac232b'],
],
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => 'request body结构信息',
'type' => 'object',
'properties' => [
'Dialogue' => [
'description' => '对话结构信息',
'type' => 'object',
'properties' => [
'Sentences' => [
'description' => '对话内容列表',
'type' => 'array',
'items' => [
'description' => '每一轮对话内容的结构信息',
'type' => 'object',
'properties' => [
'ChatId' => ['description' => '每一轮对话内容的唯一性ID', 'type' => 'string', 'required' => false, 'example' => 'ae2483e01a8446aa859925947fcf4d8e'],
'Role' => [
'description' => '(通话角色) user-客户 agent-客服 system-系统消息',
'type' => 'string',
'required' => true,
'example' => 'user',
'default' => 'user',
'enum' => ['user', 'agent', 'system'],
],
'Text' => ['description' => '对话内容信息', 'type' => 'string', 'required' => true, 'example' => '查询北京天气'],
],
'required' => false,
],
'required' => false,
],
'SessionId' => ['description' => '对话唯一性ID', 'type' => 'string', 'required' => false, 'example' => 'd25zc9c7004f8dad2b454d'],
],
'required' => true,
],
'Fields' => [
'description' => '信息抽取时,需要抽取的字段列表',
'type' => 'array',
'items' => [
'description' => '字段结构信息',
'type' => 'object',
'properties' => [
'Code' => ['description' => '字段编码', 'type' => 'string', 'required' => false, 'example' => 'phoneNumber'],
'Desc' => ['description' => '字段描述', 'type' => 'string', 'required' => false, 'example' => '用户来电咨询的原因分类,主要有投诉、咨询、政策建议等。'],
'EnumValues' => [
'description' => '枚举值列表',
'type' => 'array',
'items' => [
'description' => '枚举值结构信息',
'type' => 'object',
'properties' => [
'Desc' => ['description' => '枚举值描述', 'type' => 'string', 'required' => false, 'example' => '客户有新的需求/新的场景,客服跟进沟通需求细节'],
'EnumValue' => ['description' => '枚举值', 'type' => 'string', 'required' => true, 'example' => '新业务拓展'],
],
'required' => false,
],
'required' => false,
],
'Name' => ['description' => '字段名称', 'type' => 'string', 'required' => true, 'example' => '来电原因类型'],
],
'required' => false,
],
'required' => false,
],
'ModelCode' => [
'description' => '模型规格',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['tyxmPlus' => 'tyxmPlus', 'tyxmTurbo' => 'tyxmTurbo'],
'example' => 'tyxmTurbo',
'default' => 'tyxmTurbo',
'enum' => ['tyxmTurbo', 'tyxmPlus'],
],
'ServiceInspection' => [
'description' => '服务质检结构信息',
'type' => 'object',
'properties' => [
'InspectionContents' => [
'description' => '服务质检维度结构列表',
'type' => 'array',
'items' => [
'description' => '服务质检维度结构',
'type' => 'object',
'properties' => [
'Content' => ['description' => '服务质检维度描述', 'type' => 'string', 'required' => false, 'example' => '客服在服务客户过程中,基于已有的服务标准是否存在过度承诺的行为,如:最快到货时间是12小时,无法给客户承诺更快的到货时间。'],
'Title' => ['description' => '服务质检维度名称', 'type' => 'string', 'required' => true, 'example' => '客服是否过度承诺'],
],
'required' => false,
],
'required' => false,
],
'InspectionIntroduction' => ['description' => '服务质检场景详细介绍及描述', 'type' => 'string', 'required' => false, 'example' => '请检测客服是否存在服务不当的行为,包括:过度承诺、故意套取客户隐私信息等'],
'SceneIntroduction' => ['description' => '服务质检场景', 'type' => 'string', 'required' => false, 'example' => '保险销售场景'],
],
'required' => false,
],
'Stream' => [
'description' => 'true则会开启 SSE 响应,默认false',
'type' => 'boolean',
'required' => false,
'enumValueTitles' => ['true' => 'true', 'false' => 'false'],
'example' => 'false',
'default' => 'false',
],
'TemplateIds' => [
'description' => 'CCAI应用下的模版ID 列表',
'type' => 'array',
'items' => ['description' => 'CCAI应用下的模版ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10375'],
'required' => true,
],
'variables' => [
'description' => '变量列表',
'type' => 'array',
'items' => [
'description' => '变量列表',
'type' => 'object',
'properties' => [
'variableCode' => ['description' => '变量code', 'type' => 'string', 'required' => false, 'example' => 'name'],
'variableValue' => ['description' => '变量值', 'type' => 'string', 'required' => false, 'example' => '张三'],
],
'required' => false,
],
'required' => false,
],
'responseFormatType' => ['description' => '输出结果格式化类型,jsonObject-json结构,text-原始字符串', 'type' => 'string', 'required' => false, 'example' => 'jsonObject'],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Response结构信息',
'type' => 'object',
'properties' => [
'FinishReason' => ['description' => '如果是流式输出,正在生成时为null,生成结束时如果由于停止token导致则为stop。', 'type' => 'string', 'example' => 'stop'],
'RequestId' => ['description' => '系统生成的标志本次请求的唯一性ID', 'type' => 'string', 'example' => '17204B98-xxxx-4F9A-8464-2446A84821CA'."\n"],
'Text' => ['description' => '应用返回的结果。', 'type' => 'string', 'example' => '这段对话似乎是客服与客户之间关于一个服务或产品的讨论,但具体内容难以明确理解,因为对话中的言语比较零散和抽象。'."\n"],
'inputTokens' => ['description' => '输入Token数量', 'type' => 'string', 'example' => '4672'],
'outputTokens' => ['description' => '输出Token数量', 'type' => 'string', 'example' => '621'],
'totalTokens' => ['description' => 'Tokens总量', 'type' => 'string', 'example' => '5609'],
'usage' => [
'description' => '使用量',
'type' => 'object',
'properties' => [
'rag' => [
'description' => 'rag使用详情',
'type' => 'object',
'properties' => [
'dialogSummary' => [
'description' => '会话摘要',
'type' => 'object',
'properties' => [
'inputTokens' => ['description' => '输入Token数量', 'type' => 'integer', 'format' => 'int32', 'example' => '4672'],
'outputTokens' => ['description' => '输出Token数量', 'type' => 'integer', 'format' => 'int32', 'example' => '621'],
'invokeCount' => ['description' => '调用次数', 'type' => 'integer', 'format' => 'int32', 'example' => '3'],
],
],
'adaptive' => [
'description' => 'rag智能调用',
'type' => 'object',
'properties' => [
'inputTokens' => ['description' => '输入Token数量', 'type' => 'integer', 'format' => 'int32', 'example' => '4672'],
'outputTokens' => ['description' => '输出Token数量', 'type' => 'integer', 'format' => 'int32', 'example' => '621'],
'invokeCount' => ['description' => '调用次数', 'type' => 'integer', 'format' => 'int32', 'example' => '3'],
],
],
],
],
],
],
'ragStatus' => ['description' => 'rag执行状态', 'type' => 'string', 'example' => 'SUCCESS'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'CCAI.InvalidParam.NotExist', 'errorMessage' => 'The specified parameter %s is not valid.', 'description' => '请求API的参数不存在'],
['errorCode' => 'CCAI.Throttling.Qpm', 'errorMessage' => 'Trigger QPM flow restriction. Please purchase higher QPM for paid API. If free API has special requirements, please contact us through DingTalk group (62730018475).', 'description' => '触发QPM限流,付费API请购买更高QPM,免费API如有特殊需求,请通过钉钉群(62730018475)联系我们。'."\n"],
['errorCode' => 'CCAI.Throttling.Qps', 'errorMessage' => 'Trigger current QPS limit, pay API please buy higher QPS, the free API if you have special requirements, please contact us through the DingTalk group (62730018475).', 'description' => '触发限流,付费API请购买更高QPS,免费API如有特殊需求,请通过钉钉群(62730018475)联系我们。'."\n"],
['errorCode' => 'CCAI.ParamInvalid.IllegalParamValue', 'errorMessage' => 'The parameter value of the request API is illegal %s.', 'description' => '请求API的参数不合法'],
],
403 => [
['errorCode' => 'CCAI.IllegalPermission.NoAuth', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => '该用户未被授权可操作指定资源'],
['errorCode' => 'CCAI.ParamNotfound.MissParam', 'errorMessage' => 'Parameter verification failed, The specified parameter %s is missing.', 'description' => '参数校验失败,指定参数缺失。'],
['errorCode' => 'CCAI.TenantPermission.NoAuth', 'errorMessage' => 'The current account does not have the permission to specify the business space. Please authorize the business space permission.', 'description' => '当前账号没有指定业务空间的权限,请进行业务空间权限授权。'],
],
500 => [
['errorCode' => 'CCAI.InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '系统内部错误,请稍后重试'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"FinishReason\\": \\"stop\\",\\n \\"RequestId\\": \\"17204B98-xxxx-4F9A-8464-2446A84821CA\\\\n\\",\\n \\"Text\\": \\"这段对话似乎是客服与客户之间关于一个服务或产品的讨论,但具体内容难以明确理解,因为对话中的言语比较零散和抽象。\\\\n\\",\\n \\"inputTokens\\": \\"4672\\",\\n \\"outputTokens\\": \\"621\\",\\n \\"totalTokens\\": \\"5609\\",\\n \\"usage\\": {\\n \\"rag\\": {\\n \\"dialogSummary\\": {\\n \\"inputTokens\\": 4672,\\n \\"outputTokens\\": 621,\\n \\"invokeCount\\": 3\\n },\\n \\"adaptive\\": {\\n \\"inputTokens\\": 4672,\\n \\"outputTokens\\": 621,\\n \\"invokeCount\\": 3\\n }\\n }\\n },\\n \\"ragStatus\\": \\"SUCCESS\\"\\n}","type":"json"}]',
'title' => '通过模版ID调用通义晓蜜CCAI-对话分析AIO应用',
'description' => '请确保在使用该接口前,已充分了解通义晓蜜CCAI-对话分析AIO产品的收费方式和价格。'."\n"
."\n"
.'前提条件'."\n"
.'1. 已开通通义晓蜜CCAI-对话分析AIO服务。'."\n"
.'2. 已创建应用:应用中心完成通义晓蜜CCAI-对话分析AIO应用创建,并获取到APP-ID和WORKSPACE-ID:[获取APP-ID和WORKSPACE-ID](https://help.aliyun.com/document_detail/2782167.html?spm=a2c4g.2782164.0.0.2b2b6dcdZZ5oUE)。',
'changeSet' => [
['createdAt' => '2025-04-16T02:21:39.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-04-01T02:08:31.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2024-11-22T08:11:18.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2024-09-06T03:50:11.000Z', 'description' => '错误码发生变更、请求参数发生变更'],
['createdAt' => '2024-07-02T08:31:48.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2024-07-01T08:41:21.000Z', 'description' => '错误码发生变更、请求参数发生变更'],
['createdAt' => '2024-06-14T09:00:50.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '15', 'countWindow' => 2, 'regionId' => '*', 'api' => 'RunCompletion'],
],
],
],
'RunCompletionMessage' => [
'summary' => '支持以Message协议格式调用通义晓蜜CCAI-对话分析AIO应用获取对话摘要、关键信息抽取、质检结果、对话分析结果,应用调用支持 HTTP 调用来完成客户的响应,目前提供普通 HTTP 和 HTTP SSE 两种协议,您可根据自己的需求自行选择。',
'path' => '/{workspaceId}/ccai/app/{appId}/completion_message',
'methods' => ['post'],
'schemes' => ['http', 'https', 'sse'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json', 'application/octet-stream'],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'workspaceId',
'in' => 'path',
'schema' => ['description' => '子业务空间标识', 'type' => 'string', 'required' => true, 'example' => 'llm-ik******RVYCKzt'."\n"],
],
[
'name' => 'appId',
'in' => 'path',
'schema' => ['description' => '应用ID', 'type' => 'string', 'required' => true, 'example' => '097d65c9c7004f8dad2b454850ac232b'],
],
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => 'schema of request body',
'type' => 'object',
'properties' => [
'Messages' => [
'description' => '模型请求Message列表',
'type' => 'array',
'items' => [
'description' => 'Message结构信息',
'type' => 'object',
'properties' => [
'Content' => ['description' => 'prompt内容', 'type' => 'string', 'required' => true, 'example' => '如Role=system ,Content=You are a helpful assistant.'."\n"
.'Role=user , Content=请阅读以下对话内容,按照要求执行指令任务。'],
'Role' => [
'description' => '(通话角色) user-客户 agent-客服 system-系统消息 function-函数',
'type' => 'string',
'required' => true,
'example' => 'user',
'enum' => ['user', 'assistant', 'system', 'function'],
],
],
'required' => false,
],
'required' => true,
],
'ModelCode' => [
'description' => '模型规格',
'type' => 'string',
'required' => false,
'example' => 'tyxmTurbo',
'default' => 'tyxmTurbo',
'enum' => ['tyxmTurbo', 'tyxmPlus'],
],
'Stream' => ['description' => 'true则会开启 SSE 响应,默认false', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false'],
'responseFormatType' => ['type' => 'string', 'required' => false, 'description' => ''],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Response结构信息',
'type' => 'object',
'properties' => [
'FinishReason' => ['description' => '如果是流式输出,正在生成时为null,生成结束时如果由于停止token导致则为stop。', 'type' => 'string', 'example' => 'stop'],
'RequestId' => ['description' => '系统生成的标志本次请求的唯一性ID', 'type' => 'string', 'example' => '17204B98-xxxx-4F9A-8464-2446A84821CA'."\n"],
'Text' => ['description' => '应用返回的结果。', 'type' => 'string', 'example' => '这段对话似乎是客服与客户之间关于一个服务或产品的讨论,但具体内容难以明确理解,因为对话中的言语比较零散和抽象。'],
'inputTokens' => ['type' => 'string', 'description' => ''],
'outputTokens' => ['type' => 'string', 'description' => ''],
'totalTokens' => ['type' => 'string', 'description' => ''],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'CCAI.InvalidParam.NotExist', 'errorMessage' => 'The specified parameter %s is not valid.', 'description' => '请求API的参数不存在'],
['errorCode' => 'CCAI.Throttling.Qpm', 'errorMessage' => 'Trigger QPM flow restriction. Please purchase higher QPM for paid API. If free API has special requirements, please contact us through DingTalk group (62730018475).', 'description' => '触发QPM限流,付费API请购买更高QPM,免费API如有特殊需求,请通过钉钉群(62730018475)联系我们。'."\n"],
['errorCode' => 'CCAI.Throttling.Qps', 'errorMessage' => 'Trigger current QPS limit, pay API please buy higher QPS, the free API if you have special requirements, please contact us through the DingTalk group (62730018475).', 'description' => '触发限流,付费API请购买更高QPS,免费API如有特殊需求,请通过钉钉群(62730018475)联系我们。'."\n"],
['errorCode' => 'CCAI.ParamInvalid.IllegalParamValue', 'errorMessage' => 'The parameter value of the request API is illegal %s.', 'description' => '请求API的参数不合法'],
],
403 => [
['errorCode' => 'CCAI.IllegalPermission.NoAuth', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => '该用户未被授权可操作指定资源'],
['errorCode' => 'CCAI.ParamNotfound.MissParam', 'errorMessage' => 'Parameter verification failed, The specified parameter %s is missing.', 'description' => '参数校验失败,指定参数缺失。'],
['errorCode' => 'CCAI.TenantPermission.NoAuth', 'errorMessage' => 'The current account does not have the permission to specify the business space. Please authorize the business space permission.', 'description' => '当前账号没有指定业务空间的权限,请进行业务空间权限授权。'],
],
500 => [
['errorCode' => 'CCAI.InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '系统内部错误,请稍后重试'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"FinishReason\\": \\"stop\\",\\n \\"RequestId\\": \\"17204B98-xxxx-4F9A-8464-2446A84821CA\\\\n\\",\\n \\"Text\\": \\"这段对话似乎是客服与客户之间关于一个服务或产品的讨论,但具体内容难以明确理解,因为对话中的言语比较零散和抽象。\\",\\n \\"inputTokens\\": \\"\\",\\n \\"outputTokens\\": \\"\\",\\n \\"totalTokens\\": \\"\\"\\n}","type":"json"}]',
'title' => '使用原生Prompt调用通义晓蜜CCAI-对话分析AIO应用',
'description' => '请确保在使用该接口前,已充分了解通义晓蜜CCAI-对话分析AIO产品的收费方式和价格。'."\n"
."\n"
.'前提条件'."\n"
.'1. 已开通通义晓蜜CCAI-对话分析AIO服务。'."\n"
.'2. 已创建应用:应用中心完成通义晓蜜CCAI-对话分析AIO应用创建,并获取到APP-ID和WORKSPACE-ID:[获取APP-ID和WORKSPACE-ID](https://help.aliyun.com/document_detail/2782167.html?spm=a2c4g.2782164.0.0.2b2b6dcdZZ5oUE)。',
'changeSet' => [
['createdAt' => '2025-04-16T02:21:39.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2024-11-22T08:11:18.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2024-09-06T03:50:11.000Z', 'description' => '错误码发生变更、请求参数发生变更'],
['createdAt' => '2024-07-01T08:41:21.000Z', 'description' => '错误码发生变更、请求参数发生变更'],
],
],
'UpdateVocab' => [
'summary' => '根据词表的ID可以更新对应的词表信息,包括词表名称、词表描述信息、词表的词和权重。',
'path' => '/vocab/updateVocab',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => '请求Body',
'type' => 'object',
'properties' => [
'vocabularyId' => ['description' => '热词id', 'type' => 'string', 'required' => true, 'example' => 'dsvsv***dsvv'],
'name' => ['description' => '名称', 'type' => 'string', 'required' => false, 'example' => '热词1'],
'description' => ['description' => '描述', 'type' => 'string', 'required' => false, 'example' => '销售热词'],
'wordWeightList' => [
'description' => '热词组',
'type' => 'array',
'items' => [
'description' => '热词组',
'type' => 'object',
'properties' => [
'word' => ['description' => '单词', 'type' => 'string', 'required' => true, 'example' => '虹桥'],
'weight' => ['description' => '权重', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '2'],
],
'required' => false,
],
'required' => false,
],
'workspaceId' => ['description' => '业务空间ID', 'type' => 'string', 'required' => true, 'example' => 'llm-jhfr****w8v'],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'requestId' => ['title' => 'Id of the request', 'description' => '请求id', 'type' => 'string', 'example' => '968A8634-FA2C-5381-9B3E-*******F'],
'success' => ['description' => '请求是否成功', 'type' => 'string', 'example' => 'true'],
'data' => ['description' => '返回数据', 'type' => 'string', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'CCAI.InvalidParam.NotExist', 'errorMessage' => 'The specified parameter %s is not valid.', 'description' => '请求API的参数不存在'],
['errorCode' => 'CCAI.ParamInvalid.IllegalParamValue', 'errorMessage' => 'The parameter value of the request API is illegal %s.', 'description' => '请求API的参数不合法'],
['errorCode' => 'CCAI.Throttling.Qpm', 'errorMessage' => 'Trigger QPM flow restriction. Please purchase higher QPM for paid API. If free API has special requirements, please contact us through DingTalk group (62730018475).', 'description' => '触发QPM限流,付费API请购买更高QPM,免费API如有特殊需求,请通过钉钉群(62730018475)联系我们。'."\n"],
['errorCode' => 'CCAI.Throttling.Qps', 'errorMessage' => 'Trigger current QPS limit, pay API please buy higher QPS, the free API if you have special requirements, please contact us through the DingTalk group (62730018475).', 'description' => '触发限流,付费API请购买更高QPS,免费API如有特殊需求,请通过钉钉群(62730018475)联系我们。'."\n"],
],
403 => [
['errorCode' => 'CCAI.IllegalPermission.NoAuth', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => '该用户未被授权可操作指定资源'],
['errorCode' => 'CCAI.ParamNotfound.MissParam', 'errorMessage' => 'Parameter verification failed, The specified parameter %s is missing.', 'description' => '参数校验失败,指定参数缺失。'],
['errorCode' => 'CCAI.TenantPermission.NoAuth', 'errorMessage' => 'The current account does not have the permission to specify the business space. Please authorize the business space permission.', 'description' => '当前账号没有指定业务空间的权限,请进行业务空间权限授权。'],
],
500 => [
['errorCode' => 'CCAI.InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '系统内部错误,请稍后重试'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"968A8634-FA2C-5381-9B3E-*******F\\",\\n \\"success\\": \\"true\\",\\n \\"data\\": \\"true\\"\\n}","type":"json"}]',
'title' => '修改热词',
'description' => '请确保在使用该接口前,已充分了解通义晓蜜CCAI-对话分析AIO产品的收费方式和价格。'."\n"
."\n"
.'前提条件'."\n"
."\n"
.'- 已开通通义晓蜜CCAI-对话分析AIO服务。'."\n"
.'- 已创建应用:应用中心完成通义晓蜜CCAI-对话分析AIO应用创建,并获取到APP-ID和WORKSPACE-ID:[获取APP-ID和WORKSPACE-ID](https://help.aliyun.com/zh/model-studio/developer-reference/obtain-api-key-app-id-and-workspace-id?spm=openapi-amp.newDocPublishment.0.0.39e3281fMO5qOX)。',
'requestParamsDescription' => '## 请求代码示例'."\n"
.'```java'."\n"
."\n"
.'import com.alibaba.fastjson.JSONObject;'."\n"
.'import com.aliyun.contactcenterai20240603.Client;'."\n"
.'import com.aliyun.contactcenterai20240603.models.*;'."\n"
.'import com.aliyun.teaopenapi.models.Config;'."\n"
."\n"
.'import java.util.ArrayList;'."\n"
.'import java.util.List;'."\n"
."\n"
.'public class Vocab {'."\n"
."\n"
.' private static String accessKeyId = "YOUR_ACCESS_KEY_ID";'."\n"
.' private static String accessKeySecret = "YOUR_ACCESS_KEY_SECRET";'."\n"
."\n\n"
.' private static String workspaceId = "YOUR_WORKSPACE_ID";'."\n"
."\n"
.' private static Config config = new Config();'."\n"
."\n"
.' static {'."\n"
.' config.setAccessKeyId(accessKeyId).setAccessKeySecret(accessKeySecret).setEndpoint("contactcenterai.cn-shanghai.aliyuncs.com")'."\n"
.' .setReadTimeout(30000).setConnectTimeout(300000).setRegionId("cn-shanghai").setProtocol("HTTPS");'."\n"
.' }'."\n"
."\n"
.' public static void main(String[] args) throws Exception {'."\n"
.' Client client = new Client(config);'."\n"
."\n"
.' UpdateVocabRequest request = new UpdateVocabRequest();'."\n"
.' request.setVocabularyId("f3d82e0d********d23bd7");'."\n"
.' request.setName("销售热词");'."\n"
.' request.setDescription("南方一区销售热词");'."\n"
.' request.setWorkspaceId(workspaceId);'."\n"
."\n"
.' List<UpdateVocabRequest.UpdateVocabRequestWordWeightList> wordWeightList = new ArrayList<>();'."\n"
.' UpdateVocabRequest.UpdateVocabRequestWordWeightList word1 = new UpdateVocabRequest.UpdateVocabRequestWordWeightList();'."\n"
.' word1.setWord("欧洲");'."\n"
.' word1.setWeight(4);'."\n"
.' wordWeightList.add(word1);'."\n"
."\n"
.' UpdateVocabRequest.UpdateVocabRequestWordWeightList word2 = new UpdateVocabRequest.UpdateVocabRequestWordWeightList();'."\n"
.' word2.setWord("耳痛");'."\n"
.' word2.setWeight(2);'."\n"
.' wordWeightList.add(word2);'."\n"
."\n"
.' request.setWordWeightList(wordWeightList);'."\n"
."\n"
.' UpdateVocabResponse response = client.updateVocab(request);'."\n"
.' System.out.println(JSONObject.toJSONString(response));'."\n"
.' }'."\n"
.'}'."\n"
."\n"
.'```',
'changeSet' => [],
],
],
'endpoints' => [
['regionId' => 'cn-shanghai', 'regionName' => '华东2(上海)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'contactcenterai.cn-shanghai.aliyuncs.com', 'endpoint' => 'contactcenterai.cn-shanghai.aliyuncs.com', 'vpc' => 'contactcenterai-vpc.cn-shanghai.aliyuncs.com'],
],
'errorCodes' => [
['code' => 'CCAI.IllegalPermission.NoAuth', 'message' => 'User not authorized to operate on the specified resource.', 'http_code' => 403, 'description' => '该用户未被授权可操作指定资源'],
['code' => 'CCAI.IllegalPermission.NoAuth', 'message' => 'User not authorized to operate on the specified resource %s .', 'http_code' => 403, 'description' => '该用户未被授权可操作指定资源'],
['code' => 'CCAI.InternalError', 'message' => 'The request processing has failed due to some unknown error, exception or failure.', 'http_code' => 500, 'description' => '系统内部错误,请稍后重试'],
['code' => 'CCAI.InvalidParam.NotExist', 'message' => 'The specified parameter %s is not valid.', 'http_code' => 400, 'description' => '请求API的参数不存在'],
['code' => 'CCAI.ParamInvalid.IllegalParamValue', 'message' => 'The parameter value of the request API is illegal %s.', 'http_code' => 400, 'description' => '请求API的参数不合法'],
['code' => 'CCAI.ParamNotfound.MissParam', 'message' => 'Parameter verification failed, The specified parameter %s is missing.', 'http_code' => 403, 'description' => '参数校验失败,指定参数缺失。'],
['code' => 'CCAI.TenantPermission.NoAuth', 'message' => 'The current account does not have the permission to specify the business space. Please authorize the business space permission.', 'http_code' => 403, 'description' => '当前账号没有指定业务空间的权限,请进行业务空间权限授权。'],
['code' => 'CCAI.Throttling.Qpm', 'message' => 'Trigger QPM flow restriction. Please purchase higher QPM for paid API. If free API has special requirements, please contact us through DingTalk group (62730018475).', 'http_code' => 400, 'description' => '触发QPM限流,付费API请购买更高QPM,免费API如有特殊需求,请通过钉钉群(62730018475)联系我们。'."\n"],
['code' => 'Ccai.Throttling.Qps', 'message' => 'Trigger current QPS limit, pay API please buy higher QPS, free API if you have special requirements, please contact us through the DingTalk group (62730018475).', 'http_code' => 429, 'description' => '无效错误码,后续下线'],
['code' => 'CCAI.Throttling.Qps', 'message' => 'Trigger current QPS limit, pay API please buy higher QPS, the free API if you have special requirements, please contact us through the DingTalk group (62730018475).', 'http_code' => 400, 'description' => '触发限流,付费API请购买更高QPS,免费API如有特殊需求,请通过钉钉群(62730018475)联系我们。'."\n"],
],
'changeSet' => [
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'RunCompletion'],
],
'createdAt' => '2024-06-14T09:00:55.000Z',
'description' => '',
],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateTask'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTaskResult'],
['threshold' => '30', 'countWindow' => 2, 'regionId' => '*', 'api' => 'AnalyzeConversation'],
['threshold' => '15', 'countWindow' => 2, 'regionId' => '*', 'api' => 'RunCompletion'],
['threshold' => '15', 'countWindow' => 2, 'regionId' => '*', 'api' => 'RunCompletionMessage'],
['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AnalyzeAudioSync'],
],
],
];
|