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
|
<?php return [
'version' => '1.0',
'info' => ['style' => 'RPC', 'product' => 'nlp-automl', 'version' => '2019-11-11'],
'directories' => ['CreateAsyncPredict', 'GetAsyncPredict', 'GetPredictResult', 'RunPreTrainService'],
'components' => [
'schemas' => [],
],
'apis' => [
'CreateAsyncPredict' => [
'summary' => 'Creates an asynchronous prediction by calling CreateAsyncPredict.',
'methods' => ['post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREnlp2P1OGB', 'FEATUREnlp6HZZI5', 'FEATUREnlp8RK87E', 'FEATUREnlpMXQY7X', 'FEATUREnlp0537I6', 'FEATUREnlpAOZDQ8', 'FEATUREnlpCAMXDD', 'FEATUREnlpEZFBRW', 'FEATUREnlpM7P12V', 'FEATUREnlp3ZJX2G', 'FEATUREnlpQTX906', 'FEATUREnlp97BF9V', 'FEATUREnlpLCH6DG', 'FEATUREnlpR1YV22', 'FEATUREnlpDG0HX3', 'FEATUREnlpJOUXF2', 'FEATUREnlp9YSZ64', 'FEATUREnlpF61RQU', 'FEATUREnlpUZ2C2Y', 'FEATUREnlpM0OA48',
'FEATUREnlpZBZJI2', 'FEATUREnlp01ENOR', 'FEATUREnlpV1PN9B', 'FEATUREnlp0VR1QU', 'FEATUREnlpWB1IYO', 'FEATUREnlp6X5BYZ', 'FEATUREnlpX2LEJN', 'FEATUREnlpLSF30C', 'FEATUREnlpQ032BR', 'FEATUREnlpQHAWK2', 'FEATUREnlpWLVJE2', 'FEATUREnlp4JXFXB', 'FEATUREnlp0PKWIK', 'FEATUREnlp1V7KGA', 'FEATUREnlpR5NT62', 'FEATUREnlpUC15C2', 'FEATUREnlpOT0DNK', 'FEATUREnlpQBSUD4', 'FEATUREnlp8ES9UE', 'FEATUREnlpTE27I1',
'FEATUREnlp6WE0DC', 'FEATUREnlpVBPY3Z', 'FEATUREnlp0MGP51', 'FEATUREnlpJSUF2I',
],
],
'parameters' => [
[
'name' => 'ModelId',
'in' => 'formData',
'schema' => ['title' => '', 'description' => 'The model ID. Not required when creating an asynchronous prediction by service name and service version. Required otherwise.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '1'],
],
[
'name' => 'Content',
'in' => 'formData',
'schema' => ['description' => 'The prediction content. Maximum length: 1024 bytes.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '全国土地利用总体规划', 'title' => ''],
],
[
'name' => 'ModelVersion',
'in' => 'formData',
'schema' => ['description' => 'The version number of the model. If this parameter is not specified, the latest published version is returned. Specify this parameter when calling the asynchronous prediction operation by model ID.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'V1', 'title' => ''],
],
[
'name' => 'DetailTag',
'in' => 'formData',
'schema' => ['description' => 'Specifies whether to return detailed extraction results for text entity extraction models. Valid values: true and false.', 'type' => 'string', 'required' => false, 'example' => 'false', 'title' => ''],
],
[
'name' => 'TopK',
'in' => 'formData',
'schema' => ['description' => 'The number of top results to return.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0,3', 'title' => ''],
],
[
'name' => 'FileType',
'in' => 'formData',
'schema' => ['description' => 'The file type.', 'type' => 'string', 'required' => false, 'example' => 'text,html,pdf,docx,doc', 'title' => ''],
],
[
'name' => 'FileUrl',
'in' => 'formData',
'schema' => ['description' => 'The HTTP URL where the file is stored.', 'type' => 'string', 'required' => false, 'example' => 'http://127.0.0.1/example.docx', 'title' => ''],
],
[
'name' => 'FileContent',
'in' => 'formData',
'schema' => ['description' => 'The Base64-encoded file content.', 'type' => 'string', 'required' => false, 'example' => '[base64 encode content]', 'title' => ''],
],
[
'name' => 'FetchContent',
'in' => 'formData',
'schema' => ['description' => 'The prediction text to return.', 'type' => 'string', 'required' => false, 'example' => 'true', 'title' => ''],
],
[
'name' => 'ServiceName',
'in' => 'formData',
'schema' => ['title' => '', 'description' => 'The service name.', 'type' => 'string', 'required' => false, 'example' => 'ContractNERPretrain'],
],
[
'name' => 'ServiceVersion',
'in' => 'formData',
'schema' => ['title' => '', 'description' => 'The service version.', 'type' => 'string', 'required' => false, 'example' => 'V1'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'AsyncPredictId' => ['description' => 'The unique ID of the asynchronous prediction. You can use this ID to query the asynchronous prediction result.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E5C4531B-8331-5CD5-BEB3-2F8B58A4D680', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
200 => [
['errorCode' => '40002', 'errorMessage' => 'The specified interface is throttled.', 'description' => ''],
['errorCode' => '40013', 'errorMessage' => 'An error occurred while authenticating the model.', 'description' => ''],
],
400 => [
['errorCode' => 'InvalidAccountStatus.ServiceUnavailable', 'errorMessage' => 'The NLP Auto Machine Learning service has not been activated.', 'description' => 'The NLP Auto Machine Learning service has not been activated.'],
['errorCode' => 'InvalidAccountStatus.ServiceLimit', 'errorMessage' => 'The maximum number of free API daily visits is exceeded.', 'description' => ''],
['errorCode' => 'InvalidParameter.ModelId', 'errorMessage' => 'The specified modelId is invalid.', 'description' => ''],
['errorCode' => 'InvalidParameter.ModelVersion', 'errorMessage' => 'The specified modelVersion is invalid.', 'description' => ''],
['errorCode' => 'InvalidContentLength', 'errorMessage' => 'The length of content exceeds the limit.', 'description' => ''],
['errorCode' => 'parameterError', 'errorMessage' => 'The parameter is invalid.', 'description' => ''],
['errorCode' => 'predictLimit', 'errorMessage' => 'The maximum number of submitted tasks is exceeded.', 'description' => ''],
['errorCode' => 'postPaidArrearage', 'errorMessage' => 'The service is not opened or the account is overdue.', 'description' => ''],
],
403 => [
['errorCode' => 'Forbbiden', 'errorMessage' => 'You are not authorized to operate on the specified resource.', 'description' => 'You are not authorized to operate on the specified resource.'],
],
[
['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified Model does not exist.', 'description' => 'The specified Model does not exist.'],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request.'],
],
503 => [
['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request.'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AsyncPredictId\\": 1,\\n \\"RequestId\\": \\"E5C4531B-8331-5CD5-BEB3-2F8B58A4D680\\"\\n}","type":"json"}]',
'title' => 'Create an asynchronous prediction',
'changeSet' => [
['createdAt' => '2025-05-19T02:40:38.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-03-23T05:58:30.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2022-11-14T05:05:20.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2022-11-14T03:18:25.000Z', 'description' => 'Request parameters changed'],
],
],
'GetAsyncPredict' => [
'summary' => 'Calls GetAsyncPredict to retrieve asynchronous prediction results.',
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREnlp2P1OGB', 'FEATUREnlp6HZZI5', 'FEATUREnlp8RK87E', 'FEATUREnlpMXQY7X', 'FEATUREnlp0537I6', 'FEATUREnlpAOZDQ8', 'FEATUREnlpCAMXDD', 'FEATUREnlpEZFBRW', 'FEATUREnlpM7P12V', 'FEATUREnlp3ZJX2G', 'FEATUREnlpQTX906', 'FEATUREnlp97BF9V', 'FEATUREnlpLCH6DG', 'FEATUREnlpR1YV22', 'FEATUREnlpDG0HX3', 'FEATUREnlpJOUXF2', 'FEATUREnlp9YSZ64', 'FEATUREnlpF61RQU', 'FEATUREnlpUZ2C2Y', 'FEATUREnlpM0OA48',
'FEATUREnlpZBZJI2', 'FEATUREnlp01ENOR', 'FEATUREnlpV1PN9B', 'FEATUREnlp0VR1QU', 'FEATUREnlpWB1IYO', 'FEATUREnlp6X5BYZ', 'FEATUREnlpX2LEJN', 'FEATUREnlpLSF30C', 'FEATUREnlpQ032BR', 'FEATUREnlpQHAWK2', 'FEATUREnlpWLVJE2', 'FEATUREnlp4JXFXB', 'FEATUREnlp0PKWIK', 'FEATUREnlp1V7KGA', 'FEATUREnlpR5NT62', 'FEATUREnlpUC15C2', 'FEATUREnlpOT0DNK', 'FEATUREnlpQBSUD4', 'FEATUREnlp8ES9UE', 'FEATUREnlpTE27I1',
'FEATUREnlp6WE0DC', 'FEATUREnlpVBPY3Z', 'FEATUREnlp0MGP51', 'FEATUREnlpJSUF2I',
],
],
'parameters' => [
[
'name' => 'AsyncPredictId',
'in' => 'query',
'schema' => ['description' => 'The asynchronous prediction ID. You can obtain this ID by calling the CreateAsyncPredict operation.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1629', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'AsyncPredictId' => ['description' => 'The asynchronous prediction ID. You can obtain this ID by calling the CreateAsyncPredict operation.', 'type' => 'integer', 'format' => 'int32', 'example' => '1629', 'title' => ''],
'Status' => ['description' => 'The asynchronous prediction status. Valid values:'."\n"
."\n"
.'- 1: processing.'."\n"
.'- 2: processing completed.'."\n"
.'- 3: processing failed.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'EBF1AAD7-A3FB-4A78-B5E9-8356324B12B2', 'title' => ''],
'Content' => ['description' => 'The asynchronous prediction result in JSON string format.', 'type' => 'string', 'example' => 'json string', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidAccountStatus.ServiceUnavailable', 'errorMessage' => 'The NLP Auto Machine Learning service has not been activated.', 'description' => 'The NLP Auto Machine Learning service has not been activated.'],
['errorCode' => 'InvalidAccountStatus.ServiceLimit', 'errorMessage' => 'The maximum number of free API daily visits is exceeded.', 'description' => ''],
['errorCode' => 'InvalidParameter.ModelId', 'errorMessage' => 'The specified modelId is invalid.', 'description' => ''],
['errorCode' => 'InvalidParameter.ModelVersion', 'errorMessage' => 'The specified modelVersion is invalid.', 'description' => ''],
['errorCode' => 'InvalidContentLength', 'errorMessage' => 'The length of content exceeds the limit.', 'description' => ''],
['errorCode' => 'Account arrearage', 'errorMessage' => 'The account is arrearage.', 'description' => 'Account Arrears'],
['errorCode' => 'PermissionDeny', 'errorMessage' => 'No RAM permission.', 'description' => 'No permission to change the account'],
],
403 => [
['errorCode' => 'Forbbiden', 'errorMessage' => 'You are not authorized to operate on the specified resource.', 'description' => 'You are not authorized to operate on the specified resource.'],
],
[
['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified Model does not exist.', 'description' => 'The specified Model does not exist.'],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request.'],
],
503 => [
['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request.'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AsyncPredictId\\": 1629,\\n \\"Status\\": 2,\\n \\"RequestId\\": \\"EBF1AAD7-A3FB-4A78-B5E9-8356324B12B2\\",\\n \\"Content\\": \\"json string\\"\\n}","type":"json"}]',
'title' => 'Retrieve asynchronous prediction results',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2025-06-09T05:43:29.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2025-05-19T02:40:38.000Z', 'description' => 'Error codes changed'],
],
],
'GetPredictResult' => [
'summary' => 'Call GetPredictResult to obtain model prediction results.',
'methods' => ['post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREnlp6HZZI5', 'FEATUREnlpMXQY7X', 'FEATUREnlpAOZDQ8', 'FEATUREnlpEZFBRW', 'FEATUREnlp3ZJX2G', 'FEATUREnlp97BF9V', 'FEATUREnlpR1YV22', 'FEATUREnlpJOUXF2', 'FEATUREnlpF61RQU', 'FEATUREnlpM0OA48', 'FEATUREnlp01ENOR', 'FEATUREnlp0VR1QU', 'FEATUREnlp6X5BYZ'],
],
'parameters' => [
[
'name' => 'ModelId',
'in' => 'formData',
'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''],
],
[
'name' => 'Content',
'in' => 'formData',
'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''],
],
[
'name' => 'ModelVersion',
'in' => 'formData',
'schema' => ['type' => 'string', 'required' => false, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''],
],
[
'name' => 'DetailTag',
'in' => 'formData',
'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''],
],
[
'name' => 'TopK',
'in' => 'formData',
'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'description' => '', 'title' => '', 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Content' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidAccountStatus.ServiceUnavailable', 'errorMessage' => 'The NLP Auto Machine Learning service has not been activated.', 'description' => 'The NLP Auto Machine Learning service has not been activated.'],
['errorCode' => 'InvalidAccountStatus.ServiceLimit', 'errorMessage' => 'The maximum number of free API daily visits is exceeded.', 'description' => ''],
['errorCode' => 'InvalidParameter.ModelId', 'errorMessage' => 'The specified modelId is invalid.', 'description' => ''],
['errorCode' => 'InvalidParameter.ModelVersion', 'errorMessage' => 'The specified modelVersion is invalid.', 'description' => ''],
['errorCode' => 'InvalidContentLength', 'errorMessage' => 'The length of content exceeds the limit.', 'description' => ''],
['errorCode' => 'parameterError', 'errorMessage' => 'The parameter is invalid.', 'description' => ''],
['errorCode' => 'Account arrearage', 'errorMessage' => 'The account is arrearage.', 'description' => 'Account Arrears'],
['errorCode' => 'PermissionDeny', 'errorMessage' => 'No RAM permission.', 'description' => 'No permission to change the account'],
],
403 => [
['errorCode' => '40003', 'errorMessage' => 'An error occurred while authenticating the model.', 'description' => ''],
['errorCode' => 'Forbbiden', 'errorMessage' => 'You are not authorized to operate on the specified resource.', 'description' => 'You are not authorized to operate on the specified resource.'],
['errorCode' => '40002', 'errorMessage' => 'The specified interface is throttled.', 'description' => 'The specified interface is throttled.'],
['errorCode' => '40013', 'errorMessage' => 'An error occurred while authenticating the model.', 'description' => ''],
],
[
['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified Model does not exist.', 'description' => 'The specified Model does not exist.'],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request.'],
['errorCode' => 'ModelInferenceFailed', 'errorMessage' => 'The model inference result is null.', 'description' => ''],
],
503 => [
['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request.'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Content\\": \\"\\",\\n \\"RequestId\\": \\"\\"\\n}","type":"json"}]',
'title' => 'Get Model Prediction Results',
'changeSet' => [
['createdAt' => '2025-06-09T05:43:29.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2025-05-19T02:40:38.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-04-18T01:52:31.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-04-18T01:52:31.000Z', 'description' => 'Error codes changed'],
],
],
'RunPreTrainService' => [
'summary' => 'Calls a pre-trained model service.',
'methods' => ['post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREnlp2P1OGB', 'FEATUREnlp8RK87E', 'FEATUREnlp0537I6', 'FEATUREnlpCAMXDD', 'FEATUREnlpM7P12V', 'FEATUREnlpQTX906', 'FEATUREnlpLCH6DG', 'FEATUREnlpDG0HX3', 'FEATUREnlp9YSZ64', 'FEATUREnlpUZ2C2Y', 'FEATUREnlpZBZJI2', 'FEATUREnlpV1PN9B', 'FEATUREnlpWB1IYO', 'FEATUREnlpX2LEJN', 'FEATUREnlpLSF30C', 'FEATUREnlpQ032BR', 'FEATUREnlpQHAWK2', 'FEATUREnlpWLVJE2', 'FEATUREnlp4JXFXB', 'FEATUREnlp0PKWIK',
'FEATUREnlp1V7KGA', 'FEATUREnlpR5NT62', 'FEATUREnlpUC15C2', 'FEATUREnlpOT0DNK', 'FEATUREnlpQBSUD4', 'FEATUREnlp8ES9UE', 'FEATUREnlpTE27I1', 'FEATUREnlp6WE0DC', 'FEATUREnlpVBPY3Z', 'FEATUREnlp0MGP51', 'FEATUREnlpJSUF2I',
],
],
'parameters' => [
[
'name' => 'ServiceName',
'in' => 'formData',
'schema' => ['description' => 'The service name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ReviewAnalysis', 'title' => ''],
],
[
'name' => 'ServiceVersion',
'in' => 'formData',
'schema' => ['description' => 'The service version.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'V1', 'title' => ''],
],
[
'name' => 'PredictContent',
'in' => 'formData',
'schema' => ['description' => 'The prediction input.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{"input":{"content": "这件衣服真好看", "domain": "clothing"}}', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PredictResult' => ['description' => 'The model prediction result.', 'type' => 'string', 'example' => '{"cost":"21.812ms","imprs":[{"aspect":"款式","clause":"这件衣服真好看","neg_prob":0.0,"pos_prob":0.566100001335144,"position":"0,7","sentiment":"正"}]},"message":"SUCCESS","tracerId":"7973b50e31dcbea8323460e0134d3226"}', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '7310FFCF-9FE8-4257-AE38-0E1AD828C2CC', 'title' => ''],
'BillingCount' => ['description' => 'The number of billing units, which corresponds to the number of resource plan units deducted.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidAccountStatus.ServiceUnavailable', 'errorMessage' => 'The NLP Auto Machine Learning service has not been activated.', 'description' => 'The NLP Auto Machine Learning service has not been activated.'],
['errorCode' => 'InvalidAccountStatus.ServiceLimit', 'errorMessage' => 'The maximum number of free API daily visits is exceeded.', 'description' => ''],
['errorCode' => 'parameterError', 'errorMessage' => 'The parameter is invalid.', 'description' => ''],
['errorCode' => 'predictContentLength', 'errorMessage' => 'The length of content exceeds the limit.', 'description' => ''],
['errorCode' => 'postPaidArrearage', 'errorMessage' => 'The service is not opened or the account is overdue.', 'description' => ''],
['errorCode' => 'PermissionDeny', 'errorMessage' => 'No RAM permission.', 'description' => 'No permission to change the account'],
],
404 => [
['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified Model does not exist.', 'description' => 'The specified Model does not exist.'],
],
500 => [
['errorCode' => 'ModelInferenceError', 'errorMessage' => 'Failed to obtain the model prediction result.', 'description' => 'Get model predict result error.'],
['errorCode' => 'UnknownError', 'errorMessage' => 'A server error occurred while processing your request. Please try again later or contact customer support.', 'description' => 'A server error occurred while processing your request. Please try again later or contact customer support.'],
['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request.'],
['errorCode' => 'predictTimeout', 'errorMessage' => 'model predict cost greater than 9000ms.', 'description' => ''],
],
503 => [
['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request.'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PredictResult\\": \\"{\\\\\\"cost\\\\\\":\\\\\\"21.812ms\\\\\\",\\\\\\"imprs\\\\\\":[{\\\\\\"aspect\\\\\\":\\\\\\"款式\\\\\\",\\\\\\"clause\\\\\\":\\\\\\"这件衣服真好看\\\\\\",\\\\\\"neg_prob\\\\\\":0.0,\\\\\\"pos_prob\\\\\\":0.566100001335144,\\\\\\"position\\\\\\":\\\\\\"0,7\\\\\\",\\\\\\"sentiment\\\\\\":\\\\\\"正\\\\\\"}]},\\\\\\"message\\\\\\":\\\\\\"SUCCESS\\\\\\",\\\\\\"tracerId\\\\\\":\\\\\\"7973b50e31dcbea8323460e0134d3226\\\\\\"}\\",\\n \\"RequestId\\": \\"7310FFCF-9FE8-4257-AE38-0E1AD828C2CC\\",\\n \\"BillingCount\\": 1\\n}","type":"json"}]',
'title' => 'Call a pre-trained model service',
'changeSet' => [
['createdAt' => '2025-06-09T05:43:29.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-05-06T09:24:49.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2023-03-17T09:01:03.000Z', 'description' => 'Error codes changed'],
],
],
],
'endpoints' => [
['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'nlp-automl.cn-hangzhou.aliyuncs.com', 'endpoint' => 'nlp-automl.cn-hangzhou.aliyuncs.com', 'vpc' => 'nlp-automl-vpc.cn-hangzhou.aliyuncs.com'],
],
'errorCodes' => [
['code' => '40001', 'message' => 'The quota for calling the model is exceeded.', 'http_code' => 403, 'description' => ''],
['code' => '40002', 'message' => 'The specified interface is throttled.', 'http_code' => 403, 'description' => 'The specified interface is throttled.'],
['code' => '40003', 'message' => 'An error occurred while authenticating the model.', 'http_code' => 403, 'description' => ''],
['code' => '40004', 'message' => 'A server error occurred while processing your request. Please try again later or contact customer support.', 'http_code' => 200, 'description' => 'A server error occurred while processing your request. Please try again later or contact customer support.'],
['code' => '40013', 'message' => 'An error occurred while authenticating the model.', 'http_code' => 403, 'description' => ''],
['code' => 'Account arrearage', 'message' => 'The account is arrearage.', 'http_code' => 400, 'description' => 'Account Arrears'],
['code' => 'BaseModelNotFound', 'message' => 'The base model is not found.', 'http_code' => 400, 'description' => ''],
['code' => 'createModelConcurrency', 'message' => 'Creating multiple models at the same time is not allowed.', 'http_code' => 400, 'description' => ''],
['code' => 'DataCenter.IllegalDatasetId', 'message' => 'The format of the dataset ID is invalid.', 'http_code' => 403, 'description' => ''],
['code' => 'DataCenter.IllegalDatasetRecord', 'message' => 'The format of the dataset record is invalid.', 'http_code' => 403, 'description' => ''],
['code' => 'dataFormatError', 'message' => 'The number of data bars added exceeds 500.', 'http_code' => 400, 'description' => ''],
['code' => 'DocParseError', 'message' => 'The version of the uploaded DOC file is too early to support parsing. You are advised to replace the DOCX file with the latest version.', 'http_code' => 400, 'description' => ''],
['code' => 'FileParseError', 'message' => 'The uploaded file failed to be parsed.', 'http_code' => 500, 'description' => ''],
['code' => 'Forbbiden', 'message' => 'You are not authorized to operate on the specified resource.', 'http_code' => 403, 'description' => 'You are not authorized to operate on the specified resource.'],
['code' => 'InternalError', 'message' => 'An error occurred while processing your request.', 'http_code' => 500, 'description' => 'An error occurred while processing your request.'],
['code' => 'InvalidAccountStatus.ServiceLimit', 'message' => 'The maximum number of free API daily visits is exceeded.', 'http_code' => 400, 'description' => ''],
['code' => 'InvalidAccountStatus.ServiceUnavailable', 'message' => 'The NLP Auto Machine Learning service has not been activated.', 'http_code' => 400, 'description' => 'The NLP Auto Machine Learning service has not been activated.'],
['code' => 'InvalidContentLength', 'message' => 'The length of content exceeds the limit.', 'http_code' => 400, 'description' => ''],
['code' => 'InvalidParameter', 'message' => 'The parameter is invalid.', 'http_code' => 400, 'description' => ''],
['code' => 'InvalidParameter.ModelId', 'message' => 'The specified modelId is invalid.', 'http_code' => 400, 'description' => ''],
['code' => 'InvalidParameter.ModelVersion', 'message' => 'The specified modelVersion is invalid.', 'http_code' => 400, 'description' => ''],
['code' => 'InvalidServiceName', 'message' => 'The service does not exist.', 'http_code' => 400, 'description' => 'The service is not exists.'],
['code' => 'ModelCenter.CreateModelLimit', 'message' => 'The maximum number of models you created is exceeded.', 'http_code' => 403, 'description' => ''],
['code' => 'ModelCenter.DeployModelLimit', 'message' => 'The maximum number of online models is exceeded. You cannot deploy the model.', 'http_code' => 403, 'description' => ''],
['code' => 'ModelCenter.IllegalModelName', 'message' => 'The format of the model name is invalid.', 'http_code' => 400, 'description' => ''],
['code' => 'ModelCenter.MinTrainingcount', 'message' => 'The number of model training records is less than 4.', 'http_code' => 400, 'description' => ''],
['code' => 'ModelCenter.ModelNotFound', 'message' => 'The model information is not found.', 'http_code' => 400, 'description' => ''],
['code' => 'ModelCenter.ModelNotInProject', 'message' => 'The model is not in the specified project.', 'http_code' => 400, 'description' => ''],
['code' => 'ModelCenter.ModelStatusError', 'message' => 'The model status is abnormal.', 'http_code' => 400, 'description' => ''],
['code' => 'ModelCenter.NoDatasetOnline', 'message' => 'The status of the training dataset is not online.', 'http_code' => 400, 'description' => ''],
['code' => 'ModelCenter.NoPermission', 'message' => 'You are not authorized to perform the operation.', 'http_code' => 403, 'description' => ''],
['code' => 'ModelCenter.NotFoundConfig', 'message' => 'The configuration information of the model type is not found.', 'http_code' => 400, 'description' => ''],
['code' => 'ModelCenter.OnlineModelLimit', 'message' => 'The maximum number of online models is exceeded.', 'http_code' => 403, 'description' => ''],
['code' => 'ModelGroupNotFound', 'message' => 'The model group is not found.', 'http_code' => 400, 'description' => ''],
['code' => 'ModelInferenceError', 'message' => 'Failed to obtain the model prediction result.', 'http_code' => 500, 'description' => 'Get model predict result error.'],
['code' => 'ModelInferenceFailed', 'message' => 'The model inference result is null.', 'http_code' => 500, 'description' => ''],
['code' => 'NotFoundUploadDataError', 'message' => 'No data set is created.', 'http_code' => 400, 'description' => ''],
['code' => 'parameterError', 'message' => 'The parameter is invalid.', 'http_code' => 400, 'description' => ''],
['code' => 'PermissionDeny', 'message' => 'No RAM permission.', 'http_code' => 400, 'description' => 'No permission to change the account'],
['code' => 'postPaidArrearage', 'message' => 'The service is not opened or the account is overdue.', 'http_code' => 400, 'description' => ''],
['code' => 'postpaidArrearageError', 'message' => 'You have an overdue payment.', 'http_code' => 400, 'description' => ''],
['code' => 'predictContentLength', 'message' => 'The length of content exceeds the limit.', 'http_code' => 400, 'description' => ''],
['code' => 'predictLimit', 'message' => 'The maximum number of submitted tasks is exceeded.', 'http_code' => 400, 'description' => ''],
['code' => 'predictQpsLimit', 'message' => 'The maximum number of queries-per-second is exceeded.', 'http_code' => 403, 'description' => ''],
['code' => 'predictTimeout', 'message' => 'model predict cost greater than 9000ms.', 'http_code' => 500, 'description' => ''],
['code' => 'queryExceedMaxDuration', 'message' => 'The query data exceeds the upper limit.', 'http_code' => 400, 'description' => ''],
['code' => 'ResourceNotFound', 'message' => 'The specified Model does not exist.', 'http_code' => 404, 'description' => 'The specified Model does not exist.'],
['code' => 'ServiceUnavailable', 'message' => 'An error occurred while processing your request.', 'http_code' => 503, 'description' => 'An error occurred while processing your request.'],
['code' => 'UnknownError', 'message' => 'A server error occurred while processing your request. Please try again later or contact customer support.', 'http_code' => 500, 'description' => 'A server error occurred while processing your request. Please try again later or contact customer support.'],
],
'changeSet' => [
[
'apis' => [
['description' => 'Response parameters changed', 'api' => 'RunPreTrainService'],
],
'createdAt' => '2023-05-06T09:24:51.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'Error codes changed', 'api' => 'RunPreTrainService'],
],
'createdAt' => '2023-03-24T08:21:17.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'Request parameters changed', 'api' => 'CreateAsyncPredict'],
],
'createdAt' => '2023-03-24T08:20:06.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'Request parameters changed', 'api' => 'CreateAsyncPredict'],
],
'createdAt' => '2022-11-14T05:07:09.000Z',
'description' => '异步预测接口支持根据服务名称和服务版本进行调用。',
],
[
'apis' => [
['description' => 'Request parameters changed', 'api' => 'CreateAsyncPredict'],
],
'createdAt' => '2022-11-14T03:20:10.000Z',
'description' => '异步预测接口支持预训练模型根据服务名称和服务版本进行调用了。',
],
[
'apis' => [
['description' => 'Error codes changed', 'api' => 'GetPredictResult'],
],
'createdAt' => '2022-04-19T03:32:51.000Z',
'description' => 'GetPredictResult调用模型未返回结果时,返回ErrorCode: ModelInferenceFailed,ErrorMessage:The model inference result is null.',
],
[
'apis' => [
['description' => 'Error codes changed', 'api' => 'GetPredictResult'],
],
'createdAt' => '2022-04-18T03:06:41.000Z',
'description' => 'GetPredictResult接口模型鉴权失败时接口的http_code变更为403',
],
],
];
|