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/superappnlp | |
| parent | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (diff) | |
| download | afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.tar.gz afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.zip | |
update APIs 20260712
Diffstat (limited to 'data/en_us/superappnlp')
| -rw-r--r-- | data/en_us/superappnlp/2024-09-30/api-docs.php | 184 |
1 files changed, 55 insertions, 129 deletions
diff --git a/data/en_us/superappnlp/2024-09-30/api-docs.php b/data/en_us/superappnlp/2024-09-30/api-docs.php index 315f601..93ab5b4 100644 --- a/data/en_us/superappnlp/2024-09-30/api-docs.php +++ b/data/en_us/superappnlp/2024-09-30/api-docs.php @@ -1,29 +1,19 @@ <?php return [ 'version' => '1.0', - 'info' => [ - 'style' => 'RPC', - 'product' => 'SuperappNlp', - 'version' => '2024-09-30', - ], - 'directories' => [ - 'NlpAddressNormalization', - ], + 'info' => ['style' => 'RPC', 'product' => 'SuperappNlp', 'version' => '2024-09-30'], + 'directories' => ['NlpAddressNormalization'], 'components' => [ 'schemas' => [], ], 'apis' => [ 'NlpAddressNormalization' => [ - 'summary' => 'AI 地址区划标准化服务'."\n" + 'summary' => 'AI address administrative division normalization service'."\n" ."\n" - .'在真实业务场景中,给定的原始文本地址可能缺失了行政区划名称信息(例如,省、市、或区名称),或可能包含了错误的行政区划名称,或地址中提到的行政区划名称信息还没有和下游行业内部的地址库对齐。'."\n" - .'地址区划标准化服务采用业界最先进的AI及多语言NLP技术,能够准确分析及理解输入的无结构化文本地址内容,并预测输出标准化、对齐后的行政区划名称信息。'."\n" - .'该服务已经用于支持物流行业客户的实际生产业务,包括AI地址分单及运费自动结算等场景需求。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + .'In real-world business scenarios, a given raw text address may be missing administrative division information (for example, province, city, or district names), may contain incorrect administrative division names, or the administrative division information mentioned in the address may not yet be aligned with the downstream industry\'s internal address database.'."\n" + .'The address administrative division normalization service uses state-of-the-art AI and multilingual NLP technologies to accurately analyze and understand unstructured text address input, and predict and output standardized, aligned administrative division information.'."\n" + .'This service is already used to support production workloads for logistics industry customers, including scenarios such as AI-based address-based parcel sorting and automatic freight settlement.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -31,194 +21,130 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => [ - 'title' => '幂等参数', - 'description' => '', + 'title' => '', + 'description' => 'The idempotency parameter.', + 'enumValueTitles' => ['无' => 'None.'], 'type' => 'string', 'required' => false, - 'example' => '', + 'example' => '可以不填', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ - 'description' => '', + 'description' => 'The instance ID.', + 'enumValueTitles' => ['无' => 'None.'], 'type' => 'string', 'required' => false, 'example' => '10671', + 'title' => '', ], ], [ 'name' => 'QueryStr', 'in' => 'query', 'schema' => [ - 'description' => '', + 'description' => 'The address to parse.', + 'enumValueTitles' => ['无' => 'None.'], 'type' => 'string', 'required' => false, 'example' => '350 Magliman, Bacolor, Pampanga AQUA MALTA Refilling Station', + 'title' => '', ], ], [ 'name' => 'CityStr', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'BACOLOR ', - ], + 'schema' => ['description' => 'The city value.', 'type' => 'string', 'required' => false, 'example' => 'BACOLOR ', 'title' => ''], ], [ 'name' => 'ProvinceStr', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'PAMPANGA ', - ], + 'schema' => ['description' => 'The province.', 'type' => 'string', 'required' => false, 'example' => 'PAMPANGA ', 'title' => ''], ], [ 'name' => 'ProvinceStdManual', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The manually calibrated value for the province.', 'type' => 'string', 'required' => false, 'example' => '可以不填', 'title' => ''], ], [ 'name' => 'CityStdManual', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The manually calibrated value for the city.', 'type' => 'string', 'required' => false, 'example' => '可以不填', 'title' => ''], ], [ 'name' => 'DistrictStdManual', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The manually calibrated value for the district.', 'type' => 'string', 'required' => false, 'example' => '可以不填', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - ], + 'Code' => ['description' => 'The status code of the request.', 'type' => 'string', 'example' => 'S0000', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => 'The response data.', 'type' => 'object', 'properties' => [ - 'CityStd' => [ - 'description' => '', - 'type' => 'string', - ], - 'DistrictStd' => [ - 'description' => '', - 'type' => 'string', - ], - 'ProvinceStd' => [ - 'description' => '', - 'type' => 'string', - ], + 'CityStd' => ['description' => 'The parsed city.', 'type' => 'string', 'example' => 'MANDALUYONG', 'title' => ''], + 'DistrictStd' => ['description' => 'The parsed district.', 'type' => 'string', 'example' => 'PLEASANT HILLS', 'title' => ''], + 'ProvinceStd' => ['description' => 'The parsed province.', 'type' => 'string', 'example' => 'METRO-MANILA', 'title' => ''], 'Results' => [ + 'description' => 'No value.', 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - 'StatusEs' => [ - 'description' => '', - 'type' => 'string', + 'items' => ['description' => 'No value.', 'type' => 'string', 'example' => '[]', 'title' => ''], + 'title' => '', + 'example' => '', ], + 'StatusEs' => ['description' => 'The parsing status.', 'type' => 'string', 'example' => 'Code_000:OK', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '99540D1A-9112-56E5-8DCC-1A2603F4C500', - ], - 'Result' => [ - 'type' => 'string', - 'example' => 'success', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Timestamp' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1701051540592', - ], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '99540D1A-9112-56E5-8DCC-1A2603F4C500'], + 'Result' => ['description' => 'The response result.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. This field is typically used for determining the result.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Timestamp' => ['description' => 'The request timestamp.', 'type' => 'string', 'example' => '1701051540592', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 200 => [ - [ - 'errorCode' => 'InstanceDoesNotExist', - 'errorMessage' => 'Instance does not exist.', - ], - [ - 'errorCode' => 'InstanceCanNotUsed', - 'errorMessage' => 'Instance can not used.', - ], - [ - 'errorCode' => 'NlpParseException', - 'errorMessage' => 'Nlp parse exception.', - ], + ['errorCode' => 'InstanceDoesNotExist', 'errorMessage' => 'Instance does not exist.', 'description' => ''], + ['errorCode' => 'InstanceCanNotUsed', 'errorMessage' => 'Instance can not used.', 'description' => ''], + ['errorCode' => 'NlpParseException', 'errorMessage' => 'Nlp parse exception.', 'description' => ''], ], 400 => [ - [ - 'errorCode' => 'IdempotentParameterMismatch', - 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', - ], + ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"S0000\\",\\n \\"Data\\": {\\n \\"CityStd\\": \\"MANDALUYONG\\",\\n \\"DistrictStd\\": \\"PLEASANT HILLS\\",\\n \\"ProvinceStd\\": \\"METRO-MANILA\\",\\n \\"Results\\": [\\n \\"[]\\"\\n ],\\n \\"StatusEs\\": \\"Code_000:OK\\"\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"99540D1A-9112-56E5-8DCC-1A2603F4C500\\",\\n \\"Result\\": \\"success\\",\\n \\"Success\\": true,\\n \\"Timestamp\\": \\"1701051540592\\"\\n}","type":"json"}]', 'title' => 'NlpAddressNormalization', + 'description' => 'Address parsing operation.'."\n" + .'Converts a non-standardized address into a standardized address.'."\n" + .'Each call is recorded for the user. The service is no longer available after the user\'s remaining quota reaches 0.', + 'changeSet' => [], ], ], 'endpoints' => [ - [ - 'regionId' => 'ap-southeast-1', - 'endpoint' => 'superappnlp.ap-southeast-1.aliyuncs.com', - ], + ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'superappnlp.ap-southeast-1.aliyuncs.com', 'endpoint' => 'superappnlp.ap-southeast-1.aliyuncs.com', 'vpc' => 'superappnlp-vpc.ap-southeast-1.aliyuncs.com'], ], + 'errorCodes' => [], + 'changeSet' => [], ]; |
