Class Model

You can create a custom model by using your dataset to fine-tune an out-of-the-box text generation base model. Have your dataset ready before you create a custom model. See Training Data Requirements.
To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator who gives OCI resource access to users. See Getting Started with Policies and Getting Access to Generative AI Resouces.

Inheritance

object

Model

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.GenerativeaiService.Models

Assembly: OCI.DotNetSDK.Generativeai.dll

Syntax

public class Model

Properties

BaseModelId

Declaration

[JsonProperty(PropertyName = "baseModelId")]
public string BaseModelId { get; set; }

Property Value

Type	Description
string	The OCID of the base model that's used for fine-tuning. For pretrained models, the value is null.

Capabilities

Declaration

[Required(ErrorMessage = "Capabilities is required.")]
[JsonProperty(PropertyName = "capabilities", ItemConverterType = typeof(ResponseEnumConverter))]
public List<ModelCapability> Capabilities { get; set; }

Property Value

Type	Description
List<ModelCapability>	Describes what this model can be used for.

Remarks

Required

CompartmentId

Declaration

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

Property Value

Type	Description
string	The compartment OCID for fine-tuned models. For pretrained models, this value is null.

Remarks

Required

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. For more information, see Resource Tags. Example: {"Operations": {"CostCenter": "42"}}

Description

Declaration

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

Property Value

Type	Description
string	An optional description of the model.

DisplayName

Declaration

[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }

Property Value

Type	Description
string	A user-friendly name.

FineTuneDetails

Declaration

[JsonProperty(PropertyName = "fineTuneDetails")]
public FineTuneDetails FineTuneDetails { get; set; }

Property Value

Type	Description
FineTuneDetails

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. For more information, 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	An ID that uniquely identifies a pretrained or fine-tuned model.

Remarks

Required

IsLongTermSupported

Declaration

[JsonProperty(PropertyName = "isLongTermSupported")]
public bool? IsLongTermSupported { get; set; }

Property Value

Type	Description
bool?	Whether a model is supported long-term. Only applicable to base models.

LifecycleDetails

Declaration

[JsonProperty(PropertyName = "lifecycleDetails")]
public string LifecycleDetails { get; set; }

Property Value

Type	Description
string	A message describing the current state of the model in more detail that can provide actionable information.

LifecycleState

Declaration

[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public Model.LifecycleStateEnum? LifecycleState { get; set; }

Property Value

Type	Description
Model.LifecycleStateEnum?	The lifecycle state of the model.

Remarks

Required

ModelMetrics

Declaration

[JsonProperty(PropertyName = "modelMetrics")]
public ModelMetrics ModelMetrics { get; set; }

Property Value

Type	Description
ModelMetrics

PreviousState

Declaration

[JsonProperty(PropertyName = "previousState")]
public Model PreviousState { get; set; }

Property Value

Type	Description
Model

SystemTags

Declaration

[JsonProperty(PropertyName = "systemTags")]
public Dictionary<string, Dictionary<string, object>> SystemTags { get; set; }

Property Value

Type	Description
Dictionary<string, Dictionary<string, object>>	System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud": {"free-tier-retained": "true"}}

TimeCreated

Declaration

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

Property Value

Type	Description
DateTime?	The date and time that the model was created in the format of an RFC3339 datetime string.

Remarks

Required

TimeDeprecated

Declaration

[JsonProperty(PropertyName = "timeDeprecated")]
public DateTime? TimeDeprecated { get; set; }

Property Value

Type	Description
DateTime?	Corresponds to the time when the custom model and its associated foundation model will be deprecated.

TimeUpdated

Declaration

[JsonProperty(PropertyName = "timeUpdated")]
public DateTime? TimeUpdated { get; set; }

Property Value

Type	Description
DateTime?	The date and time that the model was updated in the format of an RFC3339 datetime string.

Type

Declaration

[Required(ErrorMessage = "Type is required.")]
[JsonProperty(PropertyName = "type")]
[JsonConverter(typeof(ResponseEnumConverter))]
public Model.TypeEnum? Type { get; set; }

Property Value

Type	Description
Model.TypeEnum?	The model type indicating whether this is a pretrained/base model or a custom/fine-tuned model.

Remarks

Required

Vendor

Declaration

[JsonProperty(PropertyName = "vendor")]
public string Vendor { get; set; }

Property Value

Type	Description
string	The provider of the base model.

Version

Declaration

[JsonProperty(PropertyName = "version")]
public string Version { get; set; }

Property Value

Type	Description
string	The version of the model.