Skip to main content
POST
/
process
/
text
/
reidentify
Reidentify Text
curl --request POST \
  --url https://api.private-ai.com/community/process/text/reidentify \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "processed_text": [
    "<string>"
  ],
  "entities": [
    {
      "processed_text": "<string>",
      "text": "<string>"
    }
  ],
  "model": "<string>",
  "reidentify_sensitive_fields": true,
  "project_id": "main"
}
'
[
  "<string>"
]

Authorizations

​
x-api-key
string
header
required

Body

application/json
​
processed_text
string[]
required

The text with redaction markers. The markers will be replaced with the entity texts. E.g. Hi [NAME_1], nice to meet you.

​
entities
ReidentifyTextRequestEntity · object[]
required

A list of all entities found in the text.

​
model
string

The LLM that provides the completions. E.g. gpt3.5-turbo. Whilst optional, this is used to improve the re-identification process by accounting for the model's unique behaviour surrounding redaction markers

​
reidentify_sensitive_fields
boolean
default:true

When this parameter is set to False, the re-identifier will mask fields ['BANK_ACCOUNT', 'CREDIT_CARD', 'CREDIT_CARD_EXPIRATION', 'CVV', 'ROUTING_NUMBER', 'ACCOUNT_NUMBER', 'DRIVER_LICENSE', 'HEALTHCARE_NUMBER', 'PASSPORT_NUMBER', 'PASSWORD', 'SSN', 'VEHICLE_ID'] with '#' instead of re-identifying them. The last quarter of CREDIT_CARD will be re-identified. When the parameter is set to True, all fields will be re-identified.

​
project_id
string
default:main

Used to categorize requests for reporting purposes. Limited to alphanumeric characters or the following special characters :_-

Maximum string length: 60
Pattern: ^[a-zA-Z0-9\-_\:]*$

Response

Successful Response