SDK Reference
PII SDK Reference
SDK reference for the PII API, available in Node.js and Python.
Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Orq MCP is live: Use natural language to interrogate traces, spot regressions, and experiment your way to optimal AI configurations. Available in Claude Desktop, Claude Code, Cursor, and more. Start now →
SDK reference for the PII API, available in Node.js and Python.
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],
}
{
hasPii?: boolean;
entities?: Record<string, number>;
}
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],
}
{
redactedText?: string;
mappings?: Record<string, string>;
}
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],
}
{
redactedText?: string;
mappings?: Record<string, string>;
}
Show Response
{
"original_text": Optional[str],
}
{
originalText?: string;
}
Was this page helpful?