Choose where you’d like to start

Parse Address

Table of Contents

Description

The zoho.ai.parseAddress ask is used to split the given address into individual components, such as: road, house, city, and district.

Note: 
  • This task only supports English.
  • The prediction results may not be accurate, which is also the case with any AI prediction. However, we are working on making it better.
  • The prediction results are dynamic. The same script may produce different outcomes at different times based on how much the machine has learned.

Syntax

<response> = zoho.ai.parseAddress(<address>);

where:

ParamsData typeDescription

<response>

KEY-VALUE

Specifies the individual components of an address and the status of the executed task

<address>

TEXT / LIST

Specifies the addresses that need to be examined

Example 1

The following script analyzes the given address and divides it into individual components.

 response = zoho.ai.parseAddress("Estancia IT Park, GST Road, Vallancherry Village, Chengalpattu, Kanchipuram district, Tamil Nadu 603202");

where:

response
The KEY-VALUE response that represents the individual components of the address, and the status of the executed task. 

Here, the individual components returned are:
  • "road": "gst road vallancherry village"
  • "city": "chengalpattu"
  • "state_district": "kanchipuram district"
  • "postcode": "603202"
  • "state": "tamil nadu"
  • "house": "estancia it park"
"Estancia IT Park, GST Road, Vallancherry Village, Chengalpattu, Kanchipuram district, Tamil Nadu 603202"
The TEXT that represents the address that needs to be examined.

Example 2

The following script analyzes the list of addresses and divides it into individual components.

 address_var = List();
 address_var.add("Estancia IT Park, GST Road, Vallancherry Village, Chengalpattu, Kanchipuram district, Tamil Nadu 603202");
 address_var.add("6800 Burleson Rd Building 310, Suite 200, Austin, TX 78744, USA");
 
 response = zoho.ai.parseAddress(address_var);

where:

address_var
The LIST variable that holds the addresses that need to be examined.

Response Format

Success Response

  • The success response returned will be returned in the following format.

     {
     "data": {
     "items": [
     {
     "road": "gst road vallancherry village",
     "city": "chengalpattu",
     "state_district": "kanchipuram district",
     "postcode": "603202",
     "state": "tamil nadu",
     "house": "estancia it park"
     },
     {
     "country": "usa",
     "unit": "suite 200",
     "road": "burleson rd building",
     "city": "austin",
     "postcode": "78744",
     "house_number": "310",
     "state": "tx"
     }
     ]
     },
     "message": "OK",
     "status": 200
     }
     

    Failure Response

    • The failure response returned for an empty address value will be in the following format:

       {
       "message": "EMPTY_VALUE_NOT_ALLOWED",
       "status": 400
       }
     

    Related Links

Get Started Now

Execute