Creates a job to perform anomaly detection.


oci anomaly-detection detect-anomaly-job create-detect-anomaly-job-object-store-output-details [OPTIONS]

Required Parameters

--compartment-id, -c [text]

The OCID of the compartment that starts the job.

--input-details [complex type]

This is a complex type whose value must be valid JSON. The value can be provided as a string on the command line or passed in as a file using the file://path/to/file syntax.

The --generate-param-json-input option can be used to generate an example of the JSON which must be provided. We recommend storing this example in a file, modifying it as needed and then passing it back in via the file:// syntax.

--model-id [text]

The OCID of the trained model.

--output-details-bucket-name [text]

Object Storage bucket name.

--output-details-namespace-name [text]

Object Storage namespace.

Optional Parameters

--are-all-estimates-required [boolean]

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

--description [text]

A short description of the detect anomaly job.

--display-name [text]

Detect anomaly job display name.

--from-json [text]

Provide input to this command as a JSON document from a file using the file://path-to/file syntax.

The --generate-full-command-json-input option can be used to generate a sample json file to be used with this command option. The key names are pre-populated and match the command option names (converted to camelCase format, e.g. compartment-id –> compartmentId), while the values of the keys need to be populated by the user before using the sample file as an input to this command. For any command option that accepts multiple values, the value of the key can be a JSON array.

Options can still be provided on the command line. If an option exists in both the JSON document and the command line then the command line specified value will be used.

For examples on usage of this option, please see our “using CLI with advanced JSON options” link:

--max-wait-seconds [integer]

The maximum time to wait for the resource to reach the lifecycle state defined by --wait-for-state. Defaults to 1200 seconds.

--output-details-prefix [text]

Object Storage folder name.

--sensitivity [float]

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

--wait-for-state [text]

This operation creates, modifies or deletes a resource that has a defined lifecycle state. Specify this option to perform the action and then wait until the resource reaches a given lifecycle state. Multiple states can be specified, returning on the first state. For example, --wait-for-state SUCCEEDED --wait-for-state FAILED would return on whichever lifecycle state is reached first. If timeout is reached, a return code of 2 is returned. For any other error, a return code of 1 is returned.

Accepted values are:

--wait-interval-seconds [integer]

Check every --wait-interval-seconds to see whether the resource has reached the lifecycle state defined by --wait-for-state. Defaults to 30 seconds.

Example using required parameter

Copy and paste the following example into a JSON file, replacing the example parameters with your own.

    oci anomaly-detection model create --generate-param-json-input model-training-details > model-training-details.json

    oci anomaly-detection detect-anomaly-job create-detect-anomaly-job-object-store-output-details --generate-param-json-input input-details > input-details.json

Copy the following CLI commands into a file named Run the command by typing “bash” and replacing the example parameters with your own.

Please note this sample will only work in the POSIX-compliant bash-like shell. You need to set up the OCI configuration and appropriate security policies before trying the examples.

    export compartment_id=<substitute-value-of-compartment_id> #
    export output_details_bucket_name=<substitute-value-of-output_details_bucket_name> #
    export output_details_namespace_name=<substitute-value-of-output_details_namespace_name> #

    project_id=$(oci anomaly-detection project create --compartment-id $compartment_id --query --raw-output)

    model_id=$(oci anomaly-detection model create --compartment-id $compartment_id --model-training-details file://model-training-details.json --project-id $project_id --query --raw-output)

    oci anomaly-detection detect-anomaly-job create-detect-anomaly-job-object-store-output-details --compartment-id $compartment_id --input-details file://input-details.json --model-id $model_id --output-details-bucket-name $output_details_bucket_name --output-details-namespace-name $output_details_namespace_name