Skip to main content
POST
/
v3
/
process
/
text
curl --request POST \ --url https://api.private-ai.com/deid/v3/process/text \ --header 'Content-Type: application/json' \ --header 'x-api-key: <api-key>' \ --data ' { "text": [ "Hello John and Jane" ], "link_batch": false, "entity_detection": { "accuracy": "high", "return_entity": true }, "processed_text": { "type": "MARKER", "pattern": "[UNIQUE_NUMBERED_ENTITY_TYPE]" } } '
[
  {
    "processed_text": "<string>",
    "entities": [
      {
        "processed_text": "<string>",
        "text": "<string>",
        "best_label": "<string>",
        "labels": {},
        "location": "Location object containing the start-end character indexes of given and processed text."
      }
    ],
    "entities_present": true,
    "characters_processed": 123
  }
]

Authorizations

​
x-api-key
string
header
required

Headers

​
x-api-key
string
default:""

Body

application/json

API 3.0 Spec Definition

​
text
string[]
required

UTF-8 encoded message(s) to process. E.g. ["My name is Adam"] or ["I live at", "263 Spadina Av"]. Request processing time increases linearly with input text length, therefore maximum length is dependent on provisioned hardware and any timeouts set by the user. Private AI has tested up to 500K characters on the CPU and GPU containers.

​
link_batch
boolean
default:false

When set to True, the list of inputs provided in text will be processed together as a single input by the Private AI PII detection model. This shares context between the different inputs and is useful when processing a sequence of short inputs, such as an SMS chat log. This option should only be enabled when the inputs are related, otherwise PII detection performance could be degraded.

​
entity_detection
Entity Detection · object

This section contains a set of parameters to control the PII detection process. All fields have sensible default that can be changed for specific needs.

​
processed_text
MarkerRedactedText · object

This section allows the user to generate redacted (default), synthetic or masked text.

Response

Successful Response

​
processed_text
string
required

The redacted, synthetic or masked text.

​
entities
EntityItem · object[]
required

A list of all entities found in the text.

​
entities_present
boolean
required

Returns True if the list of detected entities is not empty.

​
characters_processed
integer
required

The number of characters in all the text inputs.