GeneralProcessorConfig

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

Bases: ProcessorConfig

The configuration of a general processor.

Attributes:

DOCUMENT_TYPE_BANK_STATEMENT	A constant which can be used with the document_type property of a GeneralProcessorConfig.
DOCUMENT_TYPE_CHECK	A constant which can be used with the document_type property of a GeneralProcessorConfig.
DOCUMENT_TYPE_DRIVER_LICENSE	A constant which can be used with the document_type property of a GeneralProcessorConfig.
DOCUMENT_TYPE_HEALTH_INSURANCE_ID	A constant which can be used with the document_type property of a GeneralProcessorConfig.
DOCUMENT_TYPE_INVOICE	A constant which can be used with the document_type property of a GeneralProcessorConfig.
DOCUMENT_TYPE_OTHERS	A constant which can be used with the document_type property of a GeneralProcessorConfig.
DOCUMENT_TYPE_PASSPORT	A constant which can be used with the document_type property of a GeneralProcessorConfig.
DOCUMENT_TYPE_PAYSLIP	A constant which can be used with the document_type property of a GeneralProcessorConfig.
DOCUMENT_TYPE_RECEIPT	A constant which can be used with the document_type property of a GeneralProcessorConfig.
DOCUMENT_TYPE_RESUME	A constant which can be used with the document_type property of a GeneralProcessorConfig.
DOCUMENT_TYPE_TAX_FORM	A constant which can be used with the document_type property of a GeneralProcessorConfig.
PROCESSOR_TYPE_GENERAL	A constant which can be used with the processor_type property of a ProcessorConfig.
PROCESSOR_TYPE_INVOICE	A constant which can be used with the processor_type property of a ProcessorConfig.
document_type	Gets the document_type of this GeneralProcessorConfig.
features	[Required] Gets the features of this GeneralProcessorConfig.
is_zip_output_enabled	Gets the is_zip_output_enabled of this GeneralProcessorConfig.
language	Gets the language of this GeneralProcessorConfig.
processor_type	[Required] Gets the processor_type of this ProcessorConfig.

Methods:

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

DOCUMENT_TYPE_BANK_STATEMENT = 'BANK_STATEMENT'

A constant which can be used with the document_type property of a GeneralProcessorConfig. This constant has a value of “BANK_STATEMENT”

DOCUMENT_TYPE_CHECK = 'CHECK'

A constant which can be used with the document_type property of a GeneralProcessorConfig. This constant has a value of “CHECK”

DOCUMENT_TYPE_DRIVER_LICENSE = 'DRIVER_LICENSE'

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

DOCUMENT_TYPE_HEALTH_INSURANCE_ID = 'HEALTH_INSURANCE_ID'

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

DOCUMENT_TYPE_INVOICE = 'INVOICE'

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

DOCUMENT_TYPE_OTHERS = 'OTHERS'

A constant which can be used with the document_type property of a GeneralProcessorConfig. This constant has a value of “OTHERS”

DOCUMENT_TYPE_PASSPORT = 'PASSPORT'

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

DOCUMENT_TYPE_PAYSLIP = 'PAYSLIP'

A constant which can be used with the document_type property of a GeneralProcessorConfig. This constant has a value of “PAYSLIP”

DOCUMENT_TYPE_RECEIPT = 'RECEIPT'

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

DOCUMENT_TYPE_RESUME = 'RESUME'

A constant which can be used with the document_type property of a GeneralProcessorConfig. This constant has a value of “RESUME”

DOCUMENT_TYPE_TAX_FORM = 'TAX_FORM'

A constant which can be used with the document_type property of a GeneralProcessorConfig. This constant has a value of “TAX_FORM”

PROCESSOR_TYPE_GENERAL = 'GENERAL'

A constant which can be used with the processor_type property of a ProcessorConfig. This constant has a value of “GENERAL”

PROCESSOR_TYPE_INVOICE = 'INVOICE'

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

__init__(**kwargs)

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

Parameters

• processor_type (str) – The value to assign to the processor_type property of this GeneralProcessorConfig. Allowed values for this property are: “GENERAL”, “INVOICE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

• document_type (str) – The value to assign to the document_type property of this GeneralProcessorConfig. Allowed values for this property are: “INVOICE”, “RECEIPT”, “RESUME”, “TAX_FORM”, “DRIVER_LICENSE”, “PASSPORT”, “BANK_STATEMENT”, “CHECK”, “PAYSLIP”, “OTHERS”, “HEALTH_INSURANCE_ID”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

• features (list[oci.ai_document.models.DocumentFeature]) – The value to assign to the features property of this GeneralProcessorConfig.

• is_zip_output_enabled (bool) – The value to assign to the is_zip_output_enabled property of this GeneralProcessorConfig.

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

property document_type

Gets the document_type of this GeneralProcessorConfig. The document type.

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

Returns

The document_type of this GeneralProcessorConfig.

Return type

str

property features

[Required] Gets the features of this GeneralProcessorConfig. The types of document analysis requested.

Returns

The features of this GeneralProcessorConfig.

Return type

list[oci.ai_document.models.DocumentFeature]

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 is_zip_output_enabled

Gets the is_zip_output_enabled of this GeneralProcessorConfig. Whether or not to generate a ZIP file containing the results.

Returns

The is_zip_output_enabled of this GeneralProcessorConfig.

Return type

bool

property language

Gets the language of this GeneralProcessorConfig. The document language, abbreviated according to the BCP 47 Language-Tag syntax.

Returns

The language of this GeneralProcessorConfig.

Return type

str

property processor_type

[Required] Gets the processor_type of this ProcessorConfig. The type of the processor.

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

Returns

The processor_type of this ProcessorConfig.

Return type

str