Class RecommendRequest.Builder (0.7.0)

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

Request message for Recommend method.

Protobuf type google.cloud.discoveryengine.v1beta.RecommendRequest

Inheritance

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

Implements

RecommendRequestOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
`Descriptor`

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public RecommendRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns

Type	Description
`RecommendRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public RecommendRequest build()

Returns

Type	Description
`RecommendRequest`

buildPartial()

public RecommendRequest buildPartial()

Returns

Type	Description
`RecommendRequest`

clear()

public RecommendRequest.Builder clear()

Returns

Type	Description
`RecommendRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField(Descriptors.FieldDescriptor field)

public RecommendRequest.Builder clearField(Descriptors.FieldDescriptor field)

Parameter

Name	Description
`field`	`FieldDescriptor`

Returns

Type	Description
`RecommendRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

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

Type	Description
`RecommendRequest.Builder`	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public RecommendRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter

Name	Description
`oneof`	`OneofDescriptor`

Returns

Type	Description
`RecommendRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

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

Type	Description
`RecommendRequest.Builder`	This builder for chaining.

clearParams()

public RecommendRequest.Builder clearParams()

Returns

Type	Description
`RecommendRequest.Builder`

clearServingConfig()

public RecommendRequest.Builder clearServingConfig()

Required. Full resource name of the format: projects/*/locations/global/dataStores/*/servingConfigs/* Before you can request recommendations from your model, you must create at least one serving config for it.

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

Returns

Type	Description
`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.v1beta.UserEvent user_event = 2 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
`RecommendRequest.Builder`

clearUserLabels()

public RecommendRequest.Builder clearUserLabels()

Returns

Type	Description
`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

Type	Description
`RecommendRequest.Builder`	This builder for chaining.

clone()

public RecommendRequest.Builder clone()

Returns

Type	Description
`RecommendRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

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.results.document.
returnScore: Boolean. If set to true, the recommendation 'score' corresponding to each returned Document will be set in RecommendResponse.results.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.

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

Parameter

Name	Description
`key`	`String`

Returns

Type	Description
`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 Google Cloud Document for more details.

map<string, string> user_labels = 8;

Parameter

Name	Description
`key`	`String`

Returns

Type	Description
`boolean`

getDefaultInstanceForType()

public RecommendRequest getDefaultInstanceForType()

Returns

Type	Description
`RecommendRequest`

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns

Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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

Type	Description
`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 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

Type	Description
`ByteString`	The bytes for filter.

getMutableParams()

public Map<String,Value> getMutableParams()

Use alternate mutation accessors instead.

Returns

Type	Description
`Map<String,Value>`

getMutableUserLabels()

public Map<String,String> getMutableUserLabels()

Use alternate mutation accessors instead.

Returns

Type	Description
`Map<String,String>`

getPageSize()

public int getPageSize()

int32 page_size = 3;

Returns

Type	Description
`int`	The pageSize.

getParams()

public Map<String,Value> getParams()

Use #getParamsMap() instead.

Returns

Type	Description
`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.results.document.
returnScore: Boolean. If set to true, the recommendation 'score' corresponding to each returned Document will be set in RecommendResponse.results.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.

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

Returns

Type	Description
`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.results.document.
returnScore: Boolean. If set to true, the recommendation 'score' corresponding to each returned Document will be set in RecommendResponse.results.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.

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

Returns

Type	Description
`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.results.document.
returnScore: Boolean. If set to true, the recommendation 'score' corresponding to each returned Document will be set in RecommendResponse.results.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.

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

Parameters

Name	Description
`key`	`String`
`defaultValue`	`Value`

Returns

Type	Description
`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.results.document.
returnScore: Boolean. If set to true, the recommendation 'score' corresponding to each returned Document will be set in RecommendResponse.results.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.

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

Parameter

Name	Description
`key`	`String`

Returns

Type	Description
`Value`

getServingConfig()

public String getServingConfig()

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

Returns

Type	Description
`String`	The servingConfig.

getServingConfigBytes()

public ByteString getServingConfigBytes()

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

Returns

Type	Description
`ByteString`	The bytes for servingConfig.

getUserEvent()

public UserEvent getUserEvent()

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

Returns

Type	Description
`UserEvent`	The userEvent.

getUserEventBuilder()

public UserEvent.Builder getUserEventBuilder()

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

Returns

Type	Description
`UserEvent.Builder`

getUserEventOrBuilder()

public UserEventOrBuilder getUserEventOrBuilder()

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

Returns

Type	Description
`UserEventOrBuilder`

getUserLabels()

public Map<String,String> getUserLabels()

Use #getUserLabelsMap() instead.

Returns

Type	Description
`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 Google Cloud Document for more details.

map<string, string> user_labels = 8;

Returns

Type	Description
`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 Google Cloud Document for more details.

map<string, string> user_labels = 8;

Returns

Type	Description
`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 Google Cloud Document for more details.

map<string, string> user_labels = 8;

Parameters

Name	Description
`key`	`String`
`defaultValue`	`String`

Returns

Type	Description
`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 Google Cloud Document for more details.

map<string, string> user_labels = 8;

Parameter

Name	Description
`key`	`String`

Returns

Type	Description
`String`

getValidateOnly()

public boolean getValidateOnly()

bool validate_only = 5;

Returns

Type	Description
`boolean`	The validateOnly.

hasUserEvent()

public boolean hasUserEvent()

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

Returns

Type	Description
`boolean`	Whether the userEvent field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

internalGetMapField(int number)

protected MapField internalGetMapField(int number)

Parameter

Name	Description
`number`	`int`

Returns

Type	Description
`MapField`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetMapField(int fieldNumber)

internalGetMutableMapField(int number)

protected MapField internalGetMutableMapField(int number)

Parameter

Name	Description
`number`	`int`

Returns

Type	Description
`MapField`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetMutableMapField(int fieldNumber)

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
`boolean`

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(RecommendRequest other)

public RecommendRequest.Builder mergeFrom(RecommendRequest other)

Parameter

Name	Description
`other`	`RecommendRequest`

Returns

Type	Description
`RecommendRequest.Builder`

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public RecommendRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns

Type	Description
`RecommendRequest.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions

Type	Description
`IOException`

mergeFrom(Message other)

public RecommendRequest.Builder mergeFrom(Message other)

Parameter

Name	Description
`other`	`Message`

Returns

Type	Description
`RecommendRequest.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final RecommendRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
`unknownFields`	`UnknownFieldSet`

Returns

Type	Description
`RecommendRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

mergeUserEvent(UserEvent value)

public RecommendRequest.Builder mergeUserEvent(UserEvent value)

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

Parameter

Name	Description
`value`	`UserEvent`

Returns

Type	Description
`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.results.document.
returnScore: Boolean. If set to true, the recommendation 'score' corresponding to each returned Document will be set in RecommendResponse.results.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.

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

Parameter

Name	Description
`values`	`Map<String,Value>`

Returns

Type	Description
`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 Google Cloud Document for more details.

map<string, string> user_labels = 8;

Parameter

Name	Description
`values`	`Map<String,String>`

Returns

Type	Description
`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.results.document.
returnScore: Boolean. If set to true, the recommendation 'score' corresponding to each returned Document will be set in RecommendResponse.results.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.

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

Parameters

Name	Description
`key`	`String`
`value`	`Value`

Returns

Type	Description
`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 Google Cloud Document for more details.

map<string, string> user_labels = 8;

Parameters

Name	Description
`key`	`String`
`value`	`String`

Returns

Type	Description
`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.results.document.
returnScore: Boolean. If set to true, the recommendation 'score' corresponding to each returned Document will be set in RecommendResponse.results.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.

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

Parameter

Name	Description
`key`	`String`

Returns

Type	Description
`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 Google Cloud Document for more details.

map<string, string> user_labels = 8;

Parameter

Name	Description
`key`	`String`

Returns

Type	Description
`RecommendRequest.Builder`

setField(Descriptors.FieldDescriptor field, Object value)

public RecommendRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns

Type	Description
`RecommendRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

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

Name	Description
`value`	`String` The filter to set.

Returns

Type	Description
`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 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

Name	Description
`value`	`ByteString` The bytes for filter to set.

Returns

Type	Description
`RecommendRequest.Builder`	This builder for chaining.

setPageSize(int value)

public RecommendRequest.Builder setPageSize(int value)

int32 page_size = 3;

Parameter

Name	Description
`value`	`int` The pageSize to set.

Returns

Type	Description
`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

Name	Description
`field`	`FieldDescriptor`
`index`	`int`
`value`	`Object`

Returns

Type	Description
`RecommendRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setServingConfig(String value)

public RecommendRequest.Builder setServingConfig(String value)

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

Parameter

Name	Description
`value`	`String` The servingConfig to set.

Returns

Type	Description
`RecommendRequest.Builder`	This builder for chaining.

setServingConfigBytes(ByteString value)

public RecommendRequest.Builder setServingConfigBytes(ByteString value)

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

Parameter

Name	Description
`value`	`ByteString` The bytes for servingConfig to set.

Returns

Type	Description
`RecommendRequest.Builder`	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final RecommendRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
`unknownFields`	`UnknownFieldSet`

Returns

Type	Description
`RecommendRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)

setUserEvent(UserEvent value)

public RecommendRequest.Builder setUserEvent(UserEvent value)

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

Parameter

Name	Description
`value`	`UserEvent`

Returns

Type	Description
`RecommendRequest.Builder`

setUserEvent(UserEvent.Builder builderForValue)

public RecommendRequest.Builder setUserEvent(UserEvent.Builder builderForValue)

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

Parameter

Name	Description
`builderForValue`	`UserEvent.Builder`

Returns

Type	Description
`RecommendRequest.Builder`

setValidateOnly(boolean value)

public RecommendRequest.Builder setValidateOnly(boolean value)

bool validate_only = 5;

Parameter

Name	Description
`value`	`boolean` The validateOnly to set.

Returns

Type	Description
`RecommendRequest.Builder`	This builder for chaining.