Package com.azure.ai.textanalytics.models

Class CategorizedEntity

java.lang.Object

com.azure.ai.textanalytics.models.CategorizedEntity

public final class CategorizedEntity
extends Object

The CategorizedEntity model.

Constructor Summary

Constructors

Constructor	Description
CategorizedEntity(String text, EntityCategory category, String subcategory, double confidenceScore)	Creates a CategorizedEntity model that describes entity.

Method Summary

Modifier and Type	Method	Description
EntityCategory	getCategory()	Gets the category property: Categorized entity category, such as Person/Location/Org/SSN etc.
double	getConfidenceScore()	Gets the score property: If a well-known item is recognized, a decimal number denoting the confidence level between 0 and 1 will be returned.
int	getLength()	Gets the length of entity text.
int	getOffset()	Gets the offset of entity text.
String	getSubcategory()	Gets the subcategory property: Categorized entity sub category, such as Age/Year/TimeRange etc.
String	getText()	Gets the text property: Categorized 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 Detail

CategorizedEntity

public CategorizedEntity(String text,
                         EntityCategory category,
                         String subcategory,
                         double confidenceScore)

Creates a CategorizedEntity model that describes entity.

Parameters:

text - The entity text as appears in the request.

category - The entity category, such as Person/Location/Org/SSN etc.

subcategory - The entity subcategory, such as Age/Year/TimeRange etc.

confidenceScore - If a well-known item is recognized, a decimal number denoting the confidence level between 0 and 1 will be returned.

Method Detail

getText

public String getText()

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

Returns:

The text value.

getCategory

public EntityCategory 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 sub category, such as Age/Year/TimeRange etc.

Returns:

The subcategory value.

getConfidenceScore

public double getConfidenceScore()

Gets the score property: If a well-known item is recognized, a decimal number denoting the confidence level between 0 and 1 will be returned.

Returns:

The score value.

getOffset

public int getOffset()

Gets the offset of entity text. The start position for the entity text in a document.

Returns:

The offset of entity text.

getLength

public int getLength()

Gets the length of entity text.

Returns:

The length of entity text.