oracle.oci.oci_data_labeling_service_dataplane_annotation – Manage an Annotation 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_data_labeling_service_dataplane_annotation
.
New in version 2.9.0: of oracle.oci
Synopsis¶
This module allows the user to create, update and delete an Annotation resource in Oracle Cloud Infrastructure
For state=present, creates an annotation.
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 | |||
---|---|---|---|---|---|
annotation_id
string
|
A unique annotation identifier.
Required for update using state=present.
Required for delete using state=absent.
aliases: id |
||||
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 OCID of the compartment for the annotation.
Required for create using state=present.
|
||||
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 . |
||||
dataset_id
string
|
Filter the results by the OCID of the dataset.
Required for create using state=present.
|
||||
defined_tags
dictionary
|
The defined tags for this resource. Each key is predefined and scoped to a namespace. For example: `{"foo-namespace": {"bar-key": "value"}}`
This parameter is updatable.
|
||||
entities
list
/ elements=dictionary
|
The entity types are validated against the dataset to ensure consistency.
Required for create using state=present.
This parameter is updatable.
|
||||
bounding_polygon
dictionary
|
Required when entity_type is one of ['KEYVALUESELECTION', 'IMAGEOBJECTSELECTION']
|
||||
normalized_vertices
list
/ elements=dictionary / required
|
The normalized vertices that make up the polygon. They are in the order of the segments they connect.
Required when entity_type is 'IMAGEOBJECTSELECTION'
|
||||
x
float
/ required
|
The X axis coordinate.
Required when entity_type is 'IMAGEOBJECTSELECTION'
|
||||
y
float
/ required
|
The Y axis coordinate.
Required when entity_type is 'IMAGEOBJECTSELECTION'
|
||||
confidence
float
|
float value, score from OCR.
Required when entity_type is 'KEYVALUESELECTION'
|
||||
document_entity_metadata
dictionary
|
Applicable when entity_type is 'GENERIC'
|
||||
page_number
float
/ required
|
This stores page number of document.
Required when entity_type is 'GENERIC'
|
||||
entity_type
string
/ required
|
|
The entity type described in the annotation. GENERIC - An extensible entity type that is the base entity type for some annotation formats. IMAGEOBJECTSELECTION- - This allows the labeler to use specify a bounding polygon on the image to represent an object and apply labels to it. TEXTSELECTION - This allows the labeler to highlight text, by specifying an offset and a length, and apply labels to it. KEYVALUESELECTION - This allows the labeler to apply label the highlighted text from OCR.
|
|||
extended_metadata
dictionary
|
A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: `{"bar-key": "value"}`
Applicable when entity_type is one of ['GENERIC', 'IMAGEOBJECTSELECTION', 'TEXTSELECTION']
|
||||
labels
list
/ elements=dictionary
|
A collection of label entities.
Required when entity_type is one of ['GENERIC', 'IMAGEOBJECTSELECTION', 'TEXTSELECTION']
|
||||
label
string
/ required
|
The label provided by the annotator.
Required when entity_type is 'IMAGEOBJECTSELECTION'
|
||||
page_number
float
|
Integer value.
Applicable when entity_type is 'KEYVALUESELECTION'
|
||||
rotation
float
|
Integer value.
Applicable when entity_type is 'KEYVALUESELECTION'
|
||||
text
string
|
Entity Name.
Required when entity_type is 'KEYVALUESELECTION'
|
||||
text_span
dictionary
|
Required when entity_type is 'TEXTSELECTION'
|
||||
length
float
|
The length of the selected text.
Applicable when entity_type is 'TEXTSELECTION'
|
||||
offset
float
|
The offset of the selected text within the entire text.
Applicable when entity_type is 'TEXTSELECTION'
|
||||
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.
|
|||
freeform_tags
dictionary
|
A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: `{"bar-key": "value"}`
This parameter is updatable.
|
||||
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.
|
||||
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.
|
|||
record_id
string
|
The OCID of the record annotated.
Required for create using state=present.
|
||||
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 Annotation.
Use state=present to create or update an Annotation.
Use state=absent to delete an Annotation.
|
|||
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 annotation
oci_data_labeling_service_dataplane_annotation:
# required
record_id: "ocid1.record.oc1..xxxxxxEXAMPLExxxxxx"
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
entities:
- # required
bounding_polygon:
# required
normalized_vertices:
- # required
x: 3.4
y: 3.4
entity_type: IMAGEOBJECTSELECTION
labels:
- # required
label: label_example
# optional
extended_metadata: null
# optional
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
- name: Update annotation
oci_data_labeling_service_dataplane_annotation:
# required
annotation_id: "ocid1.annotation.oc1..xxxxxxEXAMPLExxxxxx"
# optional
entities:
- # required
bounding_polygon:
# required
normalized_vertices:
- # required
x: 3.4
y: 3.4
entity_type: IMAGEOBJECTSELECTION
labels:
- # required
label: label_example
# optional
extended_metadata: null
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
- name: Delete annotation
oci_data_labeling_service_dataplane_annotation:
# required
annotation_id: "ocid1.annotation.oc1..xxxxxxEXAMPLExxxxxx"
state: absent
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Authors¶
Oracle (@oracle)