AnalyzeHealthcareEntitiesResult Class

AnalyzeHealthcareEntitiesResult contains the Healthcare entities from a particular document.

Inheritance

azure.ai.textanalytics._models.DictMixin

AnalyzeHealthcareEntitiesResult

Constructor

AnalyzeHealthcareEntitiesResult(**kwargs)

Variables

id

str

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.

entities

list[HealthcareEntity]

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

entity_relations

list[HealthcareRelation]

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.

warnings

list[TextAnalyticsWarning]

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

statistics

TextDocumentStatistics

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

is_error

bool

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