AI Anomaly Detection Common Types

DBMS_CLOUD_OCI_AI_ANOMALY_DETECTION_VARCHAR2_TBL Type

Nested table type of varchar2(32767).

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_anomaly_detection_varchar2_tbl FORCE IS TABLE OF (varchar2(32767)) NOT PERSISTABLE;

DBMS_CLOUD_OCI_AI_ANOMALY_DETECTION_AI_PRIVATE_ENDPOINT_T Type

A private network reverse connection creates a connection from service to customer subnet over a private network.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_anomaly_detection_ai_private_endpoint_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  compartment_id varchar2(32767),
  subnet_id varchar2(32767),
  display_name varchar2(32767),
  dns_zones dbms_cloud_oci_ai_anomaly_detection_varchar2_tbl,
  time_created timestamp with time zone,
  time_updated timestamp with time zone,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  system_tags json_element_t,
  lifecycle_state varchar2(32767),
  lifecycle_details varchar2(32767),
  attached_data_assets dbms_cloud_oci_ai_anomaly_detection_varchar2_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_ai_private_endpoint_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_ai_private_endpoint_t (
    id varchar2,
    compartment_id varchar2,
    subnet_id varchar2,
    display_name varchar2,
    dns_zones dbms_cloud_oci_ai_anomaly_detection_varchar2_tbl,
    time_created timestamp with time zone,
    time_updated timestamp with time zone,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    system_tags json_element_t,
    lifecycle_state varchar2,
    lifecycle_details varchar2,
    attached_data_assets dbms_cloud_oci_ai_anomaly_detection_varchar2_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) Unique identifier that is immutable.

compartment_id

(required) Compartment Identifier.

subnet_id

(required) Subnet Identifier

display_name

(optional) Private Reverse Connection Endpoint display name.

dns_zones

(required) List of DNS zones to be used by the data assets. Example: custpvtsubnet.oraclevcn.com for data asset: db.custpvtsubnet.oraclevcn.com

time_created

(optional) The time the private endpoint was created. An RFC3339 formatted datetime string.

time_updated

(optional) The time the private endpoint was updated. An RFC3339 formatted datetime string.

freeform_tags

(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`

system_tags

(optional) Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{ \"orcl-cloud\": { \"free-tier-retained\": \"true\" } }`

lifecycle_state

(optional) The current state of the private endpoint resource.

Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'DELETING', 'DELETED', 'FAILED'

lifecycle_details

(optional) A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in 'Failed' state.

attached_data_assets

(optional) The list of dataAssets using the private reverse connection endpoint.

DBMS_CLOUD_OCI_AI_ANOMALY_DETECTION_AI_PRIVATE_ENDPOINT_SUMMARY_T Type

A private network reverse connection creates a connection from service to customer subnet over a private network.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_anomaly_detection_ai_private_endpoint_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  subnet_id varchar2(32767),
  dns_zones dbms_cloud_oci_ai_anomaly_detection_varchar2_tbl,
  compartment_id varchar2(32767),
  time_created timestamp with time zone,
  time_updated timestamp with time zone,
  display_name varchar2(32767),
  lifecycle_details varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  system_tags json_element_t,
  lifecycle_state varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_ai_private_endpoint_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_ai_private_endpoint_summary_t (
    id varchar2,
    subnet_id varchar2,
    dns_zones dbms_cloud_oci_ai_anomaly_detection_varchar2_tbl,
    compartment_id varchar2,
    time_created timestamp with time zone,
    time_updated timestamp with time zone,
    display_name varchar2,
    lifecycle_details varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    system_tags json_element_t,
    lifecycle_state varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) Unique identifier that is immutable.

subnet_id

(required) Subnet Identifier.

dns_zones

(required) List of DNS zones to be used by the data assets. Example: custpvtsubnet.oraclevcn.com for data asset: db.custpvtsubnet.oraclevcn.com

compartment_id

(required) Identifier of the compartment this private endpoint belongs to.

time_created

(optional) The time the private endpoint was created. An RFC3339 formatted datetime string.

time_updated

(optional) The time the private endpoint was updated. An RFC3339 formatted datetime string.

display_name

(optional) Mutable name of the Private Reverse Connection Endpoint.

lifecycle_details

(optional) A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in 'Failed' state.

freeform_tags

(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`

system_tags

(optional) Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{ \"orcl-cloud\": { \"free-tier-retained\": \"true\" } }`

lifecycle_state

(optional) The current state of the private endpoint resource.

DBMS_CLOUD_OCI_AI_ANOMALY_DETECTION_AI_PRIVATE_ENDPOINT_SUMMARY_TBL Type

Nested table type of dbms_cloud_oci_ai_anomaly_detection_ai_private_endpoint_summary_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_anomaly_detection_ai_private_endpoint_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_ai_anomaly_detection_ai_private_endpoint_summary_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_AI_ANOMALY_DETECTION_AI_PRIVATE_ENDPOINT_COLLECTION_T Type

A collection of AI Service PrivateEndpoints Each item is a AI Service PrivateEndpoint Summary object.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_anomaly_detection_ai_private_endpoint_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
  items dbms_cloud_oci_ai_anomaly_detection_ai_private_endpoint_summary_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_ai_private_endpoint_collection_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_ai_private_endpoint_collection_t (
    items dbms_cloud_oci_ai_anomaly_detection_ai_private_endpoint_summary_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

items

(required) List of AI Service PrivateEndpoint.

DBMS_CLOUD_OCI_AI_ANOMALY_DETECTION_ANOMALY_T Type

An object to hold value information for each anomaly point

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_anomaly_detection_anomaly_t FORCE AUTHID CURRENT_USER IS OBJECT (
  signal_name varchar2(32767),
  actual_value number,
  estimated_value number,
  imputed_value number,
  anomaly_score number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_anomaly_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_anomaly_t (
    signal_name varchar2,
    actual_value number,
    estimated_value number,
    imputed_value number,
    anomaly_score number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

signal_name

(required) Name of a signal where current anomaly point belongs to

actual_value

(required) The actual value for the anomaly point at given signal and timestamp/row

estimated_value

(required) The estimated value for the anomaly point at given signal and timestamp/row

imputed_value

(optional) The value imputed by an IDP step for missing values in origin data.

anomaly_score

(required) A significant score ranged from 0 to 1 to each anomaly point.

DBMS_CLOUD_OCI_AI_ANOMALY_DETECTION_ANOMALY_TBL Type

Nested table type of dbms_cloud_oci_ai_anomaly_detection_anomaly_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_anomaly_detection_anomaly_tbl FORCE IS TABLE OF (dbms_cloud_oci_ai_anomaly_detection_anomaly_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_AI_ANOMALY_DETECTION_DETECTION_RESULT_ITEM_T Type

An object to hold detection result for one timestamp/row.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_anomaly_detection_detection_result_item_t FORCE AUTHID CURRENT_USER IS OBJECT (
  l_timestamp timestamp with time zone,
  row_index number,
  score number,
  anomalies dbms_cloud_oci_ai_anomaly_detection_anomaly_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_detection_result_item_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_detection_result_item_t (
    l_timestamp timestamp with time zone,
    row_index number,
    score number,
    anomalies dbms_cloud_oci_ai_anomaly_detection_anomaly_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

l_timestamp

(optional) The time stamp associated with a list of anomaly points, format defined by RFC3339.

row_index

(optional) The index number to indicate where anomaly points are located among all rows when there are no timestamps provided.

score

(optional) A significant score across multiple signals at timestamp/row level

anomalies

(required) An array of anomalies associated with a given timestamp/row.

DBMS_CLOUD_OCI_AI_ANOMALY_DETECTION_DETECTION_RESULT_ITEM_TBL Type

Nested table type of dbms_cloud_oci_ai_anomaly_detection_detection_result_item_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_anomaly_detection_detection_result_item_tbl FORCE IS TABLE OF (dbms_cloud_oci_ai_anomaly_detection_detection_result_item_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_AI_ANOMALY_DETECTION_ANOMALY_DETECT_RESULT_T Type

Results of the detect anomalies call.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_anomaly_detection_anomaly_detect_result_t FORCE AUTHID CURRENT_USER IS OBJECT (
  detection_results dbms_cloud_oci_ai_anomaly_detection_detection_result_item_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_anomaly_detect_result_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_anomaly_detect_result_t (
    detection_results dbms_cloud_oci_ai_anomaly_detection_detection_result_item_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

detection_results

(required) A list to hold anomaly points grouped by timestamp/row.

DBMS_CLOUD_OCI_AI_ANOMALY_DETECTION_CHANGE_AI_PRIVATE_ENDPOINT_COMPARTMENT_DETAILS_T Type

Information about the change compartment for the private endpoint resource.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_anomaly_detection_change_ai_private_endpoint_compartment_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  compartment_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_change_ai_private_endpoint_compartment_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_change_ai_private_endpoint_compartment_details_t (
    compartment_id varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

compartment_id

(required) The identifier of the compartment where the resource should be moved.

DBMS_CLOUD_OCI_AI_ANOMALY_DETECTION_CHANGE_DATA_ASSET_COMPARTMENT_DETAILS_T Type

Details for changing the compartment of a data asset.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_anomaly_detection_change_data_asset_compartment_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  compartment_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_change_data_asset_compartment_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_change_data_asset_compartment_details_t (
    compartment_id varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

compartment_id

(required) The OCID of the compartment into which the resource should be moved.

DBMS_CLOUD_OCI_AI_ANOMALY_DETECTION_CHANGE_DETECT_ANOMALY_JOB_COMPARTMENT_DETAILS_T Type

Details for changing the compartment of the DetectAnomalyJob.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_anomaly_detection_change_detect_anomaly_job_compartment_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  compartment_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_change_detect_anomaly_job_compartment_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_change_detect_anomaly_job_compartment_details_t (
    compartment_id varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

compartment_id

(required) The OCID of the compartment the resource should be moved to.

DBMS_CLOUD_OCI_AI_ANOMALY_DETECTION_CHANGE_MODEL_COMPARTMENT_DETAILS_T Type

Details for changing the compartment of a model.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_anomaly_detection_change_model_compartment_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  compartment_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_change_model_compartment_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_change_model_compartment_details_t (
    compartment_id varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

compartment_id

(required) The OCID of the compartment into which the resource should be moved.

DBMS_CLOUD_OCI_AI_ANOMALY_DETECTION_CHANGE_PROJECT_COMPARTMENT_DETAILS_T Type

Details for changing the compartment of a project.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_anomaly_detection_change_project_compartment_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  compartment_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_change_project_compartment_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_change_project_compartment_details_t (
    compartment_id varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

compartment_id

(required) The OCID of the compartment into which the resource should be moved.

DBMS_CLOUD_OCI_AI_ANOMALY_DETECTION_CREATE_AI_PRIVATE_ENDPOINT_DETAILS_T Type

Information about the new private endpoint resource.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_anomaly_detection_create_ai_private_endpoint_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  dns_zones dbms_cloud_oci_ai_anomaly_detection_varchar2_tbl,
  subnet_id varchar2(32767),
  compartment_id varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  display_name varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_create_ai_private_endpoint_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_create_ai_private_endpoint_details_t (
    dns_zones dbms_cloud_oci_ai_anomaly_detection_varchar2_tbl,
    subnet_id varchar2,
    compartment_id varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    display_name varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

dns_zones

(required) List of DNS zones to be used by the data assets. Example: custpvtsubnet.oraclevcn.com for data asset: db.custpvtsubnet.oraclevcn.com

subnet_id

(required) The OCID of subnet to which the reverse connection is to be created.

compartment_id

(required) Compartment identifier.

freeform_tags

(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`

display_name

(optional) Display name of the private endpoint resource being created.

DBMS_CLOUD_OCI_AI_ANOMALY_DETECTION_DATA_SOURCE_DETAILS_T Type

Possible data sources

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_anomaly_detection_data_source_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  data_source_type varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_data_source_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_data_source_details_t (
    data_source_type varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE NOT FINAL;

Fields

Field Description

data_source_type

(required) Data source type where actually data asset is being stored

Allowed values are: 'ORACLE_OBJECT_STORAGE', 'ORACLE_ATP', 'INFLUX'

DBMS_CLOUD_OCI_AI_ANOMALY_DETECTION_CREATE_DATA_ASSET_DETAILS_T Type

Parameters needed to create a new data asset.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_anomaly_detection_create_data_asset_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  display_name varchar2(32767),
  compartment_id varchar2(32767),
  project_id varchar2(32767),
  description varchar2(32767),
  data_source_details dbms_cloud_oci_ai_anomaly_detection_data_source_details_t,
  private_endpoint_id varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_create_data_asset_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_create_data_asset_details_t (
    display_name varchar2,
    compartment_id varchar2,
    project_id varchar2,
    description varchar2,
    data_source_details dbms_cloud_oci_ai_anomaly_detection_data_source_details_t,
    private_endpoint_id varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

display_name

(optional) A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information.

compartment_id

(required) The OCID for the data asset's compartment.

project_id

(required) The OCID of the project to associate with the data asset.

description

(optional) A short description of the Ai data asset

data_source_details

(required)

private_endpoint_id

(optional) OCID of Private Endpoint.

freeform_tags

(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`

DBMS_CLOUD_OCI_AI_ANOMALY_DETECTION_INPUT_DETAILS_T Type

Detect anomaly asynchronous job details.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_anomaly_detection_input_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  input_type varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_input_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_input_details_t (
    input_type varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE NOT FINAL;

Fields

Field Description

input_type

(required) Type of request. This parameter is automatically populated by classes generated by the SDK. For raw curl requests, you must provide this field.

Allowed values are: 'INLINE', 'BASE64_ENCODED', 'OBJECT_LIST'

DBMS_CLOUD_OCI_AI_ANOMALY_DETECTION_OUTPUT_DETAILS_T Type

Detect anomaly job output details.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_anomaly_detection_output_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  output_type varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_output_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_output_details_t (
    output_type varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE NOT FINAL;

Fields

Field Description

output_type

(required) The type of output location. Allowed values are: - `OBJECT_STORAGE`: Object store output location.

Allowed values are: 'OBJECT_STORAGE'

DBMS_CLOUD_OCI_AI_ANOMALY_DETECTION_CREATE_DETECT_ANOMALY_JOB_DETAILS_T Type

Base class for the DetectAnomalies async call. It contains the identifier that is used for deciding what type of request this is.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_anomaly_detection_create_detect_anomaly_job_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  compartment_id varchar2(32767),
  description varchar2(32767),
  display_name varchar2(32767),
  model_id varchar2(32767),
  sensitivity number,
  are_all_estimates_required number,
  input_details dbms_cloud_oci_ai_anomaly_detection_input_details_t,
  output_details dbms_cloud_oci_ai_anomaly_detection_output_details_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_create_detect_anomaly_job_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_create_detect_anomaly_job_details_t (
    compartment_id varchar2,
    description varchar2,
    display_name varchar2,
    model_id varchar2,
    sensitivity number,
    are_all_estimates_required number,
    input_details dbms_cloud_oci_ai_anomaly_detection_input_details_t,
    output_details dbms_cloud_oci_ai_anomaly_detection_output_details_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

compartment_id

(required) The OCID of the compartment that starts the job.

description

(optional) A short description of the detect anomaly job.

display_name

(optional) Detect anomaly job display name.

model_id

(required) The OCID of the trained model.

sensitivity

(optional) The value that customer can adjust to control the sensitivity of anomaly detection

are_all_estimates_required

(optional) Flag to enable the service to return estimates for all data points rather than just the anomalous data points.

input_details

(required)

output_details

(required)

DBMS_CLOUD_OCI_AI_ANOMALY_DETECTION_MODEL_TRAINING_DETAILS_T Type

Specifies the details of the MSET model during the create call.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_anomaly_detection_model_training_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  algorithm_hint varchar2(32767),
  target_fap number,
  training_fraction number,
  window_size number,
  data_asset_ids dbms_cloud_oci_ai_anomaly_detection_varchar2_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_model_training_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_model_training_details_t (
    algorithm_hint varchar2,
    target_fap number,
    training_fraction number,
    window_size number,
    data_asset_ids dbms_cloud_oci_ai_anomaly_detection_varchar2_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

algorithm_hint

(optional) User can choose specific algorithm for training.

Allowed values are: 'MULTIVARIATE_MSET', 'UNIVARIATE_OCSVM'

target_fap

(optional) A target model accuracy metric user provides as their requirement

training_fraction

(optional) Fraction of total data that is used for training the model. The remaining is used for validation of the model.

window_size

(optional) This value would determine the window size of the training algorithm.

data_asset_ids

(required) 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.

DBMS_CLOUD_OCI_AI_ANOMALY_DETECTION_CREATE_MODEL_DETAILS_T Type

The information needed to train a new model

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_anomaly_detection_create_model_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  display_name varchar2(32767),
  description varchar2(32767),
  compartment_id varchar2(32767),
  model_training_details dbms_cloud_oci_ai_anomaly_detection_model_training_details_t,
  project_id varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_create_model_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_create_model_details_t (
    display_name varchar2,
    description varchar2,
    compartment_id varchar2,
    model_training_details dbms_cloud_oci_ai_anomaly_detection_model_training_details_t,
    project_id varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

display_name

(optional) A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information.

description

(optional) A short description of the ai model.

compartment_id

(required) The OCID for the ai model's compartment.

model_training_details

(required)

project_id

(required) The OCID of the project to associate with the model.

freeform_tags

(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`

DBMS_CLOUD_OCI_AI_ANOMALY_DETECTION_CREATE_PROJECT_DETAILS_T Type

Parameters needed to create a new project. Projects enable users to organize their work.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_anomaly_detection_create_project_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  display_name varchar2(32767),
  description varchar2(32767),
  compartment_id varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_create_project_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_create_project_details_t (
    display_name varchar2,
    description varchar2,
    compartment_id varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

display_name

(optional) A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information.

description

(optional) A short description of the project.

compartment_id

(required) The OCID for the project's compartment.

freeform_tags

(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`

DBMS_CLOUD_OCI_AI_ANOMALY_DETECTION_DATA_ASSET_T Type

Description of DataAsset.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_anomaly_detection_data_asset_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  compartment_id varchar2(32767),
  display_name varchar2(32767),
  description varchar2(32767),
  time_created timestamp with time zone,
  time_updated timestamp with time zone,
  lifecycle_state varchar2(32767),
  project_id varchar2(32767),
  data_source_details dbms_cloud_oci_ai_anomaly_detection_data_source_details_t,
  private_endpoint_id varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  system_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_data_asset_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_data_asset_t (
    id varchar2,
    compartment_id varchar2,
    display_name varchar2,
    description varchar2,
    time_created timestamp with time zone,
    time_updated timestamp with time zone,
    lifecycle_state varchar2,
    project_id varchar2,
    data_source_details dbms_cloud_oci_ai_anomaly_detection_data_source_details_t,
    private_endpoint_id varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    system_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The Unique Oracle ID (OCID) that is immutable on creation.

compartment_id

(required) The OCID of the compartment containing the DataAsset.

display_name

(required) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

description

(optional) A short description of the data asset.

time_created

(required) The time the the DataAsset was created. An RFC3339 formatted datetime string

time_updated

(optional) The time the the DataAsset was updated. An RFC3339 formatted datetime string

lifecycle_state

(required) The lifecycle state of the Data Asset.

Allowed values are: 'ACTIVE', 'DELETED'

project_id

(required) The Unique project id which is created at project creation that is immutable on creation.

data_source_details

(required)

private_endpoint_id

(optional) OCID of Private Endpoint.

freeform_tags

(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`

system_tags

(optional) Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{ \"orcl-cloud\": { \"free-tier-retained\": \"true\" } }`

DBMS_CLOUD_OCI_AI_ANOMALY_DETECTION_DATA_ASSET_SUMMARY_T Type

Summary of the DataAsset.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_anomaly_detection_data_asset_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  compartment_id varchar2(32767),
  display_name varchar2(32767),
  description varchar2(32767),
  time_created timestamp with time zone,
  time_updated timestamp with time zone,
  lifecycle_state varchar2(32767),
  project_id varchar2(32767),
  data_source_type varchar2(32767),
  private_endpoint_id varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  system_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_data_asset_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_data_asset_summary_t (
    id varchar2,
    compartment_id varchar2,
    display_name varchar2,
    description varchar2,
    time_created timestamp with time zone,
    time_updated timestamp with time zone,
    lifecycle_state varchar2,
    project_id varchar2,
    data_source_type varchar2,
    private_endpoint_id varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    system_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) Unique identifier that is immutable on creation

compartment_id

(required) Compartment Identifier

display_name

(required) DataAsset Identifier, can be renamed

description

(optional) A short description of the Ai data asset

time_created

(required) The time the the DataAsset was created. An RFC3339 formatted datetime string

time_updated

(optional) The time the the DataAsset was updated. An RFC3339 formatted datetime string

lifecycle_state

(optional) The current state of the data asset.

project_id

(required) Unique identifier for a project that is immutable on creation

data_source_type

(required) Data source type where actually data asset is being stored

Allowed values are: 'ORACLE_OBJECT_STORAGE', 'ORACLE_ATP', 'INFLUX'

private_endpoint_id

(optional) OCID of Private Endpoint.

freeform_tags

(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`

system_tags

(optional) Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{ \"orcl-cloud\": { \"free-tier-retained\": \"true\" } }`

DBMS_CLOUD_OCI_AI_ANOMALY_DETECTION_DATA_ASSET_SUMMARY_TBL Type

Nested table type of dbms_cloud_oci_ai_anomaly_detection_data_asset_summary_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_anomaly_detection_data_asset_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_ai_anomaly_detection_data_asset_summary_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_AI_ANOMALY_DETECTION_DATA_ASSET_COLLECTION_T Type

Results of a dataAsset search. Contains both DataAssetSummary items and other data.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_anomaly_detection_data_asset_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
  items dbms_cloud_oci_ai_anomaly_detection_data_asset_summary_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_data_asset_collection_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_data_asset_collection_t (
    items dbms_cloud_oci_ai_anomaly_detection_data_asset_summary_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

items

(required) List of dataAssets.

DBMS_CLOUD_OCI_AI_ANOMALY_DETECTION_NUMBER_TBL Type

Nested table type of number.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_anomaly_detection_number_tbl FORCE IS TABLE OF (number) NOT PERSISTABLE;

DBMS_CLOUD_OCI_AI_ANOMALY_DETECTION_DATA_ITEM_T Type

Simple object representing signal values at a certain point in time.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_anomaly_detection_data_item_t FORCE AUTHID CURRENT_USER IS OBJECT (
  l_timestamp timestamp with time zone,
  l_values dbms_cloud_oci_ai_anomaly_detection_number_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_data_item_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_data_item_t (
    l_timestamp timestamp with time zone,
    l_values dbms_cloud_oci_ai_anomaly_detection_number_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

l_timestamp

(optional) Nullable string representing timestamp.

l_values

(required) Array of double precision values.

DBMS_CLOUD_OCI_AI_ANOMALY_DETECTION_DATA_SOURCE_DETAILS_ATP_T Type

Data Source details for ATP

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_anomaly_detection_data_source_details_atp_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_ai_anomaly_detection_data_source_details_t (
  wallet_password_secret_id varchar2(32767),
  atp_user_name varchar2(32767),
  atp_password_secret_id varchar2(32767),
  cwallet_file_secret_id varchar2(32767),
  ewallet_file_secret_id varchar2(32767),
  key_store_file_secret_id varchar2(32767),
  ojdbc_file_secret_id varchar2(32767),
  tnsnames_file_secret_id varchar2(32767),
  truststore_file_secret_id varchar2(32767),
  database_name varchar2(32767),
  table_name varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_data_source_details_atp_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_data_source_details_atp_t (
    data_source_type varchar2,
    wallet_password_secret_id varchar2,
    atp_user_name varchar2,
    atp_password_secret_id varchar2,
    cwallet_file_secret_id varchar2,
    ewallet_file_secret_id varchar2,
    key_store_file_secret_id varchar2,
    ojdbc_file_secret_id varchar2,
    tnsnames_file_secret_id varchar2,
    truststore_file_secret_id varchar2,
    database_name varchar2,
    table_name varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_ai_anomaly_detection_data_source_details_atp_t is a subtype of the dbms_cloud_oci_ai_anomaly_detection_data_source_details_t type.

Fields

Field Description

wallet_password_secret_id

(optional) wallet password Secret ID in String format

atp_user_name

(optional) atp db user name

atp_password_secret_id

(optional) atp db password Secret Id

cwallet_file_secret_id

(optional) OCID of the secret containing the containers certificates of ATP wallet

ewallet_file_secret_id

(optional) OCID of the secret containing the PDB'S certificates of ATP wallet

key_store_file_secret_id

(optional) OCID of the secret containing Keystore.jks file of the ATP wallet

ojdbc_file_secret_id

(optional) OCID of the secret that contains jdbc properties file of ATP wallet

tnsnames_file_secret_id

(optional) OCID of the secret that contains the tnsnames file of ATP wallet

truststore_file_secret_id

(optional) OCID of the secret containing truststore.jks file of the ATP wallet

database_name

(optional) atp database name

table_name

(optional) atp database table name

DBMS_CLOUD_OCI_AI_ANOMALY_DETECTION_INFLUX_DETAILS_T Type

Possible data sources

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_anomaly_detection_influx_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  influx_version varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_influx_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_influx_details_t (
    influx_version varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE NOT FINAL;

Fields

Field Description

influx_version

(required) Data source type where actually data asset is being stored

Allowed values are: 'V_1_8', 'V_2_0'

DBMS_CLOUD_OCI_AI_ANOMALY_DETECTION_DATA_SOURCE_DETAILS_INFLUX_T Type

Data Source details for influx.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_anomaly_detection_data_source_details_influx_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_ai_anomaly_detection_data_source_details_t (
  version_specific_details dbms_cloud_oci_ai_anomaly_detection_influx_details_t,
  user_name varchar2(32767),
  password_secret_id varchar2(32767),
  measurement_name varchar2(32767),
  url varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_data_source_details_influx_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_data_source_details_influx_t (
    data_source_type varchar2,
    version_specific_details dbms_cloud_oci_ai_anomaly_detection_influx_details_t,
    user_name varchar2,
    password_secret_id varchar2,
    measurement_name varchar2,
    url varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_ai_anomaly_detection_data_source_details_influx_t is a subtype of the dbms_cloud_oci_ai_anomaly_detection_data_source_details_t type.

Fields

Field Description

version_specific_details

(required)

user_name

(required) Username for connection to Influx

password_secret_id

(required) Password Secret Id for the influx connection

measurement_name

(required) Measurement name for influx

url

(required) public IP address and port to influx DB

DBMS_CLOUD_OCI_AI_ANOMALY_DETECTION_DATA_SOURCE_DETAILS_OBJECT_STORAGE_T Type

Data Source details for object storage

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_anomaly_detection_data_source_details_object_storage_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_ai_anomaly_detection_data_source_details_t (
  namespace varchar2(32767),
  bucket_name varchar2(32767),
  object_name varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_data_source_details_object_storage_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_data_source_details_object_storage_t (
    data_source_type varchar2,
    namespace varchar2,
    bucket_name varchar2,
    object_name varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_ai_anomaly_detection_data_source_details_object_storage_t is a subtype of the dbms_cloud_oci_ai_anomaly_detection_data_source_details_t type.

Fields

Field Description

namespace

(optional) Object storage namespace

bucket_name

(optional) Object storage bucket name

object_name

(optional) File name

DBMS_CLOUD_OCI_AI_ANOMALY_DETECTION_DETECT_ANOMALIES_DETAILS_T Type

Base class for the DetectAnomalies call. It contains the identifier that is used for deciding what type of request this is.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_anomaly_detection_detect_anomalies_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  model_id varchar2(32767),
  request_type varchar2(32767),
  sensitivity number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_detect_anomalies_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_detect_anomalies_details_t (
    model_id varchar2,
    request_type varchar2,
    sensitivity number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE NOT FINAL;

Fields

Field Description

model_id

(required) The OCID of the trained model.

request_type

(required) Type of request. This parameter is automatically populated by classes generated by the SDK. For raw curl requests, you must provide this field.

Allowed values are: 'INLINE', 'BASE64_ENCODED'

sensitivity

(optional) Sensitivity of the algorithm to detect anomalies - higher the value, more anomalies get flagged. The value estimated during training is used by default. You can choose to provide a custom value.

DBMS_CLOUD_OCI_AI_ANOMALY_DETECTION_INPUT_JOB_DETAILS_T Type

Input details for detect anomaly job.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_anomaly_detection_input_job_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  input_type varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_input_job_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_input_job_details_t (
    input_type varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE NOT FINAL;

Fields

Field Description

input_type

(required) The type of input location Allowed values are: - `INLINE`: Inline input data. - `OBJECT_LIST`: Object store output location.

Allowed values are: 'INLINE', 'OBJECT_LIST'

DBMS_CLOUD_OCI_AI_ANOMALY_DETECTION_OUTPUT_JOB_DETAILS_T Type

Output details for detect anomaly job.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_anomaly_detection_output_job_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  output_type varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_output_job_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_output_job_details_t (
    output_type varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE NOT FINAL;

Fields

Field Description

output_type

(required) The type of output location Allowed values are: - `OBJECT_STORAGE`: Object store output location.

Allowed values are: 'OBJECT_STORAGE'

DBMS_CLOUD_OCI_AI_ANOMALY_DETECTION_DETECT_ANOMALY_JOB_T Type

Anomaly Job contains information for asynchronous detection of anomalies.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_anomaly_detection_detect_anomaly_job_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  compartment_id varchar2(32767),
  display_name varchar2(32767),
  description varchar2(32767),
  model_id varchar2(32767),
  project_id varchar2(32767),
  sensitivity number,
  are_all_estimates_required number,
  input_details dbms_cloud_oci_ai_anomaly_detection_input_job_details_t,
  output_details dbms_cloud_oci_ai_anomaly_detection_output_job_details_t,
  time_accepted timestamp with time zone,
  time_started timestamp with time zone,
  time_finished timestamp with time zone,
  lifecycle_state varchar2(32767),
  lifecycle_state_details varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  system_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_detect_anomaly_job_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_detect_anomaly_job_t (
    id varchar2,
    compartment_id varchar2,
    display_name varchar2,
    description varchar2,
    model_id varchar2,
    project_id varchar2,
    sensitivity number,
    are_all_estimates_required number,
    input_details dbms_cloud_oci_ai_anomaly_detection_input_job_details_t,
    output_details dbms_cloud_oci_ai_anomaly_detection_output_job_details_t,
    time_accepted timestamp with time zone,
    time_started timestamp with time zone,
    time_finished timestamp with time zone,
    lifecycle_state varchar2,
    lifecycle_state_details varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    system_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) Id of the job.

compartment_id

(required) The OCID of the compartment that starts the job.

display_name

(optional) Detect anomaly job display name.

description

(optional) Detect anomaly job description.

model_id

(required) The OCID of the trained model.

project_id

(optional) The OCID of the project.

sensitivity

(optional) The value that customer can adjust to control the sensitivity of anomaly detection

are_all_estimates_required

(optional) Flag to enable the service to return estimates for all data points rather than just the anomalous data points

input_details

(required)

output_details

(required)

time_accepted

(required) Job accepted time

time_started

(optional) Job started time

time_finished

(optional) Job finished time

lifecycle_state

(required) The current state of the batch document job.

Allowed values are: 'SUCCEEDED', 'PARTIALLY_SUCCEEDED', 'FAILED', 'ACCEPTED', 'CANCELED', 'IN_PROGRESS'

lifecycle_state_details

(optional) The current state details of the batch document job.

freeform_tags

(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`

system_tags

(optional) Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{ \"orcl-cloud\": { \"free-tier-retained\": \"true\" } }`

DBMS_CLOUD_OCI_AI_ANOMALY_DETECTION_DETECT_ANOMALY_JOB_SUMMARY_T Type

Anomaly Job summary contains minimal information for asynchronous inference of anomalies returned in list response.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_anomaly_detection_detect_anomaly_job_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  compartment_id varchar2(32767),
  display_name varchar2(32767),
  description varchar2(32767),
  model_id varchar2(32767),
  project_id varchar2(32767),
  time_accepted timestamp with time zone,
  time_started timestamp with time zone,
  time_finished timestamp with time zone,
  lifecycle_state varchar2(32767),
  lifecycle_state_details varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  system_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_detect_anomaly_job_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_detect_anomaly_job_summary_t (
    id varchar2,
    compartment_id varchar2,
    display_name varchar2,
    description varchar2,
    model_id varchar2,
    project_id varchar2,
    time_accepted timestamp with time zone,
    time_started timestamp with time zone,
    time_finished timestamp with time zone,
    lifecycle_state varchar2,
    lifecycle_state_details varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    system_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) Id of the job.

compartment_id

(required) The OCID of the compartment that starts the job.

display_name

(optional) Detect anomaly job display name.

description

(optional) Detect anomaly job description.

model_id

(required) The OCID of the trained model.

project_id

(optional) The OCID of the project.

time_accepted

(required) Job accepted time

time_started

(optional) Job started time

time_finished

(optional) Job finished time

lifecycle_state

(required) The current state of the batch document job.

lifecycle_state_details

(optional) The current state details of the batch document job.

freeform_tags

(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`

system_tags

(optional) Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{ \"orcl-cloud\": { \"free-tier-retained\": \"true\" } }`

DBMS_CLOUD_OCI_AI_ANOMALY_DETECTION_DETECT_ANOMALY_JOB_SUMMARY_TBL Type

Nested table type of dbms_cloud_oci_ai_anomaly_detection_detect_anomaly_job_summary_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_anomaly_detection_detect_anomaly_job_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_ai_anomaly_detection_detect_anomaly_job_summary_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_AI_ANOMALY_DETECTION_DETECT_ANOMALY_JOB_COLLECTION_T Type

A collection of anomaly jobs. Each item is a DetectAnomalyJob summary object.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_anomaly_detection_detect_anomaly_job_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
  items dbms_cloud_oci_ai_anomaly_detection_detect_anomaly_job_summary_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_detect_anomaly_job_collection_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_detect_anomaly_job_collection_t (
    items dbms_cloud_oci_ai_anomaly_detection_detect_anomaly_job_summary_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

items

(required) List of Anomaly Detection jobs.

DBMS_CLOUD_OCI_AI_ANOMALY_DETECTION_EMBEDDED_DETECT_ANOMALIES_REQUEST_T Type

The request body when the user selects to provide byte data in detect call which is Base64 encoded. The default type of the data is CSV and can be JSON by setting the 'contentType'.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_anomaly_detection_embedded_detect_anomalies_request_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_ai_anomaly_detection_detect_anomalies_details_t (
  content_type varchar2(32767),
  content clob,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_embedded_detect_anomalies_request_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_embedded_detect_anomalies_request_t (
    model_id varchar2,
    request_type varchar2,
    sensitivity number,
    content_type varchar2,
    content clob
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_ai_anomaly_detection_embedded_detect_anomalies_request_t is a subtype of the dbms_cloud_oci_ai_anomaly_detection_detect_anomalies_details_t type.

Fields

Field Description

content_type

(optional)

Allowed values are: 'CSV', 'JSON'

content

(required)

DBMS_CLOUD_OCI_AI_ANOMALY_DETECTION_EMBEDDED_INPUT_DETAILS_T Type

The request body when byte data is provided in detect call, which is Base64 encoded. The default type of the data is CSV and can be JSON by setting the 'contentType'.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_anomaly_detection_embedded_input_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_ai_anomaly_detection_input_details_t (
  content_type varchar2(32767),
  content clob,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_embedded_input_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_embedded_input_details_t (
    input_type varchar2,
    content_type varchar2,
    content clob
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_ai_anomaly_detection_embedded_input_details_t is a subtype of the dbms_cloud_oci_ai_anomaly_detection_input_details_t type.

Fields

Field Description

content_type

(required)

Allowed values are: 'CSV', 'JSON'

content

(required)

DBMS_CLOUD_OCI_AI_ANOMALY_DETECTION_ERROR_T Type

Error Information.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_anomaly_detection_error_t FORCE AUTHID CURRENT_USER IS OBJECT (
  code varchar2(32767),
  message varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_error_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_error_t (
    code varchar2,
    message varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

code

(required) A short error code that defines the error, meant for programmatic parsing.

message

(required) A human-readable error string.

DBMS_CLOUD_OCI_AI_ANOMALY_DETECTION_INFLUX_DETAILS_V1V8_T Type

Influx details for V_1_8.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_anomaly_detection_influx_details_v1v8_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_ai_anomaly_detection_influx_details_t (
  database_name varchar2(32767),
  retention_policy_name varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_influx_details_v1v8_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_influx_details_v1v8_t (
    influx_version varchar2,
    database_name varchar2,
    retention_policy_name varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_ai_anomaly_detection_influx_details_v1v8_t is a subtype of the dbms_cloud_oci_ai_anomaly_detection_influx_details_t type.

Fields

Field Description

database_name

(required) DB Name for influx connection

retention_policy_name

(optional) retention policy is how long the bucket would last

DBMS_CLOUD_OCI_AI_ANOMALY_DETECTION_INFLUX_DETAILS_V2V0_T Type

Influx details for V_2_0.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_anomaly_detection_influx_details_v2v0_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_ai_anomaly_detection_influx_details_t (
  bucket_name varchar2(32767),
  organization_name varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_influx_details_v2v0_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_influx_details_v2v0_t (
    influx_version varchar2,
    bucket_name varchar2,
    organization_name varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_ai_anomaly_detection_influx_details_v2v0_t is a subtype of the dbms_cloud_oci_ai_anomaly_detection_influx_details_t type.

Fields

Field Description

bucket_name

(required) Bucket Name for influx connection

organization_name

(required) Org name for the influx db

DBMS_CLOUD_OCI_AI_ANOMALY_DETECTION_DATA_ITEM_TBL Type

Nested table type of dbms_cloud_oci_ai_anomaly_detection_data_item_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_anomaly_detection_data_item_tbl FORCE IS TABLE OF (dbms_cloud_oci_ai_anomaly_detection_data_item_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_AI_ANOMALY_DETECTION_INLINE_DETECT_ANOMALIES_REQUEST_T Type

This is the specialised JSON format that is accepted as training data, with an additional field for 'requestType'. This is a required field used deciding whether it is an inline request or contains embedded data.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_anomaly_detection_inline_detect_anomalies_request_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_ai_anomaly_detection_detect_anomalies_details_t (
  signal_names dbms_cloud_oci_ai_anomaly_detection_varchar2_tbl,
  data dbms_cloud_oci_ai_anomaly_detection_data_item_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_inline_detect_anomalies_request_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_inline_detect_anomalies_request_t (
    model_id varchar2,
    request_type varchar2,
    sensitivity number,
    signal_names dbms_cloud_oci_ai_anomaly_detection_varchar2_tbl,
    data dbms_cloud_oci_ai_anomaly_detection_data_item_tbl
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_ai_anomaly_detection_inline_detect_anomalies_request_t is a subtype of the dbms_cloud_oci_ai_anomaly_detection_detect_anomalies_details_t type.

Fields

Field Description

signal_names

(required) List of signal names.

data

(required) Array containing data.

DBMS_CLOUD_OCI_AI_ANOMALY_DETECTION_INLINE_INPUT_DETAILS_T Type

This is the specialized JSON format that is accepted as training data, with an additional field for 'requestType'. This is a required field used deciding whether it is an inline request or contains embedded data.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_anomaly_detection_inline_input_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_ai_anomaly_detection_input_details_t (
  signal_names dbms_cloud_oci_ai_anomaly_detection_varchar2_tbl,
  data dbms_cloud_oci_ai_anomaly_detection_data_item_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_inline_input_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_inline_input_details_t (
    input_type varchar2,
    signal_names dbms_cloud_oci_ai_anomaly_detection_varchar2_tbl,
    data dbms_cloud_oci_ai_anomaly_detection_data_item_tbl
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_ai_anomaly_detection_inline_input_details_t is a subtype of the dbms_cloud_oci_ai_anomaly_detection_input_details_t type.

Fields

Field Description

signal_names

(required) List of signal names.

data

(required) Array containing data.

DBMS_CLOUD_OCI_AI_ANOMALY_DETECTION_INLINE_INPUT_JOB_DETAILS_T Type

This is the specialized JSON format with an additional field for 'locationType'. This is a required field used for deciding if it is an inline location or contains object-storage location.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_anomaly_detection_inline_input_job_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_ai_anomaly_detection_input_job_details_t (
  message varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_inline_input_job_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_inline_input_job_details_t (
    input_type varchar2,
    message varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_ai_anomaly_detection_inline_input_job_details_t is a subtype of the dbms_cloud_oci_ai_anomaly_detection_input_job_details_t type.

Fields

Field Description

message

(required) Inline input details.

DBMS_CLOUD_OCI_AI_ANOMALY_DETECTION_PER_SIGNAL_DETAILS_T Type

Detailed information like statistics, metrics and status for a signal

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_anomaly_detection_per_signal_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  signal_name varchar2(32767),
  mvi_ratio number,
  is_quantized number,
  fap number,
  l_min number,
  l_max number,
  std number,
  status varchar2(32767),
  details varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_per_signal_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_per_signal_details_t (
    signal_name varchar2,
    mvi_ratio number,
    is_quantized number,
    fap number,
    l_min number,
    l_max number,
    std number,
    status varchar2,
    details varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

signal_name

(required) The name of a signal.

mvi_ratio

(optional) The ratio of missing values in a signal filled/imputed by the IDP algorithm.

is_quantized

(optional) A boolean value to indicate if a signal is quantized or not.

fap

(optional) Accuracy metric for a signal.

l_min

(required) Min value within a signal.

l_max

(required) Max value within a signal.

std

(required) Standard deviation of values within a signal.

status

(required) 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

Allowed values are: 'ACCEPTED', 'DROPPED', 'OTHER'

details

(optional) detailed information for a signal.

DBMS_CLOUD_OCI_AI_ANOMALY_DETECTION_ROW_REDUCTION_DETAILS_T Type

Information regarding how/what row reduction methods will be applied. If this property is not present or is null, then it means row reduction is not applied.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_anomaly_detection_row_reduction_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  is_reduction_enabled number,
  reduction_percentage number,
  reduction_method varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_row_reduction_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_row_reduction_details_t (
    is_reduction_enabled number,
    reduction_percentage number,
    reduction_method varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

is_reduction_enabled

(required) A boolean value to indicate if row reduction is applied

reduction_percentage

(required) A percentage to reduce data size down to on top of original data

reduction_method

(required) Method for row reduction: * DELETE_ROW - delete rows with equal intervals * AVERAGE_ROW - average multiple rows to one row

Allowed values are: 'DELETE_ROW', 'AVERAGE_ROW'

DBMS_CLOUD_OCI_AI_ANOMALY_DETECTION_PER_SIGNAL_DETAILS_TBL Type

Nested table type of dbms_cloud_oci_ai_anomaly_detection_per_signal_details_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_anomaly_detection_per_signal_details_tbl FORCE IS TABLE OF (dbms_cloud_oci_ai_anomaly_detection_per_signal_details_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_AI_ANOMALY_DETECTION_MODEL_TRAINING_RESULTS_T Type

Specifies the details for an Anomaly Detection model trained with MSET.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_anomaly_detection_model_training_results_t FORCE AUTHID CURRENT_USER IS OBJECT (
  fap number,
  multivariate_fap number,
  algorithm varchar2(32767),
  window_size number,
  is_training_goal_achieved number,
  warning varchar2(32767),
  signal_details dbms_cloud_oci_ai_anomaly_detection_per_signal_details_tbl,
  row_reduction_details dbms_cloud_oci_ai_anomaly_detection_row_reduction_details_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_model_training_results_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_model_training_results_t (
    fap number,
    multivariate_fap number,
    algorithm varchar2,
    window_size number,
    is_training_goal_achieved number,
    warning varchar2,
    signal_details dbms_cloud_oci_ai_anomaly_detection_per_signal_details_tbl,
    row_reduction_details dbms_cloud_oci_ai_anomaly_detection_row_reduction_details_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

fap

(required) The final-achieved model accuracy metric on individual value level

multivariate_fap

(optional) The model accuracy metric on timestamp level.

algorithm

(optional) Actual algorithm used to train the model

Allowed values are: 'MULTIVARIATE_MSET', 'UNIVARIATE_OCSVM'

window_size

(optional) Window size defined during training or deduced by the algorithm.

is_training_goal_achieved

(optional) A boolean value to indicate if train goal/targetFap is achieved for trained model

warning

(optional) A warning message to explain the reason when targetFap cannot be achieved for trained model

signal_details

(optional) The list of signal details.

row_reduction_details

(optional)

DBMS_CLOUD_OCI_AI_ANOMALY_DETECTION_MODEL_T Type

Description of Model.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_anomaly_detection_model_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  display_name varchar2(32767),
  compartment_id varchar2(32767),
  model_training_details dbms_cloud_oci_ai_anomaly_detection_model_training_details_t,
  model_training_results dbms_cloud_oci_ai_anomaly_detection_model_training_results_t,
  project_id varchar2(32767),
  description varchar2(32767),
  time_created timestamp with time zone,
  time_updated timestamp with time zone,
  lifecycle_state varchar2(32767),
  lifecycle_details varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  system_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_model_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_model_t (
    id varchar2,
    display_name varchar2,
    compartment_id varchar2,
    model_training_details dbms_cloud_oci_ai_anomaly_detection_model_training_details_t,
    model_training_results dbms_cloud_oci_ai_anomaly_detection_model_training_results_t,
    project_id varchar2,
    description varchar2,
    time_created timestamp with time zone,
    time_updated timestamp with time zone,
    lifecycle_state varchar2,
    lifecycle_details varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    system_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the model that is immutable on creation.

display_name

(required) A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information.

compartment_id

(required) The OCID for the model's compartment.

model_training_details

(required)

model_training_results

(required)

project_id

(required) The OCID of the project to associate with the model.

description

(optional) A short description of the Model.

time_created

(required) The time the the Model was created. An RFC3339 formatted datetime string.

time_updated

(optional) The time the Model was updated. An RFC3339 formatted datetime string.

lifecycle_state

(required) The state of the model.

Allowed values are: 'DELETING', 'DELETED', 'FAILED', 'CREATING', 'ACTIVE', 'UPDATING'

lifecycle_details

(optional) A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

freeform_tags

(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`

system_tags

(optional) Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{ \"orcl-cloud\": { \"free-tier-retained\": \"true\" } }`

DBMS_CLOUD_OCI_AI_ANOMALY_DETECTION_MODEL_SUMMARY_T Type

Summary of the Model.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_anomaly_detection_model_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  display_name varchar2(32767),
  description varchar2(32767),
  compartment_id varchar2(32767),
  model_training_details dbms_cloud_oci_ai_anomaly_detection_model_training_details_t,
  model_training_results dbms_cloud_oci_ai_anomaly_detection_model_training_results_t,
  time_created timestamp with time zone,
  lifecycle_state varchar2(32767),
  project_id varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  system_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_model_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_model_summary_t (
    id varchar2,
    display_name varchar2,
    description varchar2,
    compartment_id varchar2,
    model_training_details dbms_cloud_oci_ai_anomaly_detection_model_training_details_t,
    model_training_results dbms_cloud_oci_ai_anomaly_detection_model_training_results_t,
    time_created timestamp with time zone,
    lifecycle_state varchar2,
    project_id varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    system_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the model.

display_name

(required) A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information.

description

(optional) A short description of the Model.

compartment_id

(required) The OCID for the model's compartment.

model_training_details

(optional)

model_training_results

(optional)

time_created

(required) The time the the Model was created. An RFC3339 formatted datetime string.

lifecycle_state

(required) The state of the model.

project_id

(required) The OCID of the project to associate with the model.

freeform_tags

(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`

system_tags

(optional) Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{ \"orcl-cloud\": { \"free-tier-retained\": \"true\" } }`

DBMS_CLOUD_OCI_AI_ANOMALY_DETECTION_MODEL_SUMMARY_TBL Type

Nested table type of dbms_cloud_oci_ai_anomaly_detection_model_summary_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_anomaly_detection_model_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_ai_anomaly_detection_model_summary_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_AI_ANOMALY_DETECTION_MODEL_COLLECTION_T Type

Results of a model search. Contains ModelSummary items.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_anomaly_detection_model_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
  items dbms_cloud_oci_ai_anomaly_detection_model_summary_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_model_collection_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_model_collection_t (
    items dbms_cloud_oci_ai_anomaly_detection_model_summary_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

items

(required) List of models

DBMS_CLOUD_OCI_AI_ANOMALY_DETECTION_OBJECT_LOCATION_T Type

A location in Object Storage that is uniquely identified by namespace name, bucket name, and object name.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_anomaly_detection_object_location_t FORCE AUTHID CURRENT_USER IS OBJECT (
  namespace_name varchar2(32767),
  bucket_name varchar2(32767),
  object_name varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_object_location_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_object_location_t (
    namespace_name varchar2,
    bucket_name varchar2,
    object_name varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

namespace_name

(required) Object Storage namespace name.

bucket_name

(required) Object Storage bucket name.

object_name

(required) Object Storage object name.

DBMS_CLOUD_OCI_AI_ANOMALY_DETECTION_OBJECT_LOCATION_TBL Type

Nested table type of dbms_cloud_oci_ai_anomaly_detection_object_location_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_anomaly_detection_object_location_tbl FORCE IS TABLE OF (dbms_cloud_oci_ai_anomaly_detection_object_location_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_AI_ANOMALY_DETECTION_OBJECT_LIST_INPUT_DETAILS_T Type

A list of object locations in Object Storage.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_anomaly_detection_object_list_input_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_ai_anomaly_detection_input_details_t (
  object_locations dbms_cloud_oci_ai_anomaly_detection_object_location_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_object_list_input_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_object_list_input_details_t (
    input_type varchar2,
    object_locations dbms_cloud_oci_ai_anomaly_detection_object_location_tbl
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_ai_anomaly_detection_object_list_input_details_t is a subtype of the dbms_cloud_oci_ai_anomaly_detection_input_details_t type.

Fields

Field Description

object_locations

(required) List of ObjectLocations.

DBMS_CLOUD_OCI_AI_ANOMALY_DETECTION_OBJECT_LIST_INPUT_JOB_DETAILS_T Type

A list of object locations in Object Storage.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_anomaly_detection_object_list_input_job_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_ai_anomaly_detection_input_job_details_t (
  object_locations dbms_cloud_oci_ai_anomaly_detection_object_location_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_object_list_input_job_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_object_list_input_job_details_t (
    input_type varchar2,
    object_locations dbms_cloud_oci_ai_anomaly_detection_object_location_tbl
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_ai_anomaly_detection_object_list_input_job_details_t is a subtype of the dbms_cloud_oci_ai_anomaly_detection_input_job_details_t type.

Fields

Field Description

object_locations

(required) List of ObjectLocations.

DBMS_CLOUD_OCI_AI_ANOMALY_DETECTION_OBJECT_STORAGE_LOCATION_T Type

This is the specialised JSON format with an additional field for 'locationType'. This is a required field used for deciding if it is an object-storage location.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_anomaly_detection_object_storage_location_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_ai_anomaly_detection_output_job_details_t (
  namespace_name varchar2(32767),
  bucket_name varchar2(32767),
  prefix varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_object_storage_location_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_object_storage_location_t (
    output_type varchar2,
    namespace_name varchar2,
    bucket_name varchar2,
    prefix varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_ai_anomaly_detection_object_storage_location_t is a subtype of the dbms_cloud_oci_ai_anomaly_detection_output_job_details_t type.

Fields

Field Description

namespace_name

(required) Object Storage namespace.

bucket_name

(required) Object Storage bucket name.

prefix

(required) Object Storage folder name.

DBMS_CLOUD_OCI_AI_ANOMALY_DETECTION_OBJECT_STORE_OUTPUT_DETAILS_T Type

OCI Object Storage Location.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_anomaly_detection_object_store_output_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_ai_anomaly_detection_output_details_t (
  namespace_name varchar2(32767),
  bucket_name varchar2(32767),
  prefix varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_object_store_output_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_object_store_output_details_t (
    output_type varchar2,
    namespace_name varchar2,
    bucket_name varchar2,
    prefix varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_ai_anomaly_detection_object_store_output_details_t is a subtype of the dbms_cloud_oci_ai_anomaly_detection_output_details_t type.

Fields

Field Description

namespace_name

(required) Object Storage namespace.

bucket_name

(required) Object Storage bucket name.

prefix

(optional) Object Storage folder name.

DBMS_CLOUD_OCI_AI_ANOMALY_DETECTION_PROJECT_T Type

Project enable users to organize their resources.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_anomaly_detection_project_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  display_name varchar2(32767),
  compartment_id varchar2(32767),
  description varchar2(32767),
  time_created timestamp with time zone,
  time_updated timestamp with time zone,
  lifecycle_state varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  system_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_project_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_project_t (
    id varchar2,
    display_name varchar2,
    compartment_id varchar2,
    description varchar2,
    time_created timestamp with time zone,
    time_updated timestamp with time zone,
    lifecycle_state varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    system_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the project that is immutable on creation.

display_name

(required) A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information.

compartment_id

(required) The OCID for the project's compartment.

description

(optional) A short description of the project.

time_created

(required) The date and time the resource was created in the timestamp format defined by RFC3339.

time_updated

(optional) The date and time the resource was updated in the timestamp format defined by RFC3339.

lifecycle_state

(required) The lifecycle state of the Project.

Allowed values are: 'ACTIVE', 'CREATING', 'FAILED', 'DELETING', 'DELETED', 'UPDATING'

freeform_tags

(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`

system_tags

(optional) Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{ \"orcl-cloud\": { \"free-tier-retained\": \"true\" } }`

DBMS_CLOUD_OCI_AI_ANOMALY_DETECTION_PROJECT_SUMMARY_T Type

Summary of the Project.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_anomaly_detection_project_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  display_name varchar2(32767),
  compartment_id varchar2(32767),
  description varchar2(32767),
  time_created timestamp with time zone,
  time_updated timestamp with time zone,
  lifecycle_state varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  system_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_project_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_project_summary_t (
    id varchar2,
    display_name varchar2,
    compartment_id varchar2,
    description varchar2,
    time_created timestamp with time zone,
    time_updated timestamp with time zone,
    lifecycle_state varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    system_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the project.

display_name

(required) A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information.

compartment_id

(required) The OCID for the project's compartment.

description

(optional) A short description of the project.

time_created

(required) The date and time the resource was created in the timestamp format defined by RFC3339.

time_updated

(optional) The date and time the resource was updated in the timestamp format defined by RFC3339.

lifecycle_state

(required) The state of the project.

freeform_tags

(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`

system_tags

(optional) Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{ \"orcl-cloud\": { \"free-tier-retained\": \"true\" } }`

DBMS_CLOUD_OCI_AI_ANOMALY_DETECTION_PROJECT_SUMMARY_TBL Type

Nested table type of dbms_cloud_oci_ai_anomaly_detection_project_summary_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_anomaly_detection_project_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_ai_anomaly_detection_project_summary_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_AI_ANOMALY_DETECTION_PROJECT_COLLECTION_T Type

Results of a projects list search. Contains Project objects.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_anomaly_detection_project_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
  items dbms_cloud_oci_ai_anomaly_detection_project_summary_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_project_collection_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_project_collection_t (
    items dbms_cloud_oci_ai_anomaly_detection_project_summary_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

items

(required) List of projects

DBMS_CLOUD_OCI_AI_ANOMALY_DETECTION_UPDATE_AI_PRIVATE_ENDPOINT_DETAILS_T Type

Information about the modified private endpoint resource.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_anomaly_detection_update_ai_private_endpoint_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  dns_zones dbms_cloud_oci_ai_anomaly_detection_varchar2_tbl,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  display_name varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_update_ai_private_endpoint_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_update_ai_private_endpoint_details_t (
    dns_zones dbms_cloud_oci_ai_anomaly_detection_varchar2_tbl,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    display_name varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

dns_zones

(optional) List of DNS zones to be used by the data assets. Example: custpvtsubnet.oraclevcn.com for data asset: db.custpvtsubnet.oraclevcn.com

freeform_tags

(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`

display_name

(optional) Display name of the private endpoint resource.

DBMS_CLOUD_OCI_AI_ANOMALY_DETECTION_UPDATE_DATA_ASSET_DETAILS_T Type

The information to be updated.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_anomaly_detection_update_data_asset_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  display_name varchar2(32767),
  description varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_update_data_asset_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_update_data_asset_details_t (
    display_name varchar2,
    description varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

display_name

(optional) DataAsset Identifier

description

(optional) DataAsset description

freeform_tags

(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`

DBMS_CLOUD_OCI_AI_ANOMALY_DETECTION_UPDATE_DETECT_ANOMALY_JOB_DETAILS_T Type

The information to be updated for the DetectAnomalyJob.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_anomaly_detection_update_detect_anomaly_job_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  description varchar2(32767),
  display_name varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_update_detect_anomaly_job_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_update_detect_anomaly_job_details_t (
    description varchar2,
    display_name varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

description

(optional) A short description of the detect anomaly job.

display_name

(optional) Detect anomaly job display name.

DBMS_CLOUD_OCI_AI_ANOMALY_DETECTION_UPDATE_MODEL_DETAILS_T Type

The information to be updated.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_anomaly_detection_update_model_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  display_name varchar2(32767),
  description varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_update_model_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_update_model_details_t (
    display_name varchar2,
    description varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

display_name

(optional) A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information.

description

(optional) A short description of the ai model.

freeform_tags

(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`

DBMS_CLOUD_OCI_AI_ANOMALY_DETECTION_UPDATE_PROJECT_DETAILS_T Type

The information to be updated for the project.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_anomaly_detection_update_project_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  display_name varchar2(32767),
  description varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_update_project_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_update_project_details_t (
    display_name varchar2,
    description varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

display_name

(optional) A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information.

description

(optional) A short description of the project.

freeform_tags

(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`

DBMS_CLOUD_OCI_AI_ANOMALY_DETECTION_WORK_REQUEST_RESOURCE_T Type

A resource created or operated on by a work request.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_anomaly_detection_work_request_resource_t FORCE AUTHID CURRENT_USER IS OBJECT (
  entity_type varchar2(32767),
  action_type varchar2(32767),
  identifier varchar2(32767),
  entity_uri varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_work_request_resource_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_work_request_resource_t (
    entity_type varchar2,
    action_type varchar2,
    identifier varchar2,
    entity_uri varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

entity_type

(required) The resource type the work request affects.

action_type

(required) The way in which this resource is affected by the work tracked in the work request. A resource being created, updated, or deleted will remain in the IN_PROGRESS state until work is complete for that resource at which point it will transition to CREATED, UPDATED, or DELETED, respectively.

Allowed values are: 'CREATED', 'UPDATED', 'DELETED', 'IN_PROGRESS', 'RELATED'

identifier

(required) The identifier of the resource the work request affects.

entity_uri

(optional) The URI path that the user can do a GET on to access the resource metadata

DBMS_CLOUD_OCI_AI_ANOMALY_DETECTION_WORK_REQUEST_RESOURCE_TBL Type

Nested table type of dbms_cloud_oci_ai_anomaly_detection_work_request_resource_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_anomaly_detection_work_request_resource_tbl FORCE IS TABLE OF (dbms_cloud_oci_ai_anomaly_detection_work_request_resource_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_AI_ANOMALY_DETECTION_WORK_REQUEST_T Type

A description of workrequest status

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_anomaly_detection_work_request_t FORCE AUTHID CURRENT_USER IS OBJECT (
  operation_type varchar2(32767),
  status varchar2(32767),
  id varchar2(32767),
  compartment_id varchar2(32767),
  resources dbms_cloud_oci_ai_anomaly_detection_work_request_resource_tbl,
  percent_complete number,
  time_accepted timestamp with time zone,
  time_started timestamp with time zone,
  time_finished timestamp with time zone,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_work_request_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_work_request_t (
    operation_type varchar2,
    status varchar2,
    id varchar2,
    compartment_id varchar2,
    resources dbms_cloud_oci_ai_anomaly_detection_work_request_resource_tbl,
    percent_complete number,
    time_accepted timestamp with time zone,
    time_started timestamp with time zone,
    time_finished timestamp with time zone
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

operation_type

(required) Type of the work request

Allowed values are: 'CREATE_MODEL', 'UPDATE_MODEL', 'DELETE_MODEL', 'CREATE_PRIVATE_ENDPOINT', 'DELETE_PRIVATE_ENDPOINT', 'UPDATE_PRIVATE_ENDPOINT', 'MOVE_PRIVATE_ENDPOINT'

status

(required) Status of current work request.

Allowed values are: 'ACCEPTED', 'IN_PROGRESS', 'FAILED', 'WAITING', 'SUCCEEDED', 'CANCELING', 'CANCELED'

id

(required) The id of the work request.

compartment_id

(required) The ocid of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request affects multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used

resources

(required) The resources affected by this work request.

percent_complete

(required) Percentage of the request completed.

time_accepted

(required) The date and time the request was created, as described in RFC 3339, section 14.29.

time_started

(optional) The date and time the request was started, as described in RFC 3339, section 14.29.

time_finished

(optional) The date and time the object was finished, as described in RFC 3339.

DBMS_CLOUD_OCI_AI_ANOMALY_DETECTION_WORK_REQUEST_ERROR_T Type

An error encountered while executing a work request.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_anomaly_detection_work_request_error_t FORCE AUTHID CURRENT_USER IS OBJECT (
  code varchar2(32767),
  message varchar2(32767),
  l_timestamp timestamp with time zone,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_work_request_error_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_work_request_error_t (
    code varchar2,
    message varchar2,
    l_timestamp timestamp with time zone
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

code

(required) A machine-usable code for the error that occured. Error codes are listed on (https://docs.cloud.oracle.com/Content/API/References/apierrors.htm)

message

(required) A human readable description of the issue encountered.

l_timestamp

(required) The time the error occured. An RFC3339 formatted datetime string.

DBMS_CLOUD_OCI_AI_ANOMALY_DETECTION_WORK_REQUEST_ERROR_TBL Type

Nested table type of dbms_cloud_oci_ai_anomaly_detection_work_request_error_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_anomaly_detection_work_request_error_tbl FORCE IS TABLE OF (dbms_cloud_oci_ai_anomaly_detection_work_request_error_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_AI_ANOMALY_DETECTION_WORK_REQUEST_ERROR_COLLECTION_T Type

Results of a workRequestError search. Contains both WorkRequestError items and other information, such as metadata.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_anomaly_detection_work_request_error_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
  items dbms_cloud_oci_ai_anomaly_detection_work_request_error_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_work_request_error_collection_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_work_request_error_collection_t (
    items dbms_cloud_oci_ai_anomaly_detection_work_request_error_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

items

(required) List of workRequestError objects.

DBMS_CLOUD_OCI_AI_ANOMALY_DETECTION_WORK_REQUEST_LOG_ENTRY_T Type

A log message from the execution of a work request.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_anomaly_detection_work_request_log_entry_t FORCE AUTHID CURRENT_USER IS OBJECT (
  message varchar2(32767),
  l_timestamp timestamp with time zone,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_work_request_log_entry_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_work_request_log_entry_t (
    message varchar2,
    l_timestamp timestamp with time zone
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

message

(required) Human-readable log message.

l_timestamp

(required) The time the log message was written. An RFC3339 formatted datetime string

DBMS_CLOUD_OCI_AI_ANOMALY_DETECTION_WORK_REQUEST_LOG_ENTRY_TBL Type

Nested table type of dbms_cloud_oci_ai_anomaly_detection_work_request_log_entry_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_anomaly_detection_work_request_log_entry_tbl FORCE IS TABLE OF (dbms_cloud_oci_ai_anomaly_detection_work_request_log_entry_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_AI_ANOMALY_DETECTION_WORK_REQUEST_LOG_ENTRY_COLLECTION_T Type

Results of a workRequestLog search. Contains both workRequestLog items and other information, such as metadata.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_anomaly_detection_work_request_log_entry_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
  items dbms_cloud_oci_ai_anomaly_detection_work_request_log_entry_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_work_request_log_entry_collection_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_work_request_log_entry_collection_t (
    items dbms_cloud_oci_ai_anomaly_detection_work_request_log_entry_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

items

(required) List of workRequestLogEntries.

DBMS_CLOUD_OCI_AI_ANOMALY_DETECTION_WORK_REQUEST_SUMMARY_T Type

A summary of the status of a work request.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_anomaly_detection_work_request_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  operation_type varchar2(32767),
  status varchar2(32767),
  id varchar2(32767),
  compartment_id varchar2(32767),
  resources dbms_cloud_oci_ai_anomaly_detection_work_request_resource_tbl,
  percent_complete number,
  time_accepted timestamp with time zone,
  time_started timestamp with time zone,
  time_finished timestamp with time zone,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_work_request_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_work_request_summary_t (
    operation_type varchar2,
    status varchar2,
    id varchar2,
    compartment_id varchar2,
    resources dbms_cloud_oci_ai_anomaly_detection_work_request_resource_tbl,
    percent_complete number,
    time_accepted timestamp with time zone,
    time_started timestamp with time zone,
    time_finished timestamp with time zone
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

operation_type

(required) Type of the work request

Allowed values are: 'CREATE_MODEL', 'UPDATE_MODEL', 'DELETE_MODEL', 'CREATE_PRIVATE_ENDPOINT', 'DELETE_PRIVATE_ENDPOINT', 'UPDATE_PRIVATE_ENDPOINT', 'MOVE_PRIVATE_ENDPOINT'

status

(required) Status of current work request.

Allowed values are: 'ACCEPTED', 'IN_PROGRESS', 'FAILED', 'WAITING', 'SUCCEEDED', 'CANCELING', 'CANCELED'

id

(required) The id of the work request.

compartment_id

(required) The ocid of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request affects multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used

resources

(required) The resources affected by this work request.

percent_complete

(required) Percentage of the request completed.

time_accepted

(required) The date and time the request was created, as described in RFC 3339, section 14.29.

time_started

(optional) The date and time the request was started, as described in RFC 3339, section 14.29.

time_finished

(optional) The date and time the object was finished, as described in RFC 3339.

DBMS_CLOUD_OCI_AI_ANOMALY_DETECTION_WORK_REQUEST_SUMMARY_TBL Type

Nested table type of dbms_cloud_oci_ai_anomaly_detection_work_request_summary_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_anomaly_detection_work_request_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_ai_anomaly_detection_work_request_summary_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_AI_ANOMALY_DETECTION_WORK_REQUEST_SUMMARY_COLLECTION_T Type

Results of a workRequest search. Contains both WorkRequest items and other information, such as metadata.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_anomaly_detection_work_request_summary_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
  items dbms_cloud_oci_ai_anomaly_detection_work_request_summary_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_work_request_summary_collection_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_anomaly_detection_work_request_summary_collection_t (
    items dbms_cloud_oci_ai_anomaly_detection_work_request_summary_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

items

(required) List of workRequestSummary objects.

Was this article helpful?