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.v2beta.Model
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 | |
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()
newBuilder()
public static Model.Builder newBuilder()
newBuilder(Model prototype)
public static Model.Builder newBuilder(Model prototype)
| Parameter |
|---|
| Name | Description |
prototype | Model
|
public static Model parseDelimitedFrom(InputStream input)
| Returns |
|---|
| Type | Description |
Model | |
public static Model parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
|---|
| Type | Description |
Model | |
parseFrom(byte[] data)
public static Model parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
| Returns |
|---|
| Type | Description |
Model | |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Model parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
| Returns |
|---|
| Type | Description |
Model | |
parseFrom(ByteString data)
public static Model parseFrom(ByteString data)
| Returns |
|---|
| Type | Description |
Model | |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Model parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
| Returns |
|---|
| Type | Description |
Model | |
public static Model parseFrom(CodedInputStream input)
| Returns |
|---|
| Type | Description |
Model | |
public static Model parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
|---|
| Type | Description |
Model | |
public static Model parseFrom(InputStream input)
| Returns |
|---|
| Type | Description |
Model | |
public static Model parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
|---|
| Type | Description |
Model | |
parseFrom(ByteBuffer data)
public static Model parseFrom(ByteBuffer data)
| Returns |
|---|
| Type | Description |
Model | |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Model parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
| Returns |
|---|
| Type | Description |
Model | |
parser()
public static Parser<Model> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
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];
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.v2beta.Model.DataState data_state = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
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.v2beta.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.v2beta.RecommendationsFilteringOption filtering_option = 18 [(.google.api.field_behavior) = OPTIONAL];
getFilteringOptionValue()
public int getFilteringOptionValue()
Optional. If RECOMMENDATIONS_FILTERING_ENABLED, recommendation filtering
by attributes is enabled for the model.
.google.cloud.retail.v2beta.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];
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.
|
getParserForType()
public Parser<Model> getParserForType()
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.v2beta.Model.PeriodicTuningState periodic_tuning_state = 11 [(.google.api.field_behavior) = OPTIONAL];
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.v2beta.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.v2beta.Model.ServingConfigList serving_config_lists = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter |
|---|
| Name | Description |
index | int
|
getServingConfigListsCount()
public int getServingConfigListsCount()
Output only. The list of valid serving configs associated with the
PageOptimizationConfig.
repeated .google.cloud.retail.v2beta.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.v2beta.Model.ServingConfigList serving_config_lists = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
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.v2beta.Model.ServingConfigList serving_config_lists = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter |
|---|
| Name | Description |
index | int
|
getServingConfigListsOrBuilderList()
public List<? extends Model.ServingConfigListOrBuilder> getServingConfigListsOrBuilderList()
Output only. The list of valid serving configs associated with the
PageOptimizationConfig.
repeated .google.cloud.retail.v2beta.Model.ServingConfigList serving_config_lists = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
List<? extends com.google.cloud.retail.v2beta.Model.ServingConfigListOrBuilder> | |
getServingState()
public Model.ServingState getServingState()
Output only. The serving state of the model: ACTIVE, NOT_ACTIVE.
.google.cloud.retail.v2beta.Model.ServingState serving_state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
getServingStateValue()
public int getServingStateValue()
Output only. The serving state of the model: ACTIVE, NOT_ACTIVE.
.google.cloud.retail.v2beta.Model.ServingState serving_state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
int | The enum numeric value on the wire for servingState.
|
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.v2beta.Model.TrainingState training_state = 3 [(.google.api.field_behavior) = OPTIONAL];
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.v2beta.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()
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.
|
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Overrides
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];
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.
|
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()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Model.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Model.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public Model.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
