CategorizedEntity Class

CategorizedEntity contains information about a particular entity found in text.

New in version v3.1: The offset and length properties.

Inheritance

azure.ai.textanalytics._models.DictMixin

CategorizedEntity

Constructor

CategorizedEntity(**kwargs)

Variables

text

str

Entity text as appears in the request.

category

str

Entity category, such as Person/Location/Org/SSN etc

subcategory

str

Entity subcategory, such as Age/Year/TimeRange etc

length

int

The entity text length. This value depends on the value of the string_index_type parameter set in the original request, which is UnicodeCodePoints by default.

offset

int

The entity text offset from the start of the document. The value depends on the value of the string_index_type parameter set in the original request, which is UnicodeCodePoints by default.

confidence_score

float

Confidence score between 0 and 1 of the extracted entity.