Package com.google.cloud.retail.v2alpha

Interface PredictRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
PredictRequest, PredictRequest.Builder
@Generated public interface PredictRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    containsLabels(String key)
    The labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64
    boolean
    containsParams(String key)
    Additional domain specific parameters for the predictions.
    String
    getFilter()
    Filter for restricting prediction results with a length limit of 5,000 characters.
    com.google.protobuf.ByteString
    getFilterBytes()
    Filter for restricting prediction results with a length limit of 5,000 characters.
    Map<String,String>
    getLabels()
    Deprecated.
    int
    getLabelsCount()
    The labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64
    Map<String,String>
    getLabelsMap()
    The labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64
    String
    getLabelsOrDefault(String key, String defaultValue)
    The labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64
    String
    getLabelsOrThrow(String key)
    The labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64
    int
    getPageSize()
    Maximum number of results to return.
    String
    getPageToken()
    Deprecated.
    google.cloud.retail.v2alpha.PredictRequest.page_token is deprecated.
    com.google.protobuf.ByteString
    getPageTokenBytes()
    Deprecated.
    google.cloud.retail.v2alpha.PredictRequest.page_token is deprecated.
    Map<String,com.google.protobuf.Value>
    getParams()
    Deprecated.
    int
    getParamsCount()
    Additional domain specific parameters for the predictions.
    Map<String,com.google.protobuf.Value>
    getParamsMap()
    Additional domain specific parameters for the predictions.
    com.google.protobuf.Value
    getParamsOrDefault(String key, com.google.protobuf.Value defaultValue)
    Additional domain specific parameters for the predictions.
    com.google.protobuf.Value
    getParamsOrThrow(String key)
    Additional domain specific parameters for the predictions.
    String
    getPlacement()
    Required.
    com.google.protobuf.ByteString
    getPlacementBytes()
    Required.
    UserEvent
    getUserEvent()
    Required.
    UserEventOrBuilder
    getUserEventOrBuilder()
    Required.
    boolean
    getValidateOnly()
    Use validate only mode for this prediction query.
    boolean
    hasUserEvent()
    Required.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getPlacement

      String getPlacement()
       Required. Full resource name of the format:
 `{placement=projects/*/locations/global/catalogs/default_catalog/servingConfigs/*}`
 or
 `{placement=projects/*/locations/global/catalogs/default_catalog/placements/*}`.
 We recommend using the `servingConfigs` resource. `placements` is a legacy
 resource.
 The ID of the Recommendations AI serving config or placement.
 Before you can request predictions from your model, you must create at
 least one serving config or placement for it. For more information, see
 [Manage serving configs]
 (https://cloud.google.com/retail/docs/manage-configs).

 The full list of available serving configs can be seen at
 https://console.cloud.google.com/ai/retail/catalogs/default_catalog/configs
      string placement = 1 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The placement.

    • getPlacementBytes

      com.google.protobuf.ByteString getPlacementBytes()
       Required. Full resource name of the format:
 `{placement=projects/*/locations/global/catalogs/default_catalog/servingConfigs/*}`
 or
 `{placement=projects/*/locations/global/catalogs/default_catalog/placements/*}`.
 We recommend using the `servingConfigs` resource. `placements` is a legacy
 resource.
 The ID of the Recommendations AI serving config or placement.
 Before you can request predictions from your model, you must create at
 least one serving config or placement for it. For more information, see
 [Manage serving configs]
 (https://cloud.google.com/retail/docs/manage-configs).

 The full list of available serving configs can be seen at
 https://console.cloud.google.com/ai/retail/catalogs/default_catalog/configs
      string placement = 1 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The bytes for placement.

    • hasUserEvent

      boolean hasUserEvent()
       Required. Context about the user, what they are looking at and what action
 they took to trigger the predict request. Note that this user event detail
 won't be ingested to userEvent logs. Thus, a separate userEvent write
 request is required for event logging.

 Don't set
 [UserEvent.visitor_id][google.cloud.retail.v2alpha.UserEvent.visitor_id] or
 [UserInfo.user_id][google.cloud.retail.v2alpha.UserInfo.user_id] to the
 same fixed ID for different users. If you are trying to receive
 non-personalized recommendations (not recommended; this can negatively
 impact model performance), instead set
 [UserEvent.visitor_id][google.cloud.retail.v2alpha.UserEvent.visitor_id] to
 a random unique ID and leave
 [UserInfo.user_id][google.cloud.retail.v2alpha.UserInfo.user_id] unset.
      .google.cloud.retail.v2alpha.UserEvent user_event = 2 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      Whether the userEvent field is set.

    • getUserEvent

      UserEvent getUserEvent()
       Required. Context about the user, what they are looking at and what action
 they took to trigger the predict request. Note that this user event detail
 won't be ingested to userEvent logs. Thus, a separate userEvent write
 request is required for event logging.

 Don't set
 [UserEvent.visitor_id][google.cloud.retail.v2alpha.UserEvent.visitor_id] or
 [UserInfo.user_id][google.cloud.retail.v2alpha.UserInfo.user_id] to the
 same fixed ID for different users. If you are trying to receive
 non-personalized recommendations (not recommended; this can negatively
 impact model performance), instead set
 [UserEvent.visitor_id][google.cloud.retail.v2alpha.UserEvent.visitor_id] to
 a random unique ID and leave
 [UserInfo.user_id][google.cloud.retail.v2alpha.UserInfo.user_id] unset.
      .google.cloud.retail.v2alpha.UserEvent user_event = 2 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The userEvent.

    • getUserEventOrBuilder

      UserEventOrBuilder getUserEventOrBuilder()
       Required. Context about the user, what they are looking at and what action
 they took to trigger the predict request. Note that this user event detail
 won't be ingested to userEvent logs. Thus, a separate userEvent write
 request is required for event logging.

 Don't set
 [UserEvent.visitor_id][google.cloud.retail.v2alpha.UserEvent.visitor_id] or
 [UserInfo.user_id][google.cloud.retail.v2alpha.UserInfo.user_id] to the
 same fixed ID for different users. If you are trying to receive
 non-personalized recommendations (not recommended; this can negatively
 impact model performance), instead set
 [UserEvent.visitor_id][google.cloud.retail.v2alpha.UserEvent.visitor_id] to
 a random unique ID and leave
 [UserInfo.user_id][google.cloud.retail.v2alpha.UserInfo.user_id] unset.
      .google.cloud.retail.v2alpha.UserEvent user_event = 2 [(.google.api.field_behavior) = REQUIRED];

    • getPageSize

      int getPageSize()
       Maximum number of results to return. Set this property to the number of
 prediction results needed. If zero, the service will choose a reasonable
 default. The maximum allowed value is 100. Values above 100 will be coerced
 to 100.
      int32 page_size = 3;
      Returns:
      The pageSize.

    • getPageToken

      @Deprecated String getPageToken()
      Deprecated.
      google.cloud.retail.v2alpha.PredictRequest.page_token is deprecated. See google/cloud/retail/v2alpha/prediction_service.proto;l=94
       This field is not used; leave it unset.
      string page_token = 4 [deprecated = true];
      Returns:
      The pageToken.

    • getPageTokenBytes

      @Deprecated com.google.protobuf.ByteString getPageTokenBytes()
      Deprecated.
      google.cloud.retail.v2alpha.PredictRequest.page_token is deprecated. See google/cloud/retail/v2alpha/prediction_service.proto;l=94
       This field is not used; leave it unset.
      string page_token = 4 [deprecated = true];
      Returns:
      The bytes for pageToken.

    • getFilter

      String getFilter()
       Filter for restricting prediction results with a length limit of 5,000
 characters. Accepts values for tags and the `filterOutOfStockItems` flag.

 * Tag expressions. Restricts predictions to products that match all of the
 specified tags. Boolean operators `OR` and `NOT` are supported if the
 expression is enclosed in parentheses, and must be separated from the
 tag values by a space. `-"tagA"` is also supported and is equivalent to
 `NOT "tagA"`. Tag values must be double quoted UTF-8 encoded strings
 with a size limit of 1,000 characters.

 Note: "Recently viewed" models don't support tag filtering at the
 moment.

 * filterOutOfStockItems. Restricts predictions to products that do not
 have a
 stockState value of OUT_OF_STOCK.

 Examples:

 * tag=("Red" OR "Blue") tag="New-Arrival" tag=(NOT "promotional")
 * filterOutOfStockItems  tag=(-"promotional")
 * filterOutOfStockItems

 If your filter blocks all prediction results, the API will return *no*
 results. If instead you want empty result sets to return generic
 (unfiltered) popular products, set `strictFiltering` to False in
 `PredictRequest.params`. Note that the API will never return items with
 storageStatus of "EXPIRED" or "DELETED" regardless of filter choices.

 If `filterSyntaxV2` is set to true under the `params` field, then
 attribute-based expressions are expected instead of the above described
 tag-based syntax. Examples:

 * (colors: ANY("Red", "Blue")) AND NOT (categories: ANY("Phones"))
 * (availability: ANY("IN_STOCK")) AND
 (colors: ANY("Red") OR categories: ANY("Phones"))

 For more information, see
 [Filter recommendations](https://cloud.google.com/retail/docs/filter-recs).
      string filter = 5;
      Returns:
      The filter.

    • getFilterBytes

      com.google.protobuf.ByteString getFilterBytes()
       Filter for restricting prediction results with a length limit of 5,000
 characters. Accepts values for tags and the `filterOutOfStockItems` flag.

 * Tag expressions. Restricts predictions to products that match all of the
 specified tags. Boolean operators `OR` and `NOT` are supported if the
 expression is enclosed in parentheses, and must be separated from the
 tag values by a space. `-"tagA"` is also supported and is equivalent to
 `NOT "tagA"`. Tag values must be double quoted UTF-8 encoded strings
 with a size limit of 1,000 characters.

 Note: "Recently viewed" models don't support tag filtering at the
 moment.

 * filterOutOfStockItems. Restricts predictions to products that do not
 have a
 stockState value of OUT_OF_STOCK.

 Examples:

 * tag=("Red" OR "Blue") tag="New-Arrival" tag=(NOT "promotional")
 * filterOutOfStockItems  tag=(-"promotional")
 * filterOutOfStockItems

 If your filter blocks all prediction results, the API will return *no*
 results. If instead you want empty result sets to return generic
 (unfiltered) popular products, set `strictFiltering` to False in
 `PredictRequest.params`. Note that the API will never return items with
 storageStatus of "EXPIRED" or "DELETED" regardless of filter choices.

 If `filterSyntaxV2` is set to true under the `params` field, then
 attribute-based expressions are expected instead of the above described
 tag-based syntax. Examples:

 * (colors: ANY("Red", "Blue")) AND NOT (categories: ANY("Phones"))
 * (availability: ANY("IN_STOCK")) AND
 (colors: ANY("Red") OR categories: ANY("Phones"))

 For more information, see
 [Filter recommendations](https://cloud.google.com/retail/docs/filter-recs).
      string filter = 5;
      Returns:
      The bytes for filter.

    • getValidateOnly

      boolean getValidateOnly()
       Use validate only mode for this prediction query. If set to true, a
 dummy model will be used that returns arbitrary products.
 Note that the validate only mode should only be used for testing the API,
 or if the model is not ready.
      bool validate_only = 6;
      Returns:
      The validateOnly.

    • getParamsCount

      int getParamsCount()
       Additional domain specific parameters for the predictions.

 Allowed values:

 * `returnProduct`: Boolean. If set to true, the associated product
 object will be returned in the `results.metadata` field in the
 prediction response.
 * `returnScore`: Boolean. If set to true, the prediction 'score'
 corresponding to each returned product will be set in the
 `results.metadata` field in the prediction response. The given
 'score' indicates the probability of a product being clicked/purchased
 given the user's context and history.
 * `strictFiltering`: Boolean. True by default. If set to false, the service
 will return generic (unfiltered) popular products instead of empty if
 your filter blocks all prediction results.
 * `priceRerankLevel`: String. Default empty. If set to be non-empty, then
 it needs to be one of {'no-price-reranking', 'low-price-reranking',
 'medium-price-reranking', 'high-price-reranking'}. This gives
 request-level control and adjusts prediction results based on product
 price.
 * `diversityLevel`: String. Default empty. If set to be non-empty, then
 it needs to be one of {'no-diversity', 'low-diversity',
 'medium-diversity', 'high-diversity', 'auto-diversity'}. This gives
 request-level control and adjusts prediction results based on product
 category.
 * `filterSyntaxV2`: Boolean. False by default. If set to true, the `filter`
 field is interpreteted according to the new, attribute-based syntax.
      map<string, .google.protobuf.Value> params = 7;

    • containsParams

      boolean containsParams(String key)
       Additional domain specific parameters for the predictions.

 Allowed values:

 * `returnProduct`: Boolean. If set to true, the associated product
 object will be returned in the `results.metadata` field in the
 prediction response.
 * `returnScore`: Boolean. If set to true, the prediction 'score'
 corresponding to each returned product will be set in the
 `results.metadata` field in the prediction response. The given
 'score' indicates the probability of a product being clicked/purchased
 given the user's context and history.
 * `strictFiltering`: Boolean. True by default. If set to false, the service
 will return generic (unfiltered) popular products instead of empty if
 your filter blocks all prediction results.
 * `priceRerankLevel`: String. Default empty. If set to be non-empty, then
 it needs to be one of {'no-price-reranking', 'low-price-reranking',
 'medium-price-reranking', 'high-price-reranking'}. This gives
 request-level control and adjusts prediction results based on product
 price.
 * `diversityLevel`: String. Default empty. If set to be non-empty, then
 it needs to be one of {'no-diversity', 'low-diversity',
 'medium-diversity', 'high-diversity', 'auto-diversity'}. This gives
 request-level control and adjusts prediction results based on product
 category.
 * `filterSyntaxV2`: Boolean. False by default. If set to true, the `filter`
 field is interpreteted according to the new, attribute-based syntax.
      map<string, .google.protobuf.Value> params = 7;

    • getParams

      @Deprecated Map<String,com.google.protobuf.Value> getParams()
      Deprecated.
      Use getParamsMap() instead.

    • getParamsMap

      Map<String,com.google.protobuf.Value> getParamsMap()
       Additional domain specific parameters for the predictions.

 Allowed values:

 * `returnProduct`: Boolean. If set to true, the associated product
 object will be returned in the `results.metadata` field in the
 prediction response.
 * `returnScore`: Boolean. If set to true, the prediction 'score'
 corresponding to each returned product will be set in the
 `results.metadata` field in the prediction response. The given
 'score' indicates the probability of a product being clicked/purchased
 given the user's context and history.
 * `strictFiltering`: Boolean. True by default. If set to false, the service
 will return generic (unfiltered) popular products instead of empty if
 your filter blocks all prediction results.
 * `priceRerankLevel`: String. Default empty. If set to be non-empty, then
 it needs to be one of {'no-price-reranking', 'low-price-reranking',
 'medium-price-reranking', 'high-price-reranking'}. This gives
 request-level control and adjusts prediction results based on product
 price.
 * `diversityLevel`: String. Default empty. If set to be non-empty, then
 it needs to be one of {'no-diversity', 'low-diversity',
 'medium-diversity', 'high-diversity', 'auto-diversity'}. This gives
 request-level control and adjusts prediction results based on product
 category.
 * `filterSyntaxV2`: Boolean. False by default. If set to true, the `filter`
 field is interpreteted according to the new, attribute-based syntax.
      map<string, .google.protobuf.Value> params = 7;

    • getParamsOrDefault

      com.google.protobuf.Value getParamsOrDefault(String key, com.google.protobuf.Value defaultValue)
       Additional domain specific parameters for the predictions.

 Allowed values:

 * `returnProduct`: Boolean. If set to true, the associated product
 object will be returned in the `results.metadata` field in the
 prediction response.
 * `returnScore`: Boolean. If set to true, the prediction 'score'
 corresponding to each returned product will be set in the
 `results.metadata` field in the prediction response. The given
 'score' indicates the probability of a product being clicked/purchased
 given the user's context and history.
 * `strictFiltering`: Boolean. True by default. If set to false, the service
 will return generic (unfiltered) popular products instead of empty if
 your filter blocks all prediction results.
 * `priceRerankLevel`: String. Default empty. If set to be non-empty, then
 it needs to be one of {'no-price-reranking', 'low-price-reranking',
 'medium-price-reranking', 'high-price-reranking'}. This gives
 request-level control and adjusts prediction results based on product
 price.
 * `diversityLevel`: String. Default empty. If set to be non-empty, then
 it needs to be one of {'no-diversity', 'low-diversity',
 'medium-diversity', 'high-diversity', 'auto-diversity'}. This gives
 request-level control and adjusts prediction results based on product
 category.
 * `filterSyntaxV2`: Boolean. False by default. If set to true, the `filter`
 field is interpreteted according to the new, attribute-based syntax.
      map<string, .google.protobuf.Value> params = 7;

    • getParamsOrThrow

      com.google.protobuf.Value getParamsOrThrow(String key)
       Additional domain specific parameters for the predictions.

 Allowed values:

 * `returnProduct`: Boolean. If set to true, the associated product
 object will be returned in the `results.metadata` field in the
 prediction response.
 * `returnScore`: Boolean. If set to true, the prediction 'score'
 corresponding to each returned product will be set in the
 `results.metadata` field in the prediction response. The given
 'score' indicates the probability of a product being clicked/purchased
 given the user's context and history.
 * `strictFiltering`: Boolean. True by default. If set to false, the service
 will return generic (unfiltered) popular products instead of empty if
 your filter blocks all prediction results.
 * `priceRerankLevel`: String. Default empty. If set to be non-empty, then
 it needs to be one of {'no-price-reranking', 'low-price-reranking',
 'medium-price-reranking', 'high-price-reranking'}. This gives
 request-level control and adjusts prediction results based on product
 price.
 * `diversityLevel`: String. Default empty. If set to be non-empty, then
 it needs to be one of {'no-diversity', 'low-diversity',
 'medium-diversity', 'high-diversity', 'auto-diversity'}. This gives
 request-level control and adjusts prediction results based on product
 category.
 * `filterSyntaxV2`: Boolean. False by default. If set to true, the `filter`
 field is interpreteted according to the new, attribute-based syntax.
      map<string, .google.protobuf.Value> params = 7;

    • getLabelsCount

      int getLabelsCount()
       The labels applied to a resource must meet the following requirements:

 * Each resource can have multiple labels, up to a maximum of 64.
 * Each label must be a key-value pair.
 * Keys have a minimum length of 1 character and a maximum length of 63
 characters and cannot be empty. Values can be empty and have a maximum
 length of 63 characters.
 * Keys and values can contain only lowercase letters, numeric characters,
 underscores, and dashes. All characters must use UTF-8 encoding, and
 international characters are allowed.
 * The key portion of a label must be unique. However, you can use the same
 key with multiple resources.
 * Keys must start with a lowercase letter or international character.

 See [Google Cloud
 Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 for more details.
      map<string, string> labels = 8;

    • containsLabels

      boolean containsLabels(String key)
       The labels applied to a resource must meet the following requirements:

 * Each resource can have multiple labels, up to a maximum of 64.
 * Each label must be a key-value pair.
 * Keys have a minimum length of 1 character and a maximum length of 63
 characters and cannot be empty. Values can be empty and have a maximum
 length of 63 characters.
 * Keys and values can contain only lowercase letters, numeric characters,
 underscores, and dashes. All characters must use UTF-8 encoding, and
 international characters are allowed.
 * The key portion of a label must be unique. However, you can use the same
 key with multiple resources.
 * Keys must start with a lowercase letter or international character.

 See [Google Cloud
 Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 for more details.
      map<string, string> labels = 8;

    • getLabels

      @Deprecated Map<String,String> getLabels()
      Deprecated.
      Use getLabelsMap() instead.

    • getLabelsMap

      Map<String,String> getLabelsMap()
       The labels applied to a resource must meet the following requirements:

 * Each resource can have multiple labels, up to a maximum of 64.
 * Each label must be a key-value pair.
 * Keys have a minimum length of 1 character and a maximum length of 63
 characters and cannot be empty. Values can be empty and have a maximum
 length of 63 characters.
 * Keys and values can contain only lowercase letters, numeric characters,
 underscores, and dashes. All characters must use UTF-8 encoding, and
 international characters are allowed.
 * The key portion of a label must be unique. However, you can use the same
 key with multiple resources.
 * Keys must start with a lowercase letter or international character.

 See [Google Cloud
 Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 for more details.
      map<string, string> labels = 8;

    • getLabelsOrDefault

      String getLabelsOrDefault(String key, String defaultValue)
       The labels applied to a resource must meet the following requirements:

 * Each resource can have multiple labels, up to a maximum of 64.
 * Each label must be a key-value pair.
 * Keys have a minimum length of 1 character and a maximum length of 63
 characters and cannot be empty. Values can be empty and have a maximum
 length of 63 characters.
 * Keys and values can contain only lowercase letters, numeric characters,
 underscores, and dashes. All characters must use UTF-8 encoding, and
 international characters are allowed.
 * The key portion of a label must be unique. However, you can use the same
 key with multiple resources.
 * Keys must start with a lowercase letter or international character.

 See [Google Cloud
 Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 for more details.
      map<string, string> labels = 8;

    • getLabelsOrThrow

      String getLabelsOrThrow(String key)
       The labels applied to a resource must meet the following requirements:

 * Each resource can have multiple labels, up to a maximum of 64.
 * Each label must be a key-value pair.
 * Keys have a minimum length of 1 character and a maximum length of 63
 characters and cannot be empty. Values can be empty and have a maximum
 length of 63 characters.
 * Keys and values can contain only lowercase letters, numeric characters,
 underscores, and dashes. All characters must use UTF-8 encoding, and
 international characters are allowed.
 * The key portion of a label must be unique. However, you can use the same
 key with multiple resources.
 * Keys must start with a lowercase letter or international character.

 See [Google Cloud
 Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 for more details.
      map<string, string> labels = 8;