Class RecommendRequest.Builder (0.29.0) 

public static final class RecommendRequest.Builder extends GeneratedMessageV3.Builder<RecommendRequest.Builder> implements RecommendRequestOrBuilder

Request message for Recommend method.

Protobuf type google.cloud.discoveryengine.v1alpha.RecommendRequest

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > RecommendRequest.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public RecommendRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
RecommendRequest.Builder
Overrides

build()

public RecommendRequest build()
Returns
TypeDescription
RecommendRequest

buildPartial()

public RecommendRequest buildPartial()
Returns
TypeDescription
RecommendRequest

clear()

public RecommendRequest.Builder clear()
Returns
TypeDescription
RecommendRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public RecommendRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
RecommendRequest.Builder
Overrides

clearFilter()

public RecommendRequest.Builder clearFilter()

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 will return generic (unfiltered) popular Documents. If you only want results strictly matching the filters, set strictFiltering to True in RecommendRequest.params to receive empty results instead.

    Note that the API will never return Documents with storageStatus of EXPIRED or DELETED regardless of filter choices.

string filter = 4;

Returns
TypeDescription
RecommendRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public RecommendRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
RecommendRequest.Builder
Overrides

clearPageSize()

public RecommendRequest.Builder clearPageSize()

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

int32 page_size = 3;

Returns
TypeDescription
RecommendRequest.Builder

This builder for chaining.

clearParams()

public RecommendRequest.Builder clearParams()
Returns
TypeDescription
RecommendRequest.Builder

clearServingConfig()

public RecommendRequest.Builder clearServingConfig()

Required. Full resource name of a 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 will be 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 [Recommend][] requests.

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

Returns
TypeDescription
RecommendRequest.Builder

This builder for chaining.

clearUserEvent()

public RecommendRequest.Builder clearUserEvent()

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 or UserEvent.user_info.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 to a random unique ID and leave UserEvent.user_info.user_id unset.

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

Returns
TypeDescription
RecommendRequest.Builder

clearUserLabels()

public RecommendRequest.Builder clearUserLabels()
Returns
TypeDescription
RecommendRequest.Builder

clearValidateOnly()

public RecommendRequest.Builder clearValidateOnly()

Use validate only mode for this recommendation query. If set to true, a fake model will be 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;

Returns
TypeDescription
RecommendRequest.Builder

This builder for chaining.

clone()

public RecommendRequest.Builder clone()
Returns
TypeDescription
RecommendRequest.Builder
Overrides

containsParams(String key)

public boolean containsParams(String key)

Additional domain specific parameters for the recommendations.

Allowed values:

  • returnDocument: Boolean. If set to true, the associated Document object will be returned in RecommendResponse.RecommendationResult.document.
  • returnScore: Boolean. If set to true, the recommendation 'score' corresponding to each returned Document will be set in 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 will return 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;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

containsUserLabels(String key)

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 for more details.

map<string, string> user_labels = 8;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

getDefaultInstanceForType()

public RecommendRequest getDefaultInstanceForType()
Returns
TypeDescription
RecommendRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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 will return generic (unfiltered) popular Documents. If you only want results strictly matching the filters, set strictFiltering to True in RecommendRequest.params to receive empty results instead.

    Note that the API will never return Documents with storageStatus of EXPIRED or DELETED regardless of filter choices.

string filter = 4;

Returns
TypeDescription
String

The filter.

getFilterBytes()

public 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 will return generic (unfiltered) popular Documents. If you only want results strictly matching the filters, set strictFiltering to True in RecommendRequest.params to receive empty results instead.

    Note that the API will never return Documents with storageStatus of EXPIRED or DELETED regardless of filter choices.

string filter = 4;

Returns
TypeDescription
ByteString

The bytes for filter.

getMutableParams() (deprecated)

public Map<String,Value> getMutableParams()

Use alternate mutation accessors instead.

Returns
TypeDescription
Map<String,Value>

getMutableUserLabels() (deprecated)

public Map<String,String> getMutableUserLabels()

Use alternate mutation accessors instead.

Returns
TypeDescription
Map<String,String>

getPageSize()

public int getPageSize()

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

int32 page_size = 3;

Returns
TypeDescription
int

The pageSize.

getParams() (deprecated)

public Map<String,Value> getParams()

Use #getParamsMap() instead.

Returns
TypeDescription
Map<String,Value>

getParamsCount()

public int getParamsCount()

Additional domain specific parameters for the recommendations.

Allowed values:

  • returnDocument: Boolean. If set to true, the associated Document object will be returned in RecommendResponse.RecommendationResult.document.
  • returnScore: Boolean. If set to true, the recommendation 'score' corresponding to each returned Document will be set in 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 will return 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;

Returns
TypeDescription
int

getParamsMap()

public Map<String,Value> getParamsMap()

Additional domain specific parameters for the recommendations.

Allowed values:

  • returnDocument: Boolean. If set to true, the associated Document object will be returned in RecommendResponse.RecommendationResult.document.
  • returnScore: Boolean. If set to true, the recommendation 'score' corresponding to each returned Document will be set in 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 will return 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;

Returns
TypeDescription
Map<String,Value>

getParamsOrDefault(String key, Value defaultValue)

public Value getParamsOrDefault(String key, Value defaultValue)

Additional domain specific parameters for the recommendations.

Allowed values:

  • returnDocument: Boolean. If set to true, the associated Document object will be returned in RecommendResponse.RecommendationResult.document.
  • returnScore: Boolean. If set to true, the recommendation 'score' corresponding to each returned Document will be set in 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 will return 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;

Parameters
NameDescription
keyString
defaultValueValue
Returns
TypeDescription
Value

getParamsOrThrow(String key)

public Value getParamsOrThrow(String key)

Additional domain specific parameters for the recommendations.

Allowed values:

  • returnDocument: Boolean. If set to true, the associated Document object will be returned in RecommendResponse.RecommendationResult.document.
  • returnScore: Boolean. If set to true, the recommendation 'score' corresponding to each returned Document will be set in 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 will return 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;

Parameter
NameDescription
keyString
Returns
TypeDescription
Value

getServingConfig()

public String getServingConfig()

Required. Full resource name of a 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 will be 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 [Recommend][] requests.

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

Returns
TypeDescription
String

The servingConfig.

getServingConfigBytes()

public ByteString getServingConfigBytes()

Required. Full resource name of a 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 will be 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 [Recommend][] requests.

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

Returns
TypeDescription
ByteString

The bytes for servingConfig.

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 or UserEvent.user_info.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 to a random unique ID and leave UserEvent.user_info.user_id unset.

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

Returns
TypeDescription
UserEvent

The userEvent.

getUserEventBuilder()

public UserEvent.Builder getUserEventBuilder()

Required. Context about the user, what they are looking at and what action they took to trigger the 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 or UserEvent.user_info.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 to a random unique ID and leave UserEvent.user_info.user_id unset.

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

Returns
TypeDescription
UserEvent.Builder

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 or UserEvent.user_info.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 to a random unique ID and leave UserEvent.user_info.user_id unset.

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

Returns
TypeDescription
UserEventOrBuilder

getUserLabels() (deprecated)

public Map<String,String> getUserLabels()

Use #getUserLabelsMap() instead.

Returns
TypeDescription
Map<String,String>

getUserLabelsCount()

public 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.
  • 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 for more details.

map<string, string> user_labels = 8;

Returns
TypeDescription
int

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 for more details.

map<string, string> user_labels = 8;

Returns
TypeDescription
Map<String,String>

getUserLabelsOrDefault(String key, String defaultValue)

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 for more details.

map<string, string> user_labels = 8;

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getUserLabelsOrThrow(String key)

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 for more details.

map<string, string> user_labels = 8;

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getValidateOnly()

public boolean getValidateOnly()

Use validate only mode for this recommendation query. If set to true, a fake model will be 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;

Returns
TypeDescription
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 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 or UserEvent.user_info.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 to a random unique ID and leave UserEvent.user_info.user_id unset.

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

Returns
TypeDescription
boolean

Whether the userEvent field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

internalGetMutableMapField(int number)

protected MapField internalGetMutableMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(RecommendRequest other)

public RecommendRequest.Builder mergeFrom(RecommendRequest other)
Parameter
NameDescription
otherRecommendRequest
Returns
TypeDescription
RecommendRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public RecommendRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RecommendRequest.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public RecommendRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
RecommendRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final RecommendRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
RecommendRequest.Builder
Overrides

mergeUserEvent(UserEvent value)

public RecommendRequest.Builder mergeUserEvent(UserEvent value)

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 or UserEvent.user_info.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 to a random unique ID and leave UserEvent.user_info.user_id unset.

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

Parameter
NameDescription
valueUserEvent
Returns
TypeDescription
RecommendRequest.Builder

putAllParams(Map<String,Value> values)

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

Additional domain specific parameters for the recommendations.

Allowed values:

  • returnDocument: Boolean. If set to true, the associated Document object will be returned in RecommendResponse.RecommendationResult.document.
  • returnScore: Boolean. If set to true, the recommendation 'score' corresponding to each returned Document will be set in 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 will return 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;

Parameter
NameDescription
valuesMap<String,Value>
Returns
TypeDescription
RecommendRequest.Builder

putAllUserLabels(Map<String,String> values)

public RecommendRequest.Builder putAllUserLabels(Map<String,String> values)

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 for more details.

map<string, string> user_labels = 8;

Parameter
NameDescription
valuesMap<String,String>
Returns
TypeDescription
RecommendRequest.Builder

putParams(String key, Value value)

public RecommendRequest.Builder putParams(String key, Value value)

Additional domain specific parameters for the recommendations.

Allowed values:

  • returnDocument: Boolean. If set to true, the associated Document object will be returned in RecommendResponse.RecommendationResult.document.
  • returnScore: Boolean. If set to true, the recommendation 'score' corresponding to each returned Document will be set in 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 will return 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;

Parameters
NameDescription
keyString
valueValue
Returns
TypeDescription
RecommendRequest.Builder

putUserLabels(String key, String value)

public RecommendRequest.Builder putUserLabels(String key, String value)

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 for more details.

map<string, string> user_labels = 8;

Parameters
NameDescription
keyString
valueString
Returns
TypeDescription
RecommendRequest.Builder

removeParams(String key)

public RecommendRequest.Builder removeParams(String key)

Additional domain specific parameters for the recommendations.

Allowed values:

  • returnDocument: Boolean. If set to true, the associated Document object will be returned in RecommendResponse.RecommendationResult.document.
  • returnScore: Boolean. If set to true, the recommendation 'score' corresponding to each returned Document will be set in 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 will return 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;

Parameter
NameDescription
keyString
Returns
TypeDescription
RecommendRequest.Builder

removeUserLabels(String key)

public RecommendRequest.Builder removeUserLabels(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 for more details.

map<string, string> user_labels = 8;

Parameter
NameDescription
keyString
Returns
TypeDescription
RecommendRequest.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public RecommendRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
RecommendRequest.Builder
Overrides

setFilter(String value)

public RecommendRequest.Builder setFilter(String value)

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 will return generic (unfiltered) popular Documents. If you only want results strictly matching the filters, set strictFiltering to True in RecommendRequest.params to receive empty results instead.

    Note that the API will never return Documents with storageStatus of EXPIRED or DELETED regardless of filter choices.

string filter = 4;

Parameter
NameDescription
valueString

The filter to set.

Returns
TypeDescription
RecommendRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public RecommendRequest.Builder setFilterBytes(ByteString value)

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 will return generic (unfiltered) popular Documents. If you only want results strictly matching the filters, set strictFiltering to True in RecommendRequest.params to receive empty results instead.

    Note that the API will never return Documents with storageStatus of EXPIRED or DELETED regardless of filter choices.

string filter = 4;

Parameter
NameDescription
valueByteString

The bytes for filter to set.

Returns
TypeDescription
RecommendRequest.Builder

This builder for chaining.

setPageSize(int value)

public RecommendRequest.Builder setPageSize(int value)

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

int32 page_size = 3;

Parameter
NameDescription
valueint

The pageSize to set.

Returns
TypeDescription
RecommendRequest.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public RecommendRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
RecommendRequest.Builder
Overrides

setServingConfig(String value)

public RecommendRequest.Builder setServingConfig(String value)

Required. Full resource name of a 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 will be 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 [Recommend][] requests.

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

Parameter
NameDescription
valueString

The servingConfig to set.

Returns
TypeDescription
RecommendRequest.Builder

This builder for chaining.

setServingConfigBytes(ByteString value)

public RecommendRequest.Builder setServingConfigBytes(ByteString value)

Required. Full resource name of a 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 will be 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 [Recommend][] requests.

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

Parameter
NameDescription
valueByteString

The bytes for servingConfig to set.

Returns
TypeDescription
RecommendRequest.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final RecommendRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
RecommendRequest.Builder
Overrides

setUserEvent(UserEvent value)

public RecommendRequest.Builder setUserEvent(UserEvent value)

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 or UserEvent.user_info.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 to a random unique ID and leave UserEvent.user_info.user_id unset.

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

Parameter
NameDescription
valueUserEvent
Returns
TypeDescription
RecommendRequest.Builder

setUserEvent(UserEvent.Builder builderForValue)

public RecommendRequest.Builder setUserEvent(UserEvent.Builder builderForValue)

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 or UserEvent.user_info.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 to a random unique ID and leave UserEvent.user_info.user_id unset.

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

Parameter
NameDescription
builderForValueUserEvent.Builder
Returns
TypeDescription
RecommendRequest.Builder

setValidateOnly(boolean value)

public RecommendRequest.Builder setValidateOnly(boolean value)

Use validate only mode for this recommendation query. If set to true, a fake model will be 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;

Parameter
NameDescription
valueboolean

The validateOnly to set.

Returns
TypeDescription
RecommendRequest.Builder

This builder for chaining.