Address type detection
This service predicts Point of Interest (POI) information for address fragments that you enter and classifies the POI into a three-level categorization system.
Test
You can perform API testing in the Address Purification console.
Request parameters
Name | Type | Required | Example | Description |
Action | String | Yes | ClassifyPOI | A required parameter. The value is `ClassifyPOI`. |
AppKey | String | Yes | xxxxx | The AppKey of the project. |
ServiceCode | String | Yes | addrp | A static field. The value is `addrp`. |
Text | String | Yes | No. 969, Wenyi West Road | The address content. |
DefaultProvince | String | No | Zhejiang Province | The default province. |
DefaultCity | String | No | Hangzhou City | The default city. |
DefaultDistrict | String | No | Yuhang District | The default administrative region. |
Response data
Name | Type | Example | Description |
Data | String | {"poi_category":"Commercial and residential#Industrial park#Industrial park", "status":"OK","time_used":{"rt":{ "basic_chunking":0.006899595260620117, "div_search":0.0002086162567138672, "segment":0.000017642974853515625, "geocode":0.00011658668518066406, "poi_category":0.3007323741912842, "address_correct":0.0022134780883789062, "complete":0.00004506111145019531, "poi_predict":0.005274772644042969, "address_search":0.23588252067565918, "structure":0.00008559226989746094},"start":1648020067.3567178}} | `poi_category`: The result of the address type detection. `time_used`: The time consumed by the algorithm. `status`: The status. |
RequestId | String | 8BFCC285-0D58-4107-B744-1CE7D3BAF79E | RequestId |
Examples
Request parameters
http(s)://[Endpoint]/?Action=ClassifyPOI
&AppKey=Axqwerasdf1a
&ServiceCode=addrp
&Text=No. 969, Wenyi West Road, Hangzhou City
&<Common request parameters>Successful response example
XML format
<?xml version="1.0" encoding="UTF-8" ?>
<RequestId>67063FCF-5C4E-5F96-ADE3-7E02522A6E86</RequestId>
<Data>
<poi_category>Commercial and residential#Industrial park#Industrial park</poi_category>
<status>OK</status>
<time_used>
<rt>
<basic_chunking>0.006899595260620117</basic_chunking>
<div_search>0.0002086162567138672</div_search>
<segment>0.000017642974853515625</segment>
<geocode>0.00011658668518066406</geocode>
<poi_category>0.3007323741912842</poi_category>
<address_correct>0.0022134780883789062</address_correct>
<complete>0.00004506111145019531</complete>
<poi_predict>0.005274772644042969</poi_predict>
<address_search>0.23588252067565918</address_search>
<structure>0.00008559226989746094</structure>
</rt>
<start>1648020067.3567178</start>
</time_used>
</Data>JSON format
{
"RequestId":"67063FCF-5C4E-5F96-ADE3-7E02522A6E86",
"Data":{
"poi_category":"Commercial and residential#Industrial park#Industrial park",
"status":"OK",
"time_used":{
"rt":{
"basic_chunking":0.006899595260620117,
"div_search":0.0002086162567138672,
"segment":0.000017642974853515625,
"geocode":0.00011658668518066406,
"poi_category":0.3007323741912842,
"address_correct":0.0022134780883789062,
"complete":0.00004506111145019531,
"poi_predict":0.005274772644042969,
"address_search":0.23588252067565918,
"structure":0.00008559226989746094
},
"start":1648020067.3567178
}
}
}Error codes
HttpCode | Error code | Error message | Description |
403 | Forbidden.NoAuth | Failed to perform user authentication. | User authentication failed. |
500 | InternalError | A service error occurred. | An internal service error occurred. |
400 | InvalidParameter | The parameter is invalid. | The parameter is invalid. |
404 | ResourceDoesNotExist | The resource does not exist. | The resource does not exist. |
429 | Throttling.User | Flow control has been triggered. | Throttling was triggered. |
400 | UserStatusInvalid | The user status is invalid. | The user status is invalid. |
For more information about error codes, see the Error Center.