Share via


SyntheticReplacementPolicyType Class

Definition

Represents the policy of replacing detected PII with synthetic values.

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

Constructors

Name Description
SyntheticReplacementPolicyType()

Initializes a new instance of SyntheticReplacementPolicyType.

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)
PreserveDataFormat

Optional flag to indicate whether to preserve the original data format in the synthetic replacement. Default is false.

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<SyntheticReplacementPolicyType>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

IJsonModel<SyntheticReplacementPolicyType>.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<SyntheticReplacementPolicyType>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<SyntheticReplacementPolicyType>.GetFormatFromOptions(ModelReaderWriterOptions)

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

IPersistableModel<SyntheticReplacementPolicyType>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to