com.google.cloud.discoveryengine.v1beta

Class RecommendRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.discoveryengine.v1beta.RecommendRequest

All Implemented Interfaces:

RecommendRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class RecommendRequest
extends com.google.protobuf.GeneratedMessageV3
implements RecommendRequestOrBuilder

 Request message for Recommend method.
 

Protobuf type google.cloud.discoveryengine.v1beta.RecommendRequest

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RecommendRequest.Builder Request message for Recommend method.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

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

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	FILTER_FIELD_NUMBER
static int	PAGE_SIZE_FIELD_NUMBER
static int	PARAMS_FIELD_NUMBER
static int	SERVING_CONFIG_FIELD_NUMBER
static int	USER_EVENT_FIELD_NUMBER
static int	USER_LABELS_FIELD_NUMBER
static int	VALIDATE_ONLY_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, 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 and Description
boolean	containsParams(String key) Additional domain specific parameters for the recommendations.
boolean	containsUserLabels(String key) The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64
boolean	equals(Object obj)
static RecommendRequest	getDefaultInstance()
RecommendRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getFilter() Filter for restricting recommendation results with a length limit of 5,000 characters.
com.google.protobuf.ByteString	getFilterBytes() Filter for restricting recommendation results with a length limit of 5,000 characters.
int	getPageSize() Maximum number of results to return.
Map<String,com.google.protobuf.Value>	getParams() Deprecated.
int	getParamsCount() Additional domain specific parameters for the recommendations.
Map<String,com.google.protobuf.Value>	getParamsMap() Additional domain specific parameters for the recommendations.
com.google.protobuf.Value	getParamsOrDefault(String key, com.google.protobuf.Value defaultValue) Additional domain specific parameters for the recommendations.
com.google.protobuf.Value	getParamsOrThrow(String key) Additional domain specific parameters for the recommendations.
com.google.protobuf.Parser<RecommendRequest>	getParserForType()
int	getSerializedSize()
String	getServingConfig() Required.
com.google.protobuf.ByteString	getServingConfigBytes() Required.
UserEvent	getUserEvent() Required.
UserEventOrBuilder	getUserEventOrBuilder() Required.
Map<String,String>	getUserLabels() Deprecated.
int	getUserLabelsCount() The user 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>	getUserLabelsMap() The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64
String	getUserLabelsOrDefault(String key, String defaultValue) The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64
String	getUserLabelsOrThrow(String key) The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64
boolean	getValidateOnly() Use validate only mode for this recommendation query.
int	hashCode()
boolean	hasUserEvent() Required.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
protected com.google.protobuf.MapFieldReflectionAccessor	internalGetMapFieldReflection(int number)
boolean	isInitialized()
static RecommendRequest.Builder	newBuilder()
static RecommendRequest.Builder	newBuilder(RecommendRequest prototype)
RecommendRequest.Builder	newBuilderForType()
protected RecommendRequest.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static RecommendRequest	parseDelimitedFrom(InputStream input)
static RecommendRequest	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RecommendRequest	parseFrom(byte[] data)
static RecommendRequest	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RecommendRequest	parseFrom(ByteBuffer data)
static RecommendRequest	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RecommendRequest	parseFrom(com.google.protobuf.ByteString data)
static RecommendRequest	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RecommendRequest	parseFrom(com.google.protobuf.CodedInputStream input)
static RecommendRequest	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RecommendRequest	parseFrom(InputStream input)
static RecommendRequest	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<RecommendRequest>	parser()
RecommendRequest.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, 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, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, 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.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

SERVING_CONFIG_FIELD_NUMBER

public static final int SERVING_CONFIG_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

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

USER_LABELS_FIELD_NUMBER

public static final int USER_LABELS_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

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

internalGetFieldAccessorTable

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

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getServingConfig

public String getServingConfig()

 Required. Full resource name of a
 [ServingConfig][google.cloud.discoveryengine.v1beta.ServingConfig]:
 `projects/*/locations/global/collections/*/engines/*/servingConfigs/*`, or
 `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*`

 One default serving config is created along with your recommendation engine
 creation. The engine ID is used as the ID of the default serving
 config. For example, for Engine
 `projects/*/locations/global/collections/*/engines/my-engine`, you can use
 `projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-engine`
 for your
 [RecommendationService.Recommend][google.cloud.discoveryengine.v1beta.RecommendationService.Recommend]
 requests.
 

string serving_config = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Specified by:

getServingConfig in interface RecommendRequestOrBuilder

Returns:

The servingConfig.

getServingConfigBytes

public com.google.protobuf.ByteString getServingConfigBytes()

 Required. Full resource name of a
 [ServingConfig][google.cloud.discoveryengine.v1beta.ServingConfig]:
 `projects/*/locations/global/collections/*/engines/*/servingConfigs/*`, or
 `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*`

 One default serving config is created along with your recommendation engine
 creation. The engine ID is used as the ID of the default serving
 config. For example, for Engine
 `projects/*/locations/global/collections/*/engines/my-engine`, you can use
 `projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-engine`
 for your
 [RecommendationService.Recommend][google.cloud.discoveryengine.v1beta.RecommendationService.Recommend]
 requests.
 

string serving_config = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Specified by:

getServingConfigBytes in interface RecommendRequestOrBuilder

Returns:

The bytes for servingConfig.

hasUserEvent

public boolean hasUserEvent()

 Required. Context about the user, what they are looking at and what action
 they took to trigger the Recommend 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.user_pseudo_id][google.cloud.discoveryengine.v1beta.UserEvent.user_pseudo_id]
 or
 [UserEvent.user_info.user_id][google.cloud.discoveryengine.v1beta.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.user_pseudo_id][google.cloud.discoveryengine.v1beta.UserEvent.user_pseudo_id]
 to a random unique ID and leave
 [UserEvent.user_info.user_id][google.cloud.discoveryengine.v1beta.UserInfo.user_id]
 unset.
 

.google.cloud.discoveryengine.v1beta.UserEvent user_event = 2 [(.google.api.field_behavior) = REQUIRED];

Specified by:

hasUserEvent in interface RecommendRequestOrBuilder

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 Recommend 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.user_pseudo_id][google.cloud.discoveryengine.v1beta.UserEvent.user_pseudo_id]
 or
 [UserEvent.user_info.user_id][google.cloud.discoveryengine.v1beta.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.user_pseudo_id][google.cloud.discoveryengine.v1beta.UserEvent.user_pseudo_id]
 to a random unique ID and leave
 [UserEvent.user_info.user_id][google.cloud.discoveryengine.v1beta.UserInfo.user_id]
 unset.
 

.google.cloud.discoveryengine.v1beta.UserEvent user_event = 2 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getUserEvent in interface RecommendRequestOrBuilder

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 Recommend 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.user_pseudo_id][google.cloud.discoveryengine.v1beta.UserEvent.user_pseudo_id]
 or
 [UserEvent.user_info.user_id][google.cloud.discoveryengine.v1beta.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.user_pseudo_id][google.cloud.discoveryengine.v1beta.UserEvent.user_pseudo_id]
 to a random unique ID and leave
 [UserEvent.user_info.user_id][google.cloud.discoveryengine.v1beta.UserInfo.user_id]
 unset.
 

.google.cloud.discoveryengine.v1beta.UserEvent user_event = 2 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getUserEventOrBuilder in interface RecommendRequestOrBuilder

getPageSize

public int getPageSize()

 Maximum number of results to return. Set this property
 to the number of recommendation results needed. If zero, the service
 chooses a reasonable default. The maximum allowed value is 100. Values
 above 100 are set to 100.
 

int32 page_size = 3;

Specified by:

getPageSize in interface RecommendRequestOrBuilder

Returns:

The pageSize.

getFilter

public String getFilter()

 Filter for restricting recommendation results with a length limit of 5,000
 characters. Currently, only filter expressions on the `filter_tags`
 attribute is supported.


 Examples:

  * `(filter_tags: ANY("Red", "Blue") OR filter_tags: ANY("Hot", "Cold"))`
  * `(filter_tags: ANY("Red", "Blue")) AND NOT (filter_tags: ANY("Green"))`

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

  * (launguage: ANY("en", "es")) AND NOT (categories: ANY("Movie"))
  * (available: true) AND
    (launguage: ANY("en", "es")) OR (categories: ANY("Movie"))

 If your filter blocks all results, the API returns generic
 (unfiltered) popular Documents. If you only want results strictly matching
 the filters, set `strictFiltering` to `true` in
 [RecommendRequest.params][google.cloud.discoveryengine.v1beta.RecommendRequest.params]
 to receive empty results instead.

 Note that the API never returns
 [Document][google.cloud.discoveryengine.v1beta.Document]s with
 `storageStatus` as `EXPIRED` or `DELETED` regardless of filter choices.
 

string filter = 4;

Specified by:

getFilter in interface RecommendRequestOrBuilder

Returns:

The filter.

getFilterBytes

public com.google.protobuf.ByteString getFilterBytes()

 Filter for restricting recommendation results with a length limit of 5,000
 characters. Currently, only filter expressions on the `filter_tags`
 attribute is supported.


 Examples:

  * `(filter_tags: ANY("Red", "Blue") OR filter_tags: ANY("Hot", "Cold"))`
  * `(filter_tags: ANY("Red", "Blue")) AND NOT (filter_tags: ANY("Green"))`

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

  * (launguage: ANY("en", "es")) AND NOT (categories: ANY("Movie"))
  * (available: true) AND
    (launguage: ANY("en", "es")) OR (categories: ANY("Movie"))

 If your filter blocks all results, the API returns generic
 (unfiltered) popular Documents. If you only want results strictly matching
 the filters, set `strictFiltering` to `true` in
 [RecommendRequest.params][google.cloud.discoveryengine.v1beta.RecommendRequest.params]
 to receive empty results instead.

 Note that the API never returns
 [Document][google.cloud.discoveryengine.v1beta.Document]s with
 `storageStatus` as `EXPIRED` or `DELETED` regardless of filter choices.
 

string filter = 4;

Specified by:

getFilterBytes in interface RecommendRequestOrBuilder

Returns:

The bytes for filter.

getValidateOnly

public boolean getValidateOnly()

 Use validate only mode for this recommendation query. If set to `true`, a
 fake model is used that returns arbitrary Document IDs.
 Note that the validate only mode should only be used for testing the API,
 or if the model is not ready.
 

bool validate_only = 5;

Specified by:

getValidateOnly in interface RecommendRequestOrBuilder

Returns:

The validateOnly.

getParamsCount

public int getParamsCount()

Description copied from interface: RecommendRequestOrBuilder

 Additional domain specific parameters for the recommendations.

 Allowed values:

 * `returnDocument`: Boolean. If set to `true`, the associated Document
    object is returned in
    [RecommendResponse.RecommendationResult.document][google.cloud.discoveryengine.v1beta.RecommendResponse.RecommendationResult.document].
 * `returnScore`: Boolean. If set to true, the recommendation score
    corresponding to each returned Document is set in
    [RecommendResponse.RecommendationResult.metadata][google.cloud.discoveryengine.v1beta.RecommendResponse.RecommendationResult.metadata].
    The given score indicates the probability of a Document conversion given
    the user's context and history.
 * `strictFiltering`: Boolean. True by default. If set to `false`, the
 service
    returns generic (unfiltered) popular Documents instead of empty if
    your filter blocks all recommendation results.
 * `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 recommendation results
    based on Document category.
 * `attributeFilteringSyntax`: Boolean. False by default. If set to true,
    the `filter` field is interpreted according to the new,
    attribute-based syntax.
 

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

Specified by:

getParamsCount in interface RecommendRequestOrBuilder

containsParams

public boolean containsParams(String key)

 Additional domain specific parameters for the recommendations.

 Allowed values:

 * `returnDocument`: Boolean. If set to `true`, the associated Document
    object is returned in
    [RecommendResponse.RecommendationResult.document][google.cloud.discoveryengine.v1beta.RecommendResponse.RecommendationResult.document].
 * `returnScore`: Boolean. If set to true, the recommendation score
    corresponding to each returned Document is set in
    [RecommendResponse.RecommendationResult.metadata][google.cloud.discoveryengine.v1beta.RecommendResponse.RecommendationResult.metadata].
    The given score indicates the probability of a Document conversion given
    the user's context and history.
 * `strictFiltering`: Boolean. True by default. If set to `false`, the
 service
    returns generic (unfiltered) popular Documents instead of empty if
    your filter blocks all recommendation results.
 * `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 recommendation results
    based on Document category.
 * `attributeFilteringSyntax`: Boolean. False by default. If set to true,
    the `filter` field is interpreted according to the new,
    attribute-based syntax.
 

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

Specified by:

containsParams in interface RecommendRequestOrBuilder

getParams

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

Deprecated.

Use getParamsMap() instead.

Specified by:

getParams in interface RecommendRequestOrBuilder

getParamsMap

public Map<String,com.google.protobuf.Value> getParamsMap()

 Additional domain specific parameters for the recommendations.

 Allowed values:

 * `returnDocument`: Boolean. If set to `true`, the associated Document
    object is returned in
    [RecommendResponse.RecommendationResult.document][google.cloud.discoveryengine.v1beta.RecommendResponse.RecommendationResult.document].
 * `returnScore`: Boolean. If set to true, the recommendation score
    corresponding to each returned Document is set in
    [RecommendResponse.RecommendationResult.metadata][google.cloud.discoveryengine.v1beta.RecommendResponse.RecommendationResult.metadata].
    The given score indicates the probability of a Document conversion given
    the user's context and history.
 * `strictFiltering`: Boolean. True by default. If set to `false`, the
 service
    returns generic (unfiltered) popular Documents instead of empty if
    your filter blocks all recommendation results.
 * `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 recommendation results
    based on Document category.
 * `attributeFilteringSyntax`: Boolean. False by default. If set to true,
    the `filter` field is interpreted according to the new,
    attribute-based syntax.
 

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

Specified by:

getParamsMap in interface RecommendRequestOrBuilder

getParamsOrDefault

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

 Additional domain specific parameters for the recommendations.

 Allowed values:

 * `returnDocument`: Boolean. If set to `true`, the associated Document
    object is returned in
    [RecommendResponse.RecommendationResult.document][google.cloud.discoveryengine.v1beta.RecommendResponse.RecommendationResult.document].
 * `returnScore`: Boolean. If set to true, the recommendation score
    corresponding to each returned Document is set in
    [RecommendResponse.RecommendationResult.metadata][google.cloud.discoveryengine.v1beta.RecommendResponse.RecommendationResult.metadata].
    The given score indicates the probability of a Document conversion given
    the user's context and history.
 * `strictFiltering`: Boolean. True by default. If set to `false`, the
 service
    returns generic (unfiltered) popular Documents instead of empty if
    your filter blocks all recommendation results.
 * `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 recommendation results
    based on Document category.
 * `attributeFilteringSyntax`: Boolean. False by default. If set to true,
    the `filter` field is interpreted according to the new,
    attribute-based syntax.
 

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

Specified by:

getParamsOrDefault in interface RecommendRequestOrBuilder

getParamsOrThrow

public com.google.protobuf.Value getParamsOrThrow(String key)

 Additional domain specific parameters for the recommendations.

 Allowed values:

 * `returnDocument`: Boolean. If set to `true`, the associated Document
    object is returned in
    [RecommendResponse.RecommendationResult.document][google.cloud.discoveryengine.v1beta.RecommendResponse.RecommendationResult.document].
 * `returnScore`: Boolean. If set to true, the recommendation score
    corresponding to each returned Document is set in
    [RecommendResponse.RecommendationResult.metadata][google.cloud.discoveryengine.v1beta.RecommendResponse.RecommendationResult.metadata].
    The given score indicates the probability of a Document conversion given
    the user's context and history.
 * `strictFiltering`: Boolean. True by default. If set to `false`, the
 service
    returns generic (unfiltered) popular Documents instead of empty if
    your filter blocks all recommendation results.
 * `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 recommendation results
    based on Document category.
 * `attributeFilteringSyntax`: Boolean. False by default. If set to true,
    the `filter` field is interpreted according to the new,
    attribute-based syntax.
 

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

Specified by:

getParamsOrThrow in interface RecommendRequestOrBuilder

getUserLabelsCount

public int getUserLabelsCount()

Description copied from interface: RecommendRequestOrBuilder

 The user 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 [Requirements for
 labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 for more details.
 

map<string, string> user_labels = 8;

Specified by:

getUserLabelsCount in interface RecommendRequestOrBuilder

containsUserLabels

public boolean containsUserLabels(String key)

 The user 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 [Requirements for
 labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 for more details.
 

map<string, string> user_labels = 8;

Specified by:

containsUserLabels in interface RecommendRequestOrBuilder

getUserLabels

@Deprecated
public Map<String,String> getUserLabels()

Deprecated.

Use getUserLabelsMap() instead.

Specified by:

getUserLabels in interface RecommendRequestOrBuilder

getUserLabelsMap

public Map<String,String> getUserLabelsMap()

 The user 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 [Requirements for
 labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 for more details.
 

map<string, string> user_labels = 8;

Specified by:

getUserLabelsMap in interface RecommendRequestOrBuilder

getUserLabelsOrDefault

public String getUserLabelsOrDefault(String key,
                                     String defaultValue)

 The user 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 [Requirements for
 labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 for more details.
 

map<string, string> user_labels = 8;

Specified by:

getUserLabelsOrDefault in interface RecommendRequestOrBuilder

getUserLabelsOrThrow

public String getUserLabelsOrThrow(String key)

 The user 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 [Requirements for
 labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 for more details.
 

map<string, string> user_labels = 8;

Specified by:

getUserLabelsOrThrow in interface RecommendRequestOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static RecommendRequest parseFrom(ByteBuffer data)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RecommendRequest parseFrom(ByteBuffer data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RecommendRequest parseFrom(com.google.protobuf.ByteString data)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RecommendRequest parseFrom(com.google.protobuf.ByteString data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RecommendRequest parseFrom(byte[] data)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RecommendRequest parseFrom(byte[] data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RecommendRequest parseFrom(InputStream input)
                                  throws IOException

Throws:

IOException

parseFrom

public static RecommendRequest parseFrom(InputStream input,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws IOException

Throws:

IOException

parseDelimitedFrom

public static RecommendRequest parseDelimitedFrom(InputStream input)
                                           throws IOException

Throws:

IOException

parseDelimitedFrom

public static RecommendRequest parseDelimitedFrom(InputStream input,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws IOException

Throws:

IOException

parseFrom

public static RecommendRequest parseFrom(com.google.protobuf.CodedInputStream input)
                                  throws IOException

Throws:

IOException

parseFrom

public static RecommendRequest parseFrom(com.google.protobuf.CodedInputStream input,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws IOException

Throws:

IOException

newBuilderForType

public RecommendRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static RecommendRequest.Builder newBuilder()

newBuilder

public static RecommendRequest.Builder newBuilder(RecommendRequest prototype)

toBuilder

public RecommendRequest.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected RecommendRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static RecommendRequest getDefaultInstance()

parser

public static com.google.protobuf.Parser<RecommendRequest> parser()

getParserForType

public com.google.protobuf.Parser<RecommendRequest> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public RecommendRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder