Chilkat Online Tools

Unicode C++ / ShipEngine Walkthrough / Confidence scores

Back to Collection Items

void ChilkatSample(void)
    {
    json.UpdateString(L"text",L"I need to send a package to my friend Amanda. Her last name is Miller, btw. Her office address is 525 Winchester Blvd. That's in California for sure. Pretty sure it's San Jose, but I'm only like 90% sure about that. Pretty sure the zip code is something like 95128, or maybe 90210.");    resp->GetBodySb(sbResponseBody);    jResp.LoadSb(sbResponseBody);    jResp.put_EmitCompact(false);    jResp.put_I(i);    v_type = jResp.stringOf(L"entities[i].type");    score = jResp.stringOf(L"entities[i].score");    text = jResp.stringOf(L"entities[i].text");    start_index = jResp.IntOf(L"entities[i].start_index");    end_index = jResp.IntOf(L"entities[i].end_index");    Value = jResp.stringOf(L"entities[i].result.value");    Line = jResp.IntOf(L"entities[i].result.line");    v_Type = jResp.stringOf(L"entities[i].result.type");    i = i + 1;
    }

Curl Command

curl -X POST
	-H "API-Key: {{API_KEY}}"
	-H "Content-Type: application/json"
	-d '{
	"text": "I need to send a package to my friend Amanda. Her last name is Miller, btw. Her office address is 525 Winchester Blvd. That\'s in California for sure. Pretty sure it\'s San Jose, but I\'m only like 90% sure about that. Pretty sure the zip code is something like 95128, or maybe 90210."
}'
https://api.shipengine.com/v1/addresses/recognize

Postman Collection Item JSON

{
  "name": "Confidence scores",
  "event": [
    {
      "listen": "test",
      "script": {
        "exec": [
          ""
        ],
        "type": "text/javascript"
      }
    }
  ],
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "name": "Content-Type",
        "type": "text",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n\t\"text\": \"I need to send a package to my friend Amanda. Her last name is Miller, btw. Her office address is 525 Winchester Blvd. That's in California for sure. Pretty sure it's San Jose, but I'm only like 90% sure about that. Pretty sure the zip code is something like 95128, or maybe 90210.\"\n}"
    },
    "url": {
      "raw": "https://api.shipengine.com/v1/addresses/recognize",
      "protocol": "https",
      "host": [
        "api",
        "shipengine",
        "com"
      ],
      "path": [
        "v1",
        "addresses",
        "recognize"
      ]
    },
    "description": "ShipEngine's Parse Address API returns confidence scores for each entity that it recognizes, as well as for the address as a whole.  You can use these scores to determine whether the address is safe to use or requires additional validation or information from the user."
  },
  "response": [
    {
      "name": "Confidence scores",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "name": "Content-Type",
            "type": "text",
            "value": "application/json"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n\t\"text\": \"I need to send a package to my friend Amanda. Her last name is Miller, btw. Her office address is 525 Winchester Blvd. That's in California for sure. Pretty sure it's San Jose, but I'm only like 90% sure about that. Pretty sure the zip code is something like 95128, or maybe 90210.\"\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "https://api.shipengine.com/v1/addresses/recognize",
          "protocol": "https",
          "host": [
            "api",
            "shipengine",
            "com"
          ],
          "path": [
            "v1",
            "addresses",
            "recognize"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Wed, 18 Sep 2019 16:18:21 GMT"
        },
        {
          "key": "Content-Type",
          "value": "application/json; charset=utf-8"
        },
        {
          "key": "Transfer-Encoding",
          "value": "chunked"
        },
        {
          "key": "Connection",
          "value": "keep-alive"
        },
        {
          "key": "Access-Control-Allow-Origin",
          "value": "https://www.shipengine.com"
        },
        {
          "key": "Vary",
          "value": "Origin"
        },
        {
          "key": "content-encoding",
          "value": "gzip"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"score\": 0.7503696513496741,\n    \"address\": {\n        \"address_line1\": \"525 Winchester Blvd\",\n        \"city_locality\": \"Miller\",\n        \"postal_code\": \"90210\",\n        \"address_residential_indicator\": \"no\"\n    },\n    \"entities\": [\n        {\n            \"type\": \"city_locality\",\n            \"score\": 0.4792571878834418,\n            \"text\": \"Miller\",\n            \"start_index\": 63,\n            \"end_index\": 68,\n            \"result\": {\n                \"value\": \"Miller\"\n            }\n        },\n        {\n            \"type\": \"residential_indicator\",\n            \"score\": 0.9519646137063122,\n            \"text\": \"office\",\n            \"start_index\": 80,\n            \"end_index\": 85,\n            \"result\": {\n                \"value\": \"no\"\n            }\n        },\n        {\n            \"type\": \"address_line\",\n            \"score\": 0.6082904353940255,\n            \"text\": \"525 Winchester Blvd\",\n            \"start_index\": 98,\n            \"end_index\": 116,\n            \"result\": {\n                \"line\": 1,\n                \"value\": \"525 Winchester Blvd\"\n            }\n        },\n        {\n            \"type\": \"number\",\n            \"score\": 0.9805313966503588,\n            \"text\": \"525\",\n            \"start_index\": 98,\n            \"end_index\": 100,\n            \"result\": {\n                \"type\": \"cardinal\",\n                \"value\": 525\n            }\n        },\n        {\n            \"type\": \"city_locality\",\n            \"score\": 0.4792571878834418,\n            \"text\": \"San Jose\",\n            \"start_index\": 167,\n            \"end_index\": 174,\n            \"result\": {\n                \"value\": \"San Jose\"\n            }\n        },\n        {\n            \"type\": \"number\",\n            \"score\": 0.9805313966503588,\n            \"text\": \"90%\",\n            \"start_index\": 195,\n            \"end_index\": 197,\n            \"result\": {\n                \"type\": \"percentage\",\n                \"value\": 0.9\n            }\n        },\n        {\n            \"type\": \"number\",\n            \"score\": 0.9805313966503588,\n            \"text\": \"95128\",\n            \"start_index\": 259,\n            \"end_index\": 263,\n            \"result\": {\n                \"type\": \"cardinal\",\n                \"value\": 95128\n            }\n        },\n        {\n            \"type\": \"postal_code\",\n            \"score\": 0.9519646137063122,\n            \"text\": \"90210\",\n            \"start_index\": 275,\n            \"end_index\": 279,\n            \"result\": {\n                \"value\": \"90210\"\n            }\n        }\n    ]\n}"
    }
  ]
}