PiiEntity Struct

  • Reference

Definition

Namespace:
Azure.AI.TextAnalytics
Assembly:
Azure.AI.TextAnalytics.dll
Package:
Azure.AI.TextAnalytics v5.3.0
Source:
PiiEntity.cs

A word or phrase identified as a Personally Identifiable Information that can be categorized as known type in a given taxonomy. The set of categories recognized by the Language service is described at https://aka.ms/azsdk/language/pii.

public readonly struct PiiEntity
type PiiEntity = struct
Public Structure PiiEntity
Inheritance
ValueType
PiiEntity

Properties

Category

Gets the PII entity category inferred by the Text Analytics service's named entity recognition model, such as Financial Account Identification/Social Security Number/Phone Number, etc. The list of available categories is described at https://aka.ms/azsdk/language/pii.
ConfidenceScore

Gets a score between 0 and 1, indicating the confidence that the text substring matches this inferred entity.
Length

Gets the length of the matching text in the input document.
Offset

Gets the starting position for the matching text in the input document.
SubCategory

Gets the subcategory of the entity inferred by the Language service's named entity recognition model. This property may not have a value if a subcategory doesn't exist for this entity. The list of available categories and subcategories is described at https://aka.ms/azsdk/language/pii.
Text

Gets the entity text as it appears in the input document.

Applies to