Share via

AnalyzeHealthcareEntitiesResult Class

  • Reference

AnalyzeHealthcareEntitiesResult contains the Healthcare entities from a particular document.

Inheritance
azure.ai.textanalytics._dict_mixin.DictMixin
AnalyzeHealthcareEntitiesResult

Constructor

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

entities

Identified Healthcare entities in the document, i.e. in the document "The subject took ibuprofen", "ibuprofen" is an identified entity from the document.

entities: List[HealthcareEntity]

entity_relations

Identified Healthcare relations between entities. For example, in the document "The subject took 100mg of ibuprofen", we would identify the relationship between the dosage of 100mg and the medication ibuprofen.

entity_relations: List[HealthcareRelation]

id

Unique, non-empty document identifier that matches the document id that was passed in with the request. If not specified in the request, an id is assigned for the document.

id: str

is_error

Boolean check for error item when iterating over list of results. Always False for an instance of a AnalyzeHealthcareEntitiesResult.

is_error: Literal[False] = False

kind

The text analysis kind - "Healthcare".

kind: Literal['Healthcare'] = 'Healthcare'

statistics

If show_stats=true was specified in the request this field will contain information about the document payload.

statistics: TextDocumentStatistics | None = None

warnings

Warnings encountered while processing document. Results will still be returned if there are warnings, but they may not be fully accurate.

warnings: List[TextAnalyticsWarning]