data/en_us/superappnlp/2024-09-30/api-docs.php


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

<?php return [
    'version' => '1.0',
    'info' => [
        'style' => 'RPC',
        'product' => 'SuperappNlp',
        'version' => '2024-09-30',
    ],
    'directories' => [
        'NlpAddressNormalization',
    ],
    'components' => [
        'schemas' => [],
    ],
    'apis' => [
        'NlpAddressNormalization' => [
            'summary' => 'AI 地址区划标准化服务'."\n"
                ."\n"
                .'在真实业务场景中，给定的原始文本地址可能缺失了行政区划名称信息（例如，省、市、或区名称），或可能包含了错误的行政区划名称，或地址中提到的行政区划名称信息还没有和下游行业内部的地址库对齐。'."\n"
                .'地址区划标准化服务采用业界最先进的AI及多语言NLP技术，能够准确分析及理解输入的无结构化文本地址内容，并预测输出标准化、对齐后的行政区划名称信息。'."\n"
                .'该服务已经用于支持物流行业客户的实际生产业务，包括AI地址分单及运费自动结算等场景需求。',
            'methods' => [
                'post',
            ],
            'schemes' => [
                'https',
            ],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'operationType' => 'read',
            'deprecated' => false,
            'systemTags' => [
                'operationType' => 'none',
                'riskType' => 'none',
                'chargeType' => 'free',
                'tenantRelevance' => 'tenant',
            ],
            'parameters' => [
                [
                    'name' => 'ClientToken',
                    'in' => 'query',
                    'allowEmptyValue' => false,
                    'schema' => [
                        'title' => '幂等参数',
                        'description' => '',
                        'type' => 'string',
                        'required' => false,
                        'example' => '',
                    ],
                ],
                [
                    'name' => 'InstanceId',
                    'in' => 'query',
                    'schema' => [
                        'description' => '',
                        'type' => 'string',
                        'required' => false,
                        'example' => '10671',
                    ],
                ],
                [
                    'name' => 'QueryStr',
                    'in' => 'query',
                    'schema' => [
                        'description' => '',
                        'type' => 'string',
                        'required' => false,
                        'example' => '350 Magliman, Bacolor, Pampanga AQUA MALTA Refilling Station',
                    ],
                ],
                [
                    'name' => 'CityStr',
                    'in' => 'query',
                    'schema' => [
                        'description' => '',
                        'type' => 'string',
                        'required' => false,
                        'example' => 'BACOLOR	',
                    ],
                ],
                [
                    'name' => 'ProvinceStr',
                    'in' => 'query',
                    'schema' => [
                        'description' => '',
                        'type' => 'string',
                        'required' => false,
                        'example' => 'PAMPANGA	',
                    ],
                ],
                [
                    'name' => 'ProvinceStdManual',
                    'in' => 'query',
                    'schema' => [
                        'description' => '',
                        'type' => 'string',
                        'required' => false,
                    ],
                ],
                [
                    'name' => 'CityStdManual',
                    'in' => 'query',
                    'schema' => [
                        'description' => '',
                        'type' => 'string',
                        'required' => false,
                    ],
                ],
                [
                    'name' => 'DistrictStdManual',
                    'in' => 'query',
                    'schema' => [
                        'description' => '',
                        'type' => 'string',
                        'required' => false,
                    ],
                ],
            ],
            'responses' => [
                200 => [
                    'schema' => [
                        'title' => 'Schema of Response',
                        'description' => 'Schema of Response',
                        'type' => 'object',
                        'properties' => [
                            'Code' => [
                                'description' => '',
                                'type' => 'string',
                            ],
                            'Data' => [
                                'description' => '',
                                'type' => 'object',
                                'properties' => [
                                    'CityStd' => [
                                        'description' => '',
                                        'type' => 'string',
                                    ],
                                    'DistrictStd' => [
                                        'description' => '',
                                        'type' => 'string',
                                    ],
                                    'ProvinceStd' => [
                                        'description' => '',
                                        'type' => 'string',
                                    ],
                                    'Results' => [
                                        'type' => 'array',
                                        'items' => [
                                            'type' => 'string',
                                        ],
                                    ],
                                    'StatusEs' => [
                                        'description' => '',
                                        'type' => 'string',
                                    ],
                                ],
                            ],
                            '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',
                            ],
                        ],
                    ],
                ],
            ],
            'errorCodes' => [
                200 => [
                    [
                        'errorCode' => 'InstanceDoesNotExist',
                        'errorMessage' => 'Instance does not exist.',
                    ],
                    [
                        'errorCode' => 'InstanceCanNotUsed',
                        'errorMessage' => 'Instance can not used.',
                    ],
                    [
                        'errorCode' => 'NlpParseException',
                        'errorMessage' => 'Nlp parse exception.',
                    ],
                ],
                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.',
                    ],
                ],
            ],
            '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',
        ],
    ],
    'endpoints' => [
        [
            'regionId' => 'ap-southeast-1',
            'endpoint' => 'superappnlp.ap-southeast-1.aliyuncs.com',
        ],
    ],
];