oracle.oci.oci_ai_language_batch_detect_language_entities_actions – Perform actions on a BatchDetectLanguageEntities resource in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 4.11.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_language_batch_detect_language_entities_actions.

New in version 2.9.0: of oracle.oci

Synopsis

  • Perform actions on a BatchDetectLanguageEntities resource in Oracle Cloud Infrastructure

  • For action=batch_detect_language_entities, the API extracts entities in text records. For each entity, its type/subtype and confidence score (between 0 and 1) is returned. It supports passing a batch of records. List of supported entities. Limitations: - A batch may have up to 100 records. - A record may be up to 5000 characters long. - The total of characters to process in a request can be up to 20,000 characters.

Requirements

The below requirements are needed on the host that executes this module.

Parameters

Parameter Choices/Defaults Comments
action
string / required
    Choices:
  • batch_detect_language_entities
The action to perform on the BatchDetectLanguageEntities.
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
    Choices:
  • service_principal
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
    Choices:
  • api_key ←
  • instance_principal
  • instance_obo_user
  • resource_principal
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 that calls the API, inference will be served from pre trained model
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.
documents
list / elements=dictionary / required
List of Documents for detect entities.
key
string / required
Document unique identifier defined by the user.
language_code
string
Language code per the ISO 639-1 standard.
text
string / required
Document text for language service call.
endpoint_id
string
The endpoint which have to be used for inferencing. If endpointId and compartmentId is provided, then inference will be served from custom model which is mapped to this Endpoint.
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.
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

Examples

- name: Perform action batch_detect_language_entities on batch_detect_language_entities
  oci_ai_language_batch_detect_language_entities_actions:
    # required
    documents:
    - # required
      key: key_example
      text: text_example

      # optional
      language_code: language_code_example
    action: batch_detect_language_entities

    # optional
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    endpoint_id: "ocid1.endpoint.oc1..xxxxxxEXAMPLExxxxxx"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
batch_detect_language_entities_result
complex
on success
Details of the BatchDetectLanguageEntities resource acted upon by the current operation

Sample:
{'documents': [{'entities': [{'length': 56, 'offset': 56, 'score': 1.2, 'sub_type': 'sub_type_example', 'text': 'text_example', 'type': 'type_example'}], 'key': 'key_example', 'language_code': 'language_code_example'}], 'errors': [{'error': {'code': 'code_example', 'message': 'message_example'}, 'key': 'key_example'}]}
 
documents
complex
on success
List of succeeded document response.

   
entities
complex
on success
List of detected entities.

     
length
integer
on success
Length of entity text

Sample:
56
     
offset
integer
on success
The number of Unicode code points preceding this entity in the submitted text.

Sample:
56
     
score
float
on success
Score or confidence for detected entity.

Sample:
1.2
     
sub_type
string
on success
Sub-type of entity text like GPE for LOCATION type

Sample:
sub_type_example
     
text
string
on success
Entity text like name of person, location, and so on.

Sample:
text_example
     
type
string
on success
Type of entity text like PER, LOC.

Sample:
type_example
   
key
string
on success
Document unique identifier defined by the user.

Sample:
key_example
   
language_code
string
on success
Language code per the ISO 639-1 standard.

Sample:
language_code_example
 
errors
complex
on success
List of failed document response.

   
error
complex
on success

     
code
string
on success
A short error code that defines the error, meant for programmatic parsing.

Sample:
code_example
     
message
string
on success
A human-readable error string.

Sample:
message_example
   
key
string
on success
Document unique identifier defined by the user.

Sample:
key_example


Authors

  • Oracle (@oracle)