ValuePhoneNumber

class oci.ai_document.models.ValuePhoneNumber(**kwargs)

Bases: FieldValue

The phone number field value.

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.
normalized_confidence	Gets the normalized_confidence of this FieldValue.
normalized_value	Gets the normalized_value of this FieldValue.
text	Gets the text of this FieldValue.
value	[Required] Gets the value of this ValuePhoneNumber.
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 ValuePhoneNumber 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 ValuePhoneNumber object with values from keyword arguments. The default value of the value_type attribute of this class is PHONE_NUMBER 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 ValuePhoneNumber. 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 ValuePhoneNumber.

• confidence (float) – The value to assign to the confidence property of this ValuePhoneNumber.

• bounding_polygon (oci.ai_document.models.BoundingPolygon) – The value to assign to the bounding_polygon property of this ValuePhoneNumber.

• word_indexes (list[int]) – The value to assign to the word_indexes property of this ValuePhoneNumber.

• normalized_value (str) – The value to assign to the normalized_value property of this ValuePhoneNumber.

• normalized_confidence (float) – The value to assign to the normalized_confidence property of this ValuePhoneNumber.

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

property bounding_polygon

[Required] Gets the bounding_polygon of this FieldValue.

Returns

The bounding_polygon of this FieldValue.

Return type

oci.ai_document.models.BoundingPolygon

property 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.

property normalized_confidence

Gets the normalized_confidence of this FieldValue. The normalized value confidence score between 0 and 1.

Returns

The normalized_confidence of this FieldValue.

Return type

float

property normalized_value

Gets the normalized_value of this FieldValue. The normalized value.

Returns

The normalized_value of this FieldValue.

Return type

str

property text

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

Returns

The text of this FieldValue.

Return type

str

property value

[Required] Gets the value of this ValuePhoneNumber. The phone number field value.

Returns

The value of this ValuePhoneNumber.

Return type

str

property 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

property 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]