CategorizedEntity Class

  • Reference

CategorizedEntity contains information about a particular entity found in text.

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

Inheritance
azure.ai.textanalytics._dict_mixin.DictMixin
CategorizedEntity

Constructor

CategorizedEntity(**kwargs: Any)

Methods

get
has_key
items
keys
update
values

get 

get(key: str, default: Any | None = None) -> Any

Parameters

Name Description
key
Required
default
default value: None

has_key 

has_key(k: str) -> bool

Parameters

Name Description
k
Required

items 

items() -> Iterable[Tuple[str, Any]]

keys 

keys() -> Iterable[str]

update 

update(*args: Any, **kwargs: Any) -> None

values 

values() -> Iterable[Any]

Attributes

category

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

category: str

confidence_score

Confidence score between 0 and 1 of the extracted entity.

confidence_score: float

length

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.

length: int

offset

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.

offset: int

subcategory

Entity subcategory, such as Age/Year/TimeRange etc

subcategory: str | None = None

text

Entity text as appears in the request.

text: str