HealthcareEntity Class

HealthcareEntity contains information about a Healthcare entity found in text.

Inheritance

azure.ai.textanalytics._dict_mixin.DictMixin

HealthcareEntity

Constructor

HealthcareEntity(**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

assertion

Contains various assertions about this entity. For example, if an entity is a diagnosis, is this diagnosis 'conditional' on a symptom? Are the doctors 'certain' about this diagnosis? Is this diagnosis 'associated' with another diagnosis?

assertion: HealthcareEntityAssertion | None = None

category

Entity category, see the HealthcareEntityCategory type for possible healthcare entity categories.

category: str

confidence_score

Confidence score between 0 and 1 of the extracted entity.

confidence_score: float

data_sources

A collection of entity references in known data sources.

data_sources: List[HealthcareEntityDataSource] | None

length

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

length: int

normalized_text

Normalized version of the raw text we extract from the document. Not all text will have a normalized version.

normalized_text: str | None = None

offset

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

offset: int

subcategory

Entity subcategory.

subcategory: str | None = None

text

Entity text as appears in the document.

text: str