create-document-job-object-list-inline-input-location
¶
Description¶
Create a document analysis batch job.
Required Parameters¶
-
--features
[complex type]
¶
The list of requested document analysis types. 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.
-
--input-location-object-locations
[complex type]
¶
The list of ObjectLocations. 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.
-
--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.
Optional Parameters¶
-
--compartment-id
,
-c
[text]
¶
The compartment identifier from the requester.
-
--display-name
[text]
¶
The document job display name.
-
--document-type
[text]
¶
The type of documents.
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
-
--is-zip-output-enabled
[boolean]
¶
Whether or not to generate a ZIP file containing the results.
-
--language
[text]
¶
The language of the document, 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
-
--max-wait-seconds
[integer]
¶
The maximum time to wait for the resource to reach the lifecycle state defined by --wait-for-state
. Defaults to 1200 seconds.
-
--wait-for-state
[text]
¶
This operation creates, modifies or deletes a resource that has a defined lifecycle state. Specify this option to perform the action and then wait until the resource reaches a given lifecycle state. Multiple states can be specified, returning on the first state. For example, --wait-for-state
SUCCEEDED --wait-for-state
FAILED would return on whichever lifecycle state is reached first. If timeout is reached, a return code of 2 is returned. For any other error, a return code of 1 is returned.
Accepted values are:
ACCEPTED, CANCELED, CANCELING, FAILED, IN_PROGRESS, SUCCEEDED
-
--wait-interval-seconds
[integer]
¶
Check every --wait-interval-seconds
to see whether the resource has reached the lifecycle state defined by --wait-for-state
. Defaults to 30 seconds.
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
, --proxy
, --query
, --raw-output
, --read-timeout
, --realm-specific-endpoint
, --region
, --release-info
, --request-id
, --version
, -?
, -d
, -h
, -i
, -v
Example using required parameter¶
Copy and paste the following example into a JSON file, replacing the example parameters with your own.
oci ai-vision document-job create-document-job-object-list-inline-input-location --generate-param-json-input features > features.json
oci ai-vision document-job create-document-job-object-list-inline-input-location --generate-param-json-input input-location-object-locations > input-location-object-locations.json
oci ai-vision document-job create-document-job-object-list-inline-input-location --generate-param-json-input output-location > output-location.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 document-job create-document-job-object-list-inline-input-location --features file://features.json --input-location-object-locations file://input-location-object-locations.json --output-location file://output-location.json