HealthcareEntity Class

HealthcareEntity contains information about a Healthcare entity found in text.

Inheritance

azure.ai.textanalytics._models.DictMixin

HealthcareEntity

Constructor

HealthcareEntity(**kwargs)

Variables

text

str

Entity text as appears in the document.

normalized_text

str

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

category

str

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

subcategory

str

Entity subcategory.

assertion

HealthcareEntityAssertion

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?

length

int

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.

offset

int

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.

confidence_score

float

Confidence score between 0 and 1 of the extracted entity.

data_sources

list[HealthcareEntityDataSource]

A collection of entity references in known data sources.