Skip to content

RedactionZone

RedactionZone describes polygonal areas on the drawing that should be obscured for confidentiality. It includes the precise geometry, associated keywords, and confidence scores so you can automate pixel masking or highlight regions for manual review. The model keeps track of overlapping annotations, sheet indices, and revision references, preserving the context needed to decide whether redaction is required. It also stores audit metadata to document when and why a zone was generated. By handling sensitive regions in a structured format, you can integrate secure sharing workflows, maintain compliance logs, and ensure partners only see the information they are entitled to while still benefiting from the rest of the extracted dataset.

Bases: BaseModel

A class that represents a redacted area in the drawing.

PARAMETER DESCRIPTION
redaction_zone_type

TYPE: RedactionZoneType

polygon

A list of x,y tuples representing the vertices of the redacted area.

TYPE: Polygon

Source code in werk24/models/v2/models.py
class RedactionZone(BaseModel):
    """
    A class that represents a redacted area in the drawing.
    """

    redaction_zone_type: RedactionZoneType
    polygon: Polygon = Field(
        ...,
        description="A list of x,y tuples representing the vertices of the redacted area.",
    )