Orq.ai · Schema

PII redaction plugin

Artificial IntelligencePlatformEnterpriseGovernanceSoftwareFactory

Properties

Name Type Description
id string PII redaction plugin.
language string Detector language. Accepts "auto" to detect the language per request; GET /v2/pii/capabilities lists the concrete languages and does not include "auto". Omitting the field defaults to "auto".
regions array Region codes selecting whole regions of coverage (e.g. "nl", "gb"). Every entity type those regions cover is redacted, alongside the base catalog. ["all"] is exclusive, and leaving both this and entit
entities array The entity types to redact. A named type is redacted even when it belongs to a region, so a region's types can be selected individually without naming the region. On its own this is a strict allowlist
entity_thresholds object Per-entity confidence cutoff overrides in [0,1]. Tunes confidence only and never changes which types are redacted, so every key must also appear in entities.
threshold number Baseline confidence cutoff applied to every entity type without a per-entity override.
on_failure string Behaviour when detection fails.
View JSON Schema on GitHub

JSON Schema

orq-piiredaction-plugin-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/orq/json-schema/orq-piiredaction-plugin-schema.json",
  "title": "PII redaction plugin",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/orq-completions-api-openapi.yml#/components/schemas/PIIRedactionPlugin",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "enum": [
        "pii_redaction"
      ],
      "description": "PII redaction plugin."
    },
    "language": {
      "type": "string",
      "description": "Detector language. Accepts \"auto\" to detect the language per request; GET /v2/pii/capabilities lists the concrete languages and does not include \"auto\". Omitting the field defaults to \"auto\"."
    },
    "regions": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Region codes selecting whole regions of coverage (e.g. \"nl\", \"gb\"). Every entity type those regions cover is redacted, alongside the base catalog. [\"all\"] is exclusive, and leaving both this and entities empty also runs every region, so selecting nothing is the widest request rather than the narrowest. Combines with entities: the two selections are unioned, so entities adds types on top of the region coverage."
    },
    "entities": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The entity types to redact. A named type is redacted even when it belongs to a region, so a region's types can be selected individually without naming the region. On its own this is a strict allowlist; alongside regions it adds to the region coverage. See GET /v2/pii/capabilities for valid types."
    },
    "entity_thresholds": {
      "type": "object",
      "additionalProperties": {
        "type": "number",
        "minimum": 0,
        "maximum": 1
      },
      "description": "Per-entity confidence cutoff overrides in [0,1]. Tunes confidence only and never changes which types are redacted, so every key must also appear in entities."
    },
    "threshold": {
      "type": "number",
      "minimum": 0,
      "maximum": 1,
      "description": "Baseline confidence cutoff applied to every entity type without a per-entity override."
    },
    "on_failure": {
      "type": "string",
      "enum": [
        "block",
        "passthrough"
      ],
      "description": "Behaviour when detection fails."
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/orq-piiredaction-plugin"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.