SelectionMark¶

class oci.ai_document.models.SelectionMark(**kwargs)¶

Bases: object

A single checkbox with selection mark.

Attributes:

`STATE_SELECTED`	A constant which can be used with the state property of a SelectionMark.
`STATE_UNSELECTED`	A constant which can be used with the state property of a SelectionMark.
`bounding_polygon`	[Required] Gets the bounding_polygon of this SelectionMark.
`confidence`	[Required] Gets the confidence of this SelectionMark.
`state`	[Required] Gets the state of this SelectionMark.

Methods:

__init__(**kwargs)

Initializes a new SelectionMark object with values from keyword arguments.

STATE_SELECTED = 'SELECTED'¶: A constant which can be used with the state property of a SelectionMark. This constant has a value of “SELECTED”

STATE_UNSELECTED = 'UNSELECTED'¶: A constant which can be used with the state property of a SelectionMark. This constant has a value of “UNSELECTED”

__init__(**kwargs)¶

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

Parameters

state (str) – The value to assign to the state property of this SelectionMark. Allowed values for this property are: “UNSELECTED”, “SELECTED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
confidence (float) – The value to assign to the confidence property of this SelectionMark.
bounding_polygon (oci.ai_document.models.BoundingPolygon) – The value to assign to the bounding_polygon property of this SelectionMark.

property bounding_polygon¶

[Required] Gets the bounding_polygon of this SelectionMark.

Returns: The bounding_polygon of this SelectionMark.
Return type: oci.ai_document.models.BoundingPolygon

property confidence¶

[Required] Gets the confidence of this SelectionMark. The confidence score, a float value between 0 and 1.

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

property state¶

[Required] Gets the state of this SelectionMark. String to display if checkbox is selected or not selected.

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

Returns: The state of this SelectionMark.
Return type: str