Class Model (2.45.0)

public final class Model extends GeneratedMessageV3 implements ModelOrBuilder

Metadata that describes the training and serving parameters of a Model. A Model can be associated with a ServingConfig and then queried through the Predict API.

Protobuf type google.cloud.retail.v2alpha.Model

Implements

ModelOrBuilder

Static Fields

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

DATA_STATE_FIELD_NUMBER

public static final int DATA_STATE_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

FILTERING_OPTION_FIELD_NUMBER

public static final int FILTERING_OPTION_FIELD_NUMBER
Field Value
Type Description
int

LAST_TUNE_TIME_FIELD_NUMBER

public static final int LAST_TUNE_TIME_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

OPTIMIZATION_OBJECTIVE_FIELD_NUMBER

public static final int OPTIMIZATION_OBJECTIVE_FIELD_NUMBER
Field Value
Type Description
int

PAGE_OPTIMIZATION_CONFIG_FIELD_NUMBER

public static final int PAGE_OPTIMIZATION_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

PERIODIC_TUNING_STATE_FIELD_NUMBER

public static final int PERIODIC_TUNING_STATE_FIELD_NUMBER
Field Value
Type Description
int

SERVING_CONFIG_LISTS_FIELD_NUMBER

public static final int SERVING_CONFIG_LISTS_FIELD_NUMBER
Field Value
Type Description
int

SERVING_STATE_FIELD_NUMBER

public static final int SERVING_STATE_FIELD_NUMBER
Field Value
Type Description
int

TRAINING_STATE_FIELD_NUMBER

public static final int TRAINING_STATE_FIELD_NUMBER
Field Value
Type Description
int

TUNING_OPERATION_FIELD_NUMBER

public static final int TUNING_OPERATION_FIELD_NUMBER
Field Value
Type Description
int

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Model getDefaultInstance()
Returns
Type Description
Model

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Model.Builder newBuilder()
Returns
Type Description
Model.Builder

newBuilder(Model prototype)

public static Model.Builder newBuilder(Model prototype)
Parameter
Name Description
prototype Model
Returns
Type Description
Model.Builder

parseDelimitedFrom(InputStream input)

public static Model parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Model
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Model parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Model
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Model parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Model
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Model parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Model
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Model parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Model
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Model parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Model
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Model parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Model
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Model parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Model
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Model parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Model
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Model parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Model
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Model parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Model
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Model parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Model
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Model> parser()
Returns
Type Description
Parser<Model>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getCreateTime()

public Timestamp getCreateTime()

Output only. Timestamp the Recommendation Model was created at.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Timestamp the Recommendation Model was created at.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDataState()

public Model.DataState getDataState()

Output only. The state of data requirements for this model: DATA_OK and DATA_ERROR.

Recommendation model cannot be trained if the data is in DATA_ERROR state. Recommendation model can have DATA_ERROR state even if serving state is ACTIVE: models were trained successfully before, but cannot be refreshed because model no longer has sufficient data for training.

.google.cloud.retail.v2alpha.Model.DataState data_state = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Model.DataState

The dataState.

getDataStateValue()

public int getDataStateValue()

Output only. The state of data requirements for this model: DATA_OK and DATA_ERROR.

Recommendation model cannot be trained if the data is in DATA_ERROR state. Recommendation model can have DATA_ERROR state even if serving state is ACTIVE: models were trained successfully before, but cannot be refreshed because model no longer has sufficient data for training.

.google.cloud.retail.v2alpha.Model.DataState data_state = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for dataState.

getDefaultInstanceForType()

public Model getDefaultInstanceForType()
Returns
Type Description
Model

getDisplayName()

public String getDisplayName()

Required. The display name of the model.

Should be human readable, used to display Recommendation Models in the Retail Cloud Console Dashboard. UTF-8 encoded string with limit of 1024 characters.

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Required. The display name of the model.

Should be human readable, used to display Recommendation Models in the Retail Cloud Console Dashboard. UTF-8 encoded string with limit of 1024 characters.

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for displayName.

getFilteringOption()

public RecommendationsFilteringOption getFilteringOption()

Optional. If RECOMMENDATIONS_FILTERING_ENABLED, recommendation filtering by attributes is enabled for the model.

.google.cloud.retail.v2alpha.RecommendationsFilteringOption filtering_option = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
RecommendationsFilteringOption

The filteringOption.

getFilteringOptionValue()

public int getFilteringOptionValue()

Optional. If RECOMMENDATIONS_FILTERING_ENABLED, recommendation filtering by attributes is enabled for the model.

.google.cloud.retail.v2alpha.RecommendationsFilteringOption filtering_option = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for filteringOption.

getLastTuneTime()

public Timestamp getLastTuneTime()

Output only. The timestamp when the latest successful tune finished.

.google.protobuf.Timestamp last_tune_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The lastTuneTime.

getLastTuneTimeOrBuilder()

public TimestampOrBuilder getLastTuneTimeOrBuilder()

Output only. The timestamp when the latest successful tune finished.

.google.protobuf.Timestamp last_tune_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getName()

public String getName()

Required. The fully qualified resource name of the model.

Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id} catalog_id has char limit of 50. recommendation_model_id has char limit of 40.

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Required. The fully qualified resource name of the model.

Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id} catalog_id has char limit of 50. recommendation_model_id has char limit of 40.

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for name.

getOptimizationObjective()

public String getOptimizationObjective()

Optional. The optimization objective e.g. cvr.

Currently supported values: ctr, cvr, revenue-per-order.

If not specified, we choose default based on model type. Default depends on type of recommendation:

recommended-for-you => ctr

others-you-may-like => ctr

frequently-bought-together => revenue_per_order

This field together with optimization_objective describe model metadata to use to control model training and serving. See https://cloud.google.com/retail/docs/models for more details on what the model metadata control and which combination of parameters are valid. For invalid combinations of parameters (e.g. type = frequently-bought-together and optimization_objective = ctr), you receive an error 400 if you try to create/update a recommendation with this set of knobs.

string optimization_objective = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The optimizationObjective.

getOptimizationObjectiveBytes()

public ByteString getOptimizationObjectiveBytes()

Optional. The optimization objective e.g. cvr.

Currently supported values: ctr, cvr, revenue-per-order.

If not specified, we choose default based on model type. Default depends on type of recommendation:

recommended-for-you => ctr

others-you-may-like => ctr

frequently-bought-together => revenue_per_order

This field together with optimization_objective describe model metadata to use to control model training and serving. See https://cloud.google.com/retail/docs/models for more details on what the model metadata control and which combination of parameters are valid. For invalid combinations of parameters (e.g. type = frequently-bought-together and optimization_objective = ctr), you receive an error 400 if you try to create/update a recommendation with this set of knobs.

string optimization_objective = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for optimizationObjective.

getPageOptimizationConfig()

public Model.PageOptimizationConfig getPageOptimizationConfig()

Optional. The page optimization config.

.google.cloud.retail.v2alpha.Model.PageOptimizationConfig page_optimization_config = 17 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Model.PageOptimizationConfig

The pageOptimizationConfig.

getPageOptimizationConfigOrBuilder()

public Model.PageOptimizationConfigOrBuilder getPageOptimizationConfigOrBuilder()

Optional. The page optimization config.

.google.cloud.retail.v2alpha.Model.PageOptimizationConfig page_optimization_config = 17 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Model.PageOptimizationConfigOrBuilder

getParserForType()

public Parser<Model> getParserForType()
Returns
Type Description
Parser<Model>
Overrides

getPeriodicTuningState()

public Model.PeriodicTuningState getPeriodicTuningState()

Optional. The state of periodic tuning.

The period we use is 3 months - to do a one-off tune earlier use the TuneModel method. Default value is PERIODIC_TUNING_ENABLED.

.google.cloud.retail.v2alpha.Model.PeriodicTuningState periodic_tuning_state = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Model.PeriodicTuningState

The periodicTuningState.

getPeriodicTuningStateValue()

public int getPeriodicTuningStateValue()

Optional. The state of periodic tuning.

The period we use is 3 months - to do a one-off tune earlier use the TuneModel method. Default value is PERIODIC_TUNING_ENABLED.

.google.cloud.retail.v2alpha.Model.PeriodicTuningState periodic_tuning_state = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for periodicTuningState.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getServingConfigLists(int index)

public Model.ServingConfigList getServingConfigLists(int index)

Output only. The list of valid serving configs associated with the PageOptimizationConfig.

repeated .google.cloud.retail.v2alpha.Model.ServingConfigList serving_config_lists = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
Model.ServingConfigList

getServingConfigListsCount()

public int getServingConfigListsCount()

Output only. The list of valid serving configs associated with the PageOptimizationConfig.

repeated .google.cloud.retail.v2alpha.Model.ServingConfigList serving_config_lists = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

getServingConfigListsList()

public List<Model.ServingConfigList> getServingConfigListsList()

Output only. The list of valid serving configs associated with the PageOptimizationConfig.

repeated .google.cloud.retail.v2alpha.Model.ServingConfigList serving_config_lists = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<ServingConfigList>

getServingConfigListsOrBuilder(int index)

public Model.ServingConfigListOrBuilder getServingConfigListsOrBuilder(int index)

Output only. The list of valid serving configs associated with the PageOptimizationConfig.

repeated .google.cloud.retail.v2alpha.Model.ServingConfigList serving_config_lists = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
Model.ServingConfigListOrBuilder

getServingConfigListsOrBuilderList()

public List<? extends Model.ServingConfigListOrBuilder> getServingConfigListsOrBuilderList()

Output only. The list of valid serving configs associated with the PageOptimizationConfig.

repeated .google.cloud.retail.v2alpha.Model.ServingConfigList serving_config_lists = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<? extends com.google.cloud.retail.v2alpha.Model.ServingConfigListOrBuilder>

getServingState()

public Model.ServingState getServingState()

Output only. The serving state of the model: ACTIVE, NOT_ACTIVE.

.google.cloud.retail.v2alpha.Model.ServingState serving_state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Model.ServingState

The servingState.

getServingStateValue()

public int getServingStateValue()

Output only. The serving state of the model: ACTIVE, NOT_ACTIVE.

.google.cloud.retail.v2alpha.Model.ServingState serving_state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for servingState.

getTrainingConfigCase()

public Model.TrainingConfigCase getTrainingConfigCase()
Returns
Type Description
Model.TrainingConfigCase

getTrainingState()

public Model.TrainingState getTrainingState()

Optional. The training state that the model is in (e.g. TRAINING or PAUSED).

Since part of the cost of running the service is frequency of training - this can be used to determine when to train model in order to control cost. If not specified: the default value for CreateModel method is TRAINING. The default value for UpdateModel method is to keep the state the same as before.

.google.cloud.retail.v2alpha.Model.TrainingState training_state = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Model.TrainingState

The trainingState.

getTrainingStateValue()

public int getTrainingStateValue()

Optional. The training state that the model is in (e.g. TRAINING or PAUSED).

Since part of the cost of running the service is frequency of training - this can be used to determine when to train model in order to control cost. If not specified: the default value for CreateModel method is TRAINING. The default value for UpdateModel method is to keep the state the same as before.

.google.cloud.retail.v2alpha.Model.TrainingState training_state = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for trainingState.

getTuningOperation()

public String getTuningOperation()

Output only. The tune operation associated with the model.

Can be used to determine if there is an ongoing tune for this recommendation. Empty field implies no tune is goig on.

string tuning_operation = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The tuningOperation.

getTuningOperationBytes()

public ByteString getTuningOperationBytes()

Output only. The tune operation associated with the model.

Can be used to determine if there is an ongoing tune for this recommendation. Empty field implies no tune is goig on.

string tuning_operation = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for tuningOperation.

getType()

public String getType()

Required. The type of model e.g. home-page.

Currently supported values: recommended-for-you, others-you-may-like, frequently-bought-together, page-optimization, similar-items, buy-it-again, on-sale-items, and recently-viewed(readonly value).

This field together with optimization_objective describe model metadata to use to control model training and serving. See https://cloud.google.com/retail/docs/models for more details on what the model metadata control and which combination of parameters are valid. For invalid combinations of parameters (e.g. type = frequently-bought-together and optimization_objective = ctr), you receive an error 400 if you try to create/update a recommendation with this set of knobs.

string type = 7 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The type.

getTypeBytes()

public ByteString getTypeBytes()

Required. The type of model e.g. home-page.

Currently supported values: recommended-for-you, others-you-may-like, frequently-bought-together, page-optimization, similar-items, buy-it-again, on-sale-items, and recently-viewed(readonly value).

This field together with optimization_objective describe model metadata to use to control model training and serving. See https://cloud.google.com/retail/docs/models for more details on what the model metadata control and which combination of parameters are valid. For invalid combinations of parameters (e.g. type = frequently-bought-together and optimization_objective = ctr), you receive an error 400 if you try to create/update a recommendation with this set of knobs.

string type = 7 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for type.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. Timestamp the Recommendation Model was last updated. E.g. if a Recommendation Model was paused - this would be the time the pause was initiated.

.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Timestamp the Recommendation Model was last updated. E.g. if a Recommendation Model was paused - this would be the time the pause was initiated.

.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

hasCreateTime()

public boolean hasCreateTime()

Output only. Timestamp the Recommendation Model was created at.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasLastTuneTime()

public boolean hasLastTuneTime()

Output only. The timestamp when the latest successful tune finished.

.google.protobuf.Timestamp last_tune_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the lastTuneTime field is set.

hasPageOptimizationConfig()

public boolean hasPageOptimizationConfig()

Optional. The page optimization config.

.google.cloud.retail.v2alpha.Model.PageOptimizationConfig page_optimization_config = 17 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the pageOptimizationConfig field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. Timestamp the Recommendation Model was last updated. E.g. if a Recommendation Model was paused - this would be the time the pause was initiated.

.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the updateTime field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Model.Builder newBuilderForType()
Returns
Type Description
Model.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Model.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Model.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Model.Builder toBuilder()
Returns
Type Description
Model.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException