summaryrefslogtreecommitdiff
path: root/data/zh_cn/superappnlp/2024-09-30/api-docs.php
diff options
context:
space:
mode:
Diffstat (limited to 'data/zh_cn/superappnlp/2024-09-30/api-docs.php')
-rw-r--r--data/zh_cn/superappnlp/2024-09-30/api-docs.php170
1 files changed, 32 insertions, 138 deletions
diff --git a/data/zh_cn/superappnlp/2024-09-30/api-docs.php b/data/zh_cn/superappnlp/2024-09-30/api-docs.php
index 2f4f5e5..b0a4eb5 100644
--- a/data/zh_cn/superappnlp/2024-09-30/api-docs.php
+++ b/data/zh_cn/superappnlp/2024-09-30/api-docs.php
@@ -1,13 +1,7 @@
<?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' => [],
],
@@ -18,12 +12,8 @@
.'在真实业务场景中，给定的原始文本地址可能缺失了行政区划名称信息（例如，省、市、或区名称），或可能包含了错误的行政区划名称，或地址中提到的行政区划名称信息还没有和下游行业内部的地址库对齐。'."\n"
.'地址区划标准化服务采用业界最先进的AI及多语言NLP技术，能够准确分析及理解输入的无结构化文本地址内容，并预测输出标准化、对齐后的行政区划名称信息。'."\n"
.'该服务已经用于支持物流行业客户的实际生产业务，包括AI地址分单及运费自动结算等场景需求。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -31,12 +21,7 @@
],
'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',
@@ -47,9 +32,7 @@
'description' => '幂等参数',
'type' => 'string',
'required' => false,
- 'enumValueTitles' => [
- '无' => '无',
- ],
+ 'enumValueTitles' => ['无' => '无'],
'example' => '可以不填',
],
],
@@ -60,9 +43,7 @@
'description' => '实例id',
'type' => 'string',
'required' => false,
- 'enumValueTitles' => [
- '无' => '无',
- ],
+ 'enumValueTitles' => ['无' => '无'],
'example' => '10671',
],
],
@@ -73,61 +54,34 @@
'description' => '解析地址',
'type' => 'string',
'required' => false,
- 'enumValueTitles' => [
- '无' => '无',
- ],
+ 'enumValueTitles' => ['无' => '无'],
'example' => '350 Magliman, Bacolor, Pampanga AQUA MALTA Refilling Station',
],
],
[
'name' => 'CityStr',
'in' => 'query',
- 'schema' => [
- 'description' => '市区值',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'BACOLOR ',
- ],
+ 'schema' => ['description' => '市区值', 'type' => 'string', 'required' => false, 'example' => 'BACOLOR '],
],
[
'name' => 'ProvinceStr',
'in' => 'query',
- 'schema' => [
- 'description' => '省',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'PAMPANGA ',
- ],
+ 'schema' => ['description' => '省', 'type' => 'string', 'required' => false, 'example' => 'PAMPANGA '],
],
[
'name' => 'ProvinceStdManual',
'in' => 'query',
- 'schema' => [
- 'description' => '省手动校准值',
- 'type' => 'string',
- 'required' => false,
- 'example' => '可以不填',
- ],
+ 'schema' => ['description' => '省手动校准值', 'type' => 'string', 'required' => false, 'example' => '可以不填'],
],
[
'name' => 'CityStdManual',
'in' => 'query',
- 'schema' => [
- 'description' => '市区手动校准值',
- 'type' => 'string',
- 'required' => false,
- 'example' => '可以不填',
- ],
+ 'schema' => ['description' => '市区手动校准值', 'type' => 'string', 'required' => false, 'example' => '可以不填'],
],
[
'name' => 'DistrictStdManual',
'in' => 'query',
- 'schema' => [
- 'description' => '地址手动校准值',
- 'type' => 'string',
- 'required' => false,
- 'example' => '可以不填',
- ],
+ 'schema' => ['description' => '地址手动校准值', 'type' => 'string', 'required' => false, 'example' => '可以不填'],
],
],
'responses' => [
@@ -137,101 +91,42 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '请求结果状态码',
- 'type' => 'string',
- 'example' => 'S0000',
- ],
+ 'Code' => ['description' => '请求结果状态码', 'type' => 'string', 'example' => 'S0000'],
'Data' => [
'description' => '响应结果',
'type' => 'object',
'properties' => [
- 'CityStd' => [
- 'description' => '解析后的市区',
- 'type' => 'string',
- 'example' => 'MANDALUYONG',
- ],
- 'DistrictStd' => [
- 'description' => '解析后的地址',
- 'type' => 'string',
- 'example' => 'PLEASANT HILLS',
- ],
- 'ProvinceStd' => [
- 'description' => '解析后的省',
- 'type' => 'string',
- 'example' => 'METRO-MANILA',
- ],
+ 'CityStd' => ['description' => '解析后的市区', 'type' => 'string', 'example' => 'MANDALUYONG'],
+ 'DistrictStd' => ['description' => '解析后的地址', 'type' => 'string', 'example' => 'PLEASANT HILLS'],
+ 'ProvinceStd' => ['description' => '解析后的省', 'type' => 'string', 'example' => 'METRO-MANILA'],
'Results' => [
'description' => '没有值',
'type' => 'array',
- 'items' => [
- 'description' => '没有值',
- 'type' => 'string',
- 'example' => '[]',
- ],
- ],
- 'StatusEs' => [
- 'description' => '解析状态',
- 'type' => 'string',
- 'example' => 'Code_000：OK',
+ 'items' => ['description' => '没有值', 'type' => 'string', 'example' => '[]'],
],
+ 'StatusEs' => ['description' => '解析状态', 'type' => 'string', 'example' => 'Code_000：OK'],
],
],
- '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' => [
- 'description' => '请求响应结果',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'Success' => [
- 'description' => '请求是否成功，一般用这个判断',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Timestamp' => [
- 'description' => '请求时间戳',
- 'type' => 'string',
- 'example' => '1701051540592',
- ],
+ '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' => ['description' => '请求响应结果', 'type' => 'string', 'example' => 'success'],
+ 'Success' => ['description' => '请求是否成功，一般用这个判断', 'type' => 'boolean', 'example' => 'true'],
+ 'Timestamp' => ['description' => '请求时间戳', 'type' => 'string', 'example' => '1701051540592'],
],
],
],
],
'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' => '地址解析接口'."\n"
@@ -240,9 +135,8 @@
],
],
'endpoints' => [
- [
- 'regionId' => 'ap-southeast-1',
- 'endpoint' => 'superappnlp.ap-southeast-1.aliyuncs.com',
- ],
+ ['regionId' => 'ap-southeast-1', 'regionName' => '新加坡', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'superappnlp.ap-southeast-1.aliyuncs.com', 'endpoint' => 'superappnlp.ap-southeast-1.aliyuncs.com', 'vpc' => 'superappnlp-vpc.ap-southeast-1.aliyuncs.com'],
],
+ 'errorCodes' => [],
+ 'changeSet' => [],
];
generated by cgit v1.2.3 (git 2.46.0) at 2026-07-12 21:46:24 +0000