analyze-document

Description

Perform different types of image analysis.

Usage

oci ai-vision analyze-document [OPTIONS]

Required Parameters

--document [complex type]

This is a complex type whose value must be valid JSON. The value can be provided as a string on the command line or passed in as a file using the file://path/to/file syntax.

The --generate-param-json-input option can be used to generate an example of the JSON which must be provided. We recommend storing this example in a file, modifying it as needed and then passing it back in via the file:// syntax.

--features [complex type]

The types of document analysis requested. This is a complex type whose value must be valid JSON. The value can be provided as a string on the command line or passed in as a file using the file://path/to/file syntax.

The --generate-param-json-input option can be used to generate an example of the JSON which must be provided. We recommend storing this example in a file, modifying it as needed and then passing it back in via the file:// syntax.

Optional Parameters

--compartment-id, -c [text]

The OCID of the compartment that calls the API.

--document-type [text]

The document type.

Accepted values are:

BANK_STATEMENT, CHECK, DRIVER_LICENSE, INVOICE, OTHERS, PASSPORT, PAYSLIP, RECEIPT, RESUME, TAX_FORM
--from-json [text]

Provide input to this command as a JSON document from a file using the file://path-to/file syntax.

The --generate-full-command-json-input option can be used to generate a sample json file to be used with this command option. The key names are pre-populated and match the command option names (converted to camelCase format, e.g. compartment-id –> compartmentId), while the values of the keys need to be populated by the user before using the sample file as an input to this command. For any command option that accepts multiple values, the value of the key can be a JSON array.

Options can still be provided on the command line. If an option exists in both the JSON document and the command line then the command line specified value will be used.

For examples on usage of this option, please see our “using CLI with advanced JSON options” link: https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/cliusing.htm#AdvancedJSONOptions

--language [text]

The document language, abbreviated according to ISO 639-2.

Accepted values are:

ARA, CES, CHI_SIM, DAN, DEU, ELL, ENG, FIN, FRA, HIN, HUN, ITA, JPN, KOR, NLD, NOR, OTHERS, POL, POR, RON, RUS, SLK, SPA, SWE, TUR
--output-location [complex type]

This is a complex type whose value must be valid JSON. The value can be provided as a string on the command line or passed in as a file using the file://path/to/file syntax.

The --generate-param-json-input option can be used to generate an example of the JSON which must be provided. We recommend storing this example in a file, modifying it as needed and then passing it back in via the file:// syntax.

Example using required parameter

Copy and paste the following example into a JSON file, replacing the example parameters with your own.

    oci ai-vision analyze-document --generate-param-json-input document > document.json
    oci ai-vision analyze-document --generate-param-json-input features > features.json

Copy the following CLI commands into a file named example.sh. Run the command by typing “bash example.sh” and replacing the example parameters with your own.

Please note this sample will only work in the POSIX-compliant bash-like shell. You need to set up the OCI configuration and appropriate security policies before trying the examples.

    oci ai-vision analyze-document --document file://document.json --features file://features.json