Skip to content

Batches

Batches live at /batches. The page shows every batch you have access to, sorted by date created (newest first by default). The Name, Created, and Documents columns are click-to-sort headers — click again to flip direction. Additional columns include Queued (count of non-terminal documents) and a Review link/badge that opens the first reviewable document in the batch.

Create a batch (admin only)

Click the Create Batch button at the top of the page to open the batch creation dialog. Fill in:

Field Default Notes
Name Required
Group Required; only existing groups appear in the dropdown
Philter instance default Pick the Philter that redacts this batch's documents
Policy A policy name that exists on the chosen Philter instance
Batch Finalization Policy Required; governs document retention when the batch is finalized
Compliance Profile Required; cannot be changed after the batch is created
Exemption Code checked When checked (the default), accepting a redaction in this batch prompts the reviewer to pick an exemption code from the chosen compliance profile. Uncheck to suppress the prompt even when the profile defines codes — useful for batches where exemption-code tracking isn't required.
Blind Double Review unchecked When checked, a random sample of incoming documents is selected for an independent second review by a different reviewer. Default sample is 10%; the percentage field accepts an integer 1–100. Both the on/off flag and the percentage are write-once — they cannot be changed after the batch is created. See Blind Double Review below.
Domain Optional grouping tag used in the Reports page aggregates
PII Threshold 0.80 Per-span confidence floor for auto-accepting detections
Document Threshold 0.25 Risk-score ceiling for auto-approving whole documents
Audit Sampling Rate 0.10 Fraction of would-be auto-approved documents pulled into review

Click Create in the dialog footer to save, or Cancel (or press Escape) to dismiss without saving. The dialog is admin-only — non-admins do not see the Create Batch button, and the underlying endpoint refuses non-admin POSTs as a defense in depth. When no user groups exist yet, the button is rendered disabled with a message reminding the operator to create a group first.

Per-row actions

Each batch row has:

  • An inline Group selector with a Save button (changes the assigned group; non-admins are limited to groups they belong to).
  • A Settings button that opens a modal to edit the PII Threshold, Document Threshold, and Audit Sampling Rate. All three are validated to [0.0, 1.0].
  • A Weights link that opens the per-batch PII weight editor (see below).
  • A Close button (admin only) that marks the batch closed.
  • A Closed badge next to the name when the batch is in the closed state.

Only admins can create or close a batch. Approval rules for each batch are managed separately under Admin → Approval Rules; see Approval rule sets for the AND-within / OR-across model and worked examples. All other settings (group, thresholds, weights) remain editable for users with access to the batch.

Closing a batch

Closing is one-way. A closed batch:

  • Refuses new uploads from the web UI (it disappears from the upload page's batch dropdown, and direct POSTs to /redact are rejected).
  • Returns HTTP 409 from the API ingestion endpoint with a body like {"error": "Batch \"<name>\" is closed and cannot accept new documents.", "batchId": "...", "closed": true}.
  • Stays fully visible in the queue and review UI — existing documents in the batch remain reviewable, exportable, and modifiable.
  • Records a BATCH_CLOSE audit entry.

There is no built-in reopen action.

PII weights (/batches/{id}/weights)

Each batch has its own per-PII-type sensitivity weight. The defaults are:

Type Default weight
ssn 10
credit-card 10
phone-number 5
email-address 5
person 3
first-name 3
surname 3
physician-name 3
street-address 3
zip-code 2
Everything else 1

The weights page lists every supported PII type alphabetically. The displayed Weight column starts at the effective value (default unless overridden for this batch). Set any value to 0 to ignore that type entirely. Save weights persists overrides; only values that differ from the default are stored, so re-tuning a single default later picks up automatically for any batch that didn't override it. Reset to defaults clears all overrides.

Higher weights cause spans of that type to contribute more to a document's risk score. The full formula is on the Risk score reference page.

Blind Double Review

Blind Double Review is an opt-in quality-control feature on a batch. When enabled, a random sample of the documents that flow into the batch is flagged for an independent second review by a different reviewer. The first reviewer's decision is preserved; a second reviewer separately reviews the same document and their decisions are recorded alongside. Together the two reviews drive the Inter-Annotator Agreement (IAA) report.

What gets flagged

The selection happens at ingest time, once per document, using the percentage configured on the batch. The decision is persisted on the document (doubleReview = true) so the same document keeps the same selection regardless of how many times it's read or re-redacted. Documents not selected follow the normal review flow.

The default sample rate is 10%. The percentage field accepts an integer in the range 1–100 and only takes effect when the Blind Double Review checkbox is also ticked.

Write-once

Blind Double Review is a property of the batch and is set at creation time only. After the batch is saved:

  • The on/off flag cannot be toggled.
  • The percentage cannot be edited.

This is intentional: changing the sample rate mid-batch would invalidate any inter-annotator agreement statistics computed across the batch's documents. If you need a different setting, create a new batch.

Reviewer experience

The first reviewer sees and reviews the document exactly as they would any other document. Once they approve or reject it, the document moves out of their queue.

For a document flagged for blind double review, the system records who did the first review and uses that to keep the second review blind:

  • My Queue continues to show the document — but only to reviewers other than the first reviewer. The first reviewer no longer sees it (it's an APPROVED or REJECTED document and would normally drop out of their queue anyway). Other reviewers in the same group see it as an outstanding item, even though its status is APPROVED or REJECTED, until one of them provides the second review.
  • The Previous and Next buttons on the review page skip double-review documents whose first review was performed by the current user, so a reviewer is never paged into a document they've already reviewed.

The second reviewer's decisions are captured as an independent annotation set so they can be compared against the first reviewer's set in the IAA report.

Visibility scope (admin checkbox)

Admins see a Limit to my groups checkbox at the top of the page. With it checked (the default), the list shows only batches in groups the admin belongs to. Unchecking it shows every batch system-wide. The selection is preserved across sort clicks and reflected in the URL via ?myGroupsOnly=….