HealthEntity¶
- class oci.ai_language.models.HealthEntity(**kwargs)¶
Bases:
objectHealth entity object
Methods:
__init__(**kwargs)Initializes a new HealthEntity object with values from keyword arguments.
Attributes:
Gets the assertions of this HealthEntity.
Gets the category of this HealthEntity.
[Required] Gets the id of this HealthEntity.
[Required] Gets the length of this HealthEntity.
Gets the matched_concepts of this HealthEntity.
[Required] Gets the offset of this HealthEntity.
[Required] Gets the score of this HealthEntity.
Gets the sub_type of this HealthEntity.
[Required] Gets the text of this HealthEntity.
[Required] Gets the type of this HealthEntity.
- __init__(**kwargs)¶
Initializes a new HealthEntity object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):
- Parameters
offset (int) – The value to assign to the offset property of this HealthEntity.
length (int) – The value to assign to the length property of this HealthEntity.
text (str) – The value to assign to the text property of this HealthEntity.
type (str) – The value to assign to the type property of this HealthEntity.
sub_type (str) – The value to assign to the sub_type property of this HealthEntity.
score (float) – The value to assign to the score property of this HealthEntity.
category (str) – The value to assign to the category property of this HealthEntity.
id (str) – The value to assign to the id property of this HealthEntity.
assertions (list[oci.ai_language.models.AssertionDetails]) – The value to assign to the assertions property of this HealthEntity.
matched_concepts (list[oci.ai_language.models.MelConcept]) – The value to assign to the matched_concepts property of this HealthEntity.
- property assertions¶
Gets the assertions of this HealthEntity. list of all assertions associated with this entity.
- Returns
The assertions of this HealthEntity.
- Return type
- property category¶
Gets the category of this HealthEntity. Entity category e.g, MEDICAL_CONDITION, MEDICATION, GENERAL, ANATOMY
- Returns
The category of this HealthEntity.
- Return type
str
- property id¶
[Required] Gets the id of this HealthEntity. Unique id of the entity
- Returns
The id of this HealthEntity.
- Return type
str
- property length¶
[Required] Gets the length of this HealthEntity. Length of entity text
- Returns
The length of this HealthEntity.
- Return type
int
- property matched_concepts¶
Gets the matched_concepts of this HealthEntity. This contains the list of matched concepts which are ranked by the relevant score with the input text
- Returns
The matched_concepts of this HealthEntity.
- Return type
- property offset¶
[Required] Gets the offset of this HealthEntity. The number of Unicode code points preceding this entity in the submitted text.
- Returns
The offset of this HealthEntity.
- Return type
int
- property score¶
[Required] Gets the score of this HealthEntity. Score or confidence for detected entity.
- Returns
The score of this HealthEntity.
- Return type
float
- property sub_type¶
Gets the sub_type of this HealthEntity. Sub-type of entity text like GPE for LOCATION type
- Returns
The sub_type of this HealthEntity.
- Return type
str
- property text¶
[Required] Gets the text of this HealthEntity. Entity text like name of person, location, and so on.
- Returns
The text of this HealthEntity.
- Return type
str
- property type¶
[Required] Gets the type of this HealthEntity. Type of entity text like PER, LOC.
- Returns
The type of this HealthEntity.
- Return type
str