Entity linking

Use the REST API to link entity values.

Group similar entities together

post

Group entities together based on the original text

Body

application/jsontext/jsonapplication/*+json

all ofOptional

Responses

200

OK

text/plainapplication/jsontext/json

post

HTTPcURLJavaScriptPython

POST /api/Synthesis/group HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 418

{
  "entities": [
    {
      "start": 1,
      "end": 1,
      "pythonStart": 1,
      "pythonEnd": 1,
      "label": "text",
      "text": "text",
      "score": 1,
      "language": "text",
      "exampleRedaction": "text",
      "head": "text",
      "tail": "text",
      "subNerEntities": [
        {
          "start": 1,
          "end": 1,
          "pythonStart": 1,
          "pythonEnd": 1,
          "label": "text",
          "text": "text",
          "score": 1,
          "language": "text",
          "exampleRedaction": "text",
          "head": "text",
          "tail": "text",
          "subNerEntities": "[Circular Reference]"
        }
      ]
    }
  ],
  "original_text": "text"
}

application/jsontext/jsonapplication/*+json

200

OK

{
  "groups": [
    {
      "representative": "text",
      "pii_type": "NUMERIC_VALUE",
      "entities": [
        {
          "start": 1,
          "end": 1,
          "pythonStart": 1,
          "pythonEnd": 1,
          "label": "text",
          "text": "text",
          "score": 1,
          "language": "text",
          "exampleRedaction": "text",
          "head": "text",
          "tail": "text",
          "subNerEntities": [
            "[Circular Reference]"
          ]
        }
      ]
    }
  ]
}