Skip to content

InlineRedactionPattern

Source code in docs_src/capo_workspaces_web/types/inline_redaction_pattern.py
class InlineRedactionPattern(TypedDict, closed=True):
    built_in_pattern_id: NotRequired[
        "capo_workspaces_web.types.built_in_pattern_id.BuiltInPatternId"
    ]
    """<p>The built-in pattern from the list of preconfigured patterns. Either a customPattern or builtInPatternId is required.</p>"""
    custom_pattern: NotRequired[
        "capo_workspaces_web.types.custom_pattern.CustomPattern"
    ]
    """<p>&gt;The configuration for a custom pattern. Either a customPattern or builtInPatternId is required.</p>"""
    redaction_place_holder: (
        "capo_workspaces_web.types.redaction_place_holder.RedactionPlaceHolder"
    )
    """<p>The redaction placeholder that will replace the redacted text in session for the inline redaction pattern.</p>"""
    enforced_urls: NotRequired[
        "capo_workspaces_web.types.inline_redaction_urls.InlineRedactionUrls"
    ]
    """<p>The enforced URL configuration for the inline redaction pattern. This will override the global enforced URL configuration.</p>"""
    exempt_urls: NotRequired[
        "capo_workspaces_web.types.inline_redaction_urls.InlineRedactionUrls"
    ]
    """<p>The exempt URL configuration for the inline redaction pattern. This will override the global exempt URL configuration for the inline redaction pattern.</p>"""
    confidence_level: NotRequired[
        "capo_workspaces_web.types.confidence_level.ConfidenceLevel"
    ]
    """<p>The confidence level for inline redaction pattern. This indicates the certainty of data type matches in the redaction process. Confidence level 3 means high confidence, and requires a formatted text pattern match in order for content to be redacted. Confidence level 2 means medium confidence, and redaction considers both formatted and unformatted text, and adds keyword associate to the logic. Confidence level 1 means low confidence, and redaction is enforced for both formatted pattern + unformatted pattern without keyword. This overrides the global confidence level.</p>"""

built_in_pattern_id instance-attribute

built_in_pattern_id: NotRequired[BuiltInPatternId]

The built-in pattern from the list of preconfigured patterns. Either a customPattern or builtInPatternId is required.

confidence_level instance-attribute

confidence_level: NotRequired[ConfidenceLevel]

The confidence level for inline redaction pattern. This indicates the certainty of data type matches in the redaction process. Confidence level 3 means high confidence, and requires a formatted text pattern match in order for content to be redacted. Confidence level 2 means medium confidence, and redaction considers both formatted and unformatted text, and adds keyword associate to the logic. Confidence level 1 means low confidence, and redaction is enforced for both formatted pattern + unformatted pattern without keyword. This overrides the global confidence level.

custom_pattern instance-attribute

custom_pattern: NotRequired[CustomPattern]

>The configuration for a custom pattern. Either a customPattern or builtInPatternId is required.

enforced_urls instance-attribute

enforced_urls: NotRequired[InlineRedactionUrls]

The enforced URL configuration for the inline redaction pattern. This will override the global enforced URL configuration.

exempt_urls instance-attribute

exempt_urls: NotRequired[InlineRedactionUrls]

The exempt URL configuration for the inline redaction pattern. This will override the global exempt URL configuration for the inline redaction pattern.

redaction_place_holder instance-attribute

redaction_place_holder: RedactionPlaceHolder

The redaction placeholder that will replace the redacted text in session for the inline redaction pattern.