PiiEntity Class

Reference

Definition

Namespace:: Azure.AI.Language.Text

Assembly:: Azure.AI.Language.Text.dll

Package:: Azure.AI.Language.Text v1.0.0-beta.2

Source:: PiiEntity.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Entity object with tags.

public class PiiEntity : System.ClientModel.Primitives.IJsonModel<Azure.AI.Language.Text.PiiEntity>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.Language.Text.PiiEntity>

type PiiEntity = class
    interface IJsonModel<PiiEntity>
    interface IPersistableModel<PiiEntity>

Public Class PiiEntity
Implements IJsonModel(Of PiiEntity), IPersistableModel(Of PiiEntity)

Inheritance: Object
PiiEntity

Implements: IJsonModel<PiiEntity> IPersistableModel<PiiEntity> IPersistableModel<T>

Properties

Category	Entity type.
ConfidenceScore	Confidence score between 0 and 1 of the extracted entity.
Length	Length for the entity text. Use of different 'stringIndexType' values can affect the length returned.
Mask	Optional field which will be returned only when using the redaction policy kind “MaskWithEntityType”. This field will contain the exact mask text used to mask the PII entity in the original text.
MaskLength	The length of the masked text. Will be present when using the redaction policy kind “MaskWithEntityType”.
MaskOffset	Start position of masked text in the redacted text when using the redaction policy kind “MaskWithEntityType”.
Offset	Start position for the entity text. Use of different 'stringIndexType' values can affect the offset returned.
Subcategory	(Optional) Entity sub type.
Tags	List of entity tags. Tags are to express some similarities/affinity between entities.
Text	Entity text as appears in the request.
Type	An entity type is the lowest (or finest) granularity at which the entity has been detected. The type maps to the specific metadata attributes associated with the entity detected.

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Explicit Interface Implementations

IJsonModel<PiiEntity>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<PiiEntity>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter.
IPersistableModel<PiiEntity>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model.
IPersistableModel<PiiEntity>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<PiiEntity>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData.

Applies to

Compartilhar via