Share via


PiiActionContent Class

Definition

Supported parameters for a PII Entities Recognition task.

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

Constructors

Name Description
PiiActionContent()

Initializes a new instance of PiiActionContent.

Properties

Name Description
ConfidenceScoreThreshold

Confidence score threshold configuration for PII entity recognition.

DisableEntityValidation

Disable entity validation for PII entity recognition.

Domain

Domain for PII task.

EntitySynonyms

(Optional) request parameter that allows the user to provide synonyms for context words that to enhance pii entity detection.

ExcludePiiCategories

Enumeration of PII categories to be excluded in the response.

LoggingOptOut

logging opt out.

ModelVersion

model version.

PiiCategories

Enumeration of PII categories to be returned in the response.

RedactionPolicies

List of RedactionPolicies to be used on the input. Please note BaseRedactionPolicy is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include CharacterMaskPolicyType, EntityMaskPolicyType, NoMaskPolicyType and SyntheticReplacementPolicyType.

StringIndexType

StringIndexType to be used for analysis.

ValueExclusionPolicy

Policy for specific words and terms that should be excluded from detection by the PII detection service.

Methods

Name Description
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Explicit Interface Implementations

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

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

IJsonModel<PiiActionContent>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<PiiActionContent>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<PiiActionContent>.GetFormatFromOptions(ModelReaderWriterOptions)

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

IPersistableModel<PiiActionContent>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to