Share via

PiiEntity Class

Package:
com.azure.ai.textanalytics.models
Maven Artifact:
com.azure:azure-ai-textanalytics:5.5.12
  • java.lang.Object
    • com.azure.ai.textanalytics.models.PiiEntity

public final class PiiEntity

The PiiEntity model.

Constructor Summary

Constructor Description
PiiEntity()

Constructs a PiiEntity model.

Method Summary

Modifier and Type Method and 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 java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

PiiEntity

public PiiEntity()

Constructs a PiiEntity model.

Method Details

getCategory

public PiiEntityCategory getCategory()

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

Returns:

The category value.

getConfidenceScore

public double getConfidenceScore()

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

Returns:

The confidenceScore value.

getLength

public int getLength()

Gets the length of entity text.

Returns:

The length of entity text.

getOffset

public int getOffset()

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

Returns:

The offset value.

getSubcategory

public String getSubcategory()

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

Returns:

The subcategory value.

getText

public String getText()

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

Returns:

The text value.

Applies to