Struct googapis::google::cloud::retail::v2alpha::PredictRequest [−][src]
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>,
}
Expand description
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 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: 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
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, 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 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 {‘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.
labels: HashMap<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.
Trait Implementations
fn merge_field<B>(
&mut self,
tag: u32,
wire_type: WireType,
buf: &mut B,
ctx: DecodeContext
) -> Result<(), DecodeError> where
B: Buf,
Returns the encoded length of the message without a length delimiter.
Encodes the message to a buffer. Read more
Encodes the message to a newly allocated buffer.
Encodes the message with a length-delimiter to a buffer. Read more
Encodes the message with a length-delimiter to a newly allocated buffer.
Decodes an instance of the message from a buffer. Read more
fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
Self: Default,
B: Buf,
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.
Decodes an instance of the message from a buffer, and merges it into self
. Read more
Decodes a length-delimited instance of the message from buffer, and
merges it into self
. Read more
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
This method tests for !=
.
Auto Trait Implementations
impl RefUnwindSafe for PredictRequest
impl Send for PredictRequest
impl Sync for PredictRequest
impl Unpin for PredictRequest
impl UnwindSafe for PredictRequest
Blanket Implementations
Mutably borrows from an owned value. Read more
Wrap the input message T
in a tonic::Request
pub fn vzip(self) -> V
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more