PHphilterd
Explain

Redact text and explain the redactions.

Changed on

Redacts the plain-text request body using the given policy and context, returning the filtered text together with an explanation of every span that was redacted (type, position, and applied filter). Use the c query parameter to select a context and p to select a policy. When output signing is enabled in Admin Settings, the response includes an X-Philter-Signature header containing an ES256 JWT that binds the SHA-256 hash of the response body, the applied policy name and version, a per-response UUID, and an issue timestamp. Verify the signature using the public key from GET /api/signing-key. Pass sign=true to request a signature when the deployment has not enabled signing. The admin setting is a floor: with it on every response is signed and sign=false does not change that. Requires the redact scope.

post/api/explain

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/explain
  • Auth
    HTTP bearer

Query parameters

cstring
pstring
filenamestring
signboolean

Headers

Authorizationstring required

Request body text/plain

string required

Response

Full text filter result with governing policy metadata.

contextstring
filteredTextstring
pieceinteger
policyContentHashstring
policyNamestring
policyVersioninteger
tokensinteger

Example response

{
  "explanation": {
    "appliedSpans": [
      {
        "filterType": "SSN"
      }
    ],
    "identifiedSpans": [
      {
        "filterType": "SSN"
      }
    ]
  }
}

Changes

  • fddc8a37e181Revision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • c4f85daa9208Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status