java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessage

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

@Generated public final class RecommendRequest extends com.google.protobuf.GeneratedMessage 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

Description

static final class

RecommendRequest.Builder

Request message for Recommend 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

PAGE_SIZE_FIELD_NUMBER

static final int

PARAMS_FIELD_NUMBER

static final int

SERVING_CONFIG_FIELD_NUMBER

static final int

USER_EVENT_FIELD_NUMBER

static final int

USER_LABELS_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

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 final 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.GeneratedMessage.FieldAccessorTable

internalGetFieldAccessorTable()

protected com.google.protobuf.MapFieldReflectionAccessor

internalGetMapFieldReflection(int number)

final boolean

isInitialized()

static RecommendRequest.Builder

newBuilder()

static RecommendRequest.Builder

newBuilder(RecommendRequest prototype)

RecommendRequest.Builder

newBuilderForType()

protected RecommendRequest.Builder

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

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(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 RecommendRequest

parseFrom(ByteBuffer data)

static RecommendRequest

parseFrom(ByteBuffer data, 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.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
- 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 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

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.