Discovery Engine v1 API - Class CustomTuningModel (1.5.0)

public sealed class CustomTuningModel : IMessage<CustomTuningModel>, IEquatable<CustomTuningModel>, IDeepCloneable<CustomTuningModel>, IBufferMessage, IMessage

Reference documentation and code samples for the Discovery Engine v1 API class CustomTuningModel.

Metadata that describes a custom tuned model.

Inheritance

object > CustomTuningModel

Namespace

Google.Cloud.DiscoveryEngine.V1

Assembly

Google.Cloud.DiscoveryEngine.V1.dll

Constructors

CustomTuningModel()

public CustomTuningModel()

CustomTuningModel(CustomTuningModel)

public CustomTuningModel(CustomTuningModel other)
Parameter
Name Description
other CustomTuningModel

Properties

CreateTime

[Obsolete]
public Timestamp CreateTime { get; set; }

Deprecated: Timestamp the Model was created at.

Property Value
Type Description
Timestamp

CustomTuningModelName

public CustomTuningModelName CustomTuningModelName { get; set; }

CustomTuningModelName-typed view over the Name resource name property.

Property Value
Type Description
CustomTuningModelName

DisplayName

public string DisplayName { get; set; }

The display name of the model.

Property Value
Type Description
string

ErrorMessage

public string ErrorMessage { get; set; }

Currently this is only populated if the model state is INPUT_VALIDATION_FAILED.

Property Value
Type Description
string

Metrics

public MapField<string, double> Metrics { get; }

The metrics of the trained model.

Property Value
Type Description
MapFieldstringdouble

ModelState

public CustomTuningModel.Types.ModelState ModelState { get; set; }

The state that the model is in (e.g.TRAINING or TRAINING_FAILED).

Property Value
Type Description
CustomTuningModelTypesModelState

ModelVersion

public long ModelVersion { get; set; }

The version of the model.

Property Value
Type Description
long

Name

public string Name { get; set; }

Required. The fully qualified resource name of the model.

Format: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}.

Model must be an alpha-numerical string with limit of 40 characters.

Property Value
Type Description
string

TrainingStartTime

public Timestamp TrainingStartTime { get; set; }

Timestamp the model training was initiated.

Property Value
Type Description
Timestamp