Sign in

v28

latestOpenAPI 3.0.0MITraw.githubusercontent.com2026-06-2881825.3 KB
Analyzer

Analyze Text

Recognizes PII entities in a given text and returns their types, locations and score

post/analyze

Request body

languagestring required

Two characters for the desired language in ISO_639-1 format

correlation_idstring

A correlation id to append to headers and traces

score_thresholdnumber double

The minimal detection score threshold

entitiesEntityTypes[]

A list of entities to analyze

return_decision_processboolean

Whether to include analysis explanation in the response

contextstring[]

list of context words which may help to raise recognized entities confidence

Example request

{
  "language": "en",
  "entities": [
    "PERSON"
  ],
  "context": [
    "address"
  ]
}

Response

OK

OR

Example response

[
  {
    "start": 24,
    "end": 32,
    "score": 0.8,
    "entity_type": "PERSON"
  }
]
All 8 operations