PII SDK Reference

PII

Detect PII

Reports whether the supplied text contains personally identifiable information, optionally with a per-type entity breakdown.

from orq_ai_sdk import Orq
import os

with Orq(
    api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:

    res = orq.pii.detect()

    # Handle response
    print(res)

import { Orq } from "@orq-ai/node";

const orq = new Orq({
  apiKey: process.env["ORQ_API_KEY"] ?? "",
});

async function run() {
  const result = await orq.pii.detect({});

  console.log(result);
}

run();

Show Parameters

{
    "text": Optional[str],
    "language": Optional[str],
    "threshold": Optional[float],
    "include_entities": Optional[bool],
}

{
  text?: string;
  language?: string;
  threshold?: number;
  includeEntities?: boolean;
}

Show Response

{
    "has_pii": Optional[bool],
    "entities": Dict[str, int],  # optional
}

{
  hasPii?: boolean;
  entities?: Record<string, number>;
}

Redact PII

Replaces detected PII with placeholders and returns the reverse mapping needed to restore the original text.

from orq_ai_sdk import Orq
import os

with Orq(
    api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:

    res = orq.pii.redact()

    # Handle response
    print(res)

import { Orq } from "@orq-ai/node";

const orq = new Orq({
  apiKey: process.env["ORQ_API_KEY"] ?? "",
});

async function run() {
  const result = await orq.pii.redact({});

  console.log(result);
}

run();

Show Parameters

{
    "text": Optional[str],
    "language": Optional[str],
    "threshold": Optional[float],
}

{
  text?: string;
  language?: string;
  threshold?: number;
}

Show Response

{
    "redacted_text": Optional[str],
    "mappings": Dict[str, str],  # optional
}

{
  redactedText?: string;
  mappings?: Record<string, string>;
}

Restore PII

Reverses a redaction, substituting placeholders back to their original values using the mapping returned by Redact.

from orq_ai_sdk import Orq
import os

with Orq(
    api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:

    res = orq.pii.restore()

    # Handle response
    print(res)

import { Orq } from "@orq-ai/node";

const orq = new Orq({
  apiKey: process.env["ORQ_API_KEY"] ?? "",
});

async function run() {
  const result = await orq.pii.restore({});

  console.log(result);
}

run();

Show Parameters

{
    "redacted_text": Optional[str],
    "mappings": Dict[str, str],  # optional
}

{
  redactedText?: string;
  mappings?: Record<string, string>;
}

Show Response

{
    "original_text": Optional[str],
}

{
  originalText?: string;
}

⌘I

Orq SDK

Terminal & Agents

Terraform

Platform APIs

Management APIs

PII

Detect PII

Redact PII

Restore PII

​PII

​Detect PII

​Redact PII

​Restore PII

PII

Detect PII

Redact PII

Restore PII