Interface CustomTuningModelOrBuilder (0.51.0)

Version latest

• 0.51.0 (latest)
• 0.50.0
• 0.49.0
• 0.48.0
• 0.47.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

public interface CustomTuningModelOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsMetrics(String key)

public abstract boolean containsMetrics(String key)

The metrics of the trained model.

map<string, double> metrics = 7;

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

getCreateTime() (deprecated)

public abstract Timestamp getCreateTime()

Deprecated. google.cloud.discoveryengine.v1.CustomTuningModel.create_time is deprecated. See google/cloud/discoveryengine/v1/custom_tuning_model.proto;l=89

Deprecated: Timestamp the Model was created at.

.google.protobuf.Timestamp create_time = 5 [deprecated = true];

Returns
Type	Description
Timestamp	The createTime.

getCreateTimeOrBuilder() (deprecated)

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

Deprecated: Timestamp the Model was created at.

.google.protobuf.Timestamp create_time = 5 [deprecated = true];

Returns
Type	Description
TimestampOrBuilder

getDisplayName()

public abstract String getDisplayName()

The display name of the model.

string display_name = 2;

Returns
Type	Description
String	The displayName.

getDisplayNameBytes()

public abstract ByteString getDisplayNameBytes()

The display name of the model.

string display_name = 2;

Returns
Type	Description
ByteString	The bytes for displayName.

getErrorMessage()

public abstract String getErrorMessage()

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

string error_message = 8;

Returns
Type	Description
String	The errorMessage.

getErrorMessageBytes()

public abstract ByteString getErrorMessageBytes()

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

string error_message = 8;

Returns
Type	Description
ByteString	The bytes for errorMessage.

getMetrics() (deprecated)

public abstract Map<String,Double> getMetrics()

Use #getMetricsMap() instead.

Returns
Type	Description
Map<String,Double>

getMetricsCount()

public abstract int getMetricsCount()

The metrics of the trained model.

map<string, double> metrics = 7;

Returns
Type	Description
int

getMetricsMap()

public abstract Map<String,Double> getMetricsMap()

The metrics of the trained model.

map<string, double> metrics = 7;

Returns
Type	Description
Map<String,Double>

getMetricsOrDefault(String key, double defaultValue)

public abstract double getMetricsOrDefault(String key, double defaultValue)

The metrics of the trained model.

map<string, double> metrics = 7;

Parameters
Name	Description
key	String
defaultValue	double

Returns
Type	Description
double

getMetricsOrThrow(String key)

public abstract double getMetricsOrThrow(String key)

The metrics of the trained model.

map<string, double> metrics = 7;

Parameter
Name	Description
key	String

Returns
Type	Description
double

getModelState()

public abstract CustomTuningModel.ModelState getModelState()

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

.google.cloud.discoveryengine.v1.CustomTuningModel.ModelState model_state = 4;

Returns
Type	Description
CustomTuningModel.ModelState	The modelState.

getModelStateValue()

public abstract int getModelStateValue()

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

.google.cloud.discoveryengine.v1.CustomTuningModel.ModelState model_state = 4;

Returns
Type	Description
int	The enum numeric value on the wire for modelState.

getModelVersion()

public abstract long getModelVersion()

The version of the model.

int64 model_version = 3;

Returns
Type	Description
long	The modelVersion.

getName()

public abstract String getName()

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.

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type	Description
String	The name.

getNameBytes()

public abstract ByteString getNameBytes()

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.

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type	Description
ByteString	The bytes for name.

getTrainingStartTime()

public abstract Timestamp getTrainingStartTime()

Timestamp the model training was initiated.

.google.protobuf.Timestamp training_start_time = 6;

Returns
Type	Description
Timestamp	The trainingStartTime.

getTrainingStartTimeOrBuilder()

public abstract TimestampOrBuilder getTrainingStartTimeOrBuilder()

Timestamp the model training was initiated.

.google.protobuf.Timestamp training_start_time = 6;

Returns
Type	Description
TimestampOrBuilder

hasCreateTime() (deprecated)

public abstract boolean hasCreateTime()

Deprecated. google.cloud.discoveryengine.v1.CustomTuningModel.create_time is deprecated. See google/cloud/discoveryengine/v1/custom_tuning_model.proto;l=89

Deprecated: Timestamp the Model was created at.

.google.protobuf.Timestamp create_time = 5 [deprecated = true];

Returns
Type	Description
boolean	Whether the createTime field is set.

hasTrainingStartTime()

public abstract boolean hasTrainingStartTime()

Timestamp the model training was initiated.

.google.protobuf.Timestamp training_start_time = 6;

Returns
Type	Description
boolean	Whether the trainingStartTime field is set.