KvModelSubType

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

Bases: oci.ai_document.models.model_sub_type.ModelSubType

The Kv model sub type

Attributes

MODEL_SUB_TYPE_DRIVER_LICENSE A constant which can be used with the model_sub_type property of a KvModelSubType.
MODEL_SUB_TYPE_HEALTH_INSURANCE_ID A constant which can be used with the model_sub_type property of a KvModelSubType.
MODEL_SUB_TYPE_INVOICE A constant which can be used with the model_sub_type property of a KvModelSubType.
MODEL_SUB_TYPE_PASSPORT A constant which can be used with the model_sub_type property of a KvModelSubType.
MODEL_SUB_TYPE_RECEIPT A constant which can be used with the model_sub_type property of a KvModelSubType.
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 KvModelSubType.
model_type [Required] Gets the model_type of this ModelSubType.

Methods

__init__(**kwargs) Initializes a new KvModelSubType 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_DRIVER_LICENSE = 'DRIVER_LICENSE'

A constant which can be used with the model_sub_type property of a KvModelSubType. This constant has a value of “DRIVER_LICENSE”

MODEL_SUB_TYPE_HEALTH_INSURANCE_ID = 'HEALTH_INSURANCE_ID'

A constant which can be used with the model_sub_type property of a KvModelSubType. This constant has a value of “HEALTH_INSURANCE_ID”

MODEL_SUB_TYPE_INVOICE = 'INVOICE'

A constant which can be used with the model_sub_type property of a KvModelSubType. This constant has a value of “INVOICE”

MODEL_SUB_TYPE_PASSPORT = 'PASSPORT'

A constant which can be used with the model_sub_type property of a KvModelSubType. This constant has a value of “PASSPORT”

MODEL_SUB_TYPE_RECEIPT = 'RECEIPT'

A constant which can be used with the model_sub_type property of a KvModelSubType. This constant has a value of “RECEIPT”

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 KvModelSubType object with values from keyword arguments. The default value of the model_type attribute of this class is PRE_TRAINED_KEY_VALUE_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 KvModelSubType. 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 KvModelSubType. Allowed values for this property are: “RECEIPT”, “INVOICE”, “PASSPORT”, “DRIVER_LICENSE”, “HEALTH_INSURANCE_ID”, ‘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 KvModelSubType. The model sub type for KEY_VALUE_EXTRACTION The allowed values are: - RECEIPT - INVOICE - PASSPORT - DRIVER_LICENSE - HEALTH_INSURANCE_ID

Allowed values for this property are: “RECEIPT”, “INVOICE”, “PASSPORT”, “DRIVER_LICENSE”, “HEALTH_INSURANCE_ID”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:The model_sub_type of this KvModelSubType.
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