DocumentElementsSubType¶

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

Bases: oci.ai_document.models.model_sub_type.ModelSubType

The Document Elements Extraction model sub type

Attributes

`MODEL_SUB_TYPE_QR_BAR_CODE`	A constant which can be used with the model_sub_type property of a DocumentElementsSubType.
`MODEL_SUB_TYPE_SIGNATURE`	A constant which can be used with the model_sub_type property of a DocumentElementsSubType.
`MODEL_TYPE_PRE_TRAINED_DOCUMENT_ELEMENTS_EXTRACTION`	str(object=’’) -> str
`MODEL_TYPE_PRE_TRAINED_KEY_VALUE_EXTRACTION`	str(object=’’) -> str
`model_sub_type`	[Required] Gets the model_sub_type of this DocumentElementsSubType.
`model_type`	[Required] Gets the model_type of this ModelSubType.

Methods

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

MODEL_SUB_TYPE_QR_BAR_CODE = 'QR_BAR_CODE'¶: A constant which can be used with the model_sub_type property of a DocumentElementsSubType. This constant has a value of “QR_BAR_CODE”

MODEL_SUB_TYPE_SIGNATURE = 'SIGNATURE'¶: A constant which can be used with the model_sub_type property of a DocumentElementsSubType. This constant has a value of “SIGNATURE”

MODEL_TYPE_PRE_TRAINED_DOCUMENT_ELEMENTS_EXTRACTION = 'PRE_TRAINED_DOCUMENT_ELEMENTS_EXTRACTION'¶

MODEL_TYPE_PRE_TRAINED_KEY_VALUE_EXTRACTION = 'PRE_TRAINED_KEY_VALUE_EXTRACTION'¶

__init__(**kwargs)¶

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

Parameters:

model_type (str) – The value to assign to the model_type property of this DocumentElementsSubType. Allowed values for this property are: “PRE_TRAINED_KEY_VALUE_EXTRACTION”, “PRE_TRAINED_DOCUMENT_ELEMENTS_EXTRACTION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
model_sub_type (str) – The value to assign to the model_sub_type property of this DocumentElementsSubType. Allowed values for this property are: “QR_BAR_CODE”, “SIGNATURE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

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.

model_sub_type¶

[Required] Gets the model_sub_type of this DocumentElementsSubType. The model sub type for DOCUMENT_ELEMENTS_EXTRACTION. The allowed values are:

QR_BAR_CODE

SIGNATURE

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

Returns:	The model_sub_type of this DocumentElementsSubType.
Return type:	str

model_type¶

[Required] Gets the model_type of this ModelSubType. Sub type model based on the model type. The allowed values are: - PRE_TRAINED_KEY_VALUE_EXTRACTION - PRE_TRAINED_DOCUMENT_ELEMENTS_EXTRACTION

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

Returns:	The model_type of this ModelSubType.
Return type:	str