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
-
(::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
andNOT
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 toNOT "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 generic (unfiltered) popular products. If you only want results strictly matching the filters, set
strictFiltering
to True inPredictRequest.params
to receive empty results instead. Note that the API will never return items with storageStatus of "EXPIRED" or "DELETED" regardless of filter choices. - Tag expressions. Restricts predictions to products that match all of the
specified tags. Boolean operators
#filter=
def filter=(value) -> ::String
-
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
andNOT
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 toNOT "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 generic (unfiltered) popular products. If you only want results strictly matching the filters, set
strictFiltering
to True inPredictRequest.params
to receive empty results instead. Note that the API will never return items with storageStatus of "EXPIRED" or "DELETED" regardless of filter choices. - Tag expressions. Restricts predictions to products that match all of the
specified tags. Boolean operators
-
(::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
andNOT
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 toNOT "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 generic (unfiltered) popular products. If you only want results strictly matching the filters, set
strictFiltering
to True inPredictRequest.params
to receive empty results instead. Note that the API will never return items with storageStatus of "EXPIRED" or "DELETED" regardless of filter choices. - Tag expressions. Restricts predictions to products that match all of the
specified tags. Boolean operators
#labels
def labels() -> ::Google::Protobuf::Map{::String => ::String}
-
(::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}
-
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.
-
(::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
- (::Integer) — Maximum number of results to return per page. 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
- value (::Integer) — Maximum number of results to return per page. 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.
- (::Integer) — Maximum number of results to return per page. 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
- (::String) — The previous PredictResponse.next_page_token.
#page_token=
def page_token=(value) -> ::String
- value (::String) — The previous PredictResponse.next_page_token.
- (::String) — The previous PredictResponse.next_page_token.
#params
def params() -> ::Google::Protobuf::Map{::String => ::Google::Protobuf::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 theresults.metadata
field in the prediction response.returnScore
: Boolean. If set to true, the prediction 'score' corresponding to each returned product will be set in theresults.metadata
field in the prediction response. The given 'score' indicates the probability of an 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.
#params=
def params=(value) -> ::Google::Protobuf::Map{::String => ::Google::Protobuf::Value}
-
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 theresults.metadata
field in the prediction response.returnScore
: Boolean. If set to true, the prediction 'score' corresponding to each returned product will be set in theresults.metadata
field in the prediction response. The given 'score' indicates the probability of an 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.
-
(::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 theresults.metadata
field in the prediction response.returnScore
: Boolean. If set to true, the prediction 'score' corresponding to each returned product will be set in theresults.metadata
field in the prediction response. The given 'score' indicates the probability of an 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.
#placement
def placement() -> ::String
-
(::String) — Required. Full resource name of the format:
{name=projects//locations/global/catalogs/default_catalog/placements/}
The ID of the Recommendations AI placement. Before you can request
predictions from your model, you must create at least one placement for it.
For more information, see Managing
placements.
The full list of available placements can be seen at https://console.cloud.google.com/recommendation/catalogs/default_catalog/placements
#placement=
def placement=(value) -> ::String
-
value (::String) — Required. Full resource name of the format:
{name=projects//locations/global/catalogs/default_catalog/placements/}
The ID of the Recommendations AI placement. Before you can request
predictions from your model, you must create at least one placement for it.
For more information, see Managing
placements.
The full list of available placements can be seen at https://console.cloud.google.com/recommendation/catalogs/default_catalog/placements
-
(::String) — Required. Full resource name of the format:
{name=projects//locations/global/catalogs/default_catalog/placements/}
The ID of the Recommendations AI placement. Before you can request
predictions from your model, you must create at least one placement for it.
For more information, see Managing
placements.
The full list of available placements can be seen at https://console.cloud.google.com/recommendation/catalogs/default_catalog/placements
#user_event
def user_event() -> ::Google::Cloud::Retail::V2::UserEvent
- (::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.
#user_event=
def user_event=(value) -> ::Google::Cloud::Retail::V2::UserEvent
- 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.
- (::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.
#validate_only
def validate_only() -> ::Boolean
- (::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
- 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.
- (::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.