oracle.oci.oci_ai_language_detect_language_entities_actions – Perform actions on a DetectLanguageEntities resource in Oracle Cloud Infrastructure

Note

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

New in version 2.9.0: of oracle.oci

Synopsis

  • Perform actions on a DetectLanguageEntities resource in Oracle Cloud Infrastructure

  • For action=detect_language_entities, the API extracts entities in text records. For each entity, its type and confidence score (between 0 and 1) is returned. Limitations: - A text may be up to 1000 characters long.

Requirements

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

Parameters

Parameter Choices/Defaults Comments
action
string / required
    Choices:
  • detect_language_entities
The action to perform on the DetectLanguageEntities.
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.
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.
is_pii
boolean
    Choices:
  • no
  • yes
If this parameter is set to true, you only get PII (Personally identifiable information) entities like PhoneNumber, Email, Person, and so on. Default value is false.
model_version
string
    Choices:
  • V2_1
  • V1_1
Named Entity Recognition model versions. By default user will get output from V2.1 implementation.
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
text
string / required
Document text for detect entities.

Examples

- name: Perform action detect_language_entities on detect_language_entities
  oci_ai_language_detect_language_entities_actions:
    # required
    text: text_example
    action: detect_language_entities

    # optional
    model_version: V2_1
    is_pii: true

Return Values

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

Key Returned Description
detect_language_entities_result
complex
on success
Details of the DetectLanguageEntities resource acted upon by the current operation

Sample:
{'entities': [{'is_pii': True, 'length': 56, 'offset': 56, 'score': 1.2, 'text': 'text_example', 'type': 'type_example'}]}
 
entities
complex
on success
List of detected entities.

   
is_pii
boolean
on success
This flag is to indicate if it is PII entity or not.

Sample:
True
   
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 of extracted entity type. Example: `0.9999856066867399`

Sample:
1.2
   
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, GPE and NOPE.

Sample:
type_example


Authors

  • Oracle (@oracle)