oracle.oci.oci_ai_anomaly_detection_model_facts – Fetches details about one or multiple Model resources 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_anomaly_detection_model_facts
.
New in version 2.9.0: of oracle.oci
Synopsis¶
Fetches details about one or multiple Model resources in Oracle Cloud Infrastructure
Returns a list of Models.
If model_id is specified, the details of a single Model will be returned.
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 ID of the compartment in which to list resources.
Required to list multiple models.
|
|
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
|
A filter to return only resources that match the entire display name given.
aliases: name |
|
lifecycle_state
string
|
|
<b>Filter</b> results by the specified lifecycle state. Must be a valid state for the resource type.
|
model_id
string
|
The OCID of the Model.
Required to get a specific model.
aliases: id |
|
project_id
string
|
The ID of the project for which to list the objects.
|
|
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. |
|
sort_by
string
|
|
Specifies the field to sort by. Accepts only one field. By default, when you sort by `timeCreated`, the results are shown in descending order. When you sort by `displayName`, the results are shown in ascending order. Sort order for the `displayName` field is case sensitive.
|
sort_order
string
|
|
The sort order to use, either 'asc' or 'desc'.
|
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 |
Notes¶
Note
For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html
Examples¶
- name: Get a specific model
oci_ai_anomaly_detection_model_facts:
# required
model_id: "ocid1.model.oc1..xxxxxxEXAMPLExxxxxx"
- name: List models
oci_ai_anomaly_detection_model_facts:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
# optional
project_id: "ocid1.project.oc1..xxxxxxEXAMPLExxxxxx"
lifecycle_state: DELETING
display_name: display_name_example
sort_order: ASC
sort_by: timeCreated
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | |||
---|---|---|---|---|---|
models
complex
|
on success |
List of Model resources
Sample:
[{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'description': 'description_example', 'display_name': 'display_name_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'DELETING', 'model_training_details': {'algorithm_hint': 'MULTIVARIATE_MSET', 'data_asset_ids': [], 'target_fap': 3.4, 'training_fraction': 3.4, 'window_size': 56}, 'model_training_results': {'algorithm': 'MULTIVARIATE_MSET', 'fap': 3.4, 'is_training_goal_achieved': True, 'multivariate_fap': 3.4, 'row_reduction_details': {'is_reduction_enabled': True, 'reduction_method': 'DELETE_ROW', 'reduction_percentage': 1.2}, 'signal_details': [{'details': 'details_example', 'fap': 3.4, 'is_quantized': True, 'max': 1.2, 'min': 1.2, 'mvi_ratio': 1.2, 'signal_name': 'signal_name_example', 'status': 'ACCEPTED', 'std': 1.2}], 'warning': 'warning_example', 'window_size': 56}, 'project_id': 'ocid1.project.oc1..xxxxxxEXAMPLExxxxxx', 'system_tags': {}, 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00'}]
|
|||
compartment_id
string
|
on success |
The OCID for the model's compartment.
Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
|
|||
defined_tags
dictionary
|
on success |
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`
Sample:
{'Operations': {'CostCenter': 'US'}}
|
|||
description
string
|
on success |
A short description of the Model.
Sample:
description_example
|
|||
display_name
string
|
on success |
A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information.
Sample:
display_name_example
|
|||
freeform_tags
dictionary
|
on success |
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`
Sample:
{'Department': 'Finance'}
|
|||
id
string
|
on success |
The OCID of the model that is immutable on creation.
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
|||
lifecycle_details
string
|
on success |
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
Returned for get operation
Sample:
lifecycle_details_example
|
|||
lifecycle_state
string
|
on success |
The state of the model.
Sample:
DELETING
|
|||
model_training_details
complex
|
on success |
|
|||
algorithm_hint
string
|
on success |
User can choose specific algorithm for training.
Sample:
MULTIVARIATE_MSET
|
|||
data_asset_ids
list
/ elements=string
|
on success |
The list of OCIDs of the data assets to train the model. The dataAssets have to be in the same project where the ai model would reside.
|
|||
target_fap
float
|
on success |
A target model accuracy metric user provides as their requirement
Sample:
3.4
|
|||
training_fraction
float
|
on success |
Fraction of total data that is used for training the model. The remaining is used for validation of the model.
Sample:
3.4
|
|||
window_size
integer
|
on success |
This value would determine the window size of the training algorithm.
Sample:
56
|
|||
model_training_results
complex
|
on success |
|
|||
algorithm
string
|
on success |
Actual algorithm used to train the model
Sample:
MULTIVARIATE_MSET
|
|||
fap
float
|
on success |
The final-achieved model accuracy metric on individual value level
Sample:
3.4
|
|||
is_training_goal_achieved
boolean
|
on success |
A boolean value to indicate if train goal/targetFap is achieved for trained model
Sample:
True
|
|||
multivariate_fap
float
|
on success |
The model accuracy metric on timestamp level.
Sample:
3.4
|
|||
row_reduction_details
complex
|
on success |
|
|||
is_reduction_enabled
boolean
|
on success |
A boolean value to indicate if row reduction is applied
Sample:
True
|
|||
reduction_method
string
|
on success |
Method for row reduction: * DELETE_ROW - delete rows with equal intervals * AVERAGE_ROW - average multiple rows to one row
Sample:
DELETE_ROW
|
|||
reduction_percentage
float
|
on success |
A percentage to reduce data size down to on top of original data
Sample:
1.2
|
|||
signal_details
complex
|
on success |
The list of signal details.
|
|||
details
string
|
on success |
detailed information for a signal.
Sample:
details_example
|
|||
fap
float
|
on success |
Accuracy metric for a signal.
Sample:
3.4
|
|||
is_quantized
boolean
|
on success |
A boolean value to indicate if a signal is quantized or not.
Sample:
True
|
|||
max
float
|
on success |
Max value within a signal.
Sample:
1.2
|
|||
min
float
|
on success |
Min value within a signal.
Sample:
1.2
|
|||
mvi_ratio
float
|
on success |
The ratio of missing values in a signal filled/imputed by the IDP algorithm.
Sample:
1.2
|
|||
signal_name
string
|
on success |
The name of a signal.
Sample:
signal_name_example
|
|||
status
string
|
on success |
Status of the signal: * ACCEPTED - the signal is used for training the model * DROPPED - the signal does not meet requirement, and is dropped before training the model. * OTHER - placeholder for other status
Sample:
ACCEPTED
|
|||
std
float
|
on success |
Standard deviation of values within a signal.
Sample:
1.2
|
|||
warning
string
|
on success |
A warning message to explain the reason when targetFap cannot be achieved for trained model
Sample:
warning_example
|
|||
window_size
integer
|
on success |
Window size defined during training or deduced by the algorithm.
Sample:
56
|
|||
project_id
string
|
on success |
The OCID of the project to associate with the model.
Sample:
ocid1.project.oc1..xxxxxxEXAMPLExxxxxx
|
|||
system_tags
dictionary
|
on success |
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{ "orcl-cloud": { "free-tier-retained": "true" } }`
|
|||
time_created
string
|
on success |
The time the the Model was created. An RFC3339 formatted datetime string.
Sample:
2013-10-20T19:20:30+01:00
|
|||
time_updated
string
|
on success |
The time the Model was updated. An RFC3339 formatted datetime string.
Returned for get operation
Sample:
2013-10-20T19:20:30+01:00
|
Authors¶
Oracle (@oracle)