CreateDocumentJobDetails¶

class oci.ai_vision.models.CreateDocumentJobDetails(**kwargs)¶

Bases: object

The batch document analysis details.

Attributes

`DOCUMENT_TYPE_BANK_STATEMENT`	A constant which can be used with the document_type property of a CreateDocumentJobDetails.
`DOCUMENT_TYPE_CHECK`	A constant which can be used with the document_type property of a CreateDocumentJobDetails.
`DOCUMENT_TYPE_DRIVER_LICENSE`	A constant which can be used with the document_type property of a CreateDocumentJobDetails.
`DOCUMENT_TYPE_INVOICE`	A constant which can be used with the document_type property of a CreateDocumentJobDetails.
`DOCUMENT_TYPE_OTHERS`	A constant which can be used with the document_type property of a CreateDocumentJobDetails.
`DOCUMENT_TYPE_PASSPORT`	A constant which can be used with the document_type property of a CreateDocumentJobDetails.
`DOCUMENT_TYPE_PAYSLIP`	A constant which can be used with the document_type property of a CreateDocumentJobDetails.
`DOCUMENT_TYPE_RECEIPT`	A constant which can be used with the document_type property of a CreateDocumentJobDetails.
`DOCUMENT_TYPE_RESUME`	A constant which can be used with the document_type property of a CreateDocumentJobDetails.
`DOCUMENT_TYPE_TAX_FORM`	A constant which can be used with the document_type property of a CreateDocumentJobDetails.
`LANGUAGE_ARA`	A constant which can be used with the language property of a CreateDocumentJobDetails.
`LANGUAGE_CES`	A constant which can be used with the language property of a CreateDocumentJobDetails.
`LANGUAGE_CHI_SIM`	A constant which can be used with the language property of a CreateDocumentJobDetails.
`LANGUAGE_DAN`	A constant which can be used with the language property of a CreateDocumentJobDetails.
`LANGUAGE_DEU`	A constant which can be used with the language property of a CreateDocumentJobDetails.
`LANGUAGE_ELL`	A constant which can be used with the language property of a CreateDocumentJobDetails.
`LANGUAGE_ENG`	A constant which can be used with the language property of a CreateDocumentJobDetails.
`LANGUAGE_FIN`	A constant which can be used with the language property of a CreateDocumentJobDetails.
`LANGUAGE_FRA`	A constant which can be used with the language property of a CreateDocumentJobDetails.
`LANGUAGE_HIN`	A constant which can be used with the language property of a CreateDocumentJobDetails.
`LANGUAGE_HUN`	A constant which can be used with the language property of a CreateDocumentJobDetails.
`LANGUAGE_ITA`	A constant which can be used with the language property of a CreateDocumentJobDetails.
`LANGUAGE_JPN`	A constant which can be used with the language property of a CreateDocumentJobDetails.
`LANGUAGE_KOR`	A constant which can be used with the language property of a CreateDocumentJobDetails.
`LANGUAGE_NLD`	A constant which can be used with the language property of a CreateDocumentJobDetails.
`LANGUAGE_NOR`	A constant which can be used with the language property of a CreateDocumentJobDetails.
`LANGUAGE_OTHERS`	A constant which can be used with the language property of a CreateDocumentJobDetails.
`LANGUAGE_POL`	A constant which can be used with the language property of a CreateDocumentJobDetails.
`LANGUAGE_POR`	A constant which can be used with the language property of a CreateDocumentJobDetails.
`LANGUAGE_RON`	A constant which can be used with the language property of a CreateDocumentJobDetails.
`LANGUAGE_RUS`	A constant which can be used with the language property of a CreateDocumentJobDetails.
`LANGUAGE_SLK`	A constant which can be used with the language property of a CreateDocumentJobDetails.
`LANGUAGE_SPA`	A constant which can be used with the language property of a CreateDocumentJobDetails.
`LANGUAGE_SWE`	A constant which can be used with the language property of a CreateDocumentJobDetails.
`LANGUAGE_TUR`	A constant which can be used with the language property of a CreateDocumentJobDetails.
`compartment_id`	Gets the compartment_id of this CreateDocumentJobDetails.
`display_name`	Gets the display_name of this CreateDocumentJobDetails.
`document_type`	Gets the document_type of this CreateDocumentJobDetails.
`features`	[Required] Gets the features of this CreateDocumentJobDetails.
`input_location`	[Required] Gets the input_location of this CreateDocumentJobDetails.
`is_zip_output_enabled`	Gets the is_zip_output_enabled of this CreateDocumentJobDetails.
`language`	Gets the language of this CreateDocumentJobDetails.
`output_location`	[Required] Gets the output_location of this CreateDocumentJobDetails.

Methods

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

DOCUMENT_TYPE_BANK_STATEMENT = 'BANK_STATEMENT'¶: A constant which can be used with the document_type property of a CreateDocumentJobDetails. 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 CreateDocumentJobDetails. 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 CreateDocumentJobDetails. This constant has a value of “DRIVER_LICENSE”

DOCUMENT_TYPE_INVOICE = 'INVOICE'¶: A constant which can be used with the document_type property of a CreateDocumentJobDetails. This constant has a value of “INVOICE”

DOCUMENT_TYPE_OTHERS = 'OTHERS'¶: A constant which can be used with the document_type property of a CreateDocumentJobDetails. This constant has a value of “OTHERS”

DOCUMENT_TYPE_PASSPORT = 'PASSPORT'¶: A constant which can be used with the document_type property of a CreateDocumentJobDetails. This constant has a value of “PASSPORT”

DOCUMENT_TYPE_PAYSLIP = 'PAYSLIP'¶: A constant which can be used with the document_type property of a CreateDocumentJobDetails. This constant has a value of “PAYSLIP”

DOCUMENT_TYPE_RECEIPT = 'RECEIPT'¶: A constant which can be used with the document_type property of a CreateDocumentJobDetails. This constant has a value of “RECEIPT”

DOCUMENT_TYPE_RESUME = 'RESUME'¶: A constant which can be used with the document_type property of a CreateDocumentJobDetails. 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 CreateDocumentJobDetails. This constant has a value of “TAX_FORM”

LANGUAGE_ARA = 'ARA'¶: A constant which can be used with the language property of a CreateDocumentJobDetails. This constant has a value of “ARA”

LANGUAGE_CES = 'CES'¶: A constant which can be used with the language property of a CreateDocumentJobDetails. This constant has a value of “CES”

LANGUAGE_CHI_SIM = 'CHI_SIM'¶: A constant which can be used with the language property of a CreateDocumentJobDetails. This constant has a value of “CHI_SIM”

LANGUAGE_DAN = 'DAN'¶: A constant which can be used with the language property of a CreateDocumentJobDetails. This constant has a value of “DAN”

LANGUAGE_DEU = 'DEU'¶: A constant which can be used with the language property of a CreateDocumentJobDetails. This constant has a value of “DEU”

LANGUAGE_ELL = 'ELL'¶: A constant which can be used with the language property of a CreateDocumentJobDetails. This constant has a value of “ELL”

LANGUAGE_ENG = 'ENG'¶: A constant which can be used with the language property of a CreateDocumentJobDetails. This constant has a value of “ENG”

LANGUAGE_FIN = 'FIN'¶: A constant which can be used with the language property of a CreateDocumentJobDetails. This constant has a value of “FIN”

LANGUAGE_FRA = 'FRA'¶: A constant which can be used with the language property of a CreateDocumentJobDetails. This constant has a value of “FRA”

LANGUAGE_HIN = 'HIN'¶: A constant which can be used with the language property of a CreateDocumentJobDetails. This constant has a value of “HIN”

LANGUAGE_HUN = 'HUN'¶: A constant which can be used with the language property of a CreateDocumentJobDetails. This constant has a value of “HUN”

LANGUAGE_ITA = 'ITA'¶: A constant which can be used with the language property of a CreateDocumentJobDetails. This constant has a value of “ITA”

LANGUAGE_JPN = 'JPN'¶: A constant which can be used with the language property of a CreateDocumentJobDetails. This constant has a value of “JPN”

LANGUAGE_KOR = 'KOR'¶: A constant which can be used with the language property of a CreateDocumentJobDetails. This constant has a value of “KOR”

LANGUAGE_NLD = 'NLD'¶: A constant which can be used with the language property of a CreateDocumentJobDetails. This constant has a value of “NLD”

LANGUAGE_NOR = 'NOR'¶: A constant which can be used with the language property of a CreateDocumentJobDetails. This constant has a value of “NOR”

LANGUAGE_OTHERS = 'OTHERS'¶: A constant which can be used with the language property of a CreateDocumentJobDetails. This constant has a value of “OTHERS”

LANGUAGE_POL = 'POL'¶: A constant which can be used with the language property of a CreateDocumentJobDetails. This constant has a value of “POL”

LANGUAGE_POR = 'POR'¶: A constant which can be used with the language property of a CreateDocumentJobDetails. This constant has a value of “POR”

LANGUAGE_RON = 'RON'¶: A constant which can be used with the language property of a CreateDocumentJobDetails. This constant has a value of “RON”

LANGUAGE_RUS = 'RUS'¶: A constant which can be used with the language property of a CreateDocumentJobDetails. This constant has a value of “RUS”

LANGUAGE_SLK = 'SLK'¶: A constant which can be used with the language property of a CreateDocumentJobDetails. This constant has a value of “SLK”

LANGUAGE_SPA = 'SPA'¶: A constant which can be used with the language property of a CreateDocumentJobDetails. This constant has a value of “SPA”

LANGUAGE_SWE = 'SWE'¶: A constant which can be used with the language property of a CreateDocumentJobDetails. This constant has a value of “SWE”

LANGUAGE_TUR = 'TUR'¶: A constant which can be used with the language property of a CreateDocumentJobDetails. This constant has a value of “TUR”

__init__(**kwargs)¶

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

Parameters:

input_location (oci.ai_vision.models.InputLocation) – The value to assign to the input_location property of this CreateDocumentJobDetails.
features (list[oci.ai_vision.models.DocumentFeature]) – The value to assign to the features property of this CreateDocumentJobDetails.
output_location (oci.ai_vision.models.OutputLocation) – The value to assign to the output_location property of this CreateDocumentJobDetails.
compartment_id (str) – The value to assign to the compartment_id property of this CreateDocumentJobDetails.
display_name (str) – The value to assign to the display_name property of this CreateDocumentJobDetails.
language (str) – The value to assign to the language property of this CreateDocumentJobDetails. Allowed values for this property are: “ENG”, “CES”, “DAN”, “NLD”, “FIN”, “FRA”, “DEU”, “ELL”, “HUN”, “ITA”, “NOR”, “POL”, “POR”, “RON”, “RUS”, “SLK”, “SPA”, “SWE”, “TUR”, “ARA”, “CHI_SIM”, “HIN”, “JPN”, “KOR”, “OTHERS”
document_type (str) – The value to assign to the document_type property of this CreateDocumentJobDetails. Allowed values for this property are: “INVOICE”, “RECEIPT”, “RESUME”, “TAX_FORM”, “DRIVER_LICENSE”, “PASSPORT”, “BANK_STATEMENT”, “CHECK”, “PAYSLIP”, “OTHERS”
is_zip_output_enabled (bool) – The value to assign to the is_zip_output_enabled property of this CreateDocumentJobDetails.

compartment_id¶

Gets the compartment_id of this CreateDocumentJobDetails. The compartment identifier from the requester.

Returns:	The compartment_id of this CreateDocumentJobDetails.
Return type:	str

display_name¶

Gets the display_name of this CreateDocumentJobDetails. The document job display name.

Returns:	The display_name of this CreateDocumentJobDetails.
Return type:	str

document_type¶

Gets the document_type of this CreateDocumentJobDetails. The type of documents.

Allowed values for this property are: “INVOICE”, “RECEIPT”, “RESUME”, “TAX_FORM”, “DRIVER_LICENSE”, “PASSPORT”, “BANK_STATEMENT”, “CHECK”, “PAYSLIP”, “OTHERS”

Returns:	The document_type of this CreateDocumentJobDetails.
Return type:	str

features¶

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

Returns:	The features of this CreateDocumentJobDetails.
Return type:	list[oci.ai_vision.models.DocumentFeature]

input_location¶

[Required] Gets the input_location of this CreateDocumentJobDetails.

Returns:	The input_location of this CreateDocumentJobDetails.
Return type:	oci.ai_vision.models.InputLocation

is_zip_output_enabled¶

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

Returns:	The is_zip_output_enabled of this CreateDocumentJobDetails.
Return type:	bool

language¶

Gets the language of this CreateDocumentJobDetails. The language of the document, abbreviated according to ISO 639-2.

Allowed values for this property are: “ENG”, “CES”, “DAN”, “NLD”, “FIN”, “FRA”, “DEU”, “ELL”, “HUN”, “ITA”, “NOR”, “POL”, “POR”, “RON”, “RUS”, “SLK”, “SPA”, “SWE”, “TUR”, “ARA”, “CHI_SIM”, “HIN”, “JPN”, “KOR”, “OTHERS”

Returns:	The language of this CreateDocumentJobDetails.
Return type:	str

output_location¶

[Required] Gets the output_location of this CreateDocumentJobDetails.

Returns:	The output_location of this CreateDocumentJobDetails.
Return type:	oci.ai_vision.models.OutputLocation