"analyze-document-object-storage-document-details"
**************************************************

* Description

* Usage

* Required Parameters

* Optional Parameters

* Global Parameters

* Examples


Description
===========

Perform different types of image analysis.


Usage
=====

   oci ai-vision analyze-document-object-storage-document-details [OPTIONS]


Required Parameters
===================

--document-bucket-name [text]

The Object Storage bucket name.

--document-namespace-name [text]

The Object Storage namespace.

--document-object-name [text]

The Object Storage object name.

--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/Conte
nt/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.


Global Parameters
=================

Use "oci --help" for help on global parameters.

"--auth-purpose", "--auth", "--cert-bundle", "--cli-auto-prompt", "--
cli-rc-file", "--config-file", "--connection-timeout", "--debug", "--
defaults-file", "--endpoint", "--generate-full-command-json-input", "
--generate-param-json-input", "--help", "--latest-version", "--max-
retries", "--no-retry", "--opc-client-request-id", "--opc-request-id",
"--output", "--profile", "--query", "--raw-output", "--read-timeout",
"--region", "--release-info", "--request-id", "--version", "-?", "-d",
"-h", "-i", "-v"


Examples
========

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

       oci ai-vision analyze-document-object-storage-document-details --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.

       export document_bucket_name=<substitute-value-of-document_bucket_name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/ai-vision/analyze-document-object-storage-document-details.html#cmdoption-document-bucket-name
       export document_namespace_name=<substitute-value-of-document_namespace_name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/ai-vision/analyze-document-object-storage-document-details.html#cmdoption-document-namespace-name
       export document_object_name=<substitute-value-of-document_object_name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/ai-vision/analyze-document-object-storage-document-details.html#cmdoption-document-object-name

       oci ai-vision analyze-document-object-storage-document-details --document-bucket-name $document_bucket_name --document-namespace-name $document_namespace_name --document-object-name $document_object_name --features file://features.json
