Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace Model

Machine-learned Model.

Properties

Optional aliasName

aliasName: undefined | string

the alias name of the model.

compartmentId

compartmentId: string

The compartment identifier.

Optional componentModels

componentModels: Array<ComponentModel>

The OCID collection of active custom Key Value models that need to be composed.

Optional definedTags

definedTags: undefined | object

Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: {@code {"foo-namespace": {"bar-key": "value"}}}

Optional description

description: undefined | string

An optional description of the model.

Optional displayName

displayName: undefined | string

A human-friendly name for the model, which can be changed.

Optional freeformTags

freeformTags: undefined | object

A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: {@code {"bar-key": "value"}}

id

id: string

A unique identifier that is immutable after creation.

Optional isComposedModel

isComposedModel: undefined | false | true

Set to true when the model is created by using multiple key value extraction models.

Optional isQuickMode

isQuickMode: undefined | false | true

Set to true when experimenting with a new model type or dataset, so model training is quick, with a predefined low number of passes through the training data.

Optional labels

labels: Array<string>

The collection of labels used to train the custom model.

Optional lifecycleDetails

lifecycleDetails: undefined | string

A message describing the current state in more detail, that can provide actionable information if training failed.

lifecycleState

lifecycleState: LifecycleState

The current state of the model.

Optional maxTrainingTimeInHours

maxTrainingTimeInHours: undefined | number

The maximum model training time in hours, expressed as a decimal fraction. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional metrics

modelType

modelType: ModelType

The type of the Document model.

modelVersion

modelVersion: string

The version of the model.

projectId

projectId: string

The OCID of the project that contains the model.

Optional systemTags

systemTags: undefined | object

Usage of system tag keys. These predefined keys are scoped to namespaces. For example: {@code {"orcl-cloud": {"free-tier-retained": "true"}}}

Optional tenancyId

tenancyId: undefined | string

The tenancy id of the model.

Optional testingDataset

timeCreated

timeCreated: Date

When the model was created, as an RFC3339 datetime string.

Optional timeUpdated

timeUpdated: Date

When the model was updated, as an RFC3339 datetime string.

Optional trainedTimeInHours

trainedTimeInHours: undefined | number

The total hours actually used for model training. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional trainingDataset

Optional validationDataset

Functions

getDeserializedJsonObj

  • getDeserializedJsonObj(obj: Model): object

getJsonObj

  • getJsonObj(obj: Model): object