diff options
| author | Zhineng Li <im@zhineng.li> | 2026-07-12 17:11:17 +0800 |
|---|---|---|
| committer | Zhineng Li <im@zhineng.li> | 2026-07-12 17:11:17 +0800 |
| commit | 1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 (patch) | |
| tree | 5f0857666365b7e40cdaa3733ebe1f3ba9e13c67 /data/en_us/nlp-automl | |
| parent | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (diff) | |
| download | afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.tar.gz afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.zip | |
update APIs 20260712
Diffstat (limited to 'data/en_us/nlp-automl')
| -rw-r--r-- | data/en_us/nlp-automl/2019-05-29/api-docs.php | 74 | ||||
| -rw-r--r-- | data/en_us/nlp-automl/2019-07-01/api-docs.php | 343 | ||||
| -rw-r--r-- | data/en_us/nlp-automl/2019-11-11/api-docs.php | 861 |
3 files changed, 423 insertions, 855 deletions
diff --git a/data/en_us/nlp-automl/2019-05-29/api-docs.php b/data/en_us/nlp-automl/2019-05-29/api-docs.php index 6116ff2..f3c1f53 100644 --- a/data/en_us/nlp-automl/2019-05-29/api-docs.php +++ b/data/en_us/nlp-automl/2019-05-29/api-docs.php @@ -1,18 +1,12 @@ <?php return [ 'version' => '1.0', - 'info' => [ - 'style' => 'ROA', - 'product' => 'nlp-automl', - 'version' => '2019-05-29', - ], + 'info' => ['style' => 'ROA', 'product' => 'nlp-automl', 'version' => '2019-05-29'], 'directories' => [ [ 'id' => 0, 'title' => '其它', 'type' => 'directory', - 'children' => [ - 'PredictModel', - ], + 'children' => ['PredictModel'], ], ], 'components' => [ @@ -22,14 +16,8 @@ 'PredictModel' => [ 'summary' => '模型结果预测', 'path' => '/api/automl/predict', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -41,41 +29,18 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREnlp6HZZI5', - 'FEATUREnlpMXQY7X', - 'FEATUREnlpAOZDQ8', - 'FEATUREnlp6X5BYZ', - 'FEATUREnlp0VR1QU', - 'FEATUREnlp01ENOR', - 'FEATUREnlpM0OA48', - 'FEATUREnlpF61RQU', - 'FEATUREnlpJOUXF2', - 'FEATUREnlpR1YV22', - 'FEATUREnlp97BF9V', - 'FEATUREnlpEZFBRW', - 'FEATUREnlp3ZJX2G', - ], + 'abilityTreeNodes' => ['FEATUREnlp6HZZI5', 'FEATUREnlpMXQY7X', 'FEATUREnlpAOZDQ8', 'FEATUREnlp6X5BYZ', 'FEATUREnlp0VR1QU', 'FEATUREnlp01ENOR', 'FEATUREnlpM0OA48', 'FEATUREnlpF61RQU', 'FEATUREnlpJOUXF2', 'FEATUREnlpR1YV22', 'FEATUREnlp97BF9V', 'FEATUREnlpEZFBRW', 'FEATUREnlp3ZJX2G'], ], 'parameters' => [ [ 'name' => 'ModelId', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true], ], [ 'name' => 'Content', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], ], 'responses' => [ @@ -83,21 +48,11 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'Data' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string'], + 'Message' => ['type' => 'string'], + 'Data' => ['type' => 'string'], + 'RequestId' => ['type' => 'string'], + 'Success' => ['type' => 'string'], ], ], ], @@ -106,9 +61,6 @@ ], ], 'endpoints' => [ - [ - 'regionId' => 'cn-hangzhou', - 'endpoint' => 'nlp-automl.cn-hangzhou.aliyuncs.com', - ], + ['regionId' => 'cn-hangzhou', 'endpoint' => 'nlp-automl.cn-hangzhou.aliyuncs.com'], ], ]; diff --git a/data/en_us/nlp-automl/2019-07-01/api-docs.php b/data/en_us/nlp-automl/2019-07-01/api-docs.php index 002b6c6..eeffd34 100644 --- a/data/en_us/nlp-automl/2019-07-01/api-docs.php +++ b/data/en_us/nlp-automl/2019-07-01/api-docs.php @@ -1,35 +1,14 @@ <?php return [ 'version' => '1.0', - 'info' => [ - 'style' => 'RPC', - 'product' => 'nlp-automl', - 'version' => '2019-07-01', - ], - 'directories' => [ - [ - 'id' => 0, - 'title' => '其它', - 'type' => 'directory', - 'children' => [ - 'AddMTInterveneWord', - 'GetPredictDoc', - 'PredictMTModelByDoc', - ], - ], - ], + 'info' => ['style' => 'RPC', 'product' => 'nlp-automl', 'version' => '2019-07-01'], + 'directories' => ['AddMTInterveneWord', 'GetPredictDoc', 'PredictMTModelByDoc'], 'components' => [ 'schemas' => [], ], 'apis' => [ 'AddMTInterveneWord' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -43,53 +22,27 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'SourceText', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'hello', - ], + 'schema' => ['description' => 'The source text.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'hello', 'title' => ''], ], [ 'name' => 'TargetText', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'schema' => ['description' => 'The target text.', 'type' => 'string', 'required' => false, 'example' => '你好', 'title' => ''], ], [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'PackageId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '1', - 'default' => 'mt_automl', - ], + 'schema' => ['description' => 'The word package ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'default' => 'mt_automl', 'example' => '1', 'title' => ''], ], ], 'responses' => [ @@ -97,44 +50,36 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'parameterError', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '46E6B40D-2B6C-571B-AC41-86207DE288A5', - ], - 'WordId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], + 'Code' => ['description' => 'The response code. Valid values:'."\n" + .'- 200: success.'."\n" + .'- Other values: error codes. For more information, see error codes.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message corresponding to the error code.', 'type' => 'string', 'example' => 'parameterError', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '46E6B40D-2B6C-571B-AC41-86207DE288A5', 'title' => ''], + 'WordId' => ['description' => 'The ID of the successfully added word.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"parameterError\\",\\n \\"RequestId\\": \\"46E6B40D-2B6C-571B-AC41-86207DE288A5\\",\\n \\"WordId\\": 1\\n}","type":"json"}]', - ], - 'GetPredictDoc' => [ - 'methods' => [ - 'head', - 'post', - 'get', + 'title' => 'Add intervention data', + 'summary' => 'Adds the source text and target text to be intervened to the dataset corresponding to the specified ProjectId and PackageId.', + 'description' => 'Before using this operation, make sure that you fully understand the billing method and [pricing](https://common-buy.aliyun.com/?commodityCode=nlp_bag#/buy) of the NLP Self-learning Platform.', + 'changeSet' => [ + ['createdAt' => '2022-03-07T07:22:38.000Z', 'description' => 'Response parameters changed, Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddMTInterveneWord'], + ], + 'product' => ['code' => 'nlp', 'title' => '自然语言处理'], ], + ], + 'GetPredictDoc' => [ + 'methods' => ['head', 'post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -151,32 +96,17 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'DocId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1000', - ], + 'schema' => ['description' => 'The document ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1000', 'title' => ''], ], [ 'name' => 'Product', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - 'default' => 'mt_automl', - ], + 'schema' => ['description' => 'The product code.', 'type' => 'string', 'required' => false, 'default' => 'mt_automl', 'example' => '空', 'title' => ''], ], ], 'responses' => [ @@ -184,43 +114,38 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '86D18195-D89C-4C8C-9DC4-5FCE789CE6D5', - ], - 'ResultContent' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'xxx', - ], - 'XLIFFInfo' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'xxx', - ], + 'Status' => ['description' => 'The processing status. Valid values:'."\n" + .'- 0: initialization'."\n" + .'- 1: processing'."\n" + .'- 2: processing succeeded'."\n" + .'- 3: processing failed.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '86D18195-D89C-4C8C-9DC4-5FCE789CE6D5', 'title' => ''], + 'ResultContent' => ['description' => 'The prediction result, in file stream format.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], + 'XLIFFInfo' => ['description' => 'The XLIFF information, in file stream format.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": 2,\\n \\"RequestId\\": \\"86D18195-D89C-4C8C-9DC4-5FCE789CE6D5\\",\\n \\"ResultContent\\": \\"xxx\\",\\n \\"XLIFFInfo\\": \\"xxx\\"\\n}","type":"json"}]', - ], - 'PredictMTModelByDoc' => [ - 'methods' => [ - 'head', - 'post', - 'get', + 'title' => 'Retrieve document prediction result', + 'summary' => 'Retrieves the prediction result of a document based on the docId returned by PredictMTModelByDoc.', + 'description' => 'Before using this operation, make sure that you fully understand the billing of NLP AutoLearning and its [pricing](https://common-buy.aliyun.com/?commodityCode=nlp_bag#/buy).', + 'changeSet' => [ + ['createdAt' => '2024-07-04T02:12:17.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPredictDoc'], + ], + 'product' => ['code' => 'nlp', 'title' => '自然语言处理'], ], + ], + 'PredictMTModelByDoc' => [ + 'methods' => ['head', 'post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -237,64 +162,32 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'FileContent', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '[base64 encode content]', - ], + 'schema' => ['description' => 'The file data content. The file content must be processed with Base64 encoding.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '[base64 encode content]', 'title' => ''], ], [ 'name' => 'FileType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'docx', - ], + 'schema' => ['description' => 'The file type.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'docx', 'title' => ''], ], [ 'name' => 'ModelId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The model ID.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'NeedXLIFF', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'Specifies whether XLIFF information is required.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ 'name' => 'ModelVersion', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'v1', - ], + 'schema' => ['description' => 'The model version.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'v1', 'title' => ''], ], ], 'responses' => [ @@ -302,27 +195,107 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'DocId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '86D18195-D89C-4C8C-9DC4-5FCE789CE6D5', - ], + 'DocId' => ['description' => 'The document ID.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '86D18195-D89C-4C8C-9DC4-5FCE789CE6D5', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DocId\\": \\"1\\",\\n \\"RequestId\\": \\"86D18195-D89C-4C8C-9DC4-5FCE789CE6D5\\"\\n}","type":"json"}]', + 'title' => 'Submit a document prediction task', + 'summary' => 'Uploads document content and uses a specified model for prediction.', + 'description' => 'Before using this operation, make sure that you fully understand the billing method and [pricing](https://common-buy.aliyun.com/?commodityCode=nlp_bag#/buy) of NLP Self-learning Platform.', + 'changeSet' => [ + ['createdAt' => '2024-07-04T02:12:17.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PredictMTModelByDoc'], + ], + 'product' => ['code' => 'nlp', 'title' => '自然语言处理'], + ], ], ], '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' => [ [ - 'regionId' => 'cn-hangzhou', - 'endpoint' => 'nlp-automl.cn-hangzhou.aliyuncs.com', + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'GetPredictDoc'], + ['description' => 'Error codes changed', 'api' => 'PredictMTModelByDoc'], + ], + 'createdAt' => '2024-07-04T02:12:21.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed, Error codes changed', 'api' => 'AddMTInterveneWord'], + ], + 'createdAt' => '2022-03-07T07:23:44.000Z', + 'description' => '修改AddMTInterveneWord这个接口的返回的message和wordId的数据类型,其他接口从public修改为private', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPredictDoc'], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PredictMTModelByDoc'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddMTInterveneWord'], ], + 'product' => ['code' => 'nlp', 'title' => 'nlp-automl'], ], ]; diff --git a/data/en_us/nlp-automl/2019-11-11/api-docs.php b/data/en_us/nlp-automl/2019-11-11/api-docs.php index 22db059..e626d2c 100644 --- a/data/en_us/nlp-automl/2019-11-11/api-docs.php +++ b/data/en_us/nlp-automl/2019-11-11/api-docs.php @@ -1,43 +1,15 @@ <?php return [ 'version' => '1.0', - 'info' => [ - 'style' => 'RPC', - 'product' => 'nlp-automl', - 'version' => '2019-11-11', - ], - 'directories' => [ - [ - 'id' => 66230, - 'title' => null, - 'type' => 'directory', - 'children' => [ - 'CreateAsyncPredict', - 'GetAsyncPredict', - ], - ], - [ - 'id' => 66233, - 'title' => null, - 'type' => 'directory', - 'children' => [ - 'GetPredictResult', - 'RunPreTrainService', - ], - ], - ], + 'info' => ['style' => 'RPC', 'product' => 'nlp-automl', 'version' => '2019-11-11'], + 'directories' => ['CreateAsyncPredict', 'GetAsyncPredict', 'GetPredictResult', 'RunPreTrainService'], 'components' => [ 'schemas' => [], ], 'apis' => [ 'CreateAsyncPredict' => [ - 'summary' => '创建异步预测任务', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'summary' => 'Creates an asynchronous prediction by calling CreateAsyncPredict.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -50,170 +22,66 @@ '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', + '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'example' => '1', - ], + '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' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '', - ], + 'schema' => ['description' => 'The prediction content. Maximum length: 1024 bytes.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '全国土地利用总体规划', 'title' => ''], ], [ 'name' => 'ModelVersion', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'V1', - ], + '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' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'false', - ], + '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0,3', - ], + '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' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'text,html,pdf,docx,doc', - ], + 'schema' => ['description' => 'The file type.', 'type' => 'string', 'required' => false, 'example' => 'text,html,pdf,docx,doc', 'title' => ''], ], [ 'name' => 'FileUrl', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'http://127.0.0.1/example.docx', - ], + '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' => '', - 'type' => 'string', - 'required' => false, - 'example' => '[base64 encode content]', - ], + 'schema' => ['description' => 'The Base64-encoded file content.', 'type' => 'string', 'required' => false, 'example' => '[base64 encode content]', 'title' => ''], ], [ 'name' => 'FetchContent', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'true,false', - ], + 'schema' => ['description' => 'The prediction text to return.', 'type' => 'string', 'required' => false, 'example' => 'true', 'title' => ''], ], [ 'name' => 'ServiceName', 'in' => 'formData', - 'schema' => [ - 'title' => '服务名称', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'ContractNERPretrain', - ], + 'schema' => ['title' => '', 'description' => 'The service name.', 'type' => 'string', 'required' => false, 'example' => 'ContractNERPretrain'], ], [ 'name' => 'ServiceVersion', 'in' => 'formData', - 'schema' => [ - 'title' => '服务版本', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'V1', - ], + 'schema' => ['title' => '', 'description' => 'The service version.', 'type' => 'string', 'required' => false, 'example' => 'V1'], ], ], 'responses' => [ @@ -221,103 +89,56 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'AsyncPredictId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'E5C4531B-8331-5CD5-BEB3-2F8B58A4D680', - ], + '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.', - ], - [ - 'errorCode' => '40013', - 'errorMessage' => 'An error occurred while authenticating the model.', - ], + ['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.', - ], - [ - 'errorCode' => 'InvalidAccountStatus.ServiceLimit', - 'errorMessage' => 'The maximum number of free API daily visits is exceeded.', - ], - [ - 'errorCode' => 'InvalidParameter.ModelId', - 'errorMessage' => 'The specified modelId is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.ModelVersion', - 'errorMessage' => 'The specified modelVersion is invalid.', - ], - [ - 'errorCode' => 'InvalidContentLength', - 'errorMessage' => 'The length of content exceeds the limit.', - ], - [ - 'errorCode' => 'parameterError', - 'errorMessage' => 'The parameter is invalid.', - ], - [ - 'errorCode' => 'predictLimit', - 'errorMessage' => 'The maximum number of submitted tasks is exceeded.', - ], - [ - 'errorCode' => 'postPaidArrearage', - 'errorMessage' => 'The service is not opened or the account is overdue.', - ], + ['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.', - ], + ['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.', - ], + ['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.', - ], + ['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.', - ], + ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request.'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"AsyncPredictId\\": 1,\\n \\"RequestId\\": \\"E5C4531B-8331-5CD5-BEB3-2F8B58A4D680\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateAsyncPredictResponse>\\r\\n <requestId>A357B459-3EA6-4F68-B285-FFDDF4E4662D</requestId>\\r\\n <asyncPredictId>1634</asyncPredictId>\\r\\n</CreateAsyncPredictResponse>","errorExample":""}]', - 'title' => 'CreateAsyncPredict', + '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' => '获取异步预测结果', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'summary' => 'Calls GetAsyncPredict to retrieve asynchronous prediction results.', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -330,64 +151,16 @@ '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', + '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1629', - ], + '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' => [ @@ -395,102 +168,58 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'AsyncPredictId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1629', - ], - 'Status' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'EBF1AAD7-A3FB-4A78-B5E9-8356324B12B2', - ], - 'Content' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'json string', - ], + '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.', - ], - [ - 'errorCode' => 'InvalidAccountStatus.ServiceLimit', - 'errorMessage' => 'The maximum number of free API daily visits is exceeded.', - ], - [ - 'errorCode' => 'InvalidParameter.ModelId', - 'errorMessage' => 'The specified modelId is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.ModelVersion', - 'errorMessage' => 'The specified modelVersion is invalid.', - ], - [ - 'errorCode' => 'InvalidContentLength', - 'errorMessage' => 'The length of content exceeds the limit.', - ], - [ - 'errorCode' => 'Account arrearage', - 'errorMessage' => 'The account is arrearage.', - ], - [ - 'errorCode' => 'PermissionDeny', - 'errorMessage' => 'No RAM permission.', - ], + ['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.', - ], + ['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.', - ], + ['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.', - ], + ['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.', - ], + ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request.'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"AsyncPredictId\\": 1629,\\n \\"Status\\": 2,\\n \\"RequestId\\": \\"EBF1AAD7-A3FB-4A78-B5E9-8356324B12B2\\",\\n \\"Content\\": \\"json string\\"\\n}","errorExample":""},{"type":"xml","example":"<GetAsyncPredictResponse>\\n <requestId>EBF1AAD7-A3FB-4A78-B5E9-8356324B12B2</requestId>\\n <asyncPredictId>1629</asyncPredictId>\\n <status>2</status>\\n <content></content>\\n</GetAsyncPredictResponse>","errorExample":""}]', + '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' => '获取模型预测结果', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'summary' => 'Call GetPredictResult to obtain model prediction results.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -502,77 +231,33 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREnlp6HZZI5', - 'FEATUREnlpMXQY7X', - 'FEATUREnlpAOZDQ8', - 'FEATUREnlpEZFBRW', - 'FEATUREnlp3ZJX2G', - 'FEATUREnlp97BF9V', - 'FEATUREnlpR1YV22', - 'FEATUREnlpJOUXF2', - 'FEATUREnlpF61RQU', - 'FEATUREnlpM0OA48', - 'FEATUREnlp01ENOR', - 'FEATUREnlp0VR1QU', - 'FEATUREnlp6X5BYZ', - ], + 'abilityTreeNodes' => ['FEATUREnlp6HZZI5', 'FEATUREnlpMXQY7X', 'FEATUREnlpAOZDQ8', 'FEATUREnlpEZFBRW', 'FEATUREnlp3ZJX2G', 'FEATUREnlp97BF9V', 'FEATUREnlpR1YV22', 'FEATUREnlpJOUXF2', 'FEATUREnlpF61RQU', 'FEATUREnlpM0OA48', 'FEATUREnlp01ENOR', 'FEATUREnlp0VR1QU', 'FEATUREnlp6X5BYZ'], ], 'parameters' => [ [ 'name' => 'ModelId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1818', - ], + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'Content', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '', - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'ModelVersion', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'V1', - ], + 'schema' => ['type' => 'string', 'required' => false, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'DetailTag', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'TopK', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3', - ], + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ @@ -580,111 +265,56 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Content' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '32CE4E89-218B-4DAE-A103-E6BFA66EE63B', - ], + '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.', - ], - [ - 'errorCode' => 'InvalidAccountStatus.ServiceLimit', - 'errorMessage' => 'The maximum number of free API daily visits is exceeded.', - ], - [ - 'errorCode' => 'InvalidParameter.ModelId', - 'errorMessage' => 'The specified modelId is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.ModelVersion', - 'errorMessage' => 'The specified modelVersion is invalid.', - ], - [ - 'errorCode' => 'InvalidContentLength', - 'errorMessage' => 'The length of content exceeds the limit.', - ], - [ - 'errorCode' => 'parameterError', - 'errorMessage' => 'The parameter is invalid.', - ], - [ - 'errorCode' => 'Account arrearage', - 'errorMessage' => 'The account is arrearage.', - ], - [ - 'errorCode' => 'PermissionDeny', - 'errorMessage' => 'No RAM permission.', - ], + ['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.', - ], - [ - 'errorCode' => 'Forbbiden', - 'errorMessage' => 'You are not authorized to operate on the specified resource.', - ], - [ - 'errorCode' => '40002', - 'errorMessage' => 'The specified interface is throttled.', - ], - [ - 'errorCode' => '40013', - 'errorMessage' => 'An error occurred while authenticating the model.', - ], + ['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.', - ], + ['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.', - ], - [ - 'errorCode' => 'ModelInferenceFailed', - 'errorMessage' => 'The model inference result is null.', - ], + ['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.', - ], + ['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' => 'GetPredictResult', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + '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' => '预训练服务', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'summary' => 'Calls a pre-trained model service.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -697,72 +327,25 @@ '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', + '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' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ReviewAnalysis', - ], + 'schema' => ['description' => 'The service name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ReviewAnalysis', 'title' => ''], ], [ 'name' => 'ServiceVersion', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'V1', - ], + 'schema' => ['description' => 'The service version.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'V1', 'title' => ''], ], [ 'name' => 'PredictContent', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '', - ], + 'schema' => ['description' => 'The prediction input.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{"input":{"content": "这件衣服真好看", "domain": "clothing"}}', 'title' => ''], ], ], 'responses' => [ @@ -770,90 +353,150 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'PredictResult' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '7310FFCF-9FE8-4257-AE38-0E1AD828C2CC', - ], - 'BillingCount' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + '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.', - ], - [ - 'errorCode' => 'InvalidAccountStatus.ServiceLimit', - 'errorMessage' => 'The maximum number of free API daily visits is exceeded.', - ], - [ - 'errorCode' => 'parameterError', - 'errorMessage' => 'The parameter is invalid.', - ], - [ - 'errorCode' => 'predictContentLength', - 'errorMessage' => 'The length of content exceeds the limit.', - ], - [ - 'errorCode' => 'postPaidArrearage', - 'errorMessage' => 'The service is not opened or the account is overdue.', - ], - [ - 'errorCode' => 'PermissionDeny', - 'errorMessage' => 'No RAM permission.', - ], + ['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.', - ], + ['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.', - ], - [ - 'errorCode' => 'UnknownError', - 'errorMessage' => '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.', - ], - [ - 'errorCode' => 'predictTimeout', - 'errorMessage' => 'model predict cost greater than 9000ms.', - ], + ['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.', - ], + ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request.'], ], ], - 'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"<RunPreTrainServiceResponse>\\n <PredictResult>{\\"cost\\":\\"21.812ms\\",\\"imprs\\":[{\\"aspect\\":\\"款式\\",\\"clause\\":\\"这件衣服真好看\\",\\"neg_prob\\":0.0,\\"pos_prob\\":0.566100001335144,\\"position\\":\\"0,7\\",\\"sentiment\\":\\"正\\"}]},\\"message\\":\\"SUCCESS\\",\\"tracerId\\":\\"7973b50e31dcbea8323460e0134d3226\\"}</PredictResult>\\n <RequestId>7310FFCF-9FE8-4257-AE38-0E1AD828C2CC</RequestId>\\n <BillingCount>1</BillingCount>\\n</RunPreTrainServiceResponse>","errorExample":""}]', - 'title' => 'RunPreTrainService', + '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' => '', + ], [ - 'regionId' => 'cn-hangzhou', - 'endpoint' => 'nlp-automl.cn-hangzhou.aliyuncs.com', + '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', ], ], ]; |
