Retail V2 API - Class Google::Cloud::Retail::V2::PredictRequest (v0.16.0)

Version 0.16.0

• 1.2.0 (latest)
• 1.1.0
• 1.0.1
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.2
• 0.17.0
• 0.16.1
• 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.6.4

Reference documentation and code samples for the Retail V2 API class Google::Cloud::Retail::V2::PredictRequest.

Request message for Predict method.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#filter

def filter() -> ::String

Returns

• (::String) — 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.

#filter=

def filter=(value) -> ::String

Parameter

• value (::String) — 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.

Returns

• (::String) — 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.

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}

Returns

• (::Google::Protobuf::Map{::String => ::String}) — 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 for more details.

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}

Parameter

• value (::Google::Protobuf::Map{::String => ::String}) — 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 for more details.

Returns

• (::Google::Protobuf::Map{::String => ::String}) — 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 for more details.

#page_size

def page_size() -> ::Integer

Returns

• (::Integer) — 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.

#page_size=

def page_size=(value) -> ::Integer

Parameter

• value (::Integer) — 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.

Returns

• (::Integer) — 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.

#page_token

def page_token() -> ::String

Returns

• (::String) — This field is not used; leave it unset.

#page_token=

def page_token=(value) -> ::String

Parameter

• value (::String) — This field is not used; leave it unset.

Returns

• (::String) — This field is not used; leave it unset.

#params

def params() -> ::Google::Protobuf::Map{::String => ::Google::Protobuf::Value}

Returns

• (::Google::Protobuf::Map{::String => ::Google::Protobuf::Value}) —

  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 '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 '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.

#params=

def params=(value) -> ::Google::Protobuf::Map{::String => ::Google::Protobuf::Value}

Parameter

• value (::Google::Protobuf::Map{::String => ::Google::Protobuf::Value}) —

  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 '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 '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.

Returns

• (::Google::Protobuf::Map{::String => ::Google::Protobuf::Value}) —

  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 '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 '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.

#placement

def placement() -> ::String

Returns

• (::String) — 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.

  The full list of available serving configs can be seen at https://console.cloud.google.com/ai/retail/catalogs/default_catalog/configs

#placement=

def placement=(value) -> ::String

Parameter

• value (::String) — 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.

  The full list of available serving configs can be seen at https://console.cloud.google.com/ai/retail/catalogs/default_catalog/configs

Returns

• (::String) — 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.

  The full list of available serving configs can be seen at https://console.cloud.google.com/ai/retail/catalogs/default_catalog/configs

#user_event

def user_event() -> ::Google::Cloud::Retail::V2::UserEvent

Returns

• (::Google::Cloud::Retail::V2::UserEvent) — 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 or 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 to a random unique ID and leave UserInfo.user_id unset.

#user_event=

def user_event=(value) -> ::Google::Cloud::Retail::V2::UserEvent

Parameter

• value (::Google::Cloud::Retail::V2::UserEvent) — 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 or 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 to a random unique ID and leave UserInfo.user_id unset.

Returns

• (::Google::Cloud::Retail::V2::UserEvent) — 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 or 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 to a random unique ID and leave UserInfo.user_id unset.

#validate_only

def validate_only() -> ::Boolean

Returns

• (::Boolean) — 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.

#validate_only=

def validate_only=(value) -> ::Boolean

Parameter

• value (::Boolean) — 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.

Returns

• (::Boolean) — 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.