FieldName¶

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

Bases: object

The name of a form field.

Methods

__init__(**kwargs) Initializes a new FieldName object with values from keyword arguments.

Attributes

`bounding_polygon`	Gets the bounding_polygon of this FieldName.
`confidence`	Gets the confidence of this FieldName.
`name`	[Required] Gets the name of this FieldName.
`word_indexes`	Gets the word_indexes of this FieldName.

__init__(**kwargs)¶

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

Parameters:

name (str) – The value to assign to the name property of this FieldName.
confidence (float) – The value to assign to the confidence property of this FieldName.
bounding_polygon (oci.ai_document.models.BoundingPolygon) – The value to assign to the bounding_polygon property of this FieldName.
word_indexes (list[int]) – The value to assign to the word_indexes property of this FieldName.

bounding_polygon¶

Gets the bounding_polygon of this FieldName.

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

confidence¶

Gets the confidence of this FieldName. The confidence score between 0 and 1.

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

name¶

[Required] Gets the name of this FieldName. The name of the field.

Returns:	The name of this FieldName.
Return type:	str

word_indexes¶

Gets the word_indexes of this FieldName. The indexes of the words in the field name.

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