latestSwagger 2.02026-08-2053114259.7 KB

41da8739a690

Dataset Management

Edit a dataset

Updates a dataset to use the specified configuration.

put/api/Dataset

Query parameters

shouldRescanboolean

When true, triggers a rescan of dataset files after the update

Request body

idstring

The dataset to edit

namestring

The new name of the dataset

generatorSetupobject nullable

A dictionary mapping entity type names to their transformation type (e.g. Redaction, Synthesis, Off).

generatorMetadataobject nullable

A dictionary mapping entity type names to their transformation metadata configuration.

labelBlockListsobject nullable

The new excluded entity value list. Legacy strings inputs are accepted for backward compatibility and normalized into regexes.

labelAllowListsobject nullable

The new added entity value list. Legacy strings inputs are accepted for backward compatibility and normalized into regexes.

docXImagePolicy'Redact' | 'Ignore' | 'Remove'

Possible values: <ul> <li>Redact: Run images through OCR and redact sensitive text</li> <li>Ignore: Leave images alone</li> <li>Remove: Cover image with opaque black box</li> </ul>

rtfImagePolicy'Ignore' | 'Remove'

Possible values: <ul> <li>Ignore: Leave images alone</li> <li>Remove: Replace each image with an opaque black box of the same size</li> </ul>

pdfSignaturePolicy'Redact' | 'Ignore'

Possible values: <ul> <li>Redact: Cover signature with opaque black box</li> <li>Ignore: Do not attempt to detect signature</li> </ul>

pdfSynthModePolicy'V1' | 'V2' | 'V5'

Possible values: <ul> <li>V1: Original mode with incorrect font, size and style</li> <li>V2: Legacy style-aware mode. Persisted V2 values now use the V5 font detector.</li> <li>V5: Style-aware mode backed by the V5 OpenVINO font model</li> </ul>

docXCommentPolicy'Remove' | 'Ignore'

Possible values: <ul> <li>Remove: Remove all comments for file</li> <li>Ignore: Leave comments alone</li> </ul>

docXTablePolicy'Redact' | 'Remove'

Possible values: <ul> <li>Redact: Treat table content normally, feed into redaction process.</li> <li>Remove: Replace all characters and symbols in table with a placeholder.</li> </ul>

llmClassificationPolicy'Disabled' | 'Enabled' | 'PdfIdentificationAndSynthesis'

Possible values: <ul> <li>Disabled: Do not use LLM for structured data classification</li> <li>Enabled: Use LLM to classify structured data for PII detection</li> <li>PdfIdentificationAndSynthesis: Use an LLM instead of the NER model and C# generators for PDF PII identification and synthesis. Other file types continue to use their existing detection and synthesis paths.</li> </ul>

llmTableClassificationPolicy'Disabled' | 'Enabled' | 'PdfIdentificationAndSynthesis'

outputPathstring nullable

The Location to store dataset files. Not applicable to local datasets

ocrServiceProvider'Azure' | 'PyTesseract' | 'Textract' | 'None'

The OCR engine used for text extraction from images, scanned documents, and PDFs

Example request

{
  "generatorSetup": {
    "NAME_GIVEN": "Redaction",
    "NAME_FAMILY": "Redaction"
  },
  "labelBlockLists": {
    "NAME_FAMILY": {
      "regexes": [
        ".*\\s(disease|syndrome|disorder)"
      ]
    }
  },
  "labelAllowLists": {
    "HEALTHCARE_ID": {
      "regexes": [
        "[a-z]{2}\\d{9}"
      ]
    }
  }
}

Response

Returns the updated dataset

idstring

namestring

generatorMetadataobject nullable

A dictionary mapping entity type names to their transformation metadata configuration.

outputFormat'Original' | 'Markdown'

The output format for redacted files: Original preserves the source format, Markdown produces a markdown version.

generatorSetupobject nullable

A dictionary mapping entity type names to their transformation type (e.g. Redaction, Synthesis, Off).

labelBlockListsobject nullable

labelAllowListsobject nullable

tagsstring[]

lastUpdatedInstant

A point in time represented as an ISO 8601 timestamp string.

createdInstant