Share via


CharacterMaskPolicyType Class

Definition

Represents the policy of redacting with a redaction character.

public class CharacterMaskPolicyType : Azure.AI.Language.Text.BaseRedactionPolicy, System.ClientModel.Primitives.IJsonModel<Azure.AI.Language.Text.CharacterMaskPolicyType>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.Language.Text.CharacterMaskPolicyType>
type CharacterMaskPolicyType = class
    inherit BaseRedactionPolicy
    interface IJsonModel<CharacterMaskPolicyType>
    interface IPersistableModel<CharacterMaskPolicyType>
Public Class CharacterMaskPolicyType
Inherits BaseRedactionPolicy
Implements IJsonModel(Of CharacterMaskPolicyType), IPersistableModel(Of CharacterMaskPolicyType)
Inheritance
CharacterMaskPolicyType
Implements

Constructors

Name Description
CharacterMaskPolicyType()

Initializes a new instance of CharacterMaskPolicyType.

Properties

Name Description
EntityTypes

(Optional) describes the PII categories to which the redaction policy will be applied. If not specified, the redaction policy will be applied to all PII categories.

(Inherited from BaseRedactionPolicy)
IsDefault

(Optional) flag to indicate whether this redaction policy is the default policy to be applied when no specific policy is defined for a PII category. Only one policy can be marked as default.

(Inherited from BaseRedactionPolicy)
PolicyName

(Optional) name of the redaction policy for identification purposes.

(Inherited from BaseRedactionPolicy)
RedactionCharacter

Optional parameter to use a Custom Character to be used for redaction in PII responses. Default character will bce * as before. We allow specific ascii characters for redaction.

UnmaskFromEnd

Optional parameter to indicate whether to unmask characters from the end of the redacted PII entity. Default is true.

UnmaskLength

Optional parameter to indicate the length of unmasked characters at the end of the redacted PII entity. Default is 0.

Methods

Name Description
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Explicit Interface Implementations

Name Description
IJsonModel<BaseRedactionPolicy>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

(Inherited from BaseRedactionPolicy)
IJsonModel<BaseRedactionPolicy>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

(Inherited from BaseRedactionPolicy)
IJsonModel<CharacterMaskPolicyType>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<CharacterMaskPolicyType>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<BaseRedactionPolicy>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

(Inherited from BaseRedactionPolicy)
IPersistableModel<BaseRedactionPolicy>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

(Inherited from BaseRedactionPolicy)
IPersistableModel<BaseRedactionPolicy>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

(Inherited from BaseRedactionPolicy)
IPersistableModel<CharacterMaskPolicyType>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<CharacterMaskPolicyType>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<CharacterMaskPolicyType>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to