Reference documentation and code samples for the Google Cloud Recommendation Engine V1beta1 Client class PredictRequest.
Request message for Predict method.
Generated from protobuf message google.cloud.recommendationengine.v1beta1.PredictRequest
Methods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Required. Full resource name of the format: |
↳ user_event |
Google\Cloud\RecommendationEngine\V1beta1\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 |
int
Optional. Maximum number of results to return per page. Set this property to the number of prediction results required. If zero, the service will choose a reasonable default. |
↳ page_token |
string
Optional. The previous PredictResponse.next_page_token. |
↳ filter |
string
Optional. Filter for restricting prediction results. Accepts values for tags and the |
↳ dry_run |
bool
Optional. Use dryRun mode for this prediction query. If set to true, a dummy model will be used that returns arbitrary catalog items. Note that the dryRun mode should only be used for testing the API, or if the model is not ready. |
↳ params |
array|Google\Protobuf\Internal\MapField
Optional. Additional domain specific parameters for the predictions. Allowed values: * |
↳ labels |
array|Google\Protobuf\Internal\MapField
Optional. 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. |
getName
Required. 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 afteradd-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 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/datafeeds/default_catalog/dashboard
Returns | |
---|---|
Type | Description |
string |
setName
Required. 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 afteradd-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 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/datafeeds/default_catalog/dashboard
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getUserEvent
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.
Returns | |
---|---|
Type | Description |
Google\Cloud\RecommendationEngine\V1beta1\UserEvent|null |
hasUserEvent
clearUserEvent
setUserEvent
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.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\RecommendationEngine\V1beta1\UserEvent
|
Returns | |
---|---|
Type | Description |
$this |
getPageSize
Optional. Maximum number of results to return per page. Set this property to the number of prediction results required. If zero, the service will choose a reasonable default.
Returns | |
---|---|
Type | Description |
int |
setPageSize
Optional. Maximum number of results to return per page. Set this property to the number of prediction results required. If zero, the service will choose a reasonable default.
Parameter | |
---|---|
Name | Description |
var |
int
|
Returns | |
---|---|
Type | Description |
$this |
getPageToken
Optional. The previous PredictResponse.next_page_token.
Returns | |
---|---|
Type | Description |
string |
setPageToken
Optional. The previous PredictResponse.next_page_token.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getFilter
Optional. Filter for restricting prediction results. Accepts values for
tags and the filterOutOfStockItems
flag.
- Tag expressions. Restricts predictions to items 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 KiB.- filterOutOfStockItems. Restricts predictions to items 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
Returns | |
---|---|
Type | Description |
string |
setFilter
Optional. Filter for restricting prediction results. Accepts values for
tags and the filterOutOfStockItems
flag.
- Tag expressions. Restricts predictions to items 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 KiB.- filterOutOfStockItems. Restricts predictions to items 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
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getDryRun
Optional. Use dryRun mode for this prediction query. If set to true, a dummy model will be used that returns arbitrary catalog items.
Note that the dryRun mode should only be used for testing the API, or if the model is not ready.
Returns | |
---|---|
Type | Description |
bool |
setDryRun
Optional. Use dryRun mode for this prediction query. If set to true, a dummy model will be used that returns arbitrary catalog items.
Note that the dryRun mode should only be used for testing the API, or if the model is not ready.
Parameter | |
---|---|
Name | Description |
var |
bool
|
Returns | |
---|---|
Type | Description |
$this |
getParams
Optional. Additional domain specific parameters for the predictions.
Allowed values:
returnCatalogItem
: Boolean. If set to true, the associated catalogItem object will be returned in thePredictResponse.PredictionResult.itemMetadata
object in the method response.returnItemScore
: Boolean. If set to true, the prediction 'score' corresponding to each returned item will be set in themetadata
field in the prediction response. The given 'score' indicates the probability of an item being clicked/purchased given the user's context and history.
Returns | |
---|---|
Type | Description |
Google\Protobuf\Internal\MapField |
setParams
Optional. Additional domain specific parameters for the predictions.
Allowed values:
returnCatalogItem
: Boolean. If set to true, the associated catalogItem object will be returned in thePredictResponse.PredictionResult.itemMetadata
object in the method response.returnItemScore
: Boolean. If set to true, the prediction 'score' corresponding to each returned item will be set in themetadata
field in the prediction response. The given 'score' indicates the probability of an item being clicked/purchased given the user's context and history.
Parameter | |
---|---|
Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
Returns | |
---|---|
Type | Description |
$this |
getLabels
Optional. 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.
Returns | |
---|---|
Type | Description |
Google\Protobuf\Internal\MapField |
setLabels
Optional. 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.
Parameter | |
---|---|
Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
Returns | |
---|---|
Type | Description |
$this |