Struct gapi_grpc::google::cloud::retail::v2beta::PredictRequest

pub struct PredictRequest {
    pub placement: String,
    pub user_event: Option<UserEvent>,
    pub page_size: i32,
    pub page_token: String,
    pub filter: String,
    pub validate_only: bool,
    pub params: HashMap<String, Value>,
    pub labels: HashMap<String, String>,
}

Request message for Predict method.

Fields

placement: String

Required. Full resource name of the format: {name=projects//locations/global/catalogs/default_catalog/placements/} The id of the recommendation engine placement. This id is used to identify the set of models that will be used to make the prediction.

We currently support three placements with the following IDs by default:

• shopping_cart: Predicts products frequently bought together with one or more products in the same shopping session. Commonly displayed after add-to-cart events, on product detail pages, or on the shopping cart page.

• home_page: Predicts the next product that a user will most likely engage with or purchase based on the shopping or viewing history of the specified userId or visitorId. For example - Recommendations for you.

• product_detail: Predicts the next product that a user will most likely engage with or purchase. The prediction is based on the shopping or viewing history of the specified userId or visitorId and its relevance to a specified CatalogItem. Typically used on product detail pages. For example - More products like this.

• recently_viewed_default: Returns up to 75 products recently viewed by the specified userId or visitorId, most recent ones first. Returns nothing if neither of them has viewed any products yet. For example - Recently viewed.

The full list of available placements can be seen at https://console.cloud.google.com/recommendation/catalogs/default_catalog/placements

user_event: Option<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.

page_size: i32

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: String

The previous PredictResponse.next_page_token.

filter: 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.

• 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, nothing will be returned. If you want generic (unfiltered) popular products to be returned instead, set strictFiltering to false in PredictRequest.params.

validate_only: bool

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.

params: HashMap<String, 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 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.

labels: HashMap<String, String>

The labels for the predict request.

• Label keys can contain lowercase letters, digits and hyphens, must start with a letter, and must end with a letter or digit.
• Non-zero label values can contain lowercase letters, digits and hyphens, must start with a letter, and must end with a letter or digit.
• No more than 64 labels can be associated with a given request.

See https://goo.gl/xmQnxf for more information on and examples of labels.

Trait Implementations

impl Clone for PredictRequest

fn clone(&self) -> PredictRequest

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PredictRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for PredictRequest

fn default() -> PredictRequest

Returns the “default value” for a type.

impl Message for PredictRequest

fn encode_raw<B>(&self, buf: &mut B) where
    B: BufMut, 

fn merge_field<B>(
    &mut self,
    tag: u32,
    wire_type: WireType,
    buf: &mut B,
    ctx: DecodeContext
) -> Result<(), DecodeError> where
    B: Buf, 

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

pub fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message to a buffer.

pub fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message with a length-delimiter to a buffer.

pub fn decode<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

Decodes an instance of the message from a buffer.

pub fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

Decodes a length-delimited instance of the message from the buffer.

pub fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes an instance of the message from a buffer, and merges it into self.

pub fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq<PredictRequest> for PredictRequest

fn eq(&self, other: &PredictRequest) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &PredictRequest) -> bool

This method tests for !=.

impl StructuralPartialEq for PredictRequest