Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace 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](https://docs.cloud.oracle.com/iaas/Content/Identity/policiesgs/get-started-with-policies.htm) and [Getting Access to Generative AI Resouces](https://docs.cloud.oracle.com/iaas/Content/generative-ai/iam-policies.htm).

Properties

Optional baseModelId

baseModelId: undefined | string

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

capabilities

capabilities: Array<Capabilities>

Describes what this model can be used for.

compartmentId

compartmentId: string

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

Optional definedTags

definedTags: undefined | object

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}

Optional description

description: undefined | string

An optional description of the model.

Optional displayName

displayName: undefined | string

A user-friendly name.

Optional fineTuneDetails

fineTuneDetails: model.FineTuneDetails

Optional freeformTags

freeformTags: undefined | object

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: {@code {\"Department\": \"Finance\"}}

id

id: string

An ID that uniquely identifies a pretrained or fine-tuned model.

Optional isLongTermSupported

isLongTermSupported: undefined | false | true

Whether a model is supported long-term. Only applicable to base models.

Optional lifecycleDetails

lifecycleDetails: undefined | string

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

lifecycleState

lifecycleState: LifecycleState

The lifecycle state of the model.

Optional modelMetrics

Optional previousState

previousState: model.Model

Optional systemTags

systemTags: undefined | object

System tags for this resource. Each key is predefined and scoped to a namespace.

Example: {@code {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}}

timeCreated

timeCreated: Date

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

Optional timeDeprecated

timeDeprecated: Date

Corresponds to the time when the custom model and its associated foundation model will be deprecated.

Optional timeUpdated

timeUpdated: Date

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

type

type: Type

The model type indicating whether this is a pretrained/base model or a custom/fine-tuned model.

Optional vendor

vendor: undefined | string

The provider of the base model.

Optional version

version: undefined | string

The version of the model.

Functions

getDeserializedJsonObj

  • getDeserializedJsonObj(obj: Model): object

getJsonObj

  • getJsonObj(obj: Model): object