ValueArray¶

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

Bases: oci.ai_document.models.field_value.FieldValue

The array of field values.

Attributes

`VALUE_TYPE_ARRAY`	str(object=’’) -> str
`VALUE_TYPE_DATE`	str(object=’’) -> str
`VALUE_TYPE_INTEGER`	str(object=’’) -> str
`VALUE_TYPE_NUMBER`	str(object=’’) -> str
`VALUE_TYPE_PHONE_NUMBER`	str(object=’’) -> str
`VALUE_TYPE_STRING`	str(object=’’) -> str
`VALUE_TYPE_TIME`	str(object=’’) -> str
`bounding_polygon`	[Required] Gets the bounding_polygon of this FieldValue.
`confidence`	[Required] Gets the confidence of this FieldValue.
`items`	[Required] Gets the items of this ValueArray.
`text`	Gets the text of this FieldValue.
`value_type`	[Required] Gets the value_type of this FieldValue.
`word_indexes`	[Required] Gets the word_indexes of this FieldValue.

Methods

`__init__`(**kwargs)	Initializes a new ValueArray 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.

VALUE_TYPE_ARRAY = 'ARRAY'¶

VALUE_TYPE_DATE = 'DATE'¶

VALUE_TYPE_INTEGER = 'INTEGER'¶

VALUE_TYPE_NUMBER = 'NUMBER'¶

VALUE_TYPE_PHONE_NUMBER = 'PHONE_NUMBER'¶

VALUE_TYPE_STRING = 'STRING'¶

VALUE_TYPE_TIME = 'TIME'¶

__init__(**kwargs)¶

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

Parameters:

value_type (str) – The value to assign to the value_type property of this ValueArray. Allowed values for this property are: “STRING”, “DATE”, “TIME”, “PHONE_NUMBER”, “NUMBER”, “INTEGER”, “ARRAY”
text (str) – The value to assign to the text property of this ValueArray.
confidence (float) – The value to assign to the confidence property of this ValueArray.
bounding_polygon (oci.ai_document.models.BoundingPolygon) – The value to assign to the bounding_polygon property of this ValueArray.
word_indexes (list[int]) – The value to assign to the word_indexes property of this ValueArray.
items (list[oci.ai_document.models.DocumentField]) – The value to assign to the items property of this ValueArray.

bounding_polygon¶

[Required] Gets the bounding_polygon of this FieldValue.

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

confidence¶

[Required] Gets the confidence of this FieldValue. The confidence score between 0 and 1.

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

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.

items¶

[Required] Gets the items of this ValueArray. The array of values.

Returns:	The items of this ValueArray.
Return type:	list[oci.ai_document.models.DocumentField]

text¶

Gets the text of this FieldValue. The detected text of a field.

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

value_type¶

[Required] Gets the value_type of this FieldValue. The type of data detected.

Allowed values for this property are: “STRING”, “DATE”, “TIME”, “PHONE_NUMBER”, “NUMBER”, “INTEGER”, “ARRAY”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The value_type of this FieldValue.
Return type:	str

word_indexes¶

[Required] Gets the word_indexes of this FieldValue. The indexes of the words in the field value.

Returns:	The word_indexes of this FieldValue.
Return type:	list[int]