oci.AiAnomalyDetection.Model
Explore with Pulumi AI
This resource provides the Model resource in Oracle Cloud Infrastructure Ai Anomaly Detection service.
Creates a new Model.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testModel = new oci.aianomalydetection.Model("test_model", {
    compartmentId: compartmentId,
    modelTrainingDetails: {
        dataAssetIds: modelModelTrainingDetailsDataAssetIds,
        algorithmHint: modelModelTrainingDetailsAlgorithmHint,
        targetFap: modelModelTrainingDetailsTargetFap,
        trainingFraction: modelModelTrainingDetailsTrainingFraction,
        windowSize: modelModelTrainingDetailsWindowSize,
    },
    projectId: testProject.id,
    definedTags: {
        "foo-namespace.bar-key": "value",
    },
    description: modelDescription,
    displayName: modelDisplayName,
    freeformTags: {
        "bar-key": "value",
    },
});
import pulumi
import pulumi_oci as oci
test_model = oci.ai_anomaly_detection.Model("test_model",
    compartment_id=compartment_id,
    model_training_details={
        "data_asset_ids": model_model_training_details_data_asset_ids,
        "algorithm_hint": model_model_training_details_algorithm_hint,
        "target_fap": model_model_training_details_target_fap,
        "training_fraction": model_model_training_details_training_fraction,
        "window_size": model_model_training_details_window_size,
    },
    project_id=test_project["id"],
    defined_tags={
        "foo-namespace.bar-key": "value",
    },
    description=model_description,
    display_name=model_display_name,
    freeform_tags={
        "bar-key": "value",
    })
package main
import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/aianomalydetection"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := aianomalydetection.NewModel(ctx, "test_model", &aianomalydetection.ModelArgs{
			CompartmentId: pulumi.Any(compartmentId),
			ModelTrainingDetails: &aianomalydetection.ModelModelTrainingDetailsArgs{
				DataAssetIds:     pulumi.Any(modelModelTrainingDetailsDataAssetIds),
				AlgorithmHint:    pulumi.Any(modelModelTrainingDetailsAlgorithmHint),
				TargetFap:        pulumi.Any(modelModelTrainingDetailsTargetFap),
				TrainingFraction: pulumi.Any(modelModelTrainingDetailsTrainingFraction),
				WindowSize:       pulumi.Any(modelModelTrainingDetailsWindowSize),
			},
			ProjectId: pulumi.Any(testProject.Id),
			DefinedTags: pulumi.StringMap{
				"foo-namespace.bar-key": pulumi.String("value"),
			},
			Description: pulumi.Any(modelDescription),
			DisplayName: pulumi.Any(modelDisplayName),
			FreeformTags: pulumi.StringMap{
				"bar-key": pulumi.String("value"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;
return await Deployment.RunAsync(() => 
{
    var testModel = new Oci.AiAnomalyDetection.Model("test_model", new()
    {
        CompartmentId = compartmentId,
        ModelTrainingDetails = new Oci.AiAnomalyDetection.Inputs.ModelModelTrainingDetailsArgs
        {
            DataAssetIds = modelModelTrainingDetailsDataAssetIds,
            AlgorithmHint = modelModelTrainingDetailsAlgorithmHint,
            TargetFap = modelModelTrainingDetailsTargetFap,
            TrainingFraction = modelModelTrainingDetailsTrainingFraction,
            WindowSize = modelModelTrainingDetailsWindowSize,
        },
        ProjectId = testProject.Id,
        DefinedTags = 
        {
            { "foo-namespace.bar-key", "value" },
        },
        Description = modelDescription,
        DisplayName = modelDisplayName,
        FreeformTags = 
        {
            { "bar-key", "value" },
        },
    });
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.AiAnomalyDetection.Model;
import com.pulumi.oci.AiAnomalyDetection.ModelArgs;
import com.pulumi.oci.AiAnomalyDetection.inputs.ModelModelTrainingDetailsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var testModel = new Model("testModel", ModelArgs.builder()
            .compartmentId(compartmentId)
            .modelTrainingDetails(ModelModelTrainingDetailsArgs.builder()
                .dataAssetIds(modelModelTrainingDetailsDataAssetIds)
                .algorithmHint(modelModelTrainingDetailsAlgorithmHint)
                .targetFap(modelModelTrainingDetailsTargetFap)
                .trainingFraction(modelModelTrainingDetailsTrainingFraction)
                .windowSize(modelModelTrainingDetailsWindowSize)
                .build())
            .projectId(testProject.id())
            .definedTags(Map.of("foo-namespace.bar-key", "value"))
            .description(modelDescription)
            .displayName(modelDisplayName)
            .freeformTags(Map.of("bar-key", "value"))
            .build());
    }
}
resources:
  testModel:
    type: oci:AiAnomalyDetection:Model
    name: test_model
    properties:
      compartmentId: ${compartmentId}
      modelTrainingDetails:
        dataAssetIds: ${modelModelTrainingDetailsDataAssetIds}
        algorithmHint: ${modelModelTrainingDetailsAlgorithmHint}
        targetFap: ${modelModelTrainingDetailsTargetFap}
        trainingFraction: ${modelModelTrainingDetailsTrainingFraction}
        windowSize: ${modelModelTrainingDetailsWindowSize}
      projectId: ${testProject.id}
      definedTags:
        foo-namespace.bar-key: value
      description: ${modelDescription}
      displayName: ${modelDisplayName}
      freeformTags:
        bar-key: value
Create Model Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Model(name: string, args: ModelArgs, opts?: CustomResourceOptions);@overload
def Model(resource_name: str,
          args: ModelArgs,
          opts: Optional[ResourceOptions] = None)
@overload
def Model(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          compartment_id: Optional[str] = None,
          model_training_details: Optional[ModelModelTrainingDetailsArgs] = None,
          project_id: Optional[str] = None,
          defined_tags: Optional[Mapping[str, str]] = None,
          description: Optional[str] = None,
          display_name: Optional[str] = None,
          freeform_tags: Optional[Mapping[str, str]] = None)func NewModel(ctx *Context, name string, args ModelArgs, opts ...ResourceOption) (*Model, error)public Model(string name, ModelArgs args, CustomResourceOptions? opts = null)type: oci:AiAnomalyDetection:Model
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args ModelArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args ModelArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args ModelArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ModelArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ModelArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var modelResource = new Oci.AiAnomalyDetection.Model("modelResource", new()
{
    CompartmentId = "string",
    ModelTrainingDetails = new Oci.AiAnomalyDetection.Inputs.ModelModelTrainingDetailsArgs
    {
        DataAssetIds = new[]
        {
            "string",
        },
        AlgorithmHint = "string",
        TargetFap = 0,
        TrainingFraction = 0,
        WindowSize = 0,
    },
    ProjectId = "string",
    DefinedTags = 
    {
        { "string", "string" },
    },
    Description = "string",
    DisplayName = "string",
    FreeformTags = 
    {
        { "string", "string" },
    },
});
example, err := aianomalydetection.NewModel(ctx, "modelResource", &aianomalydetection.ModelArgs{
	CompartmentId: pulumi.String("string"),
	ModelTrainingDetails: &aianomalydetection.ModelModelTrainingDetailsArgs{
		DataAssetIds: pulumi.StringArray{
			pulumi.String("string"),
		},
		AlgorithmHint:    pulumi.String("string"),
		TargetFap:        pulumi.Float64(0),
		TrainingFraction: pulumi.Float64(0),
		WindowSize:       pulumi.Int(0),
	},
	ProjectId: pulumi.String("string"),
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Description: pulumi.String("string"),
	DisplayName: pulumi.String("string"),
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})
var modelResource = new com.pulumi.oci.AiAnomalyDetection.Model("modelResource", com.pulumi.oci.AiAnomalyDetection.ModelArgs.builder()
    .compartmentId("string")
    .modelTrainingDetails(ModelModelTrainingDetailsArgs.builder()
        .dataAssetIds("string")
        .algorithmHint("string")
        .targetFap(0.0)
        .trainingFraction(0.0)
        .windowSize(0)
        .build())
    .projectId("string")
    .definedTags(Map.of("string", "string"))
    .description("string")
    .displayName("string")
    .freeformTags(Map.of("string", "string"))
    .build());
model_resource = oci.ai_anomaly_detection.Model("modelResource",
    compartment_id="string",
    model_training_details={
        "data_asset_ids": ["string"],
        "algorithm_hint": "string",
        "target_fap": 0,
        "training_fraction": 0,
        "window_size": 0,
    },
    project_id="string",
    defined_tags={
        "string": "string",
    },
    description="string",
    display_name="string",
    freeform_tags={
        "string": "string",
    })
const modelResource = new oci.aianomalydetection.Model("modelResource", {
    compartmentId: "string",
    modelTrainingDetails: {
        dataAssetIds: ["string"],
        algorithmHint: "string",
        targetFap: 0,
        trainingFraction: 0,
        windowSize: 0,
    },
    projectId: "string",
    definedTags: {
        string: "string",
    },
    description: "string",
    displayName: "string",
    freeformTags: {
        string: "string",
    },
});
type: oci:AiAnomalyDetection:Model
properties:
    compartmentId: string
    definedTags:
        string: string
    description: string
    displayName: string
    freeformTags:
        string: string
    modelTrainingDetails:
        algorithmHint: string
        dataAssetIds:
            - string
        targetFap: 0
        trainingFraction: 0
        windowSize: 0
    projectId: string
Model Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Model resource accepts the following input properties:
- CompartmentId string
- (Updatable) The OCID for the ai model's compartment.
- ModelTraining ModelDetails Model Training Details 
- Specifies the details of the MSET model during the create call.
- ProjectId string
- The OCID of the project to associate with the model. - ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values 
- Dictionary<string, string>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- Description string
- (Updatable) A short description of the ai model.
- DisplayName string
- (Updatable) A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information.
- Dictionary<string, string>
- (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
- CompartmentId string
- (Updatable) The OCID for the ai model's compartment.
- ModelTraining ModelDetails Model Training Details Args 
- Specifies the details of the MSET model during the create call.
- ProjectId string
- The OCID of the project to associate with the model. - ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values 
- map[string]string
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- Description string
- (Updatable) A short description of the ai model.
- DisplayName string
- (Updatable) A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information.
- map[string]string
- (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
- compartmentId String
- (Updatable) The OCID for the ai model's compartment.
- modelTraining ModelDetails Model Training Details 
- Specifies the details of the MSET model during the create call.
- projectId String
- The OCID of the project to associate with the model. - ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values 
- Map<String,String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- description String
- (Updatable) A short description of the ai model.
- displayName String
- (Updatable) A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information.
- Map<String,String>
- (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
- compartmentId string
- (Updatable) The OCID for the ai model's compartment.
- modelTraining ModelDetails Model Training Details 
- Specifies the details of the MSET model during the create call.
- projectId string
- The OCID of the project to associate with the model. - ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values 
- {[key: string]: string}
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- description string
- (Updatable) A short description of the ai model.
- displayName string
- (Updatable) A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information.
- {[key: string]: string}
- (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
- compartment_id str
- (Updatable) The OCID for the ai model's compartment.
- model_training_ Modeldetails Model Training Details Args 
- Specifies the details of the MSET model during the create call.
- project_id str
- The OCID of the project to associate with the model. - ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values 
- Mapping[str, str]
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- description str
- (Updatable) A short description of the ai model.
- display_name str
- (Updatable) A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information.
- Mapping[str, str]
- (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
- compartmentId String
- (Updatable) The OCID for the ai model's compartment.
- modelTraining Property MapDetails 
- Specifies the details of the MSET model during the create call.
- projectId String
- The OCID of the project to associate with the model. - ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values 
- Map<String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- description String
- (Updatable) A short description of the ai model.
- displayName String
- (Updatable) A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information.
- Map<String>
- (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
Outputs
All input properties are implicitly available as output properties. Additionally, the Model resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- LifecycleDetails string
- A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
- ModelTraining List<ModelResults Model Training Result> 
- Specifies the details for an Anomaly Detection model trained with MSET.
- State string
- The state of the model.
- Dictionary<string, string>
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
- TimeCreated string
- The time the the Model was created. An RFC3339 formatted datetime string.
- TimeUpdated string
- The time the Model was updated. An RFC3339 formatted datetime string.
- Id string
- The provider-assigned unique ID for this managed resource.
- LifecycleDetails string
- A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
- ModelTraining []ModelResults Model Training Result 
- Specifies the details for an Anomaly Detection model trained with MSET.
- State string
- The state of the model.
- map[string]string
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
- TimeCreated string
- The time the the Model was created. An RFC3339 formatted datetime string.
- TimeUpdated string
- The time the Model was updated. An RFC3339 formatted datetime string.
- id String
- The provider-assigned unique ID for this managed resource.
- lifecycleDetails String
- A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
- modelTraining List<ModelResults Model Training Result> 
- Specifies the details for an Anomaly Detection model trained with MSET.
- state String
- The state of the model.
- Map<String,String>
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
- timeCreated String
- The time the the Model was created. An RFC3339 formatted datetime string.
- timeUpdated String
- The time the Model was updated. An RFC3339 formatted datetime string.
- id string
- The provider-assigned unique ID for this managed resource.
- lifecycleDetails string
- A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
- modelTraining ModelResults Model Training Result[] 
- Specifies the details for an Anomaly Detection model trained with MSET.
- state string
- The state of the model.
- {[key: string]: string}
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
- timeCreated string
- The time the the Model was created. An RFC3339 formatted datetime string.
- timeUpdated string
- The time the Model was updated. An RFC3339 formatted datetime string.
- id str
- The provider-assigned unique ID for this managed resource.
- lifecycle_details str
- A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
- model_training_ Sequence[Modelresults Model Training Result] 
- Specifies the details for an Anomaly Detection model trained with MSET.
- state str
- The state of the model.
- Mapping[str, str]
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
- time_created str
- The time the the Model was created. An RFC3339 formatted datetime string.
- time_updated str
- The time the Model was updated. An RFC3339 formatted datetime string.
- id String
- The provider-assigned unique ID for this managed resource.
- lifecycleDetails String
- A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
- modelTraining List<Property Map>Results 
- Specifies the details for an Anomaly Detection model trained with MSET.
- state String
- The state of the model.
- Map<String>
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
- timeCreated String
- The time the the Model was created. An RFC3339 formatted datetime string.
- timeUpdated String
- The time the Model was updated. An RFC3339 formatted datetime string.
Look up Existing Model Resource
Get an existing Model resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: ModelState, opts?: CustomResourceOptions): Model@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        compartment_id: Optional[str] = None,
        defined_tags: Optional[Mapping[str, str]] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, str]] = None,
        lifecycle_details: Optional[str] = None,
        model_training_details: Optional[ModelModelTrainingDetailsArgs] = None,
        model_training_results: Optional[Sequence[ModelModelTrainingResultArgs]] = None,
        project_id: Optional[str] = None,
        state: Optional[str] = None,
        system_tags: Optional[Mapping[str, str]] = None,
        time_created: Optional[str] = None,
        time_updated: Optional[str] = None) -> Modelfunc GetModel(ctx *Context, name string, id IDInput, state *ModelState, opts ...ResourceOption) (*Model, error)public static Model Get(string name, Input<string> id, ModelState? state, CustomResourceOptions? opts = null)public static Model get(String name, Output<String> id, ModelState state, CustomResourceOptions options)resources:  _:    type: oci:AiAnomalyDetection:Model    get:      id: ${id}- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- CompartmentId string
- (Updatable) The OCID for the ai model's compartment.
- Dictionary<string, string>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- Description string
- (Updatable) A short description of the ai model.
- DisplayName string
- (Updatable) A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information.
- Dictionary<string, string>
- (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
- LifecycleDetails string
- A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
- ModelTraining ModelDetails Model Training Details 
- Specifies the details of the MSET model during the create call.
- ModelTraining List<ModelResults Model Training Result> 
- Specifies the details for an Anomaly Detection model trained with MSET.
- ProjectId string
- The OCID of the project to associate with the model. - ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values 
- State string
- The state of the model.
- Dictionary<string, string>
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
- TimeCreated string
- The time the the Model was created. An RFC3339 formatted datetime string.
- TimeUpdated string
- The time the Model was updated. An RFC3339 formatted datetime string.
- CompartmentId string
- (Updatable) The OCID for the ai model's compartment.
- map[string]string
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- Description string
- (Updatable) A short description of the ai model.
- DisplayName string
- (Updatable) A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information.
- map[string]string
- (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
- LifecycleDetails string
- A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
- ModelTraining ModelDetails Model Training Details Args 
- Specifies the details of the MSET model during the create call.
- ModelTraining []ModelResults Model Training Result Args 
- Specifies the details for an Anomaly Detection model trained with MSET.
- ProjectId string
- The OCID of the project to associate with the model. - ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values 
- State string
- The state of the model.
- map[string]string
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
- TimeCreated string
- The time the the Model was created. An RFC3339 formatted datetime string.
- TimeUpdated string
- The time the Model was updated. An RFC3339 formatted datetime string.
- compartmentId String
- (Updatable) The OCID for the ai model's compartment.
- Map<String,String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- description String
- (Updatable) A short description of the ai model.
- displayName String
- (Updatable) A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information.
- Map<String,String>
- (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
- lifecycleDetails String
- A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
- modelTraining ModelDetails Model Training Details 
- Specifies the details of the MSET model during the create call.
- modelTraining List<ModelResults Model Training Result> 
- Specifies the details for an Anomaly Detection model trained with MSET.
- projectId String
- The OCID of the project to associate with the model. - ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values 
- state String
- The state of the model.
- Map<String,String>
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
- timeCreated String
- The time the the Model was created. An RFC3339 formatted datetime string.
- timeUpdated String
- The time the Model was updated. An RFC3339 formatted datetime string.
- compartmentId string
- (Updatable) The OCID for the ai model's compartment.
- {[key: string]: string}
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- description string
- (Updatable) A short description of the ai model.
- displayName string
- (Updatable) A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information.
- {[key: string]: string}
- (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
- lifecycleDetails string
- A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
- modelTraining ModelDetails Model Training Details 
- Specifies the details of the MSET model during the create call.
- modelTraining ModelResults Model Training Result[] 
- Specifies the details for an Anomaly Detection model trained with MSET.
- projectId string
- The OCID of the project to associate with the model. - ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values 
- state string
- The state of the model.
- {[key: string]: string}
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
- timeCreated string
- The time the the Model was created. An RFC3339 formatted datetime string.
- timeUpdated string
- The time the Model was updated. An RFC3339 formatted datetime string.
- compartment_id str
- (Updatable) The OCID for the ai model's compartment.
- Mapping[str, str]
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- description str
- (Updatable) A short description of the ai model.
- display_name str
- (Updatable) A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information.
- Mapping[str, str]
- (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
- lifecycle_details str
- A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
- model_training_ Modeldetails Model Training Details Args 
- Specifies the details of the MSET model during the create call.
- model_training_ Sequence[Modelresults Model Training Result Args] 
- Specifies the details for an Anomaly Detection model trained with MSET.
- project_id str
- The OCID of the project to associate with the model. - ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values 
- state str
- The state of the model.
- Mapping[str, str]
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
- time_created str
- The time the the Model was created. An RFC3339 formatted datetime string.
- time_updated str
- The time the Model was updated. An RFC3339 formatted datetime string.
- compartmentId String
- (Updatable) The OCID for the ai model's compartment.
- Map<String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- description String
- (Updatable) A short description of the ai model.
- displayName String
- (Updatable) A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information.
- Map<String>
- (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
- lifecycleDetails String
- A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
- modelTraining Property MapDetails 
- Specifies the details of the MSET model during the create call.
- modelTraining List<Property Map>Results 
- Specifies the details for an Anomaly Detection model trained with MSET.
- projectId String
- The OCID of the project to associate with the model. - ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values 
- state String
- The state of the model.
- Map<String>
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
- timeCreated String
- The time the the Model was created. An RFC3339 formatted datetime string.
- timeUpdated String
- The time the Model was updated. An RFC3339 formatted datetime string.
Supporting Types
ModelModelTrainingDetails, ModelModelTrainingDetailsArgs        
- DataAsset List<string>Ids 
- 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.
- AlgorithmHint string
- User can choose specific algorithm for training.
- TargetFap double
- A target model accuracy metric user provides as their requirement
- TrainingFraction double
- Fraction of total data that is used for training the model. The remaining is used for validation of the model.
- WindowSize int
- This value would determine the window size of the training algorithm.
- DataAsset []stringIds 
- 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.
- AlgorithmHint string
- User can choose specific algorithm for training.
- TargetFap float64
- A target model accuracy metric user provides as their requirement
- TrainingFraction float64
- Fraction of total data that is used for training the model. The remaining is used for validation of the model.
- WindowSize int
- This value would determine the window size of the training algorithm.
- dataAsset List<String>Ids 
- 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.
- algorithmHint String
- User can choose specific algorithm for training.
- targetFap Double
- A target model accuracy metric user provides as their requirement
- trainingFraction Double
- Fraction of total data that is used for training the model. The remaining is used for validation of the model.
- windowSize Integer
- This value would determine the window size of the training algorithm.
- dataAsset string[]Ids 
- 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.
- algorithmHint string
- User can choose specific algorithm for training.
- targetFap number
- A target model accuracy metric user provides as their requirement
- trainingFraction number
- Fraction of total data that is used for training the model. The remaining is used for validation of the model.
- windowSize number
- This value would determine the window size of the training algorithm.
- data_asset_ Sequence[str]ids 
- 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.
- algorithm_hint str
- User can choose specific algorithm for training.
- target_fap float
- A target model accuracy metric user provides as their requirement
- training_fraction float
- Fraction of total data that is used for training the model. The remaining is used for validation of the model.
- window_size int
- This value would determine the window size of the training algorithm.
- dataAsset List<String>Ids 
- 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.
- algorithmHint String
- User can choose specific algorithm for training.
- targetFap Number
- A target model accuracy metric user provides as their requirement
- trainingFraction Number
- Fraction of total data that is used for training the model. The remaining is used for validation of the model.
- windowSize Number
- This value would determine the window size of the training algorithm.
ModelModelTrainingResult, ModelModelTrainingResultArgs        
- Fap double
- Accuracy metric for a signal.
- IsTraining boolGoal Achieved 
- A boolean value to indicate if train goal/targetFap is achieved for trained model
- Mae double
- MaxInference intSync Rows 
- MultivariateFap double
- The model accuracy metric on timestamp level.
- Rmse double
- RowReduction List<ModelDetails Model Training Result Row Reduction Detail> 
- 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.
- SignalDetails List<ModelModel Training Result Signal Detail> 
- The list of signal details.
- Warning string
- A warning message to explain the reason when targetFap cannot be achieved for trained model
- WindowSize int
- Window size defined during training or deduced by the algorithm.
- Fap float64
- Accuracy metric for a signal.
- IsTraining boolGoal Achieved 
- A boolean value to indicate if train goal/targetFap is achieved for trained model
- Mae float64
- MaxInference intSync Rows 
- MultivariateFap float64
- The model accuracy metric on timestamp level.
- Rmse float64
- RowReduction []ModelDetails Model Training Result Row Reduction Detail 
- 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.
- SignalDetails []ModelModel Training Result Signal Detail 
- The list of signal details.
- Warning string
- A warning message to explain the reason when targetFap cannot be achieved for trained model
- WindowSize int
- Window size defined during training or deduced by the algorithm.
- fap Double
- Accuracy metric for a signal.
- isTraining BooleanGoal Achieved 
- A boolean value to indicate if train goal/targetFap is achieved for trained model
- mae Double
- maxInference IntegerSync Rows 
- multivariateFap Double
- The model accuracy metric on timestamp level.
- rmse Double
- rowReduction List<ModelDetails Model Training Result Row Reduction Detail> 
- 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.
- signalDetails List<ModelModel Training Result Signal Detail> 
- The list of signal details.
- warning String
- A warning message to explain the reason when targetFap cannot be achieved for trained model
- windowSize Integer
- Window size defined during training or deduced by the algorithm.
- fap number
- Accuracy metric for a signal.
- isTraining booleanGoal Achieved 
- A boolean value to indicate if train goal/targetFap is achieved for trained model
- mae number
- maxInference numberSync Rows 
- multivariateFap number
- The model accuracy metric on timestamp level.
- rmse number
- rowReduction ModelDetails Model Training Result Row Reduction Detail[] 
- 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.
- signalDetails ModelModel Training Result Signal Detail[] 
- The list of signal details.
- warning string
- A warning message to explain the reason when targetFap cannot be achieved for trained model
- windowSize number
- Window size defined during training or deduced by the algorithm.
- fap float
- Accuracy metric for a signal.
- is_training_ boolgoal_ achieved 
- A boolean value to indicate if train goal/targetFap is achieved for trained model
- mae float
- max_inference_ intsync_ rows 
- multivariate_fap float
- The model accuracy metric on timestamp level.
- rmse float
- row_reduction_ Sequence[Modeldetails Model Training Result Row Reduction Detail] 
- 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.
- signal_details Sequence[ModelModel Training Result Signal Detail] 
- The list of signal details.
- warning str
- A warning message to explain the reason when targetFap cannot be achieved for trained model
- window_size int
- Window size defined during training or deduced by the algorithm.
- fap Number
- Accuracy metric for a signal.
- isTraining BooleanGoal Achieved 
- A boolean value to indicate if train goal/targetFap is achieved for trained model
- mae Number
- maxInference NumberSync Rows 
- multivariateFap Number
- The model accuracy metric on timestamp level.
- rmse Number
- rowReduction List<Property Map>Details 
- 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.
- signalDetails List<Property Map>
- The list of signal details.
- warning String
- A warning message to explain the reason when targetFap cannot be achieved for trained model
- windowSize Number
- Window size defined during training or deduced by the algorithm.
ModelModelTrainingResultRowReductionDetail, ModelModelTrainingResultRowReductionDetailArgs              
- IsReduction boolEnabled 
- A boolean value to indicate if row reduction is applied
- ReductionMethod string
- Method for row reduction:- DELETE_ROW - delete rows with equal intervals
- AVERAGE_ROW - average multiple rows to one row
 
- ReductionPercentage double
- A percentage to reduce data size down to on top of original data
- IsReduction boolEnabled 
- A boolean value to indicate if row reduction is applied
- ReductionMethod string
- Method for row reduction:- DELETE_ROW - delete rows with equal intervals
- AVERAGE_ROW - average multiple rows to one row
 
- ReductionPercentage float64
- A percentage to reduce data size down to on top of original data
- isReduction BooleanEnabled 
- A boolean value to indicate if row reduction is applied
- reductionMethod String
- Method for row reduction:- DELETE_ROW - delete rows with equal intervals
- AVERAGE_ROW - average multiple rows to one row
 
- reductionPercentage Double
- A percentage to reduce data size down to on top of original data
- isReduction booleanEnabled 
- A boolean value to indicate if row reduction is applied
- reductionMethod string
- Method for row reduction:- DELETE_ROW - delete rows with equal intervals
- AVERAGE_ROW - average multiple rows to one row
 
- reductionPercentage number
- A percentage to reduce data size down to on top of original data
- is_reduction_ boolenabled 
- A boolean value to indicate if row reduction is applied
- reduction_method str
- Method for row reduction:- DELETE_ROW - delete rows with equal intervals
- AVERAGE_ROW - average multiple rows to one row
 
- reduction_percentage float
- A percentage to reduce data size down to on top of original data
- isReduction BooleanEnabled 
- A boolean value to indicate if row reduction is applied
- reductionMethod String
- Method for row reduction:- DELETE_ROW - delete rows with equal intervals
- AVERAGE_ROW - average multiple rows to one row
 
- reductionPercentage Number
- A percentage to reduce data size down to on top of original data
ModelModelTrainingResultSignalDetail, ModelModelTrainingResultSignalDetailArgs            
- Details string
- detailed information for a signal.
- Fap double
- Accuracy metric for a signal.
- IsQuantized bool
- A boolean value to indicate if a signal is quantized or not.
- Max double
- Max value within a signal.
- Min double
- Min value within a signal.
- MviRatio double
- The ratio of missing values in a signal filled/imputed by the IDP algorithm.
- SignalName string
- The name of a signal.
- Status string
- 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
 
- Std double
- Standard deviation of values within a signal.
- Details string
- detailed information for a signal.
- Fap float64
- Accuracy metric for a signal.
- IsQuantized bool
- A boolean value to indicate if a signal is quantized or not.
- Max float64
- Max value within a signal.
- Min float64
- Min value within a signal.
- MviRatio float64
- The ratio of missing values in a signal filled/imputed by the IDP algorithm.
- SignalName string
- The name of a signal.
- Status string
- 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
 
- Std float64
- Standard deviation of values within a signal.
- details String
- detailed information for a signal.
- fap Double
- Accuracy metric for a signal.
- isQuantized Boolean
- A boolean value to indicate if a signal is quantized or not.
- max Double
- Max value within a signal.
- min Double
- Min value within a signal.
- mviRatio Double
- The ratio of missing values in a signal filled/imputed by the IDP algorithm.
- signalName String
- The name of a signal.
- status String
- 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
 
- std Double
- Standard deviation of values within a signal.
- details string
- detailed information for a signal.
- fap number
- Accuracy metric for a signal.
- isQuantized boolean
- A boolean value to indicate if a signal is quantized or not.
- max number
- Max value within a signal.
- min number
- Min value within a signal.
- mviRatio number
- The ratio of missing values in a signal filled/imputed by the IDP algorithm.
- signalName string
- The name of a signal.
- status string
- 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
 
- std number
- Standard deviation of values within a signal.
- details str
- detailed information for a signal.
- fap float
- Accuracy metric for a signal.
- is_quantized bool
- A boolean value to indicate if a signal is quantized or not.
- max float
- Max value within a signal.
- min float
- Min value within a signal.
- mvi_ratio float
- The ratio of missing values in a signal filled/imputed by the IDP algorithm.
- signal_name str
- The name of a signal.
- status str
- 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
 
- std float
- Standard deviation of values within a signal.
- details String
- detailed information for a signal.
- fap Number
- Accuracy metric for a signal.
- isQuantized Boolean
- A boolean value to indicate if a signal is quantized or not.
- max Number
- Max value within a signal.
- min Number
- Min value within a signal.
- mviRatio Number
- The ratio of missing values in a signal filled/imputed by the IDP algorithm.
- signalName String
- The name of a signal.
- status String
- 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
 
- std Number
- Standard deviation of values within a signal.
Import
Models can be imported using the id, e.g.
$ pulumi import oci:AiAnomalyDetection/model:Model test_model "id"
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the ociTerraform Provider.