DocumentJob¶
- class oci.ai_vision.models.DocumentJob(**kwargs)¶
Bases:
objectThe job details for a batch document analysis.
Attributes:
A constant which can be used with the document_type property of a DocumentJob.
A constant which can be used with the document_type property of a DocumentJob.
A constant which can be used with the document_type property of a DocumentJob.
A constant which can be used with the document_type property of a DocumentJob.
A constant which can be used with the document_type property of a DocumentJob.
A constant which can be used with the document_type property of a DocumentJob.
A constant which can be used with the document_type property of a DocumentJob.
A constant which can be used with the document_type property of a DocumentJob.
A constant which can be used with the document_type property of a DocumentJob.
A constant which can be used with the document_type property of a DocumentJob.
A constant which can be used with the language property of a DocumentJob.
A constant which can be used with the language property of a DocumentJob.
A constant which can be used with the language property of a DocumentJob.
A constant which can be used with the language property of a DocumentJob.
A constant which can be used with the language property of a DocumentJob.
A constant which can be used with the language property of a DocumentJob.
A constant which can be used with the language property of a DocumentJob.
A constant which can be used with the language property of a DocumentJob.
A constant which can be used with the language property of a DocumentJob.
A constant which can be used with the language property of a DocumentJob.
A constant which can be used with the language property of a DocumentJob.
A constant which can be used with the language property of a DocumentJob.
A constant which can be used with the language property of a DocumentJob.
A constant which can be used with the language property of a DocumentJob.
A constant which can be used with the language property of a DocumentJob.
A constant which can be used with the language property of a DocumentJob.
A constant which can be used with the language property of a DocumentJob.
A constant which can be used with the language property of a DocumentJob.
A constant which can be used with the language property of a DocumentJob.
A constant which can be used with the language property of a DocumentJob.
A constant which can be used with the language property of a DocumentJob.
A constant which can be used with the language property of a DocumentJob.
A constant which can be used with the language property of a DocumentJob.
A constant which can be used with the language property of a DocumentJob.
A constant which can be used with the language property of a DocumentJob.
A constant which can be used with the lifecycle_details property of a DocumentJob.
A constant which can be used with the lifecycle_details property of a DocumentJob.
A constant which can be used with the lifecycle_state property of a DocumentJob.
A constant which can be used with the lifecycle_state property of a DocumentJob.
A constant which can be used with the lifecycle_state property of a DocumentJob.
A constant which can be used with the lifecycle_state property of a DocumentJob.
A constant which can be used with the lifecycle_state property of a DocumentJob.
A constant which can be used with the lifecycle_state property of a DocumentJob.
[Required] Gets the compartment_id of this DocumentJob.
Gets the display_name of this DocumentJob.
Gets the document_type of this DocumentJob.
[Required] Gets the features of this DocumentJob.
[Required] Gets the id of this DocumentJob.
Gets the input_location of this DocumentJob.
Gets the is_zip_output_enabled of this DocumentJob.
Gets the language of this DocumentJob.
Gets the lifecycle_details of this DocumentJob.
[Required] Gets the lifecycle_state of this DocumentJob.
[Required] Gets the output_location of this DocumentJob.
Gets the percent_complete of this DocumentJob.
[Required] Gets the time_accepted of this DocumentJob.
Gets the time_finished of this DocumentJob.
Gets the time_started of this DocumentJob.
Methods:
__init__(**kwargs)Initializes a new DocumentJob 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 DocumentJob. 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 DocumentJob. 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 DocumentJob. 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 DocumentJob. This constant has a value of “INVOICE”
- DOCUMENT_TYPE_OTHERS = 'OTHERS'¶
A constant which can be used with the document_type property of a DocumentJob. This constant has a value of “OTHERS”
- DOCUMENT_TYPE_PASSPORT = 'PASSPORT'¶
A constant which can be used with the document_type property of a DocumentJob. This constant has a value of “PASSPORT”
- DOCUMENT_TYPE_PAYSLIP = 'PAYSLIP'¶
A constant which can be used with the document_type property of a DocumentJob. This constant has a value of “PAYSLIP”
- DOCUMENT_TYPE_RECEIPT = 'RECEIPT'¶
A constant which can be used with the document_type property of a DocumentJob. This constant has a value of “RECEIPT”
- DOCUMENT_TYPE_RESUME = 'RESUME'¶
A constant which can be used with the document_type property of a DocumentJob. 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 DocumentJob. This constant has a value of “TAX_FORM”
- LANGUAGE_ARA = 'ARA'¶
A constant which can be used with the language property of a DocumentJob. This constant has a value of “ARA”
- LANGUAGE_CES = 'CES'¶
A constant which can be used with the language property of a DocumentJob. This constant has a value of “CES”
- LANGUAGE_CHI_SIM = 'CHI_SIM'¶
A constant which can be used with the language property of a DocumentJob. This constant has a value of “CHI_SIM”
- LANGUAGE_DAN = 'DAN'¶
A constant which can be used with the language property of a DocumentJob. This constant has a value of “DAN”
- LANGUAGE_DEU = 'DEU'¶
A constant which can be used with the language property of a DocumentJob. This constant has a value of “DEU”
- LANGUAGE_ELL = 'ELL'¶
A constant which can be used with the language property of a DocumentJob. This constant has a value of “ELL”
- LANGUAGE_ENG = 'ENG'¶
A constant which can be used with the language property of a DocumentJob. This constant has a value of “ENG”
- LANGUAGE_FIN = 'FIN'¶
A constant which can be used with the language property of a DocumentJob. This constant has a value of “FIN”
- LANGUAGE_FRA = 'FRA'¶
A constant which can be used with the language property of a DocumentJob. This constant has a value of “FRA”
- LANGUAGE_HIN = 'HIN'¶
A constant which can be used with the language property of a DocumentJob. This constant has a value of “HIN”
- LANGUAGE_HUN = 'HUN'¶
A constant which can be used with the language property of a DocumentJob. This constant has a value of “HUN”
- LANGUAGE_ITA = 'ITA'¶
A constant which can be used with the language property of a DocumentJob. This constant has a value of “ITA”
- LANGUAGE_JPN = 'JPN'¶
A constant which can be used with the language property of a DocumentJob. This constant has a value of “JPN”
- LANGUAGE_KOR = 'KOR'¶
A constant which can be used with the language property of a DocumentJob. This constant has a value of “KOR”
- LANGUAGE_NLD = 'NLD'¶
A constant which can be used with the language property of a DocumentJob. This constant has a value of “NLD”
- LANGUAGE_NOR = 'NOR'¶
A constant which can be used with the language property of a DocumentJob. This constant has a value of “NOR”
- LANGUAGE_OTHERS = 'OTHERS'¶
A constant which can be used with the language property of a DocumentJob. This constant has a value of “OTHERS”
- LANGUAGE_POL = 'POL'¶
A constant which can be used with the language property of a DocumentJob. This constant has a value of “POL”
- LANGUAGE_POR = 'POR'¶
A constant which can be used with the language property of a DocumentJob. This constant has a value of “POR”
- LANGUAGE_RON = 'RON'¶
A constant which can be used with the language property of a DocumentJob. This constant has a value of “RON”
- LANGUAGE_RUS = 'RUS'¶
A constant which can be used with the language property of a DocumentJob. This constant has a value of “RUS”
- LANGUAGE_SLK = 'SLK'¶
A constant which can be used with the language property of a DocumentJob. This constant has a value of “SLK”
- LANGUAGE_SPA = 'SPA'¶
A constant which can be used with the language property of a DocumentJob. This constant has a value of “SPA”
- LANGUAGE_SWE = 'SWE'¶
A constant which can be used with the language property of a DocumentJob. This constant has a value of “SWE”
- LANGUAGE_TUR = 'TUR'¶
A constant which can be used with the language property of a DocumentJob. This constant has a value of “TUR”
- LIFECYCLE_DETAILS_COMPLETELY_FAILED = 'COMPLETELY_FAILED'¶
A constant which can be used with the lifecycle_details property of a DocumentJob. This constant has a value of “COMPLETELY_FAILED”
- LIFECYCLE_DETAILS_PARTIALLY_SUCCEEDED = 'PARTIALLY_SUCCEEDED'¶
A constant which can be used with the lifecycle_details property of a DocumentJob. This constant has a value of “PARTIALLY_SUCCEEDED”
- LIFECYCLE_STATE_ACCEPTED = 'ACCEPTED'¶
A constant which can be used with the lifecycle_state property of a DocumentJob. This constant has a value of “ACCEPTED”
- LIFECYCLE_STATE_CANCELED = 'CANCELED'¶
A constant which can be used with the lifecycle_state property of a DocumentJob. This constant has a value of “CANCELED”
- LIFECYCLE_STATE_CANCELING = 'CANCELING'¶
A constant which can be used with the lifecycle_state property of a DocumentJob. This constant has a value of “CANCELING”
- LIFECYCLE_STATE_FAILED = 'FAILED'¶
A constant which can be used with the lifecycle_state property of a DocumentJob. This constant has a value of “FAILED”
- LIFECYCLE_STATE_IN_PROGRESS = 'IN_PROGRESS'¶
A constant which can be used with the lifecycle_state property of a DocumentJob. This constant has a value of “IN_PROGRESS”
- LIFECYCLE_STATE_SUCCEEDED = 'SUCCEEDED'¶
A constant which can be used with the lifecycle_state property of a DocumentJob. This constant has a value of “SUCCEEDED”
- __init__(**kwargs)¶
Initializes a new DocumentJob object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):
- Parameters
id (str) – The value to assign to the id property of this DocumentJob.
compartment_id (str) – The value to assign to the compartment_id property of this DocumentJob.
display_name (str) – The value to assign to the display_name property of this DocumentJob.
features (list[oci.ai_vision.models.DocumentFeature]) – The value to assign to the features property of this DocumentJob.
language (str) – The value to assign to the language property of this DocumentJob. 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”, ‘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 DocumentJob. Allowed values for this property are: “INVOICE”, “RECEIPT”, “RESUME”, “TAX_FORM”, “DRIVER_LICENSE”, “PASSPORT”, “BANK_STATEMENT”, “CHECK”, “PAYSLIP”, “OTHERS”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
input_location (oci.ai_vision.models.InputLocation) – The value to assign to the input_location property of this DocumentJob.
time_accepted (datetime) – The value to assign to the time_accepted property of this DocumentJob.
time_started (datetime) – The value to assign to the time_started property of this DocumentJob.
time_finished (datetime) – The value to assign to the time_finished property of this DocumentJob.
percent_complete (float) – The value to assign to the percent_complete property of this DocumentJob.
output_location (oci.ai_vision.models.OutputLocation) – The value to assign to the output_location property of this DocumentJob.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this DocumentJob. Allowed values for this property are: “SUCCEEDED”, “FAILED”, “ACCEPTED”, “CANCELED”, “IN_PROGRESS”, “CANCELING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
is_zip_output_enabled (bool) – The value to assign to the is_zip_output_enabled property of this DocumentJob.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this DocumentJob. Allowed values for this property are: “PARTIALLY_SUCCEEDED”, “COMPLETELY_FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- property compartment_id¶
[Required] Gets the compartment_id of this DocumentJob. The OCID of the compartment that starts the job.
- Returns
The compartment_id of this DocumentJob.
- Return type
str
- property display_name¶
Gets the display_name of this DocumentJob. The document job display name.
- Returns
The display_name of this DocumentJob.
- Return type
str
- property document_type¶
Gets the document_type of this DocumentJob. The type of document.
Allowed values for this property are: “INVOICE”, “RECEIPT”, “RESUME”, “TAX_FORM”, “DRIVER_LICENSE”, “PASSPORT”, “BANK_STATEMENT”, “CHECK”, “PAYSLIP”, “OTHERS”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The document_type of this DocumentJob.
- Return type
str
- property features¶
[Required] Gets the features of this DocumentJob. The list of requested document analysis types.
- Returns
The features of this DocumentJob.
- Return type
- property id¶
[Required] Gets the id of this DocumentJob. The job id.
- Returns
The id of this DocumentJob.
- Return type
str
- property input_location¶
Gets the input_location of this DocumentJob.
- Returns
The input_location of this DocumentJob.
- Return type
- property is_zip_output_enabled¶
Gets the is_zip_output_enabled of this DocumentJob. Whether or not to generate a ZIP file containing the results.
- Returns
The is_zip_output_enabled of this DocumentJob.
- Return type
bool
- property language¶
Gets the language of this DocumentJob. The document language, 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”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The language of this DocumentJob.
- Return type
str
- property lifecycle_details¶
Gets the lifecycle_details of this DocumentJob. The detailed status of FAILED state.
Allowed values for this property are: “PARTIALLY_SUCCEEDED”, “COMPLETELY_FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The lifecycle_details of this DocumentJob.
- Return type
str
- property lifecycle_state¶
[Required] Gets the lifecycle_state of this DocumentJob. The current state of the batch document job.
Allowed values for this property are: “SUCCEEDED”, “FAILED”, “ACCEPTED”, “CANCELED”, “IN_PROGRESS”, “CANCELING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The lifecycle_state of this DocumentJob.
- Return type
str
- property output_location¶
[Required] Gets the output_location of this DocumentJob.
- Returns
The output_location of this DocumentJob.
- Return type
- property percent_complete¶
Gets the percent_complete of this DocumentJob. How much progress the operation has made, compared to the total amount of work to be performed.
- Returns
The percent_complete of this DocumentJob.
- Return type
float
- property time_accepted¶
[Required] Gets the time_accepted of this DocumentJob. The job acceptance time.
- Returns
The time_accepted of this DocumentJob.
- Return type
datetime
- property time_finished¶
Gets the time_finished of this DocumentJob. The job finish time.
- Returns
The time_finished of this DocumentJob.
- Return type
datetime
- property time_started¶
Gets the time_started of this DocumentJob. The job start time.
- Returns
The time_started of this DocumentJob.
- Return type
datetime