DocumentField¶

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

Bases: object

Form field.

Attributes:

`FIELD_TYPE_KEY_VALUE`	A constant which can be used with the field_type property of a DocumentField.
`FIELD_TYPE_LINE_ITEM`	A constant which can be used with the field_type property of a DocumentField.
`FIELD_TYPE_LINE_ITEM_FIELD`	A constant which can be used with the field_type property of a DocumentField.
`FIELD_TYPE_LINE_ITEM_GROUP`	A constant which can be used with the field_type property of a DocumentField.
`field_label`	Gets the field_label of this DocumentField.
`field_name`	Gets the field_name of this DocumentField.
`field_type`	[Required] Gets the field_type of this DocumentField.
`field_value`	[Required] Gets the field_value of this DocumentField.

Methods:

__init__(**kwargs)

Initializes a new DocumentField object with values from keyword arguments.

FIELD_TYPE_KEY_VALUE = 'KEY_VALUE'¶: A constant which can be used with the field_type property of a DocumentField. This constant has a value of “KEY_VALUE”

FIELD_TYPE_LINE_ITEM = 'LINE_ITEM'¶: A constant which can be used with the field_type property of a DocumentField. This constant has a value of “LINE_ITEM”

FIELD_TYPE_LINE_ITEM_FIELD = 'LINE_ITEM_FIELD'¶: A constant which can be used with the field_type property of a DocumentField. This constant has a value of “LINE_ITEM_FIELD”

FIELD_TYPE_LINE_ITEM_GROUP = 'LINE_ITEM_GROUP'¶: A constant which can be used with the field_type property of a DocumentField. This constant has a value of “LINE_ITEM_GROUP”

__init__(**kwargs)¶

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

Parameters

field_type (str) – The value to assign to the field_type property of this DocumentField. Allowed values for this property are: “LINE_ITEM_GROUP”, “LINE_ITEM”, “LINE_ITEM_FIELD”, “KEY_VALUE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
field_label (oci.ai_document.models.FieldLabel) – The value to assign to the field_label property of this DocumentField.
field_name (oci.ai_document.models.FieldName) – The value to assign to the field_name property of this DocumentField.
field_value (oci.ai_document.models.FieldValue) – The value to assign to the field_value property of this DocumentField.

property field_label¶

Gets the field_label of this DocumentField.

Returns: The field_label of this DocumentField.
Return type: oci.ai_document.models.FieldLabel

property field_name¶

Gets the field_name of this DocumentField.

Returns: The field_name of this DocumentField.
Return type: oci.ai_document.models.FieldName

property field_type¶

[Required] Gets the field_type of this DocumentField. The field type.

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

Returns: The field_type of this DocumentField.
Return type: str

property field_value¶

[Required] Gets the field_value of this DocumentField.

Returns: The field_value of this DocumentField.
Return type: oci.ai_document.models.FieldValue