HierarchicalEntity

class oci.ai_language.models.HierarchicalEntity(**kwargs)

Bases: object

Hierarchical entity object

Methods:

__init__(**kwargs)

Initializes a new HierarchicalEntity object with values from keyword arguments.

Attributes:

length

Gets the length of this HierarchicalEntity.

meta_info

Gets the meta_info of this HierarchicalEntity.

offset

Gets the offset of this HierarchicalEntity.

score

Gets the score of this HierarchicalEntity.

sub_type

Gets the sub_type of this HierarchicalEntity.

text

Gets the text of this HierarchicalEntity.

type

Gets the type of this HierarchicalEntity.

__init__(**kwargs)

Initializes a new HierarchicalEntity object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters
  • meta_info (oci.ai_language.models.MetaInfo) – The value to assign to the meta_info property of this HierarchicalEntity.

  • offset (int) – The value to assign to the offset property of this HierarchicalEntity.

  • length (int) – The value to assign to the length property of this HierarchicalEntity.

  • text (str) – The value to assign to the text property of this HierarchicalEntity.

  • type (str) – The value to assign to the type property of this HierarchicalEntity.

  • sub_type (str) – The value to assign to the sub_type property of this HierarchicalEntity.

  • score (float) – The value to assign to the score property of this HierarchicalEntity.

property length

Gets the length of this HierarchicalEntity. Length of entity text

Returns

The length of this HierarchicalEntity.

Return type

int

property meta_info

Gets the meta_info of this HierarchicalEntity.

Returns

The meta_info of this HierarchicalEntity.

Return type

oci.ai_language.models.MetaInfo

property offset

Gets the offset of this HierarchicalEntity. The number of Unicode code points preceding this entity in the submitted text.

Returns

The offset of this HierarchicalEntity.

Return type

int

property score

Gets the score of this HierarchicalEntity. Score or confidence for detected entity.

Returns

The score of this HierarchicalEntity.

Return type

float

property sub_type

Gets the sub_type of this HierarchicalEntity. Sub-type of entity text like GPE for LOCATION type

Returns

The sub_type of this HierarchicalEntity.

Return type

str

property text

Gets the text of this HierarchicalEntity. Entity text like name of person, location, and so on.

Returns

The text of this HierarchicalEntity.

Return type

str

property type

Gets the type of this HierarchicalEntity. Type of entity text like PER, LOC.

Returns

The type of this HierarchicalEntity.

Return type

str