Class Model

Machine-learned Model.

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.AidocumentService.Models

Assembly: OCI.DotNetSDK.Aidocument.dll

Syntax

public class Model

Properties

AliasName

Declaration

[JsonProperty(PropertyName = "aliasName")]
public string AliasName { get; set; }

Property Value

Type	Description
string	the alias name of the model.

CompartmentId

Declaration

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

Property Value

Type	Description
string	The compartment identifier.

Remarks

Required

ComponentModels

Declaration

[JsonProperty(PropertyName = "componentModels")]
public List<ComponentModel> ComponentModels { get; set; }

Property Value

Type	Description
List<ComponentModel>	The OCID collection of active custom Key Value models that need to be composed.

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 Example: {"foo-namespace": {"bar-key": "value"}}

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 human-friendly name for the model, which can be changed.

FreeformTags

Declaration

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

Property Value

Type	Description
Dictionary<string, string>	A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For Example: {"bar-key": "value"}

Id

Declaration

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

Property Value

Type	Description
string	A unique identifier that is immutable after creation.

Remarks

Required

InferenceUnits

Declaration

[JsonProperty(PropertyName = "inferenceUnits")]
public int? InferenceUnits { get; set; }

Property Value

Type	Description
int?	Number of replicas required for this model.

IsComposedModel

Declaration

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

Property Value

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

IsQuickMode

Declaration

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

Property Value

Type	Description
bool?	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.

Labels

Declaration

[JsonProperty(PropertyName = "labels")]
public List<string> Labels { get; set; }

Property Value

Type	Description
List<string>	The collection of labels used to train the custom model.

Language

Declaration

[JsonProperty(PropertyName = "language")]
public string Language { get; set; }

Property Value

Type	Description
string	The document language for model training, abbreviated according to the BCP 47 syntax.

LifecycleDetails

Declaration

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

Property Value

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

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 current state of the model.

Remarks

Required

Locks

Declaration

[JsonProperty(PropertyName = "locks")]
public List<ResourceLock> Locks { get; set; }

Property Value

Type	Description
List<ResourceLock>	Locks associated with this resource.

MaxTrainingTimeInHours

Declaration

[JsonProperty(PropertyName = "maxTrainingTimeInHours")]
public double MaxTrainingTimeInHours { get; set; }

Property Value

Type	Description
double	The maximum model training time in hours, expressed as a decimal fraction.

Metrics

Declaration

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

Property Value

Type	Description
ModelMetrics

ModelSubType

Declaration

[JsonProperty(PropertyName = "modelSubType")]
public ModelSubType ModelSubType { get; set; }

Property Value

Type	Description
ModelSubType	Applicable to only PRE_TRAINED_KEY_VALUE_EXTRACTION, PRE_TRAINED_DOCUMENT_ELEMENTS_EXTRACTION.

ModelType

Declaration

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

Property Value

Type	Description
Model.ModelTypeEnum?	The type of the Document model.

Remarks

Required

ModelVersion

Declaration

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

Property Value

Type	Description
string	The version of the model.

Remarks

Required

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 that contains the model.

Remarks

Required

SystemTags

Declaration

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

Property Value

Type	Description
Dictionary<string, Dictionary<string, object>>	Usage of system tag keys. These predefined keys are scoped to namespaces. For Example: {"orcl-cloud": {"free-tier-retained": "true"}}

TenancyId

Declaration

[JsonProperty(PropertyName = "tenancyId")]
public string TenancyId { get; set; }

Property Value

Type	Description
string	The tenancy id of the model.

TestingDataset

Declaration

[JsonProperty(PropertyName = "testingDataset")]
public Dataset TestingDataset { get; set; }

Property Value

Type	Description
Dataset

TimeCreated

Declaration

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

Property Value

Type	Description
DateTime?	When the model was created, as an RFC3339 datetime string.

Remarks

Required

TimeUpdated

Declaration

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

Property Value

Type	Description
DateTime?	When the model was updated, as an RFC3339 datetime string.

TrainedTimeInHours

Declaration

[JsonProperty(PropertyName = "trainedTimeInHours")]
public double TrainedTimeInHours { get; set; }

Property Value

Type	Description
double	The total hours actually used for model training.

TrainingDataset

Declaration

[JsonProperty(PropertyName = "trainingDataset")]
public Dataset TrainingDataset { get; set; }

Property Value

Type	Description
Dataset

ValidationDataset

Declaration

[JsonProperty(PropertyName = "validationDataset")]
public Dataset ValidationDataset { get; set; }

Property Value

Type	Description
Dataset