summaryrefslogtreecommitdiff
path: root/data/en_us/superappnlp/2024-09-30/api-docs.php
blob: 93ab5b4f4f35c26c80bcd176ae4a30296eeb7eca (plain)
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
<?php return [
    'version' => '1.0',
    'info' => ['style' => 'RPC', 'product' => 'SuperappNlp', 'version' => '2024-09-30'],
    'directories' => ['NlpAddressNormalization'],
    'components' => [
        'schemas' => [],
    ],
    'apis' => [
        'NlpAddressNormalization' => [
            'summary' => 'AI address administrative division normalization service'."\n"
                ."\n"
                .'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' => [],
                ],
            ],
            'operationType' => 'read',
            'deprecated' => false,
            'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'],
            'parameters' => [
                [
                    'name' => 'ClientToken',
                    'in' => 'query',
                    'allowEmptyValue' => false,
                    'schema' => [
                        'title' => '',
                        'description' => 'The idempotency parameter.',
                        'enumValueTitles' => ['无' => 'None.'],
                        'type' => 'string',
                        'required' => false,
                        'example' => '可以不填',
                    ],
                ],
                [
                    'name' => 'InstanceId',
                    'in' => 'query',
                    'schema' => [
                        'description' => 'The instance ID.',
                        'enumValueTitles' => ['无' => 'None.'],
                        'type' => 'string',
                        'required' => false,
                        'example' => '10671',
                        'title' => '',
                    ],
                ],
                [
                    'name' => 'QueryStr',
                    'in' => 'query',
                    'schema' => [
                        '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' => 'The city value.', 'type' => 'string', 'required' => false, 'example' => 'BACOLOR	', 'title' => ''],
                ],
                [
                    'name' => 'ProvinceStr',
                    'in' => 'query',
                    'schema' => ['description' => 'The province.', 'type' => 'string', 'required' => false, 'example' => 'PAMPANGA	', 'title' => ''],
                ],
                [
                    'name' => 'ProvinceStdManual',
                    'in' => 'query',
                    'schema' => ['description' => 'The manually calibrated value for the province.', 'type' => 'string', 'required' => false, 'example' => '可以不填', 'title' => ''],
                ],
                [
                    'name' => 'CityStdManual',
                    'in' => 'query',
                    'schema' => ['description' => 'The manually calibrated value for the city.', 'type' => 'string', 'required' => false, 'example' => '可以不填', 'title' => ''],
                ],
                [
                    'name' => 'DistrictStdManual',
                    'in' => 'query',
                    'schema' => ['description' => 'The manually calibrated value for the district.', 'type' => 'string', 'required' => false, 'example' => '可以不填', 'title' => ''],
                ],
            ],
            'responses' => [
                200 => [
                    'schema' => [
                        'title' => '',
                        'description' => 'Schema of Response',
                        'type' => 'object',
                        'properties' => [
                            'Code' => ['description' => 'The status code of the request.', 'type' => 'string', 'example' => 'S0000', 'title' => ''],
                            'Data' => [
                                'description' => 'The response data.',
                                'type' => 'object',
                                'properties' => [
                                    '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' => ['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' => '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.', '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.', 'description' => ''],
                ],
            ],
            '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', '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' => [],
];