Reidentify Text
curl --request POST \
--url https://api.private-ai.com/deid/v3/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>"
}
'import requests
url = "https://api.private-ai.com/deid/v3/process/text/reidentify"
payload = {
"processed_text": ["<string>"],
"entities": [
{
"processed_text": "<string>",
"text": "<string>"
}
],
"model": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
processed_text: ['<string>'],
entities: [{processed_text: '<string>', text: '<string>'}],
model: '<string>'
})
};
fetch('https://api.private-ai.com/deid/v3/process/text/reidentify', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.private-ai.com/deid/v3/process/text/reidentify",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'processed_text' => [
'<string>'
],
'entities' => [
[
'processed_text' => '<string>',
'text' => '<string>'
]
],
'model' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.private-ai.com/deid/v3/process/text/reidentify"
payload := strings.NewReader("{\n \"processed_text\": [\n \"<string>\"\n ],\n \"entities\": [\n {\n \"processed_text\": \"<string>\",\n \"text\": \"<string>\"\n }\n ],\n \"model\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.private-ai.com/deid/v3/process/text/reidentify")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"processed_text\": [\n \"<string>\"\n ],\n \"entities\": [\n {\n \"processed_text\": \"<string>\",\n \"text\": \"<string>\"\n }\n ],\n \"model\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.private-ai.com/deid/v3/process/text/reidentify")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"processed_text\": [\n \"<string>\"\n ],\n \"entities\": [\n {\n \"processed_text\": \"<string>\",\n \"text\": \"<string>\"\n }\n ],\n \"model\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body[
"<string>"
]{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}API Reference
Reidentify Text
This route is intended to improve integrations with LLMs such as ChatGPT. Entities that are removed prior to sending to the LLM can be re-injected into the response from the LLM to improve user experience.
POST
/
v3
/
process
/
text
/
reidentify
Reidentify Text
curl --request POST \
--url https://api.private-ai.com/deid/v3/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>"
}
'import requests
url = "https://api.private-ai.com/deid/v3/process/text/reidentify"
payload = {
"processed_text": ["<string>"],
"entities": [
{
"processed_text": "<string>",
"text": "<string>"
}
],
"model": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
processed_text: ['<string>'],
entities: [{processed_text: '<string>', text: '<string>'}],
model: '<string>'
})
};
fetch('https://api.private-ai.com/deid/v3/process/text/reidentify', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.private-ai.com/deid/v3/process/text/reidentify",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'processed_text' => [
'<string>'
],
'entities' => [
[
'processed_text' => '<string>',
'text' => '<string>'
]
],
'model' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.private-ai.com/deid/v3/process/text/reidentify"
payload := strings.NewReader("{\n \"processed_text\": [\n \"<string>\"\n ],\n \"entities\": [\n {\n \"processed_text\": \"<string>\",\n \"text\": \"<string>\"\n }\n ],\n \"model\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.private-ai.com/deid/v3/process/text/reidentify")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"processed_text\": [\n \"<string>\"\n ],\n \"entities\": [\n {\n \"processed_text\": \"<string>\",\n \"text\": \"<string>\"\n }\n ],\n \"model\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.private-ai.com/deid/v3/process/text/reidentify")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"processed_text\": [\n \"<string>\"\n ],\n \"entities\": [\n {\n \"processed_text\": \"<string>\",\n \"text\": \"<string>\"\n }\n ],\n \"model\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body[
"<string>"
]{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}Authorizations
Headers
Body
application/json
The text with redaction markers. The markers will be replaced with the entity texts. E.g. Hi [NAME_1], nice to meet you.
A list of all entities found in the text.
Show child attributes
Show child attributes
The LLM that provides the completions. E.g. gpt3.5-turbo. While optional, this is used to improve the re-identification process by accounting for the model's unique behaviour surrounding redaction markers
Response
Successful Response
⌘I