Entity interface
A word or phrase identified as an entity that is categorized within a taxonomy of types. The set of categories recognized by the Text Analytics service is described at https://docs.microsoft.com/azure/cognitive-services/Text-Analytics/named-entity-types .
Properties
| category | Entity type. |
| confidence |
Confidence score between 0 and 1 of the extracted entity. |
| length | Length for the entity text. Use of different 'stringIndexType' values can affect the length returned. |
| offset | Start position for the entity text. Use of different 'stringIndexType' values can affect the offset returned. |
| sub |
(Optional) Entity sub type. |
| text | Entity text as appears in the request. |
Property Details
category
Entity type.
category: stringProperty Value
string
confidenceScore
Confidence score between 0 and 1 of the extracted entity.
confidenceScore: numberProperty Value
number
length
Length for the entity text. Use of different 'stringIndexType' values can affect the length returned.
length: numberProperty Value
number
offset
Start position for the entity text. Use of different 'stringIndexType' values can affect the offset returned.
offset: numberProperty Value
number
subCategory
(Optional) Entity sub type.
subCategory?: stringProperty Value
string
text
Entity text as appears in the request.
text: stringProperty Value
string