public static final class PredictRequest.Builder extends GeneratedMessageV3.Builder<PredictRequest.Builder> implements PredictRequestOrBuilderRequest message for Predict method.
Protobuf type google.cloud.recommendationengine.v1beta1.PredictRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > PredictRequest.BuilderImplements
PredictRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Type | Description |
| Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public PredictRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Name | Description |
| field | FieldDescriptor |
| value | Object |
| Type | Description |
| PredictRequest.Builder |
build()
public PredictRequest build()| Type | Description |
| PredictRequest |
buildPartial()
public PredictRequest buildPartial()| Type | Description |
| PredictRequest |
clear()
public PredictRequest.Builder clear()| Type | Description |
| PredictRequest.Builder |
clearDryRun()
public PredictRequest.Builder clearDryRun()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.
bool dry_run = 4 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| PredictRequest.Builder | This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public PredictRequest.Builder clearField(Descriptors.FieldDescriptor field)| Name | Description |
| field | FieldDescriptor |
| Type | Description |
| PredictRequest.Builder |
clearFilter()
public PredictRequest.Builder clearFilter() 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
ORandNOTare 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
string filter = 3 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| PredictRequest.Builder | This builder for chaining. |
clearLabels()
public PredictRequest.Builder clearLabels()| Type | Description |
| PredictRequest.Builder |
clearName()
public PredictRequest.Builder clearName() 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-cartevents, 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 specifieduserIdorvisitorId. 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 specifieduserIdorvisitorIdand 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 specifieduserIdorvisitorId, 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
string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Type | Description |
| PredictRequest.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public PredictRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Name | Description |
| oneof | OneofDescriptor |
| Type | Description |
| PredictRequest.Builder |
clearPageSize()
public PredictRequest.Builder clearPageSize()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.
int32 page_size = 7 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| PredictRequest.Builder | This builder for chaining. |
clearPageToken()
public PredictRequest.Builder clearPageToken()Optional. The previous PredictResponse.next_page_token.
string page_token = 8 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| PredictRequest.Builder | This builder for chaining. |
clearParams()
public PredictRequest.Builder clearParams()| Type | Description |
| PredictRequest.Builder |
clearUserEvent()
public PredictRequest.Builder clearUserEvent()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.recommendationengine.v1beta1.UserEvent user_event = 2 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
| PredictRequest.Builder |
clone()
public PredictRequest.Builder clone()| Type | Description |
| PredictRequest.Builder |
containsLabels(String key)
public boolean containsLabels(String key)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.
map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];
| Name | Description |
| key | String |
| Type | Description |
| boolean |
containsParams(String key)
public boolean containsParams(String key)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.itemMetadataobject in the method response.returnItemScore: Boolean. If set to true, the prediction 'score' corresponding to each returned item will be set in themetadatafield in the prediction response. The given 'score' indicates the probability of an item being clicked/purchased given the user's context and history.
map<string, .google.protobuf.Value> params = 6 [(.google.api.field_behavior) = OPTIONAL];
| Name | Description |
| key | String |
| Type | Description |
| boolean |
getDefaultInstanceForType()
public PredictRequest getDefaultInstanceForType()| Type | Description |
| PredictRequest |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Type | Description |
| Descriptor |
getDryRun()
public boolean 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.
bool dry_run = 4 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| boolean | The dryRun. |
getFilter()
public String 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
ORandNOTare 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
string filter = 3 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| String | The filter. |
getFilterBytes()
public ByteString getFilterBytes() 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
ORandNOTare 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
string filter = 3 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| ByteString | The bytes for filter. |
getLabels()
public Map<String,String> getLabels()Use #getLabelsMap() instead.
| Type | Description |
| Map<String,String> |
getLabelsCount()
public int getLabelsCount()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.
map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| int |
getLabelsMap()
public Map<String,String> getLabelsMap()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.
map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| Map<String,String> |
getLabelsOrDefault(String key, String defaultValue)
public String getLabelsOrDefault(String key, String defaultValue)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.
map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];
| Name | Description |
| key | String |
| defaultValue | String |
| Type | Description |
| String |
getLabelsOrThrow(String key)
public String getLabelsOrThrow(String key)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.
map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];
| Name | Description |
| key | String |
| Type | Description |
| String |
getMutableLabels()
public Map<String,String> getMutableLabels()Use alternate mutation accessors instead.
| Type | Description |
| Map<String,String> |
getMutableParams()
public Map<String,Value> getMutableParams()Use alternate mutation accessors instead.
| Type | Description |
| Map<String,Value> |
getName()
public String 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-cartevents, 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 specifieduserIdorvisitorId. 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 specifieduserIdorvisitorIdand 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 specifieduserIdorvisitorId, 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
string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Type | Description |
| String | The name. |
getNameBytes()
public ByteString getNameBytes() 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-cartevents, 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 specifieduserIdorvisitorId. 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 specifieduserIdorvisitorIdand 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 specifieduserIdorvisitorId, 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
string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Type | Description |
| ByteString | The bytes for name. |
getPageSize()
public int 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.
int32 page_size = 7 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| int | The pageSize. |
getPageToken()
public String getPageToken()Optional. The previous PredictResponse.next_page_token.
string page_token = 8 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| String | The pageToken. |
getPageTokenBytes()
public ByteString getPageTokenBytes()Optional. The previous PredictResponse.next_page_token.
string page_token = 8 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| ByteString | The bytes for pageToken. |
getParams()
public Map<String,Value> getParams()Use #getParamsMap() instead.
| Type | Description |
| Map<String,Value> |
getParamsCount()
public int getParamsCount()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.itemMetadataobject in the method response.returnItemScore: Boolean. If set to true, the prediction 'score' corresponding to each returned item will be set in themetadatafield in the prediction response. The given 'score' indicates the probability of an item being clicked/purchased given the user's context and history.
map<string, .google.protobuf.Value> params = 6 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| int |
getParamsMap()
public Map<String,Value> getParamsMap()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.itemMetadataobject in the method response.returnItemScore: Boolean. If set to true, the prediction 'score' corresponding to each returned item will be set in themetadatafield in the prediction response. The given 'score' indicates the probability of an item being clicked/purchased given the user's context and history.
map<string, .google.protobuf.Value> params = 6 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| Map<String,Value> |
getParamsOrDefault(String key, Value defaultValue)
public Value getParamsOrDefault(String key, Value defaultValue)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.itemMetadataobject in the method response.returnItemScore: Boolean. If set to true, the prediction 'score' corresponding to each returned item will be set in themetadatafield in the prediction response. The given 'score' indicates the probability of an item being clicked/purchased given the user's context and history.
map<string, .google.protobuf.Value> params = 6 [(.google.api.field_behavior) = OPTIONAL];
| Name | Description |
| key | String |
| defaultValue | Value |
| Type | Description |
| Value |
getParamsOrThrow(String key)
public Value getParamsOrThrow(String key)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.itemMetadataobject in the method response.returnItemScore: Boolean. If set to true, the prediction 'score' corresponding to each returned item will be set in themetadatafield in the prediction response. The given 'score' indicates the probability of an item being clicked/purchased given the user's context and history.
map<string, .google.protobuf.Value> params = 6 [(.google.api.field_behavior) = OPTIONAL];
| Name | Description |
| key | String |
| Type | Description |
| Value |
getUserEvent()
public UserEvent 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.
.google.cloud.recommendationengine.v1beta1.UserEvent user_event = 2 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
| UserEvent | The userEvent. |
getUserEventBuilder()
public UserEvent.Builder getUserEventBuilder()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.recommendationengine.v1beta1.UserEvent user_event = 2 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
| UserEvent.Builder |
getUserEventOrBuilder()
public UserEventOrBuilder getUserEventOrBuilder()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.recommendationengine.v1beta1.UserEvent user_event = 2 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
| UserEventOrBuilder |
hasUserEvent()
public boolean hasUserEvent()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.recommendationengine.v1beta1.UserEvent user_event = 2 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
| boolean | Whether the userEvent field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Type | Description |
| FieldAccessorTable |
internalGetMapField(int number)
protected MapField internalGetMapField(int number)| Name | Description |
| number | int |
| Type | Description |
| MapField |
internalGetMutableMapField(int number)
protected MapField internalGetMutableMapField(int number)| Name | Description |
| number | int |
| Type | Description |
| MapField |
isInitialized()
public final boolean isInitialized()| Type | Description |
| boolean |
mergeFrom(PredictRequest other)
public PredictRequest.Builder mergeFrom(PredictRequest other)| Name | Description |
| other | PredictRequest |
| Type | Description |
| PredictRequest.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public PredictRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
| input | CodedInputStream |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| PredictRequest.Builder |
| Type | Description |
| IOException |
mergeFrom(Message other)
public PredictRequest.Builder mergeFrom(Message other)| Name | Description |
| other | Message |
| Type | Description |
| PredictRequest.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final PredictRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Name | Description |
| unknownFields | UnknownFieldSet |
| Type | Description |
| PredictRequest.Builder |
mergeUserEvent(UserEvent value)
public PredictRequest.Builder mergeUserEvent(UserEvent value)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.recommendationengine.v1beta1.UserEvent user_event = 2 [(.google.api.field_behavior) = REQUIRED];
| Name | Description |
| value | UserEvent |
| Type | Description |
| PredictRequest.Builder |
putAllLabels(Map<String,String> values)
public PredictRequest.Builder putAllLabels(Map<String,String> values)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.
map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];
| Name | Description |
| values | Map<String,String> |
| Type | Description |
| PredictRequest.Builder |
putAllParams(Map<String,Value> values)
public PredictRequest.Builder putAllParams(Map<String,Value> values)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.itemMetadataobject in the method response.returnItemScore: Boolean. If set to true, the prediction 'score' corresponding to each returned item will be set in themetadatafield in the prediction response. The given 'score' indicates the probability of an item being clicked/purchased given the user's context and history.
map<string, .google.protobuf.Value> params = 6 [(.google.api.field_behavior) = OPTIONAL];
| Name | Description |
| values | Map<String,Value> |
| Type | Description |
| PredictRequest.Builder |
putLabels(String key, String value)
public PredictRequest.Builder putLabels(String key, String value)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.
map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];
| Name | Description |
| key | String |
| value | String |
| Type | Description |
| PredictRequest.Builder |
putParams(String key, Value value)
public PredictRequest.Builder putParams(String key, Value value)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.itemMetadataobject in the method response.returnItemScore: Boolean. If set to true, the prediction 'score' corresponding to each returned item will be set in themetadatafield in the prediction response. The given 'score' indicates the probability of an item being clicked/purchased given the user's context and history.
map<string, .google.protobuf.Value> params = 6 [(.google.api.field_behavior) = OPTIONAL];
| Name | Description |
| key | String |
| value | Value |
| Type | Description |
| PredictRequest.Builder |
removeLabels(String key)
public PredictRequest.Builder removeLabels(String key)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.
map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];
| Name | Description |
| key | String |
| Type | Description |
| PredictRequest.Builder |
removeParams(String key)
public PredictRequest.Builder removeParams(String key)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.itemMetadataobject in the method response.returnItemScore: Boolean. If set to true, the prediction 'score' corresponding to each returned item will be set in themetadatafield in the prediction response. The given 'score' indicates the probability of an item being clicked/purchased given the user's context and history.
map<string, .google.protobuf.Value> params = 6 [(.google.api.field_behavior) = OPTIONAL];
| Name | Description |
| key | String |
| Type | Description |
| PredictRequest.Builder |
setDryRun(boolean value)
public PredictRequest.Builder setDryRun(boolean value)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.
bool dry_run = 4 [(.google.api.field_behavior) = OPTIONAL];
| Name | Description |
| value | booleanThe dryRun to set. |
| Type | Description |
| PredictRequest.Builder | This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public PredictRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)| Name | Description |
| field | FieldDescriptor |
| value | Object |
| Type | Description |
| PredictRequest.Builder |
setFilter(String value)
public PredictRequest.Builder setFilter(String value) 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
ORandNOTare 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
string filter = 3 [(.google.api.field_behavior) = OPTIONAL];
| Name | Description |
| value | StringThe filter to set. |
| Type | Description |
| PredictRequest.Builder | This builder for chaining. |
setFilterBytes(ByteString value)
public PredictRequest.Builder setFilterBytes(ByteString value) 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
ORandNOTare 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
string filter = 3 [(.google.api.field_behavior) = OPTIONAL];
| Name | Description |
| value | ByteStringThe bytes for filter to set. |
| Type | Description |
| PredictRequest.Builder | This builder for chaining. |
setName(String value)
public PredictRequest.Builder setName(String value) 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-cartevents, 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 specifieduserIdorvisitorId. 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 specifieduserIdorvisitorIdand 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 specifieduserIdorvisitorId, 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
string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Name | Description |
| value | StringThe name to set. |
| Type | Description |
| PredictRequest.Builder | This builder for chaining. |
setNameBytes(ByteString value)
public PredictRequest.Builder setNameBytes(ByteString value) 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-cartevents, 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 specifieduserIdorvisitorId. 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 specifieduserIdorvisitorIdand 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 specifieduserIdorvisitorId, 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
string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Name | Description |
| value | ByteStringThe bytes for name to set. |
| Type | Description |
| PredictRequest.Builder | This builder for chaining. |
setPageSize(int value)
public PredictRequest.Builder setPageSize(int value)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.
int32 page_size = 7 [(.google.api.field_behavior) = OPTIONAL];
| Name | Description |
| value | intThe pageSize to set. |
| Type | Description |
| PredictRequest.Builder | This builder for chaining. |
setPageToken(String value)
public PredictRequest.Builder setPageToken(String value)Optional. The previous PredictResponse.next_page_token.
string page_token = 8 [(.google.api.field_behavior) = OPTIONAL];
| Name | Description |
| value | StringThe pageToken to set. |
| Type | Description |
| PredictRequest.Builder | This builder for chaining. |
setPageTokenBytes(ByteString value)
public PredictRequest.Builder setPageTokenBytes(ByteString value)Optional. The previous PredictResponse.next_page_token.
string page_token = 8 [(.google.api.field_behavior) = OPTIONAL];
| Name | Description |
| value | ByteStringThe bytes for pageToken to set. |
| Type | Description |
| PredictRequest.Builder | This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public PredictRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Name | Description |
| field | FieldDescriptor |
| index | int |
| value | Object |
| Type | Description |
| PredictRequest.Builder |
setUnknownFields(UnknownFieldSet unknownFields)
public final PredictRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)| Name | Description |
| unknownFields | UnknownFieldSet |
| Type | Description |
| PredictRequest.Builder |
setUserEvent(UserEvent value)
public PredictRequest.Builder setUserEvent(UserEvent value)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.recommendationengine.v1beta1.UserEvent user_event = 2 [(.google.api.field_behavior) = REQUIRED];
| Name | Description |
| value | UserEvent |
| Type | Description |
| PredictRequest.Builder |
setUserEvent(UserEvent.Builder builderForValue)
public PredictRequest.Builder setUserEvent(UserEvent.Builder builderForValue)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.recommendationengine.v1beta1.UserEvent user_event = 2 [(.google.api.field_behavior) = REQUIRED];
| Name | Description |
| builderForValue | UserEvent.Builder |
| Type | Description |
| PredictRequest.Builder |