FieldValue¶

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

Bases: object

The value of a form field.

Attributes

`VALUE_TYPE_ARRAY`	A constant which can be used with the value_type property of a FieldValue.
`VALUE_TYPE_DATE`	A constant which can be used with the value_type property of a FieldValue.
`VALUE_TYPE_INTEGER`	A constant which can be used with the value_type property of a FieldValue.
`VALUE_TYPE_NUMBER`	A constant which can be used with the value_type property of a FieldValue.
`VALUE_TYPE_PHONE_NUMBER`	A constant which can be used with the value_type property of a FieldValue.
`VALUE_TYPE_STRING`	A constant which can be used with the value_type property of a FieldValue.
`VALUE_TYPE_TIME`	A constant which can be used with the value_type property of a FieldValue.
`bounding_polygon`	[Required] Gets the bounding_polygon of this FieldValue.
`confidence`	[Required] Gets the confidence of this FieldValue.
`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 FieldValue 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'¶: A constant which can be used with the value_type property of a FieldValue. This constant has a value of “ARRAY”

VALUE_TYPE_DATE = 'DATE'¶: A constant which can be used with the value_type property of a FieldValue. This constant has a value of “DATE”

VALUE_TYPE_INTEGER = 'INTEGER'¶: A constant which can be used with the value_type property of a FieldValue. This constant has a value of “INTEGER”

VALUE_TYPE_NUMBER = 'NUMBER'¶: A constant which can be used with the value_type property of a FieldValue. This constant has a value of “NUMBER”

VALUE_TYPE_PHONE_NUMBER = 'PHONE_NUMBER'¶: A constant which can be used with the value_type property of a FieldValue. This constant has a value of “PHONE_NUMBER”

VALUE_TYPE_STRING = 'STRING'¶: A constant which can be used with the value_type property of a FieldValue. This constant has a value of “STRING”

VALUE_TYPE_TIME = 'TIME'¶: A constant which can be used with the value_type property of a FieldValue. This constant has a value of “TIME”

__init__(**kwargs)¶

Initializes a new FieldValue object with values from keyword arguments. This class has the following subclasses and if you are using this class as input to a service operations then you should favor using a subclass over the base class:

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 FieldValue. 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’.
text (str) – The value to assign to the text property of this FieldValue.
confidence (float) – The value to assign to the confidence property of this FieldValue.
bounding_polygon (oci.ai_document.models.BoundingPolygon) – The value to assign to the bounding_polygon property of this FieldValue.
word_indexes (list[int]) – The value to assign to the word_indexes property of this FieldValue.

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.

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]