Skip to content

RedactionConfiguration

Source code in docs_src/capo_connect/types/redaction_configuration.py
class RedactionConfiguration(TypedDict, closed=True):
    behavior: "capo_connect.types.behavior.Behavior"
    """<p>Controls whether redaction is applied to the analytics output. Valid values: <code>Enable</code> | <code>Disable</code>.</p>"""
    policy: "capo_connect.types.policy.Policy"
    """<p>The redaction output policy that determines which versions of the transcript are stored. Valid values: <code>None</code> | <code>RedactedOnly</code> | <code>RedactedAndOriginal</code>.</p>"""
    entities: NotRequired["capo_connect.types.entities.Entities"]
    """<p>The list of PII entity types to redact from the transcript (for example, <code>NAME</code>, <code>ADDRESS</code>, <code>CREDIT_DEBIT_NUMBER</code>).</p>"""
    mask_mode: NotRequired["capo_connect.types.mask_mode.MaskMode"]
    """<p>The masking mode that determines how redacted content is replaced in the output. Valid values: <code>PII</code> (replaces with the literal string [PII]) | <code>EntityType</code> (replaces with the entity type name, for example [NAME]).</p>"""

behavior instance-attribute

behavior: Behavior

Controls whether redaction is applied to the analytics output. Valid values: Enable | Disable.

entities instance-attribute

entities: NotRequired[Entities]

The list of PII entity types to redact from the transcript (for example, NAME, ADDRESS, CREDIT_DEBIT_NUMBER).

mask_mode instance-attribute

mask_mode: NotRequired[MaskMode]

The masking mode that determines how redacted content is replaced in the output. Valid values: PII (replaces with the literal string [PII]) | EntityType (replaces with the entity type name, for example [NAME]).

policy instance-attribute

policy: Policy

The redaction output policy that determines which versions of the transcript are stored. Valid values: None | RedactedOnly | RedactedAndOriginal.