AnalyzeDocumentDetails

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

Bases: object

The details of how to analyze a document.

Attributes:

DOCUMENT_TYPE_BANK_STATEMENT	A constant which can be used with the document_type property of a AnalyzeDocumentDetails.
DOCUMENT_TYPE_CHECK	A constant which can be used with the document_type property of a AnalyzeDocumentDetails.
DOCUMENT_TYPE_DRIVER_LICENSE	A constant which can be used with the document_type property of a AnalyzeDocumentDetails.
DOCUMENT_TYPE_HEALTH_INSURANCE_ID	A constant which can be used with the document_type property of a AnalyzeDocumentDetails.
DOCUMENT_TYPE_INVOICE	A constant which can be used with the document_type property of a AnalyzeDocumentDetails.
DOCUMENT_TYPE_OTHERS	A constant which can be used with the document_type property of a AnalyzeDocumentDetails.
DOCUMENT_TYPE_PASSPORT	A constant which can be used with the document_type property of a AnalyzeDocumentDetails.
DOCUMENT_TYPE_PAYSLIP	A constant which can be used with the document_type property of a AnalyzeDocumentDetails.
DOCUMENT_TYPE_RECEIPT	A constant which can be used with the document_type property of a AnalyzeDocumentDetails.
DOCUMENT_TYPE_RESUME	A constant which can be used with the document_type property of a AnalyzeDocumentDetails.
DOCUMENT_TYPE_TAX_FORM	A constant which can be used with the document_type property of a AnalyzeDocumentDetails.
compartment_id	Gets the compartment_id of this AnalyzeDocumentDetails.
document	[Required] Gets the document of this AnalyzeDocumentDetails.
document_type	Gets the document_type of this AnalyzeDocumentDetails.
features	[Required] Gets the features of this AnalyzeDocumentDetails.
language	Gets the language of this AnalyzeDocumentDetails.
ocr_data	Gets the ocr_data of this AnalyzeDocumentDetails.
output_location	Gets the output_location of this AnalyzeDocumentDetails.

Methods:

__init__(**kwargs)

Initializes a new AnalyzeDocumentDetails 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 AnalyzeDocumentDetails. 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 AnalyzeDocumentDetails. 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 AnalyzeDocumentDetails. 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 AnalyzeDocumentDetails. 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 AnalyzeDocumentDetails. This constant has a value of “INVOICE”

DOCUMENT_TYPE_OTHERS = 'OTHERS'

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

DOCUMENT_TYPE_PASSPORT = 'PASSPORT'

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

DOCUMENT_TYPE_PAYSLIP = 'PAYSLIP'

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

DOCUMENT_TYPE_RECEIPT = 'RECEIPT'

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

DOCUMENT_TYPE_RESUME = 'RESUME'

A constant which can be used with the document_type property of a AnalyzeDocumentDetails. 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 AnalyzeDocumentDetails. This constant has a value of “TAX_FORM”

__init__(**kwargs)

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

Parameters

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

• document (oci.ai_document.models.DocumentDetails) – The value to assign to the document property of this AnalyzeDocumentDetails.

• compartment_id (str) – The value to assign to the compartment_id property of this AnalyzeDocumentDetails.

• output_location (oci.ai_document.models.OutputLocation) – The value to assign to the output_location property of this AnalyzeDocumentDetails.

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

• document_type (str) – The value to assign to the document_type property of this AnalyzeDocumentDetails. Allowed values for this property are: “INVOICE”, “RECEIPT”, “RESUME”, “TAX_FORM”, “DRIVER_LICENSE”, “PASSPORT”, “BANK_STATEMENT”, “CHECK”, “PAYSLIP”, “OTHERS”, “HEALTH_INSURANCE_ID”

• ocr_data (oci.ai_document.models.AnalyzeDocumentResult) – The value to assign to the ocr_data property of this AnalyzeDocumentDetails.

property compartment_id

Gets the compartment_id of this AnalyzeDocumentDetails. The compartment identifier.

Returns

The compartment_id of this AnalyzeDocumentDetails.

Return type

str

property document

[Required] Gets the document of this AnalyzeDocumentDetails.

Returns

The document of this AnalyzeDocumentDetails.

Return type

oci.ai_document.models.DocumentDetails

property document_type

Gets the document_type of this AnalyzeDocumentDetails. 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”

Returns

The document_type of this AnalyzeDocumentDetails.

Return type

str

property features

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

Returns

The features of this AnalyzeDocumentDetails.

Return type

list[oci.ai_document.models.DocumentFeature]

property language

Gets the language of this AnalyzeDocumentDetails. The document language, abbreviated according to the BCP 47 syntax.

Returns

The language of this AnalyzeDocumentDetails.

Return type

str

property ocr_data

Gets the ocr_data of this AnalyzeDocumentDetails.

Returns

The ocr_data of this AnalyzeDocumentDetails.

Return type

oci.ai_document.models.AnalyzeDocumentResult

property output_location

Gets the output_location of this AnalyzeDocumentDetails.

Returns

The output_location of this AnalyzeDocumentDetails.

Return type

oci.ai_document.models.OutputLocation