Interpret fields

Uses AI to explain how the system will interpret your requested field names, and how confident it is in extracting each one.

POST /v1/fields/interpret

Interpret fields

cURL

curl --request POST \
  --url https://api.pointset.io/v1/fields/interpret \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "entity_type": "restaurant",
  "fields": [
    {
      "name": "menu_url",
      "description": "URL to the online menu"
    }
  ]
}
'

200

{
  "interpretations": [
    {
      "name": "<string>",
      "understood_as": "<string>",
      "confidence": "high",
      "suggestion": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

entity_type · string · required

Minimum string length: 1

Example:

"restaurant"

fields · object[] · required

Minimum array length: 1

Show child attributes

Response

200

application/json

OK

interpretations · object[] · required

Show child attributes