AnalyzeDocumentDetails

class oci.ai_vision.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_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.

LANGUAGE_ARA

A constant which can be used with the language property of a AnalyzeDocumentDetails.

LANGUAGE_CES

A constant which can be used with the language property of a AnalyzeDocumentDetails.

LANGUAGE_CHI_SIM

A constant which can be used with the language property of a AnalyzeDocumentDetails.

LANGUAGE_DAN

A constant which can be used with the language property of a AnalyzeDocumentDetails.

LANGUAGE_DEU

A constant which can be used with the language property of a AnalyzeDocumentDetails.

LANGUAGE_ELL

A constant which can be used with the language property of a AnalyzeDocumentDetails.

LANGUAGE_ENG

A constant which can be used with the language property of a AnalyzeDocumentDetails.

LANGUAGE_FIN

A constant which can be used with the language property of a AnalyzeDocumentDetails.

LANGUAGE_FRA

A constant which can be used with the language property of a AnalyzeDocumentDetails.

LANGUAGE_HIN

A constant which can be used with the language property of a AnalyzeDocumentDetails.

LANGUAGE_HUN

A constant which can be used with the language property of a AnalyzeDocumentDetails.

LANGUAGE_ITA

A constant which can be used with the language property of a AnalyzeDocumentDetails.

LANGUAGE_JPN

A constant which can be used with the language property of a AnalyzeDocumentDetails.

LANGUAGE_KOR

A constant which can be used with the language property of a AnalyzeDocumentDetails.

LANGUAGE_NLD

A constant which can be used with the language property of a AnalyzeDocumentDetails.

LANGUAGE_NOR

A constant which can be used with the language property of a AnalyzeDocumentDetails.

LANGUAGE_OTHERS

A constant which can be used with the language property of a AnalyzeDocumentDetails.

LANGUAGE_POL

A constant which can be used with the language property of a AnalyzeDocumentDetails.

LANGUAGE_POR

A constant which can be used with the language property of a AnalyzeDocumentDetails.

LANGUAGE_RON

A constant which can be used with the language property of a AnalyzeDocumentDetails.

LANGUAGE_RUS

A constant which can be used with the language property of a AnalyzeDocumentDetails.

LANGUAGE_SLK

A constant which can be used with the language property of a AnalyzeDocumentDetails.

LANGUAGE_SPA

A constant which can be used with the language property of a AnalyzeDocumentDetails.

LANGUAGE_SWE

A constant which can be used with the language property of a AnalyzeDocumentDetails.

LANGUAGE_TUR

A constant which can be used with the language 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.

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_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”

LANGUAGE_ARA = 'ARA'

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

LANGUAGE_CES = 'CES'

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

LANGUAGE_CHI_SIM = 'CHI_SIM'

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

LANGUAGE_DAN = 'DAN'

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

LANGUAGE_DEU = 'DEU'

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

LANGUAGE_ELL = 'ELL'

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

LANGUAGE_ENG = 'ENG'

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

LANGUAGE_FIN = 'FIN'

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

LANGUAGE_FRA = 'FRA'

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

LANGUAGE_HIN = 'HIN'

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

LANGUAGE_HUN = 'HUN'

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

LANGUAGE_ITA = 'ITA'

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

LANGUAGE_JPN = 'JPN'

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

LANGUAGE_KOR = 'KOR'

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

LANGUAGE_NLD = 'NLD'

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

LANGUAGE_NOR = 'NOR'

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

LANGUAGE_OTHERS = 'OTHERS'

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

LANGUAGE_POL = 'POL'

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

LANGUAGE_POR = 'POR'

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

LANGUAGE_RON = 'RON'

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

LANGUAGE_RUS = 'RUS'

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

LANGUAGE_SLK = 'SLK'

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

LANGUAGE_SPA = 'SPA'

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

LANGUAGE_SWE = 'SWE'

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

LANGUAGE_TUR = 'TUR'

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

__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_vision.models.DocumentFeature]) – The value to assign to the features property of this AnalyzeDocumentDetails.

  • document (oci.ai_vision.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_vision.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. 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 AnalyzeDocumentDetails. Allowed values for this property are: “INVOICE”, “RECEIPT”, “RESUME”, “TAX_FORM”, “DRIVER_LICENSE”, “PASSPORT”, “BANK_STATEMENT”, “CHECK”, “PAYSLIP”, “OTHERS”

property compartment_id

Gets the compartment_id of this AnalyzeDocumentDetails. The OCID of the compartment that calls the API.

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_vision.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”

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_vision.models.DocumentFeature]

property language

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

Returns

The language of this AnalyzeDocumentDetails.

Return type

str

property output_location

Gets the output_location of this AnalyzeDocumentDetails.

Returns

The output_location of this AnalyzeDocumentDetails.

Return type

oci.ai_vision.models.OutputLocation