Class PredictRequest.Builder (2.49.0)

public static final class PredictRequest.Builder extends GeneratedMessageV3.Builder<PredictRequest.Builder> implements PredictRequestOrBuilder

Request message for Predict method.

Protobuf type google.cloud.retail.v2.PredictRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public PredictRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
PredictRequest.Builder
Overrides

build()

public PredictRequest build()
Returns
Type Description
PredictRequest

buildPartial()

public PredictRequest buildPartial()
Returns
Type Description
PredictRequest

clear()

public PredictRequest.Builder clear()
Returns
Type Description
PredictRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public PredictRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
PredictRequest.Builder
Overrides

clearFilter()

public PredictRequest.Builder clearFilter()

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.

    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, the API will return no results. If instead you want empty result sets to return generic (unfiltered) popular products, set strictFiltering to False in PredictRequest.params. Note that the API will never return items with storageStatus of "EXPIRED" or "DELETED" regardless of filter choices.

    If filterSyntaxV2 is set to true under the params field, then attribute-based expressions are expected instead of the above described tag-based syntax. Examples:

  • (colors: ANY("Red", "Blue")) AND NOT (categories: ANY("Phones"))

  • (availability: ANY("IN_STOCK")) AND (colors: ANY("Red") OR categories: ANY("Phones"))

    For more information, see Filter recommendations.

string filter = 5;

Returns
Type Description
PredictRequest.Builder

This builder for chaining.

clearLabels()

public PredictRequest.Builder clearLabels()
Returns
Type Description
PredictRequest.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public PredictRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
PredictRequest.Builder
Overrides

clearPageSize()

public PredictRequest.Builder clearPageSize()

Maximum number of results to return. 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.

int32 page_size = 3;

Returns
Type Description
PredictRequest.Builder

This builder for chaining.

clearPageToken() (deprecated)

public PredictRequest.Builder clearPageToken()

Deprecated. google.cloud.retail.v2.PredictRequest.page_token is deprecated. See google/cloud/retail/v2/prediction_service.proto;l=94

This field is not used; leave it unset.

string page_token = 4 [deprecated = true];

Returns
Type Description
PredictRequest.Builder

This builder for chaining.

clearParams()

public PredictRequest.Builder clearParams()
Returns
Type Description
PredictRequest.Builder

clearPlacement()

public PredictRequest.Builder clearPlacement()

Required. Full resource name of the format: {placement=projects/*/locations/global/catalogs/default_catalog/servingConfigs/*} or {placement=projects/*/locations/global/catalogs/default_catalog/placements/*}. We recommend using the servingConfigs resource. placements is a legacy resource. The ID of the Recommendations AI serving config or placement. Before you can request predictions from your model, you must create at least one serving config or placement for it. For more information, see Manage serving configs.

The full list of available serving configs can be seen at https://console.cloud.google.com/ai/retail/catalogs/default_catalog/configs

string placement = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
PredictRequest.Builder

This builder for chaining.

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.

Don't set UserEvent.visitor_id or UserInfo.user_id to the same fixed ID for different users. If you are trying to receive non-personalized recommendations (not recommended; this can negatively impact model performance), instead set UserEvent.visitor_id to a random unique ID and leave UserInfo.user_id unset.

.google.cloud.retail.v2.UserEvent user_event = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
PredictRequest.Builder

clearValidateOnly()

public PredictRequest.Builder clearValidateOnly()

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.

bool validate_only = 6;

Returns
Type Description
PredictRequest.Builder

This builder for chaining.

clone()

public PredictRequest.Builder clone()
Returns
Type Description
PredictRequest.Builder
Overrides

containsLabels(String key)

public boolean containsLabels(String key)

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.

map<string, string> labels = 8;

Parameter
Name Description
key String
Returns
Type Description
boolean

containsParams(String key)

public boolean containsParams(String key)

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 a 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.
  • filterSyntaxV2: Boolean. False by default. If set to true, the filter field is interpreteted according to the new, attribute-based syntax.

map<string, .google.protobuf.Value> params = 7;

Parameter
Name Description
key String
Returns
Type Description
boolean

getDefaultInstanceForType()

public PredictRequest getDefaultInstanceForType()
Returns
Type Description
PredictRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getFilter()

public String getFilter()

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.

    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, the API will return no results. If instead you want empty result sets to return generic (unfiltered) popular products, set strictFiltering to False in PredictRequest.params. Note that the API will never return items with storageStatus of "EXPIRED" or "DELETED" regardless of filter choices.

    If filterSyntaxV2 is set to true under the params field, then attribute-based expressions are expected instead of the above described tag-based syntax. Examples:

  • (colors: ANY("Red", "Blue")) AND NOT (categories: ANY("Phones"))

  • (availability: ANY("IN_STOCK")) AND (colors: ANY("Red") OR categories: ANY("Phones"))

    For more information, see Filter recommendations.

string filter = 5;

Returns
Type Description
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

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.

    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, the API will return no results. If instead you want empty result sets to return generic (unfiltered) popular products, set strictFiltering to False in PredictRequest.params. Note that the API will never return items with storageStatus of "EXPIRED" or "DELETED" regardless of filter choices.

    If filterSyntaxV2 is set to true under the params field, then attribute-based expressions are expected instead of the above described tag-based syntax. Examples:

  • (colors: ANY("Red", "Blue")) AND NOT (categories: ANY("Phones"))

  • (availability: ANY("IN_STOCK")) AND (colors: ANY("Red") OR categories: ANY("Phones"))

    For more information, see Filter recommendations.

string filter = 5;

Returns
Type Description
ByteString

The bytes for filter.

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

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.

map<string, string> labels = 8;

Returns
Type Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

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.

map<string, string> labels = 8;

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

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.

map<string, string> labels = 8;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

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.

map<string, string> labels = 8;

Parameter
Name Description
key String
Returns
Type Description
String

getMutableLabels() (deprecated)

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getMutableParams() (deprecated)

public Map<String,Value> getMutableParams()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,Value>

getPageSize()

public int getPageSize()

Maximum number of results to return. 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.

int32 page_size = 3;

Returns
Type Description
int

The pageSize.

getPageToken() (deprecated)

public String getPageToken()

Deprecated. google.cloud.retail.v2.PredictRequest.page_token is deprecated. See google/cloud/retail/v2/prediction_service.proto;l=94

This field is not used; leave it unset.

string page_token = 4 [deprecated = true];

Returns
Type Description
String

The pageToken.

getPageTokenBytes() (deprecated)

public ByteString getPageTokenBytes()

Deprecated. google.cloud.retail.v2.PredictRequest.page_token is deprecated. See google/cloud/retail/v2/prediction_service.proto;l=94

This field is not used; leave it unset.

string page_token = 4 [deprecated = true];

Returns
Type Description
ByteString

The bytes for pageToken.

getParams() (deprecated)

public Map<String,Value> getParams()

Use #getParamsMap() instead.

Returns
Type Description
Map<String,Value>

getParamsCount()

public int getParamsCount()

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 a 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.
  • filterSyntaxV2: Boolean. False by default. If set to true, the filter field is interpreteted according to the new, attribute-based syntax.

map<string, .google.protobuf.Value> params = 7;

Returns
Type Description
int

getParamsMap()

public Map<String,Value> getParamsMap()

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 a 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.
  • filterSyntaxV2: Boolean. False by default. If set to true, the filter field is interpreteted according to the new, attribute-based syntax.

map<string, .google.protobuf.Value> params = 7;

Returns
Type Description
Map<String,Value>

getParamsOrDefault(String key, Value defaultValue)

public Value getParamsOrDefault(String key, Value defaultValue)

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 a 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.
  • filterSyntaxV2: Boolean. False by default. If set to true, the filter field is interpreteted according to the new, attribute-based syntax.

map<string, .google.protobuf.Value> params = 7;

Parameters
Name Description
key String
defaultValue Value
Returns
Type Description
Value

getParamsOrThrow(String key)

public Value getParamsOrThrow(String key)

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 a 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.
  • filterSyntaxV2: Boolean. False by default. If set to true, the filter field is interpreteted according to the new, attribute-based syntax.

map<string, .google.protobuf.Value> params = 7;

Parameter
Name Description
key String
Returns
Type Description
Value

getPlacement()

public String getPlacement()

Required. Full resource name of the format: {placement=projects/*/locations/global/catalogs/default_catalog/servingConfigs/*} or {placement=projects/*/locations/global/catalogs/default_catalog/placements/*}. We recommend using the servingConfigs resource. placements is a legacy resource. The ID of the Recommendations AI serving config or placement. Before you can request predictions from your model, you must create at least one serving config or placement for it. For more information, see Manage serving configs.

The full list of available serving configs can be seen at https://console.cloud.google.com/ai/retail/catalogs/default_catalog/configs

string placement = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The placement.

getPlacementBytes()

public ByteString getPlacementBytes()

Required. Full resource name of the format: {placement=projects/*/locations/global/catalogs/default_catalog/servingConfigs/*} or {placement=projects/*/locations/global/catalogs/default_catalog/placements/*}. We recommend using the servingConfigs resource. placements is a legacy resource. The ID of the Recommendations AI serving config or placement. Before you can request predictions from your model, you must create at least one serving config or placement for it. For more information, see Manage serving configs.

The full list of available serving configs can be seen at https://console.cloud.google.com/ai/retail/catalogs/default_catalog/configs

string placement = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for placement.

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.

Don't set UserEvent.visitor_id or UserInfo.user_id to the same fixed ID for different users. If you are trying to receive non-personalized recommendations (not recommended; this can negatively impact model performance), instead set UserEvent.visitor_id to a random unique ID and leave UserInfo.user_id unset.

.google.cloud.retail.v2.UserEvent user_event = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
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.

Don't set UserEvent.visitor_id or UserInfo.user_id to the same fixed ID for different users. If you are trying to receive non-personalized recommendations (not recommended; this can negatively impact model performance), instead set UserEvent.visitor_id to a random unique ID and leave UserInfo.user_id unset.

.google.cloud.retail.v2.UserEvent user_event = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
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.

Don't set UserEvent.visitor_id or UserInfo.user_id to the same fixed ID for different users. If you are trying to receive non-personalized recommendations (not recommended; this can negatively impact model performance), instead set UserEvent.visitor_id to a random unique ID and leave UserInfo.user_id unset.

.google.cloud.retail.v2.UserEvent user_event = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
UserEventOrBuilder

getValidateOnly()

public boolean getValidateOnly()

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.

bool validate_only = 6;

Returns
Type Description
boolean

The validateOnly.

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.

Don't set UserEvent.visitor_id or UserInfo.user_id to the same fixed ID for different users. If you are trying to receive non-personalized recommendations (not recommended; this can negatively impact model performance), instead set UserEvent.visitor_id to a random unique ID and leave UserInfo.user_id unset.

.google.cloud.retail.v2.UserEvent user_event = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the userEvent field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(PredictRequest other)

public PredictRequest.Builder mergeFrom(PredictRequest other)
Parameter
Name Description
other PredictRequest
Returns
Type Description
PredictRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public PredictRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PredictRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public PredictRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
PredictRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final PredictRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
PredictRequest.Builder
Overrides

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.

Don't set UserEvent.visitor_id or UserInfo.user_id to the same fixed ID for different users. If you are trying to receive non-personalized recommendations (not recommended; this can negatively impact model performance), instead set UserEvent.visitor_id to a random unique ID and leave UserInfo.user_id unset.

.google.cloud.retail.v2.UserEvent user_event = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value UserEvent
Returns
Type Description
PredictRequest.Builder

putAllLabels(Map<String,String> values)

public PredictRequest.Builder putAllLabels(Map<String,String> values)

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.

map<string, string> labels = 8;

Parameter
Name Description
values Map<String,String>
Returns
Type Description
PredictRequest.Builder

putAllParams(Map<String,Value> values)

public PredictRequest.Builder putAllParams(Map<String,Value> values)

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 a 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.
  • filterSyntaxV2: Boolean. False by default. If set to true, the filter field is interpreteted according to the new, attribute-based syntax.

map<string, .google.protobuf.Value> params = 7;

Parameter
Name Description
values Map<String,Value>
Returns
Type Description
PredictRequest.Builder

putLabels(String key, String value)

public PredictRequest.Builder putLabels(String key, String value)

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.

map<string, string> labels = 8;

Parameters
Name Description
key String
value String
Returns
Type Description
PredictRequest.Builder

putParams(String key, Value value)

public PredictRequest.Builder putParams(String key, Value 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 a 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.
  • filterSyntaxV2: Boolean. False by default. If set to true, the filter field is interpreteted according to the new, attribute-based syntax.

map<string, .google.protobuf.Value> params = 7;

Parameters
Name Description
key String
value Value
Returns
Type Description
PredictRequest.Builder

putParamsBuilderIfAbsent(String key)

public Value.Builder putParamsBuilderIfAbsent(String key)

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 a 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.
  • filterSyntaxV2: Boolean. False by default. If set to true, the filter field is interpreteted according to the new, attribute-based syntax.

map<string, .google.protobuf.Value> params = 7;

Parameter
Name Description
key String
Returns
Type Description
Builder

removeLabels(String key)

public PredictRequest.Builder removeLabels(String key)

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.

map<string, string> labels = 8;

Parameter
Name Description
key String
Returns
Type Description
PredictRequest.Builder

removeParams(String key)

public PredictRequest.Builder removeParams(String key)

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 a 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.
  • filterSyntaxV2: Boolean. False by default. If set to true, the filter field is interpreteted according to the new, attribute-based syntax.

map<string, .google.protobuf.Value> params = 7;

Parameter
Name Description
key String
Returns
Type Description
PredictRequest.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public PredictRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
PredictRequest.Builder
Overrides

setFilter(String value)

public PredictRequest.Builder setFilter(String value)

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.

    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, the API will return no results. If instead you want empty result sets to return generic (unfiltered) popular products, set strictFiltering to False in PredictRequest.params. Note that the API will never return items with storageStatus of "EXPIRED" or "DELETED" regardless of filter choices.

    If filterSyntaxV2 is set to true under the params field, then attribute-based expressions are expected instead of the above described tag-based syntax. Examples:

  • (colors: ANY("Red", "Blue")) AND NOT (categories: ANY("Phones"))

  • (availability: ANY("IN_STOCK")) AND (colors: ANY("Red") OR categories: ANY("Phones"))

    For more information, see Filter recommendations.

string filter = 5;

Parameter
Name Description
value String

The filter to set.

Returns
Type Description
PredictRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public PredictRequest.Builder setFilterBytes(ByteString value)

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.

    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, the API will return no results. If instead you want empty result sets to return generic (unfiltered) popular products, set strictFiltering to False in PredictRequest.params. Note that the API will never return items with storageStatus of "EXPIRED" or "DELETED" regardless of filter choices.

    If filterSyntaxV2 is set to true under the params field, then attribute-based expressions are expected instead of the above described tag-based syntax. Examples:

  • (colors: ANY("Red", "Blue")) AND NOT (categories: ANY("Phones"))

  • (availability: ANY("IN_STOCK")) AND (colors: ANY("Red") OR categories: ANY("Phones"))

    For more information, see Filter recommendations.

string filter = 5;

Parameter
Name Description
value ByteString

The bytes for filter to set.

Returns
Type Description
PredictRequest.Builder

This builder for chaining.

setPageSize(int value)

public PredictRequest.Builder setPageSize(int value)

Maximum number of results to return. 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.

int32 page_size = 3;

Parameter
Name Description
value int

The pageSize to set.

Returns
Type Description
PredictRequest.Builder

This builder for chaining.

setPageToken(String value) (deprecated)

public PredictRequest.Builder setPageToken(String value)

Deprecated. google.cloud.retail.v2.PredictRequest.page_token is deprecated. See google/cloud/retail/v2/prediction_service.proto;l=94

This field is not used; leave it unset.

string page_token = 4 [deprecated = true];

Parameter
Name Description
value String

The pageToken to set.

Returns
Type Description
PredictRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value) (deprecated)

public PredictRequest.Builder setPageTokenBytes(ByteString value)

Deprecated. google.cloud.retail.v2.PredictRequest.page_token is deprecated. See google/cloud/retail/v2/prediction_service.proto;l=94

This field is not used; leave it unset.

string page_token = 4 [deprecated = true];

Parameter
Name Description
value ByteString

The bytes for pageToken to set.

Returns
Type Description
PredictRequest.Builder

This builder for chaining.

setPlacement(String value)

public PredictRequest.Builder setPlacement(String value)

Required. Full resource name of the format: {placement=projects/*/locations/global/catalogs/default_catalog/servingConfigs/*} or {placement=projects/*/locations/global/catalogs/default_catalog/placements/*}. We recommend using the servingConfigs resource. placements is a legacy resource. The ID of the Recommendations AI serving config or placement. Before you can request predictions from your model, you must create at least one serving config or placement for it. For more information, see Manage serving configs.

The full list of available serving configs can be seen at https://console.cloud.google.com/ai/retail/catalogs/default_catalog/configs

string placement = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The placement to set.

Returns
Type Description
PredictRequest.Builder

This builder for chaining.

setPlacementBytes(ByteString value)

public PredictRequest.Builder setPlacementBytes(ByteString value)

Required. Full resource name of the format: {placement=projects/*/locations/global/catalogs/default_catalog/servingConfigs/*} or {placement=projects/*/locations/global/catalogs/default_catalog/placements/*}. We recommend using the servingConfigs resource. placements is a legacy resource. The ID of the Recommendations AI serving config or placement. Before you can request predictions from your model, you must create at least one serving config or placement for it. For more information, see Manage serving configs.

The full list of available serving configs can be seen at https://console.cloud.google.com/ai/retail/catalogs/default_catalog/configs

string placement = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for placement to set.

Returns
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)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
PredictRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final PredictRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
PredictRequest.Builder
Overrides

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.

Don't set UserEvent.visitor_id or UserInfo.user_id to the same fixed ID for different users. If you are trying to receive non-personalized recommendations (not recommended; this can negatively impact model performance), instead set UserEvent.visitor_id to a random unique ID and leave UserInfo.user_id unset.

.google.cloud.retail.v2.UserEvent user_event = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value UserEvent
Returns
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.

Don't set UserEvent.visitor_id or UserInfo.user_id to the same fixed ID for different users. If you are trying to receive non-personalized recommendations (not recommended; this can negatively impact model performance), instead set UserEvent.visitor_id to a random unique ID and leave UserInfo.user_id unset.

.google.cloud.retail.v2.UserEvent user_event = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
builderForValue UserEvent.Builder
Returns
Type Description
PredictRequest.Builder

setValidateOnly(boolean value)

public PredictRequest.Builder setValidateOnly(boolean value)

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.

bool validate_only = 6;

Parameter
Name Description
value boolean

The validateOnly to set.

Returns
Type Description
PredictRequest.Builder

This builder for chaining.