public final class PredictRequest extends GeneratedMessageV3 implements PredictRequestOrBuilder
Request message for Predict method.
Protobuf type google.cloud.retail.v2beta.PredictRequest
Static Fields
FILTER_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER
Field Value
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
Field Value
PAGE_SIZE_FIELD_NUMBER
public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
PAGE_TOKEN_FIELD_NUMBER
public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
PARAMS_FIELD_NUMBER
public static final int PARAMS_FIELD_NUMBER
Field Value
PLACEMENT_FIELD_NUMBER
public static final int PLACEMENT_FIELD_NUMBER
Field Value
USER_EVENT_FIELD_NUMBER
public static final int USER_EVENT_FIELD_NUMBER
Field Value
VALIDATE_ONLY_FIELD_NUMBER
public static final int VALIDATE_ONLY_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static PredictRequest getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static PredictRequest.Builder newBuilder()
Returns
newBuilder(PredictRequest prototype)
public static PredictRequest.Builder newBuilder(PredictRequest prototype)
Parameter
Returns
public static PredictRequest parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static PredictRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static PredictRequest parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static PredictRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static PredictRequest parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static PredictRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static PredictRequest parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static PredictRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static PredictRequest parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static PredictRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static PredictRequest parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static PredictRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<PredictRequest> parser()
Returns
Methods
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;
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 an product being clicked/purchased
given the user's context and history.strictFiltering: Boolean. True by default. If set to false, the service
will return generic (unfiltered) popular products instead of empty if
your filter blocks all prediction results.priceRerankLevel: String. Default empty. If set to be non-empty, then
it needs to be one of {'no-price-reranking', 'low-price-reranking',
'medium-price-reranking', 'high-price-reranking'}. This gives
request-level control and adjusts prediction results based on product
price.diversityLevel: String. Default empty. If set to be non-empty, then
it needs to be one of {'no-diversity', 'low-diversity',
'medium-diversity', 'high-diversity', 'auto-diversity'}. This gives
request-level control and adjusts prediction results based on product
category.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;
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getDefaultInstanceForType()
public PredictRequest getDefaultInstanceForType()
Returns
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 generic
(unfiltered) popular products. If you only want results strictly matching
the filters, set
strictFiltering to True in PredictRequest.params to
receive empty results instead.
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"))
string filter = 5;
| 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 generic
(unfiltered) popular products. If you only want results strictly matching
the filters, set
strictFiltering to True in PredictRequest.params to
receive empty results instead.
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"))
string filter = 5;
getLabels()
public Map<String,String> getLabels()
Returns
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;
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;
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;
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;
getPageSize()
Maximum number of results to return per page. Set this property
to the number of prediction results needed. If zero, the service will
choose a reasonable default. The maximum allowed value is 100. Values
above 100 will be coerced to 100.
int32 page_size = 3;
| Type | Description |
| int | The pageSize.
|
getPageToken()
public String getPageToken()
This field is not used for now; leave it unset.
string page_token = 4;
| Type | Description |
| String | The pageToken.
|
getPageTokenBytes()
public ByteString getPageTokenBytes()
This field is not used for now; leave it unset.
string page_token = 4;
getParams()
public Map<String,Value> getParams()
Returns
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 an product being clicked/purchased
given the user's context and history.strictFiltering: Boolean. True by default. If set to false, the service
will return generic (unfiltered) popular products instead of empty if
your filter blocks all prediction results.priceRerankLevel: String. Default empty. If set to be non-empty, then
it needs to be one of {'no-price-reranking', 'low-price-reranking',
'medium-price-reranking', 'high-price-reranking'}. This gives
request-level control and adjusts prediction results based on product
price.diversityLevel: String. Default empty. If set to be non-empty, then
it needs to be one of {'no-diversity', 'low-diversity',
'medium-diversity', 'high-diversity', 'auto-diversity'}. This gives
request-level control and adjusts prediction results based on product
category.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;
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 an product being clicked/purchased
given the user's context and history.strictFiltering: Boolean. True by default. If set to false, the service
will return generic (unfiltered) popular products instead of empty if
your filter blocks all prediction results.priceRerankLevel: String. Default empty. If set to be non-empty, then
it needs to be one of {'no-price-reranking', 'low-price-reranking',
'medium-price-reranking', 'high-price-reranking'}. This gives
request-level control and adjusts prediction results based on product
price.diversityLevel: String. Default empty. If set to be non-empty, then
it needs to be one of {'no-diversity', 'low-diversity',
'medium-diversity', 'high-diversity', 'auto-diversity'}. This gives
request-level control and adjusts prediction results based on product
category.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;
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 an product being clicked/purchased
given the user's context and history.strictFiltering: Boolean. True by default. If set to false, the service
will return generic (unfiltered) popular products instead of empty if
your filter blocks all prediction results.priceRerankLevel: String. Default empty. If set to be non-empty, then
it needs to be one of {'no-price-reranking', 'low-price-reranking',
'medium-price-reranking', 'high-price-reranking'}. This gives
request-level control and adjusts prediction results based on product
price.diversityLevel: String. Default empty. If set to be non-empty, then
it needs to be one of {'no-diversity', 'low-diversity',
'medium-diversity', 'high-diversity', 'auto-diversity'}. This gives
request-level control and adjusts prediction results based on product
category.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;
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 an product being clicked/purchased
given the user's context and history.strictFiltering: Boolean. True by default. If set to false, the service
will return generic (unfiltered) popular products instead of empty if
your filter blocks all prediction results.priceRerankLevel: String. Default empty. If set to be non-empty, then
it needs to be one of {'no-price-reranking', 'low-price-reranking',
'medium-price-reranking', 'high-price-reranking'}. This gives
request-level control and adjusts prediction results based on product
price.diversityLevel: String. Default empty. If set to be non-empty, then
it needs to be one of {'no-diversity', 'low-diversity',
'medium-diversity', 'high-diversity', 'auto-diversity'}. This gives
request-level control and adjusts prediction results based on product
category.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;
getParserForType()
public Parser<PredictRequest> getParserForType()
Returns
Overrides
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
Managing serving configurations.
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];
| 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
Managing serving configurations.
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];
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
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.v2beta.UserEvent user_event = 2 [(.google.api.field_behavior) = REQUIRED];
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.v2beta.UserEvent user_event = 2 [(.google.api.field_behavior) = REQUIRED];
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;
| 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.v2beta.UserEvent user_event = 2 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
| boolean | Whether the userEvent field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
Parameter
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public PredictRequest.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected PredictRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public PredictRequest.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
