Zum Hauptinhalt springen

Create Redaction Job

POST 
/redaction/jobs

Start detecting personal data in an uploaded document.

Without label_ids the job detects the project's default selection, the entities marked selected in GET /configs?kind=redaction. With label_ids it detects exactly those for this run; ids outside the config's entity_set and an empty list are a 400. The selection is fixed when the job is created and returned as label_ids; a later change to the default does not affect the job.

instructions adds what else to redact in the reviewer's own words ("Schwärze alle Wohnadressen und alles zum Thema Sitzplatz, Loggia"). The job reads them when it is created and returns each as its own category under instructions, with the words it was taken from; their hits come back under those names, apart from the entities. With label_ids: [] the job detects the instructions alone. Instructions that ask to redact nothing or more than ten separate things, or are too long to read, are a 422 naming body.instructions; a 503 means they could not be read right now.

Runs asynchronously: returns a pending job, which stays pending until the document has been read. Poll GET /redaction/jobs/{job_id} every 2–5 seconds until it is completed or failed.

Request​

Responses​

Redaction job accepted