Skip to content

RedactionKeyword

RedactionKeyword specifies a sensitive word or phrase that should be masked before documents are shared. Each instance holds a single field: the keyword text to match on the drawing. Passing a list of these objects to a redaction request tells the pipeline which terms to locate and obscure, and matched occurrences come back as redaction zones with their locations. Use the object to enforce confidentiality policies, comply with ITAR or NDA requirements, and protect customer names or proprietary part numbers while still leveraging the rest of the extracted data. Because the keyword list is structured, you can maintain it centrally and reuse the same terms across every drawing you process.

Bases: BaseModel

A class that represents a keyword to redact from the drawing.

PARAMETER DESCRIPTION
keyword

The keyword to redact from the drawing.

TYPE: str

Source code in werk24/models/v2/models.py
class RedactionKeyword(BaseModel):
    """
    A class that represents a keyword to redact from the drawing.
    """

    keyword: str = Field(..., description="The keyword to redact from the drawing.")