KeyValueSelectionEntity¶

class oci.data_labeling_service_dataplane.models.KeyValueSelectionEntity(**kwargs)¶

Bases: oci.data_labeling_service_dataplane.models.entity.Entity

This allows the labeler to apply label the highlighted text from OCR, this includes labelled and unlabelled data.

Attributes

`ENTITY_TYPE_GENERIC`	str(object=’’) -> str
`ENTITY_TYPE_IMAGEOBJECTSELECTION`	str(object=’’) -> str
`ENTITY_TYPE_KEYVALUESELECTION`	str(object=’’) -> str
`ENTITY_TYPE_TEXTSELECTION`	str(object=’’) -> str
`bounding_polygon`	[Required] Gets the bounding_polygon of this KeyValueSelectionEntity.
`confidence`	[Required] Gets the confidence of this KeyValueSelectionEntity.
`entity_type`	[Required] Gets the entity_type of this Entity.
`labels`	Gets the labels of this KeyValueSelectionEntity.
`page_number`	Gets the page_number of this KeyValueSelectionEntity.
`rotation`	Gets the rotation of this KeyValueSelectionEntity.
`text`	[Required] Gets the text of this KeyValueSelectionEntity.

Methods

`__init__`(**kwargs)	Initializes a new KeyValueSelectionEntity object with values from keyword arguments.
`get_subtype`(object_dictionary)	Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

ENTITY_TYPE_GENERIC = 'GENERIC'¶

ENTITY_TYPE_IMAGEOBJECTSELECTION = 'IMAGEOBJECTSELECTION'¶

ENTITY_TYPE_KEYVALUESELECTION = 'KEYVALUESELECTION'¶

ENTITY_TYPE_TEXTSELECTION = 'TEXTSELECTION'¶

__init__(**kwargs)¶

Initializes a new KeyValueSelectionEntity object with values from keyword arguments. The default value of the entity_type attribute of this class is KEYVALUESELECTION and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

entity_type (str) – The value to assign to the entity_type property of this KeyValueSelectionEntity. Allowed values for this property are: “GENERIC”, “IMAGEOBJECTSELECTION”, “TEXTSELECTION”, “KEYVALUESELECTION”
text (str) – The value to assign to the text property of this KeyValueSelectionEntity.
labels (list[oci.data_labeling_service_dataplane.models.Label]) – The value to assign to the labels property of this KeyValueSelectionEntity.
bounding_polygon (oci.data_labeling_service_dataplane.models.BoundingPolygon) – The value to assign to the bounding_polygon property of this KeyValueSelectionEntity.
rotation (float) – The value to assign to the rotation property of this KeyValueSelectionEntity.
confidence (float) – The value to assign to the confidence property of this KeyValueSelectionEntity.
page_number (float) – The value to assign to the page_number property of this KeyValueSelectionEntity.

bounding_polygon¶

[Required] Gets the bounding_polygon of this KeyValueSelectionEntity.

Returns:	The bounding_polygon of this KeyValueSelectionEntity.
Return type:	oci.data_labeling_service_dataplane.models.BoundingPolygon

confidence¶

[Required] Gets the confidence of this KeyValueSelectionEntity. float value, score from OCR.

Returns:	The confidence of this KeyValueSelectionEntity.
Return type:	float

entity_type¶

[Required] Gets the entity_type of this Entity. The entity type described in the annotation. GENERIC - An extensible entity type that is the base entity type for some annotation formats. IMAGEOBJECTSELECTION- - This allows the labeler to use specify a bounding polygon on the image to represent an object and apply labels to it. TEXTSELECTION - This allows the labeler to highlight text, by specifying an offset and a length, and apply labels to it. KEYVALUESELECTION - This allows the labeler to apply label the highlighted text from OCR.

Allowed values for this property are: “GENERIC”, “IMAGEOBJECTSELECTION”, “TEXTSELECTION”, “KEYVALUESELECTION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The entity_type of this Entity.
Return type:	str

static get_subtype(object_dictionary)¶: Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

labels¶

Gets the labels of this KeyValueSelectionEntity. A collection of label entities.

Returns:	The labels of this KeyValueSelectionEntity.
Return type:	list[oci.data_labeling_service_dataplane.models.Label]

page_number¶

Gets the page_number of this KeyValueSelectionEntity. Integer value.

Returns:	The page_number of this KeyValueSelectionEntity.
Return type:	float

rotation¶

Gets the rotation of this KeyValueSelectionEntity. Integer value.

Returns:	The rotation of this KeyValueSelectionEntity.
Return type:	float

text¶

[Required] Gets the text of this KeyValueSelectionEntity. Entity Name.

Returns:	The text of this KeyValueSelectionEntity.
Return type:	str