oracle.oci.oci_ai_vision_image_job – Manage an ImageJob resource in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 5.2.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install oracle.oci
.
To use it in a playbook, specify: oracle.oci.oci_ai_vision_image_job
.
New in version 2.9.0: of oracle.oci
Synopsis¶
This module allows the user to create an ImageJob resource in Oracle Cloud Infrastructure
For state=present, create an image analysis batch job.
This resource has the following action operations in the oracle.oci.oci_ai_vision_image_job_actions module: cancel.
Requirements¶
The below requirements are needed on the host that executes this module.
python >= 3.6
Python SDK for Oracle Cloud Infrastructure https://oracle-cloud-infrastructure-python-sdk.readthedocs.io
Parameters¶
Parameter | Choices/Defaults | Comments | ||
---|---|---|---|---|
api_user
string
|
The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the value of the OCI_USER_ID environment variable, if any, is used. This option is required if the user is not specified through a configuration file (See
config_file_location ). To get the user's OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm. |
|||
api_user_fingerprint
string
|
Fingerprint for the key pair being used. If not set, then the value of the OCI_USER_FINGERPRINT environment variable, if any, is used. This option is required if the key fingerprint is not specified through a configuration file (See
config_file_location ). To get the key pair's fingerprint value please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm. |
|||
api_user_key_file
string
|
Full path and filename of the private key (in PEM format). If not set, then the value of the OCI_USER_KEY_FILE variable, if any, is used. This option is required if the private key is not specified through a configuration file (See
config_file_location ). If the key is encrypted with a pass-phrase, the api_user_key_pass_phrase option must also be provided. |
|||
api_user_key_pass_phrase
string
|
Passphrase used by the key referenced in
api_user_key_file , if it is encrypted. If not set, then the value of the OCI_USER_KEY_PASS_PHRASE variable, if any, is used. This option is required if the key passphrase is not specified through a configuration file (See config_file_location ). |
|||
auth_purpose
string
|
|
The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None.
|
||
auth_type
string
|
|
The type of authentication to use for making API requests. By default
auth_type="api_key" based authentication is performed and the API key (see api_user_key_file) in your config file will be used. If this 'auth_type' module option is not specified, the value of the OCI_ANSIBLE_AUTH_TYPE, if any, is used. Use auth_type="instance_principal" to use instance principal based authentication when running ansible playbooks within an OCI compute instance. |
||
cert_bundle
string
|
The full path to a CA certificate bundle to be used for SSL verification. This will override the default CA certificate bundle. If not set, then the value of the OCI_ANSIBLE_CERT_BUNDLE variable, if any, is used.
|
|||
compartment_id
string
|
The compartment identifier from the requester.
|
|||
config_file_location
string
|
Path to configuration file. If not set then the value of the OCI_CONFIG_FILE environment variable, if any, is used. Otherwise, defaults to ~/.oci/config.
|
|||
config_profile_name
string
|
The profile to load from the config file referenced by
config_file_location . If not set, then the value of the OCI_CONFIG_PROFILE environment variable, if any, is used. Otherwise, defaults to the "DEFAULT" profile in config_file_location . |
|||
display_name
string
|
The image job display name.
aliases: name |
|||
features
list
/ elements=dictionary / required
|
The list of requested image analysis types.
|
|||
feature_type
string
/ required
|
|
The type of image analysis requested. The allowed values are: - `IMAGE_CLASSIFICATION`: Label the image. - `OBJECT_DETECTION`: Identify objects in the image with bounding boxes. - `TEXT_DETECTION`: Recognize text in the image.
|
||
language
string
|
|
The language of the document image, abbreviated according to ISO 639-2.
Applicable when feature_type is 'TEXT_DETECTION'
|
||
max_results
integer
|
The maximum number of results to return.
Applicable when feature_type is one of ['IMAGE_CLASSIFICATION', 'OBJECT_DETECTION']
|
|||
model_id
string
|
The custom model ID.
Applicable when feature_type is one of ['IMAGE_CLASSIFICATION', 'OBJECT_DETECTION']
|
|||
force_create
boolean
|
|
Whether to attempt non-idempotent creation of a resource. By default, create resource is an idempotent operation, and doesn't create the resource if it already exists. Setting this option to true, forcefully creates a copy of the resource, even if it already exists.This option is mutually exclusive with key_by.
|
||
input_location
dictionary
/ required
|
||||
object_locations
list
/ elements=dictionary / required
|
The list of ObjectLocations.
|
|||
bucket_name
string
/ required
|
The Object Storage bucket name.
|
|||
namespace_name
string
/ required
|
The Object Storage namespace name.
|
|||
object_name
string
/ required
|
The Object Storage object name.
|
|||
source_type
string
/ required
|
|
The type of input location. The allowed values are: - `OBJECT_LIST_INLINE_INPUT_LOCATION`: A list of object locations in Object Storage.
|
||
is_zip_output_enabled
boolean
|
|
Whether or not to generate a ZIP file containing the results.
|
||
key_by
list
/ elements=string
|
The list of attributes of this resource which should be used to uniquely identify an instance of the resource. By default, all the attributes of a resource are used to uniquely identify a resource.
|
|||
output_location
dictionary
/ required
|
||||
bucket_name
string
/ required
|
The Object Storage bucket name.
|
|||
namespace_name
string
/ required
|
The Object Storage namespace.
|
|||
prefix
string
/ required
|
The Object Storage folder name.
|
|||
realm_specific_endpoint_template_enabled
boolean
|
|
Enable/Disable realm specific endpoint template for service client. By Default, realm specific endpoint template is disabled. If not set, then the value of the OCI_REALM_SPECIFIC_SERVICE_ENDPOINT_TEMPLATE_ENABLED variable, if any, is used.
|
||
region
string
|
The Oracle Cloud Infrastructure region to use for all OCI API requests. If not set, then the value of the OCI_REGION variable, if any, is used. This option is required if the region is not specified through a configuration file (See
config_file_location ). Please refer to https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm for more information on OCI regions. |
|||
state
string
|
|
The state of the ImageJob.
Use state=present to create an ImageJob.
|
||
tenancy
string
|
OCID of your tenancy. If not set, then the value of the OCI_TENANCY variable, if any, is used. This option is required if the tenancy OCID is not specified through a configuration file (See
config_file_location ). To get the tenancy OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm |
|||
wait
boolean
|
|
Whether to wait for create or delete operation to complete.
|
||
wait_timeout
integer
|
Time, in seconds, to wait when wait=yes. Defaults to 1200 for most of the services but some services might have a longer wait timeout.
|
Notes¶
Note
For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html
Examples¶
- name: Create image_job
oci_ai_vision_image_job:
# required
input_location:
# required
source_type: OBJECT_LIST_INLINE_INPUT_LOCATION
object_locations:
- # required
namespace_name: namespace_name_example
bucket_name: bucket_name_example
object_name: object_name_example
features:
- # required
feature_type: TEXT_DETECTION
# optional
language: ENG
output_location:
# required
namespace_name: namespace_name_example
bucket_name: bucket_name_example
prefix: prefix_example
# optional
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
display_name: display_name_example
is_zip_output_enabled: true
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Authors¶
Oracle (@oracle)