Package com.google.cloud.retail.v2beta

Interface ModelOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    Model, Model.Builder
    public interface ModelOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getName

        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:
        The name.

      • getNameBytes

        com.google.protobuf.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:
        The bytes for name.

      • getDisplayName

        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:
        The displayName.

      • getDisplayNameBytes

        com.google.protobuf.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:
        The bytes for displayName.

      • getTrainingStateValue

        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:
        The enum numeric value on the wire for trainingState.

      • getTrainingState

        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];
        Returns:
        The trainingState.

      • getServingStateValue

        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:
        The enum numeric value on the wire for servingState.

      • getServingState

        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];
        Returns:
        The servingState.

      • hasCreateTime

        boolean hasCreateTime()
         Output only. Timestamp the Recommendation Model was created at.
        .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        Whether the createTime field is set.

      • getCreateTime

        com.google.protobuf.Timestamp getCreateTime()
         Output only. Timestamp the Recommendation Model was created at.
        .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         Output only. Timestamp the Recommendation Model was created at.
        .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • hasUpdateTime

        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:
        Whether the updateTime field is set.

      • getUpdateTime

        com.google.protobuf.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:
        The updateTime.

      • getUpdateTimeOrBuilder

        com.google.protobuf.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];

      • getType

        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][google.cloud.retail.v2beta.Model.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:
        The type.

      • getTypeBytes

        com.google.protobuf.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][google.cloud.retail.v2beta.Model.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:
        The bytes for type.

      • getOptimizationObjective

        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][google.cloud.retail.v2beta.Model.type]
 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:
        The optimizationObjective.

      • getOptimizationObjectiveBytes

        com.google.protobuf.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][google.cloud.retail.v2beta.Model.type]
 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:
        The bytes for optimizationObjective.

      • getPeriodicTuningStateValue

        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:
        The enum numeric value on the wire for periodicTuningState.

      • getPeriodicTuningState

        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];
        Returns:
        The periodicTuningState.

      • hasLastTuneTime

        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:
        Whether the lastTuneTime field is set.

      • getLastTuneTime

        com.google.protobuf.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:
        The lastTuneTime.

      • getLastTuneTimeOrBuilder

        com.google.protobuf.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];

      • getTuningOperation

        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:
        The tuningOperation.

      • getTuningOperationBytes

        com.google.protobuf.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:
        The bytes for tuningOperation.

      • getDataStateValue

        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:
        The enum numeric value on the wire for dataState.

      • getDataState

        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];
        Returns:
        The dataState.

      • getFilteringOptionValue

        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:
        The enum numeric value on the wire for filteringOption.

      • getFilteringOption

        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];
        Returns:
        The filteringOption.

      • getServingConfigListsList

        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];

      • getServingConfigLists

        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];

      • getServingConfigListsCount

        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];

      • getServingConfigListsOrBuilderList

        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];

      • getServingConfigListsOrBuilder

        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];