Class CategorizedEntity
java.lang.Object
com.azure.ai.textanalytics.models.CategorizedEntity
The
CategorizedEntity
model.-
Constructor Summary
ConstructorDescriptionCategorizedEntity
(String text, EntityCategory category, String subcategory, double confidenceScore) Creates aCategorizedEntity
model that describes entity. -
Method Summary
Modifier and TypeMethodDescriptionGets the category property: Categorized entity category, such as Person/Location/Org/SSN etc.double
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
Gets the length of entity text.int
Gets the offset of entity text.Gets the subcategory property: Categorized entity sub category, such as Age/Year/TimeRange etc.getText()
Gets the text property: Categorized entity text as appears in the request.
-
Constructor Details
-
CategorizedEntity
public CategorizedEntity(String text, EntityCategory category, String subcategory, double confidenceScore) Creates aCategorizedEntity
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 Details
-
getText
Gets the text property: Categorized entity text as appears in the request.- Returns:
- The text value.
-
getCategory
Gets the category property: Categorized entity category, such as Person/Location/Org/SSN etc.- Returns:
- The category value.
-
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.
-