Package com.azure.ai.textanalytics.models

Class PiiEntity

java.lang.Object

com.azure.ai.textanalytics.models.PiiEntity

public final class PiiEntity
extends Object

The PiiEntity model.

Constructor Summary

Constructors

Constructor	Description
PiiEntity()

Method Summary

Modifier and Type	Method	Description
PiiEntityCategory	getCategory()	Gets the category property: Categorized entity category, such as Person/Location/Org/SSN etc.
double	getConfidenceScore()	Gets the score property: Confidence score between 0 and 1 of the recognized entity.
int	getLength()	Gets the length of entity text.
int	getOffset()	Gets the offset property: the start position for the entity text.
String	getSubcategory()	Gets the subcategory property: Categorized entity subcategory, such as Medical/Stock exchange/Sports etc.
String	getText()	Gets the text property: PII entity text as appears in the request.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PiiEntity

public PiiEntity()

Method Details

getText

public String getText()

Gets the text property: PII entity text as appears in the request.

Returns:

The text value.

getCategory

public PiiEntityCategory getCategory()

Gets the category property: Categorized entity category, such as Person/Location/Org/SSN etc.

Returns:

The category value.

getSubcategory

public String getSubcategory()

Gets the subcategory property: Categorized entity subcategory, such as Medical/Stock exchange/Sports etc.

Returns:

The subcategory value.

getConfidenceScore

public double getConfidenceScore()

Gets the score property: Confidence score between 0 and 1 of the recognized entity.

Returns:

The confidenceScore value.

getOffset

public int getOffset()

Gets the offset property: the start position for the entity text.

Returns:

The offset value.

getLength

public int getLength()

Gets the length of entity text.

Returns:

The length of entity text.