Class Model

Models are mathematical representations of the relationships between data. Models are represented by their associated metadata and artifacts.

Inheritance
object
Model
Inherited Members
Namespace: Oci.DatascienceService.Models
Assembly: OCI.DotNetSDK.Datascience.dll
Syntax
public class Model

Properties

BackupOperationDetails

Declaration
[Required(ErrorMessage = "BackupOperationDetails is required.")]
[JsonProperty(PropertyName = "backupOperationDetails")]
public BackupOperationDetails BackupOperationDetails { get; set; }
Property Value
Type Description
BackupOperationDetails
Remarks

Required

BackupSetting

Declaration
[Required(ErrorMessage = "BackupSetting is required.")]
[JsonProperty(PropertyName = "backupSetting")]
public BackupSetting BackupSetting { get; set; }
Property Value
Type Description
BackupSetting
Remarks

Required

Category

Declaration
[Required(ErrorMessage = "Category is required.")]
[JsonProperty(PropertyName = "category")]
[JsonConverter(typeof(ResponseEnumConverter))]
public ModelCategory? Category { get; set; }
Property Value
Type Description
ModelCategory?

The category of the model.
Remarks

Required

CompartmentId

Declaration
[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }
Property Value
Type Description
string

The OCID of the model's compartment.
Remarks

Required

CreatedBy

Declaration
[Required(ErrorMessage = "CreatedBy is required.")]
[JsonProperty(PropertyName = "createdBy")]
public string CreatedBy { get; set; }
Property Value
Type Description
string

The OCID of the user who created the model.
Remarks

Required

CustomMetadataList

Declaration
[JsonProperty(PropertyName = "customMetadataList")]
public List<Metadata> CustomMetadataList { get; set; }
Property Value
Type Description
List<Metadata>

An array of custom metadata details for the model.

DefinedMetadataList

Declaration
[JsonProperty(PropertyName = "definedMetadataList")]
public List<Metadata> DefinedMetadataList { get; set; }
Property Value
Type Description
List<Metadata>

An array of defined metadata details for the model.

DefinedTags

Declaration
[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }
Property Value
Type Description
Dictionary<string, Dictionary<string, object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"Operations": {"CostCenter": "42"}}

Description

Declaration
[JsonProperty(PropertyName = "description")]
public string Description { get; set; }
Property Value
Type Description
string

A short description of the model.

DisplayName

Declaration
[Required(ErrorMessage = "DisplayName is required.")]
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }
Property Value
Type Description
string

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

Required

FreeformTags

Declaration
[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }
Property Value
Type Description
Dictionary<string, string>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See Resource Tags. Example: {"Department": "Finance"}

Id

Declaration
[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }
Property Value
Type Description
string

The OCID of the model.
Remarks

Required

InputSchema

Declaration
[JsonProperty(PropertyName = "inputSchema")]
public string InputSchema { get; set; }
Property Value
Type Description
string

Input schema file content in String format

IsModelByReference

Declaration
[Required(ErrorMessage = "IsModelByReference is required.")]
[JsonProperty(PropertyName = "isModelByReference")]
public bool? IsModelByReference { get; set; }
Property Value
Type Description
bool?

Identifier to indicate whether a model artifact resides in the Service Tenancy or Customer Tenancy.
Remarks

Required

LifecycleDetails

Declaration
[Required(ErrorMessage = "LifecycleDetails is required.")]
[JsonProperty(PropertyName = "lifecycleDetails")]
public string LifecycleDetails { get; set; }
Property Value
Type Description
string

Details about the lifecycle state of the model.
Remarks

Required

LifecycleState

Declaration
[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public ModelLifecycleState? LifecycleState { get; set; }
Property Value
Type Description
ModelLifecycleState?

The state of the model.
Remarks

Required

ModelVersionSetId

Declaration
[Required(ErrorMessage = "ModelVersionSetId is required.")]
[JsonProperty(PropertyName = "modelVersionSetId")]
public string ModelVersionSetId { get; set; }
Property Value
Type Description
string

The OCID of the model version set that the model is associated to.
Remarks

Required

ModelVersionSetName

Declaration
[Required(ErrorMessage = "ModelVersionSetName is required.")]
[JsonProperty(PropertyName = "modelVersionSetName")]
public string ModelVersionSetName { get; set; }
Property Value
Type Description
string

The name of the model version set that the model is associated to.
Remarks

Required

OutputSchema

Declaration
[JsonProperty(PropertyName = "outputSchema")]
public string OutputSchema { get; set; }
Property Value
Type Description
string

Output schema file content in String format

ProjectId

Declaration
[Required(ErrorMessage = "ProjectId is required.")]
[JsonProperty(PropertyName = "projectId")]
public string ProjectId { get; set; }
Property Value
Type Description
string

The OCID of the project associated with the model.
Remarks

Required

RetentionOperationDetails

Declaration
[Required(ErrorMessage = "RetentionOperationDetails is required.")]
[JsonProperty(PropertyName = "retentionOperationDetails")]
public RetentionOperationDetails RetentionOperationDetails { get; set; }
Property Value
Type Description
RetentionOperationDetails
Remarks

Required

RetentionSetting

Declaration
[Required(ErrorMessage = "RetentionSetting is required.")]
[JsonProperty(PropertyName = "retentionSetting")]
public RetentionSetting RetentionSetting { get; set; }
Property Value
Type Description
RetentionSetting
Remarks

Required

TimeCreated

Declaration
[Required(ErrorMessage = "TimeCreated is required.")]
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }
Property Value
Type Description
DateTime?

The date and time the resource was created in the timestamp format defined by RFC3339. Example: 2019-08-25T21:10:29.41Z
Remarks

Required

VersionId

Declaration
[Required(ErrorMessage = "VersionId is required.")]
[JsonProperty(PropertyName = "versionId")]
public long? VersionId { get; set; }
Property Value
Type Description
long?

Unique identifier assigned to each version of the model.
Remarks

Required

VersionLabel

Declaration
[Required(ErrorMessage = "VersionLabel is required.")]
[JsonProperty(PropertyName = "versionLabel")]
public string VersionLabel { get; set; }
Property Value
Type Description
string

The version label can add an additional description of the lifecycle state of the model or the application using and training the model.
Remarks

Required