POI prediction

Updated at:

Predicts a Point of Interest (POI) name from address information, such as administrative regions, street names, and street numbers.

Test

You can run an API test in the Address Purification console.

Request parameters

Name

Type

Required

Example value

Description

Action

String

Yes

PredictPOI

A required parameter.

Set the value to PredictPOI.

AppKey

String

Yes

Axqwerasdf1a

The AppKey of your project.

ServiceCode

String

Yes

addrp

Static field: addrp

Text

String

Yes

No. 969, Wenyi West Road

The text 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 value

Description

Data

String

{"poi_predict":"Alibaba Xixi Park;Xixi Park;Alibaba;Taobao City;Alibaba Group;Alibaba Xixi Qin Cheng Li","status":"OK","time_used":{"rt":{"div_search":0.000037670135498046875,"segment":0.00001239776611328125,"geocode":0.0001304149627685547,"address_correct":0.0041658878326416016,"complete":0.00006031990051269531,"poi_predict":0.009544134140014648,"address_search":0.07369542121887207,"structure":0.005392313003540039},"start":1619321042.0037758}}

  • poi_predict: The POI prediction result.

  • time_used: The time consumed by the algorithm.

  • status: The status.

RequestId

String

E0627DDE-28D7-4C00-A611-E047DF81AF05

The ID of the request.

Examples

Request example

http(s)://[Endpoint]/?Action=PredictPOI
&AppKey=Axqwerasdf1a
&ServiceCode=addrp
&Text=No. 969, Wenyi West Road
&<Common request parameters>

Successful response example

XML format

 <RequestId>E064C7AC-AAD9-49A2-BE2B-CAF0E227DC44</RequestId>
 <Data>
  <poi_predict>Alibaba Xixi Park;Xixi Park;Alibaba;Taobao City;Alibaba Group;Alibaba Xixi Qin Cheng Li</poi_predict>
  <status>OK</status>
  <time_used>
   <rt>
    <div_search>0.000037670135498046875</div_search>
    <segment>0.00001239776611328125</segment>
    <geocode>0.0001304149627685547</geocode>
    <address_correct>0.0041658878326416016</address_correct>
    <complete>0.00006031990051269531</complete>
    <poi_predict>0.009544134140014648</poi_predict>
    <address_search>0.07369542121887207</address_search>
    <structure>0.005392313003540039</structure>
   </rt>
   <start>1619321042.0037758</start>
  </time_used>
 </Data>

JSON format

{
    "RequestId": "E064C7AC-AAD9-49A2-BE2B-CAF0E227DC44",
    "Data": {
        "poi_predict": "Alibaba Xixi Park;Xixi Park;Alibaba;Taobao City;Alibaba Group;Alibaba Xixi Qin Cheng Li",
        "status": "OK",
        "time_used": {
            "rt": {
                "div_search": 0.000037670135498046875,
                "segment": 0.00001239776611328125,
                "geocode": 0.0001304149627685547,
                "address_correct": 0.0041658878326416016,
                "complete": 0.00006031990051269531,
                "poi_predict": 0.009544134140014648,
                "address_search": 0.07369542121887207,
                "structure": 0.005392313003540039
            },
            "start": 1619321042.0037758
        }
    }
}

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 error codes, see the Error Center.