Class CreateModelDetails

The information needed to create a new model.

Inheritance

object

CreateModelDetails

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 CreateModelDetails

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 list 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"}

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 the model training is quick, with a predefined low number of passes through the training data.

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.

ModelType

Declaration

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

Property Value

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

Remarks

Required

ModelVersion

Declaration

[JsonProperty(PropertyName = "modelVersion")]
public string ModelVersion { get; set; }

Property Value

Type	Description
string	The model version

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

TestingDataset

Declaration

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

Property Value

Type	Description
Dataset

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