Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace ModelSummary

Summary of the model.

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 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 a fine-tuned model.

Optional isLongTermSupported

isLongTermSupported: undefined | false | true

Whether a model is supported long-term. Applies only to base models.

Optional lifecycleDetails

lifecycleDetails: undefined | string

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

lifecycleState

lifecycleState: string

The lifecycle state of the model.

Allowed values are: - ACTIVE - CREATING - DELETING - DELETED - FAILED

Optional modelMetrics

modelMetrics: model.TextGenerationModelMetrics

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.

type

type: string

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

Allowed values are: - BASE - CUSTOM

Optional vendor

vendor: undefined | string

The provider of the model.

Optional version

version: undefined | string

The version of the model.

Functions

getDeserializedJsonObj

getJsonObj