java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessage

com.google.cloud.retail.v2alpha.PredictRequest

All Implemented Interfaces:: PredictRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

@Generated public final class PredictRequest extends com.google.protobuf.GeneratedMessage implements PredictRequestOrBuilder

 Request message for Predict method.

Protobuf type google.cloud.retail.v2alpha.PredictRequest

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

static final class

PredictRequest.Builder

Request message for Predict method.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage
com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage
com.google.protobuf.AbstractMessage.BuilderParent

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum
Field Summary

Fields

Modifier and Type

Field

Description

static final int

FILTER_FIELD_NUMBER

static final int

LABELS_FIELD_NUMBER

static final int

PAGE_SIZE_FIELD_NUMBER

static final int

PAGE_TOKEN_FIELD_NUMBER

static final int

PARAMS_FIELD_NUMBER

static final int

PLACEMENT_FIELD_NUMBER

static final int

USER_EVENT_FIELD_NUMBER

static final int

VALIDATE_ONLY_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode
Method Summary

Modifier and Type

Method

Description

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

boolean

containsParams(String key)

Additional domain specific parameters for the predictions.

boolean

equals(Object obj)

static PredictRequest

getDefaultInstance()

PredictRequest

getDefaultInstanceForType()

static final com.google.protobuf.Descriptors.Descriptor

getDescriptor()

String

getFilter()

Filter for restricting prediction results with a length limit of 5,000 characters.

com.google.protobuf.ByteString

getFilterBytes()

Filter for restricting prediction results with a length limit of 5,000 characters.

Map<String,String>

getLabels()

Deprecated.

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

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

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

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

int

getPageSize()

Maximum number of results to return.

String

getPageToken()

Deprecated.
google.cloud.retail.v2alpha.PredictRequest.page_token is deprecated.

com.google.protobuf.ByteString

getPageTokenBytes()

Deprecated.
google.cloud.retail.v2alpha.PredictRequest.page_token is deprecated.

Map<String,com.google.protobuf.Value>

getParams()

Deprecated.

int

getParamsCount()

Additional domain specific parameters for the predictions.

Map<String,com.google.protobuf.Value>

getParamsMap()

Additional domain specific parameters for the predictions.

com.google.protobuf.Value

getParamsOrDefault(String key, com.google.protobuf.Value defaultValue)

Additional domain specific parameters for the predictions.

com.google.protobuf.Value

getParamsOrThrow(String key)

Additional domain specific parameters for the predictions.

com.google.protobuf.Parser<PredictRequest>

getParserForType()

String

getPlacement()

Required.

com.google.protobuf.ByteString

getPlacementBytes()

Required.

int

getSerializedSize()

UserEvent

getUserEvent()

Required.

UserEventOrBuilder

getUserEventOrBuilder()

Required.

boolean

getValidateOnly()

Use validate only mode for this prediction query.

int

hashCode()

boolean

hasUserEvent()

Required.

protected com.google.protobuf.GeneratedMessage.FieldAccessorTable

internalGetFieldAccessorTable()

protected com.google.protobuf.MapFieldReflectionAccessor

internalGetMapFieldReflection(int number)

final boolean

isInitialized()

static PredictRequest.Builder

newBuilder()

static PredictRequest.Builder

newBuilder(PredictRequest prototype)

PredictRequest.Builder

newBuilderForType()

protected PredictRequest.Builder

newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)

static PredictRequest

parseDelimitedFrom(InputStream input)

static PredictRequest

parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)

static PredictRequest

parseFrom(byte[] data)

static PredictRequest

parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)

static PredictRequest

parseFrom(com.google.protobuf.ByteString data)

static PredictRequest

parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)

static PredictRequest

parseFrom(com.google.protobuf.CodedInputStream input)

static PredictRequest

parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)

static PredictRequest

parseFrom(InputStream input)

static PredictRequest

parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)

static PredictRequest

parseFrom(ByteBuffer data)

static PredictRequest

parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)

static com.google.protobuf.Parser<PredictRequest>

parser()

PredictRequest.Builder

toBuilder()

void

writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessage
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashFields, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Field Details
- PLACEMENT_FIELD_NUMBER
  
  public static final int PLACEMENT_FIELD_NUMBER
  See Also:
  
  Constant Field Values
- USER_EVENT_FIELD_NUMBER
  
  public static final int USER_EVENT_FIELD_NUMBER
  See Also:
  
  Constant Field Values
- PAGE_SIZE_FIELD_NUMBER
  
  public static final int PAGE_SIZE_FIELD_NUMBER
  See Also:
  
  Constant Field Values
- PAGE_TOKEN_FIELD_NUMBER
  
  public static final int PAGE_TOKEN_FIELD_NUMBER
  See Also:
  
  Constant Field Values
- FILTER_FIELD_NUMBER
  
  public static final int FILTER_FIELD_NUMBER
  See Also:
  
  Constant Field Values
- VALIDATE_ONLY_FIELD_NUMBER
  
  public static final int VALIDATE_ONLY_FIELD_NUMBER
  See Also:
  
  Constant Field Values
- PARAMS_FIELD_NUMBER
  
  public static final int PARAMS_FIELD_NUMBER
  See Also:
  
  Constant Field Values
- LABELS_FIELD_NUMBER
  
  public static final int LABELS_FIELD_NUMBER
  See Also:
  
  Constant Field Values

Method Details

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
internalGetMapFieldReflection

protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)

Overrides:

internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage
internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

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]
 (https://cloud.google.com/retail/docs/manage-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];

Specified by:: getPlacement in interface PredictRequestOrBuilder
Returns:: The placement.

getPlacementBytes

public com.google.protobuf.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]
 (https://cloud.google.com/retail/docs/manage-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];

Specified by:: getPlacementBytes in interface PredictRequestOrBuilder
Returns:: The bytes for placement.

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][google.cloud.retail.v2alpha.UserEvent.visitor_id] or
 [UserInfo.user_id][google.cloud.retail.v2alpha.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][google.cloud.retail.v2alpha.UserEvent.visitor_id] to
 a random unique ID and leave
 [UserInfo.user_id][google.cloud.retail.v2alpha.UserInfo.user_id] unset.


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

Specified by:: hasUserEvent in interface PredictRequestOrBuilder
Returns:: Whether the userEvent field is set.

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][google.cloud.retail.v2alpha.UserEvent.visitor_id] or
 [UserInfo.user_id][google.cloud.retail.v2alpha.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][google.cloud.retail.v2alpha.UserEvent.visitor_id] to
 a random unique ID and leave
 [UserInfo.user_id][google.cloud.retail.v2alpha.UserInfo.user_id] unset.


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

Specified by:: getUserEvent in interface PredictRequestOrBuilder
Returns:: The userEvent.

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][google.cloud.retail.v2alpha.UserEvent.visitor_id] or
 [UserInfo.user_id][google.cloud.retail.v2alpha.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][google.cloud.retail.v2alpha.UserEvent.visitor_id] to
 a random unique ID and leave
 [UserInfo.user_id][google.cloud.retail.v2alpha.UserInfo.user_id] unset.


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

Specified by:: getUserEventOrBuilder in interface PredictRequestOrBuilder

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;

Specified by:: getPageSize in interface PredictRequestOrBuilder
Returns:: The pageSize.

getPageToken

@Deprecated public String getPageToken()

Deprecated.
google.cloud.retail.v2alpha.PredictRequest.page_token is deprecated. See google/cloud/retail/v2alpha/prediction_service.proto;l=94
```
 This field is not used; leave it unset.
 
```
string page_token = 4 [deprecated = true];
Specified by:

getPageToken in interface PredictRequestOrBuilder

Returns:

The pageToken.
getPageTokenBytes

@Deprecated public com.google.protobuf.ByteString getPageTokenBytes()

Deprecated.
google.cloud.retail.v2alpha.PredictRequest.page_token is deprecated. See google/cloud/retail/v2alpha/prediction_service.proto;l=94
```
 This field is not used; leave it unset.
 
```
string page_token = 4 [deprecated = true];
Specified by:

getPageTokenBytes in interface PredictRequestOrBuilder

Returns:

The bytes for pageToken.

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](https://cloud.google.com/retail/docs/filter-recs).

string filter = 5;

Specified by:: getFilter in interface PredictRequestOrBuilder
Returns:: The filter.

getFilterBytes

public com.google.protobuf.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](https://cloud.google.com/retail/docs/filter-recs).

string filter = 5;

Specified by:: getFilterBytes in interface PredictRequestOrBuilder
Returns:: The bytes for filter.

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;

Specified by:: getValidateOnly in interface PredictRequestOrBuilder
Returns:: The validateOnly.

getParamsCount

public int getParamsCount()

Description copied from interface: PredictRequestOrBuilder

 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;

Specified by:: getParamsCount in interface PredictRequestOrBuilder

containsParams

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;

Specified by:: containsParams in interface PredictRequestOrBuilder

getParams

@Deprecated public Map<String,com.google.protobuf.Value> getParams()

Deprecated.

Use getParamsMap() instead.

Specified by:

getParams in interface PredictRequestOrBuilder

getParamsMap

public Map<String,com.google.protobuf.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;

Specified by:: getParamsMap in interface PredictRequestOrBuilder

getParamsOrDefault

public com.google.protobuf.Value getParamsOrDefault(String key, com.google.protobuf.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;

Specified by:: getParamsOrDefault in interface PredictRequestOrBuilder

getParamsOrThrow

public com.google.protobuf.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;

Specified by:: getParamsOrThrow in interface PredictRequestOrBuilder