GoogleCloudRecommendationengineV1beta1PredictRequest class
Request message for Predict method.
Full resource name of the format: {name=projects / * /locations/global/catalogs/default_catalog/eventStores/default_event_store/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 items frequently bought together with one or more
catalog items in the same shopping session. Commonly displayed after
add-to-cart
event, 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 specifieduserId
orvisitorId
. 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 specifieduserId
orvisitorId
and its relevance to a specifiedCatalogItem
. Typically used on product detail pages. For example
- More items like this. *
recently_viewed_default
: Returns up to 75 items recently viewed by the specifieduserId
orvisitorId
, most recent ones first. Returns nothing if neither of them has viewed any items 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
Constructors
-
GoogleCloudRecommendationengineV1beta1PredictRequest({bool? dryRun, String? filter, Map<
String, String> ? labels, int? pageSize, String? pageToken, Map<String, Object?> ? params, GoogleCloudRecommendationengineV1beta1UserEvent? userEvent}) - GoogleCloudRecommendationengineV1beta1PredictRequest.fromJson(Map json_)
Properties
- dryRun ↔ bool?
-
Use dryRun mode for this prediction query.
getter/setter pair
- filter ↔ String?
-
Filter for restricting prediction results.
getter/setter pair
- hashCode → int
-
The hash code for this object.
no setterinherited
-
labels
↔ Map<
String, String> ? -
The labels for the predict request.
getter/setter pair
- pageSize ↔ int?
-
Maximum number of results to return per page.
getter/setter pair
- pageToken ↔ String?
-
The previous PredictResponse.next_page_token.
getter/setter pair
-
params
↔ Map<
String, Object?> ? -
Additional domain specific parameters for the predictions.
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- userEvent ↔ GoogleCloudRecommendationengineV1beta1UserEvent?
-
Context about the user, what they are looking at and what action they took
to trigger the predict request.
getter/setter pair
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toJson(
) → Map< String, dynamic> -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited