Class SearchRequest.Builder (0.28.0)

public static final class SearchRequest.Builder extends GeneratedMessageV3.Builder<SearchRequest.Builder> implements SearchRequestOrBuilder

Request message for SearchService.Search method.

Protobuf type google.cloud.discoveryengine.v1alpha.SearchRequest

Inheritance

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

Implements

SearchRequestOrBuilder

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)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(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

addAllFacetSpecs(Iterable<? extends SearchRequest.FacetSpec> values)

public SearchRequest.Builder addAllFacetSpecs(Iterable<? extends SearchRequest.FacetSpec> values)

Facet specifications for faceted search. If empty, no facets are returned.

A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.

repeated .google.cloud.discoveryengine.v1alpha.SearchRequest.FacetSpec facet_specs = 9;

Parameter
Name	Description
`values`	`Iterable<? extends com.google.cloud.discoveryengine.v1alpha.SearchRequest.FacetSpec>`

Returns
Type	Description
`SearchRequest.Builder`

addFacetSpecs(SearchRequest.FacetSpec value)

public SearchRequest.Builder addFacetSpecs(SearchRequest.FacetSpec value)

Facet specifications for faceted search. If empty, no facets are returned.

A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.

repeated .google.cloud.discoveryengine.v1alpha.SearchRequest.FacetSpec facet_specs = 9;

Parameter
Name	Description
`value`	`SearchRequest.FacetSpec`

Returns
Type	Description
`SearchRequest.Builder`

addFacetSpecs(SearchRequest.FacetSpec.Builder builderForValue)

public SearchRequest.Builder addFacetSpecs(SearchRequest.FacetSpec.Builder builderForValue)

Facet specifications for faceted search. If empty, no facets are returned.

A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.

repeated .google.cloud.discoveryengine.v1alpha.SearchRequest.FacetSpec facet_specs = 9;

Parameter
Name	Description
`builderForValue`	`SearchRequest.FacetSpec.Builder`

Returns
Type	Description
`SearchRequest.Builder`

addFacetSpecs(int index, SearchRequest.FacetSpec value)

public SearchRequest.Builder addFacetSpecs(int index, SearchRequest.FacetSpec value)

Facet specifications for faceted search. If empty, no facets are returned.

A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.

repeated .google.cloud.discoveryengine.v1alpha.SearchRequest.FacetSpec facet_specs = 9;

Parameters
Name	Description
`index`	`int`
`value`	`SearchRequest.FacetSpec`

Returns
Type	Description
`SearchRequest.Builder`

addFacetSpecs(int index, SearchRequest.FacetSpec.Builder builderForValue)

public SearchRequest.Builder addFacetSpecs(int index, SearchRequest.FacetSpec.Builder builderForValue)

Facet specifications for faceted search. If empty, no facets are returned.

A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.

repeated .google.cloud.discoveryengine.v1alpha.SearchRequest.FacetSpec facet_specs = 9;

Parameters
Name	Description
`index`	`int`
`builderForValue`	`SearchRequest.FacetSpec.Builder`

Returns
Type	Description
`SearchRequest.Builder`

addFacetSpecsBuilder()

public SearchRequest.FacetSpec.Builder addFacetSpecsBuilder()

Facet specifications for faceted search. If empty, no facets are returned.

A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.

repeated .google.cloud.discoveryengine.v1alpha.SearchRequest.FacetSpec facet_specs = 9;

Returns
Type	Description
`SearchRequest.FacetSpec.Builder`

addFacetSpecsBuilder(int index)

public SearchRequest.FacetSpec.Builder addFacetSpecsBuilder(int index)

Facet specifications for faceted search. If empty, no facets are returned.

A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.

repeated .google.cloud.discoveryengine.v1alpha.SearchRequest.FacetSpec facet_specs = 9;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`SearchRequest.FacetSpec.Builder`

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

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

Returns
Type	Description
`SearchRequest.Builder`

Overrides

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

build()

public SearchRequest build()

Returns
Type	Description
`SearchRequest`

buildPartial()

public SearchRequest buildPartial()

Returns
Type	Description
`SearchRequest`

clear()

public SearchRequest.Builder clear()

Returns
Type	Description
`SearchRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearBoostSpec()

public SearchRequest.Builder clearBoostSpec()

Boost specification to boost certain documents. For more information on boosting, see Boosting

.google.cloud.discoveryengine.v1alpha.SearchRequest.BoostSpec boost_spec = 10;

Returns
Type	Description
`SearchRequest.Builder`

clearBranch()

public SearchRequest.Builder clearBranch()

The branch resource name, such as projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0.

Use default_branch as the branch ID or leave this field empty, to search documents under the default branch.

string branch = 2 [(.google.api.resource_reference) = { ... }

Returns
Type	Description
`SearchRequest.Builder`	This builder for chaining.

clearContentSearchSpec()

public SearchRequest.Builder clearContentSearchSpec()

A specification for configuring the behavior of content search.

.google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec content_search_spec = 24;

Returns
Type	Description
`SearchRequest.Builder`

clearEmbeddingSpec()

public SearchRequest.Builder clearEmbeddingSpec()

Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of [SearchRequest.embedding_spec.embedding_vectors.vector][] and the document embedding that is provided in [SearchRequest.embedding_spec.embedding_vectors.field_path][].

If [SearchRequest.embedding_spec.embedding_vectors.field_path][] is not provided, it will use [ServingConfig.embedding_config.field_paths][].

.google.cloud.discoveryengine.v1alpha.SearchRequest.EmbeddingSpec embedding_spec = 23;

Returns
Type	Description
`SearchRequest.Builder`

clearFacetSpecs()

public SearchRequest.Builder clearFacetSpecs()

Facet specifications for faceted search. If empty, no facets are returned.

A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.

repeated .google.cloud.discoveryengine.v1alpha.SearchRequest.FacetSpec facet_specs = 9;

Returns
Type	Description
`SearchRequest.Builder`

clearField(Descriptors.FieldDescriptor field)

public SearchRequest.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
`field`	`FieldDescriptor`

Returns
Type	Description
`SearchRequest.Builder`

Overrides

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

clearFilter()

public SearchRequest.Builder clearFilter()

The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive.

If this field is unrecognizable, an INVALID_ARGUMENT is returned.

Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")'

For more information about filtering including syntax and filter operators, see Filter

string filter = 7;

Returns
Type	Description
`SearchRequest.Builder`	This builder for chaining.

clearImageQuery()

public SearchRequest.Builder clearImageQuery()

Raw image query.

.google.cloud.discoveryengine.v1alpha.SearchRequest.ImageQuery image_query = 19;

Returns
Type	Description
`SearchRequest.Builder`

clearOffset()

public SearchRequest.Builder clearOffset()

A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset.

If this field is negative, an INVALID_ARGUMENT is returned.

int32 offset = 6;

Returns
Type	Description
`SearchRequest.Builder`	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public SearchRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
`oneof`	`OneofDescriptor`

Returns
Type	Description
`SearchRequest.Builder`

Overrides

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

clearOrderBy()

public SearchRequest.Builder clearOrderBy()

The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. order_by expression is case-sensitive. For more information on ordering, see Ordering

If this field is unrecognizable, an INVALID_ARGUMENT is returned.

string order_by = 8;

Returns
Type	Description
`SearchRequest.Builder`	This builder for chaining.

clearPageSize()

public SearchRequest.Builder clearPageSize()

Maximum number of Documents to return. If unspecified, defaults to a reasonable value. The maximum allowed value is

Values above 100 are coerced to 100.

If this field is negative, an INVALID_ARGUMENT is returned.

int32 page_size = 4;

Returns
Type	Description
`SearchRequest.Builder`	This builder for chaining.

clearPageToken()

public SearchRequest.Builder clearPageToken()

A page token received from a previous SearchService.Search call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.

string page_token = 5;

Returns
Type	Description
`SearchRequest.Builder`	This builder for chaining.

clearParams()

public SearchRequest.Builder clearParams()

Returns
Type	Description
`SearchRequest.Builder`

clearQuery()

public SearchRequest.Builder clearQuery()

Raw search query.

string query = 3;

Returns
Type	Description
`SearchRequest.Builder`	This builder for chaining.

clearQueryExpansionSpec()

public SearchRequest.Builder clearQueryExpansionSpec()

The query expansion specification that specifies the conditions under which query expansion occurs.

.google.cloud.discoveryengine.v1alpha.SearchRequest.QueryExpansionSpec query_expansion_spec = 13;

Returns
Type	Description
`SearchRequest.Builder`

clearRankingExpression()

public SearchRequest.Builder clearRankingExpression()

The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The ranking expression is a single function or multiple functions that are joint by "+".

ranking_expression = function, { " + ", function }; Supported functions:
double * relevance_score
double * dotProduct(embedding_field_path) Function variables: relevance_score: pre-defined keywords, used for measure relevance between query and document. embedding_field_path: the document embedding field used with query embedding vector. dotProduct: embedding function between embedding_field_path and query embedding vector.

Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be 0.5 * relevance_score + 0.3 * dotProduct(doc_embedding).

string ranking_expression = 26;

Returns
Type	Description
`SearchRequest.Builder`	This builder for chaining.

clearSafeSearch()

public SearchRequest.Builder clearSafeSearch()

Whether to turn on safe search. This is only supported for website search.

bool safe_search = 20;

Returns
Type	Description
`SearchRequest.Builder`	This builder for chaining.

clearServingConfig()

public SearchRequest.Builder clearServingConfig()

Required. The resource name of the Search serving config, such as projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config, or projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config. This field is used to identify the serving configuration name, set of models used to make the search.

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

Returns
Type	Description
`SearchRequest.Builder`	This builder for chaining.

clearSpellCorrectionSpec()

public SearchRequest.Builder clearSpellCorrectionSpec()

The spell correction specification that specifies the mode under which spell correction takes effect.

.google.cloud.discoveryengine.v1alpha.SearchRequest.SpellCorrectionSpec spell_correction_spec = 14;

Returns
Type	Description
`SearchRequest.Builder`

clearUserInfo()

public SearchRequest.Builder clearUserInfo()

Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce device_type for analytics.

.google.cloud.discoveryengine.v1alpha.UserInfo user_info = 21;

Returns
Type	Description
`SearchRequest.Builder`

clearUserLabels()

public SearchRequest.Builder clearUserLabels()

Returns
Type	Description
`SearchRequest.Builder`

clearUserPseudoId()

public SearchRequest.Builder clearUserPseudoId()

A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website.

This field should NOT have a fixed value such as unknown_visitor.

This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id

The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.

string user_pseudo_id = 15;

Returns
Type	Description
`SearchRequest.Builder`	This builder for chaining.

clone()

public SearchRequest.Builder clone()

Returns
Type	Description
`SearchRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

containsParams(String key)

public boolean containsParams(String key)

Additional search parameters.

For public website search only, supported values are:

user_country_code: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. Example: user_country_code: "au"

For available codes see Country Codes
search_type: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. Example: search_type: 1

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

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 = 22;

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`boolean`

getBoostSpec()

public SearchRequest.BoostSpec getBoostSpec()

Boost specification to boost certain documents. For more information on boosting, see Boosting

.google.cloud.discoveryengine.v1alpha.SearchRequest.BoostSpec boost_spec = 10;

Returns
Type	Description
`SearchRequest.BoostSpec`	The boostSpec.

getBoostSpecBuilder()

public SearchRequest.BoostSpec.Builder getBoostSpecBuilder()

Boost specification to boost certain documents. For more information on boosting, see Boosting

.google.cloud.discoveryengine.v1alpha.SearchRequest.BoostSpec boost_spec = 10;

Returns
Type	Description
`SearchRequest.BoostSpec.Builder`

getBoostSpecOrBuilder()

public SearchRequest.BoostSpecOrBuilder getBoostSpecOrBuilder()

Boost specification to boost certain documents. For more information on boosting, see Boosting

.google.cloud.discoveryengine.v1alpha.SearchRequest.BoostSpec boost_spec = 10;

Returns
Type	Description
`SearchRequest.BoostSpecOrBuilder`

getBranch()

public String getBranch()

The branch resource name, such as projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0.

Use default_branch as the branch ID or leave this field empty, to search documents under the default branch.

string branch = 2 [(.google.api.resource_reference) = { ... }

Returns
Type	Description
`String`	The branch.

getBranchBytes()

public ByteString getBranchBytes()

The branch resource name, such as projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0.

Use default_branch as the branch ID or leave this field empty, to search documents under the default branch.

string branch = 2 [(.google.api.resource_reference) = { ... }

Returns
Type	Description
`ByteString`	The bytes for branch.

getContentSearchSpec()

public SearchRequest.ContentSearchSpec getContentSearchSpec()

A specification for configuring the behavior of content search.

.google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec content_search_spec = 24;

Returns
Type	Description
`SearchRequest.ContentSearchSpec`	The contentSearchSpec.

getContentSearchSpecBuilder()

public SearchRequest.ContentSearchSpec.Builder getContentSearchSpecBuilder()

A specification for configuring the behavior of content search.

.google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec content_search_spec = 24;

Returns
Type	Description
`SearchRequest.ContentSearchSpec.Builder`

getContentSearchSpecOrBuilder()

public SearchRequest.ContentSearchSpecOrBuilder getContentSearchSpecOrBuilder()

A specification for configuring the behavior of content search.

.google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec content_search_spec = 24;

Returns
Type	Description
`SearchRequest.ContentSearchSpecOrBuilder`

getDefaultInstanceForType()

public SearchRequest getDefaultInstanceForType()

Returns
Type	Description
`SearchRequest`

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getEmbeddingSpec()

public SearchRequest.EmbeddingSpec getEmbeddingSpec()

If [SearchRequest.embedding_spec.embedding_vectors.field_path][] is not provided, it will use [ServingConfig.embedding_config.field_paths][].

.google.cloud.discoveryengine.v1alpha.SearchRequest.EmbeddingSpec embedding_spec = 23;

Returns
Type	Description
`SearchRequest.EmbeddingSpec`	The embeddingSpec.

getEmbeddingSpecBuilder()

public SearchRequest.EmbeddingSpec.Builder getEmbeddingSpecBuilder()

If [SearchRequest.embedding_spec.embedding_vectors.field_path][] is not provided, it will use [ServingConfig.embedding_config.field_paths][].

.google.cloud.discoveryengine.v1alpha.SearchRequest.EmbeddingSpec embedding_spec = 23;

Returns
Type	Description
`SearchRequest.EmbeddingSpec.Builder`

getEmbeddingSpecOrBuilder()

public SearchRequest.EmbeddingSpecOrBuilder getEmbeddingSpecOrBuilder()

If [SearchRequest.embedding_spec.embedding_vectors.field_path][] is not provided, it will use [ServingConfig.embedding_config.field_paths][].

.google.cloud.discoveryengine.v1alpha.SearchRequest.EmbeddingSpec embedding_spec = 23;

Returns
Type	Description
`SearchRequest.EmbeddingSpecOrBuilder`

getFacetSpecs(int index)

public SearchRequest.FacetSpec getFacetSpecs(int index)

Facet specifications for faceted search. If empty, no facets are returned.

A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.

repeated .google.cloud.discoveryengine.v1alpha.SearchRequest.FacetSpec facet_specs = 9;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`SearchRequest.FacetSpec`

getFacetSpecsBuilder(int index)

public SearchRequest.FacetSpec.Builder getFacetSpecsBuilder(int index)

Facet specifications for faceted search. If empty, no facets are returned.

A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.

repeated .google.cloud.discoveryengine.v1alpha.SearchRequest.FacetSpec facet_specs = 9;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`SearchRequest.FacetSpec.Builder`

getFacetSpecsBuilderList()

public List<SearchRequest.FacetSpec.Builder> getFacetSpecsBuilderList()

Facet specifications for faceted search. If empty, no facets are returned.

A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.

repeated .google.cloud.discoveryengine.v1alpha.SearchRequest.FacetSpec facet_specs = 9;

Returns
Type	Description
`List<Builder>`

getFacetSpecsCount()

public int getFacetSpecsCount()

Facet specifications for faceted search. If empty, no facets are returned.

A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.

repeated .google.cloud.discoveryengine.v1alpha.SearchRequest.FacetSpec facet_specs = 9;

Returns
Type	Description
`int`

getFacetSpecsList()

public List<SearchRequest.FacetSpec> getFacetSpecsList()

Facet specifications for faceted search. If empty, no facets are returned.

A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.

repeated .google.cloud.discoveryengine.v1alpha.SearchRequest.FacetSpec facet_specs = 9;

Returns
Type	Description
`List<FacetSpec>`

getFacetSpecsOrBuilder(int index)

public SearchRequest.FacetSpecOrBuilder getFacetSpecsOrBuilder(int index)

Facet specifications for faceted search. If empty, no facets are returned.

A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.

repeated .google.cloud.discoveryengine.v1alpha.SearchRequest.FacetSpec facet_specs = 9;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`SearchRequest.FacetSpecOrBuilder`

getFacetSpecsOrBuilderList()

public List<? extends SearchRequest.FacetSpecOrBuilder> getFacetSpecsOrBuilderList()

Facet specifications for faceted search. If empty, no facets are returned.

A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.

repeated .google.cloud.discoveryengine.v1alpha.SearchRequest.FacetSpec facet_specs = 9;

Returns
Type	Description
`List<? extends com.google.cloud.discoveryengine.v1alpha.SearchRequest.FacetSpecOrBuilder>`

getFilter()

public String getFilter()

The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive.

If this field is unrecognizable, an INVALID_ARGUMENT is returned.

For more information about filtering including syntax and filter operators, see Filter

string filter = 7;

Returns
Type	Description
`String`	The filter.

getFilterBytes()

public ByteString getFilterBytes()

The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive.

If this field is unrecognizable, an INVALID_ARGUMENT is returned.

For more information about filtering including syntax and filter operators, see Filter

string filter = 7;

Returns
Type	Description
`ByteString`	The bytes for filter.

getImageQuery()

public SearchRequest.ImageQuery getImageQuery()

Raw image query.

.google.cloud.discoveryengine.v1alpha.SearchRequest.ImageQuery image_query = 19;

Returns
Type	Description
`SearchRequest.ImageQuery`	The imageQuery.

getImageQueryBuilder()

public SearchRequest.ImageQuery.Builder getImageQueryBuilder()

Raw image query.

.google.cloud.discoveryengine.v1alpha.SearchRequest.ImageQuery image_query = 19;

Returns
Type	Description
`SearchRequest.ImageQuery.Builder`

getImageQueryOrBuilder()

public SearchRequest.ImageQueryOrBuilder getImageQueryOrBuilder()

Raw image query.

.google.cloud.discoveryengine.v1alpha.SearchRequest.ImageQuery image_query = 19;

Returns
Type	Description
`SearchRequest.ImageQueryOrBuilder`

getMutableParams() (deprecated)

public Map<String,Value> getMutableParams()

Use alternate mutation accessors instead.

Returns
Type	Description
`Map<String,Value>`

getMutableUserLabels() (deprecated)

public Map<String,String> getMutableUserLabels()

Use alternate mutation accessors instead.

Returns
Type	Description
`Map<String,String>`

getOffset()

public int getOffset()

If this field is negative, an INVALID_ARGUMENT is returned.

int32 offset = 6;

Returns
Type	Description
`int`	The offset.

getOrderBy()

public String getOrderBy()

If this field is unrecognizable, an INVALID_ARGUMENT is returned.

string order_by = 8;

Returns
Type	Description
`String`	The orderBy.

getOrderByBytes()

public ByteString getOrderByBytes()

If this field is unrecognizable, an INVALID_ARGUMENT is returned.

string order_by = 8;

Returns
Type	Description
`ByteString`	The bytes for orderBy.

getPageSize()

public int getPageSize()

Maximum number of Documents to return. If unspecified, defaults to a reasonable value. The maximum allowed value is

Values above 100 are coerced to 100.

If this field is negative, an INVALID_ARGUMENT is returned.

int32 page_size = 4;

Returns
Type	Description
`int`	The pageSize.

getPageToken()

public String getPageToken()

A page token received from a previous SearchService.Search call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.

string page_token = 5;

Returns
Type	Description
`String`	The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

A page token received from a previous SearchService.Search call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.

string page_token = 5;

Returns
Type	Description
`ByteString`	The bytes for pageToken.

getParams() (deprecated)

public Map<String,Value> getParams()

Use #getParamsMap() instead.

Returns
Type	Description
`Map<String,Value>`

getParamsCount()

public int getParamsCount()

Additional search parameters.

For public website search only, supported values are:

user_country_code: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. Example: user_country_code: "au"

For available codes see Country Codes
search_type: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. Example: search_type: 1

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

Returns
Type	Description
`int`

getParamsMap()

public Map<String,Value> getParamsMap()

Additional search parameters.

For public website search only, supported values are:

user_country_code: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. Example: user_country_code: "au"

For available codes see Country Codes
search_type: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. Example: search_type: 1

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

Returns
Type	Description
`Map<String,Value>`

getParamsOrDefault(String key, Value defaultValue)

public Value getParamsOrDefault(String key, Value defaultValue)

Additional search parameters.

For public website search only, supported values are:

user_country_code: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. Example: user_country_code: "au"

For available codes see Country Codes
search_type: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. Example: search_type: 1

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

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

Returns
Type	Description
`Value`

getParamsOrThrow(String key)

public Value getParamsOrThrow(String key)

Additional search parameters.

For public website search only, supported values are:

user_country_code: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. Example: user_country_code: "au"

For available codes see Country Codes
search_type: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. Example: search_type: 1

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

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`Value`

getQuery()

public String getQuery()

Raw search query.

string query = 3;

Returns
Type	Description
`String`	The query.

getQueryBytes()

public ByteString getQueryBytes()

Raw search query.

string query = 3;

Returns
Type	Description
`ByteString`	The bytes for query.

getQueryExpansionSpec()

public SearchRequest.QueryExpansionSpec getQueryExpansionSpec()

The query expansion specification that specifies the conditions under which query expansion occurs.

.google.cloud.discoveryengine.v1alpha.SearchRequest.QueryExpansionSpec query_expansion_spec = 13;

Returns
Type	Description
`SearchRequest.QueryExpansionSpec`	The queryExpansionSpec.

getQueryExpansionSpecBuilder()

public SearchRequest.QueryExpansionSpec.Builder getQueryExpansionSpecBuilder()

The query expansion specification that specifies the conditions under which query expansion occurs.

.google.cloud.discoveryengine.v1alpha.SearchRequest.QueryExpansionSpec query_expansion_spec = 13;

Returns
Type	Description
`SearchRequest.QueryExpansionSpec.Builder`

getQueryExpansionSpecOrBuilder()

public SearchRequest.QueryExpansionSpecOrBuilder getQueryExpansionSpecOrBuilder()

The query expansion specification that specifies the conditions under which query expansion occurs.

.google.cloud.discoveryengine.v1alpha.SearchRequest.QueryExpansionSpec query_expansion_spec = 13;

Returns
Type	Description
`SearchRequest.QueryExpansionSpecOrBuilder`

getRankingExpression()

public String getRankingExpression()

ranking_expression = function, { " + ", function }; Supported functions:
double * relevance_score
double * dotProduct(embedding_field_path) Function variables: relevance_score: pre-defined keywords, used for measure relevance between query and document. embedding_field_path: the document embedding field used with query embedding vector. dotProduct: embedding function between embedding_field_path and query embedding vector.

Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be 0.5 * relevance_score + 0.3 * dotProduct(doc_embedding).

string ranking_expression = 26;

Returns
Type	Description
`String`	The rankingExpression.

getRankingExpressionBytes()

public ByteString getRankingExpressionBytes()

ranking_expression = function, { " + ", function }; Supported functions:
double * relevance_score
double * dotProduct(embedding_field_path) Function variables: relevance_score: pre-defined keywords, used for measure relevance between query and document. embedding_field_path: the document embedding field used with query embedding vector. dotProduct: embedding function between embedding_field_path and query embedding vector.

Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be 0.5 * relevance_score + 0.3 * dotProduct(doc_embedding).

string ranking_expression = 26;

Returns
Type	Description
`ByteString`	The bytes for rankingExpression.

getSafeSearch()

public boolean getSafeSearch()

Whether to turn on safe search. This is only supported for website search.

bool safe_search = 20;

Returns
Type	Description
`boolean`	The safeSearch.

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.

getSpellCorrectionSpec()

public SearchRequest.SpellCorrectionSpec getSpellCorrectionSpec()

The spell correction specification that specifies the mode under which spell correction takes effect.

.google.cloud.discoveryengine.v1alpha.SearchRequest.SpellCorrectionSpec spell_correction_spec = 14;

Returns
Type	Description
`SearchRequest.SpellCorrectionSpec`	The spellCorrectionSpec.

getSpellCorrectionSpecBuilder()

public SearchRequest.SpellCorrectionSpec.Builder getSpellCorrectionSpecBuilder()

The spell correction specification that specifies the mode under which spell correction takes effect.

.google.cloud.discoveryengine.v1alpha.SearchRequest.SpellCorrectionSpec spell_correction_spec = 14;

Returns
Type	Description
`SearchRequest.SpellCorrectionSpec.Builder`

getSpellCorrectionSpecOrBuilder()

public SearchRequest.SpellCorrectionSpecOrBuilder getSpellCorrectionSpecOrBuilder()

The spell correction specification that specifies the mode under which spell correction takes effect.

.google.cloud.discoveryengine.v1alpha.SearchRequest.SpellCorrectionSpec spell_correction_spec = 14;

Returns
Type	Description
`SearchRequest.SpellCorrectionSpecOrBuilder`

getUserInfo()

public UserInfo getUserInfo()

Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce device_type for analytics.

.google.cloud.discoveryengine.v1alpha.UserInfo user_info = 21;

Returns
Type	Description
`UserInfo`	The userInfo.

getUserInfoBuilder()

public UserInfo.Builder getUserInfoBuilder()

Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce device_type for analytics.

.google.cloud.discoveryengine.v1alpha.UserInfo user_info = 21;

Returns
Type	Description
`UserInfo.Builder`

getUserInfoOrBuilder()

public UserInfoOrBuilder getUserInfoOrBuilder()

Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce device_type for analytics.

.google.cloud.discoveryengine.v1alpha.UserInfo user_info = 21;

Returns
Type	Description
`UserInfoOrBuilder`

getUserLabels() (deprecated)

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 = 22;

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 = 22;

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 = 22;

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 = 22;

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`String`

getUserPseudoId()

public String getUserPseudoId()

This field should NOT have a fixed value such as unknown_visitor.

This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id

The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.

string user_pseudo_id = 15;

Returns
Type	Description
`String`	The userPseudoId.

getUserPseudoIdBytes()

public ByteString getUserPseudoIdBytes()

This field should NOT have a fixed value such as unknown_visitor.

This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id

The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.

string user_pseudo_id = 15;

Returns
Type	Description
`ByteString`	The bytes for userPseudoId.

hasBoostSpec()

public boolean hasBoostSpec()

Boost specification to boost certain documents. For more information on boosting, see Boosting

.google.cloud.discoveryengine.v1alpha.SearchRequest.BoostSpec boost_spec = 10;

Returns
Type	Description
`boolean`	Whether the boostSpec field is set.

hasContentSearchSpec()

public boolean hasContentSearchSpec()

A specification for configuring the behavior of content search.

.google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec content_search_spec = 24;

Returns
Type	Description
`boolean`	Whether the contentSearchSpec field is set.

hasEmbeddingSpec()

public boolean hasEmbeddingSpec()

If [SearchRequest.embedding_spec.embedding_vectors.field_path][] is not provided, it will use [ServingConfig.embedding_config.field_paths][].

.google.cloud.discoveryengine.v1alpha.SearchRequest.EmbeddingSpec embedding_spec = 23;

Returns
Type	Description
`boolean`	Whether the embeddingSpec field is set.

hasImageQuery()

public boolean hasImageQuery()

Raw image query.

.google.cloud.discoveryengine.v1alpha.SearchRequest.ImageQuery image_query = 19;

Returns
Type	Description
`boolean`	Whether the imageQuery field is set.

hasQueryExpansionSpec()

public boolean hasQueryExpansionSpec()

The query expansion specification that specifies the conditions under which query expansion occurs.

.google.cloud.discoveryengine.v1alpha.SearchRequest.QueryExpansionSpec query_expansion_spec = 13;

Returns
Type	Description
`boolean`	Whether the queryExpansionSpec field is set.

hasSpellCorrectionSpec()

public boolean hasSpellCorrectionSpec()

The spell correction specification that specifies the mode under which spell correction takes effect.

.google.cloud.discoveryengine.v1alpha.SearchRequest.SpellCorrectionSpec spell_correction_spec = 14;

Returns
Type	Description
`boolean`	Whether the spellCorrectionSpec field is set.

hasUserInfo()

public boolean hasUserInfo()

Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce device_type for analytics.

.google.cloud.discoveryengine.v1alpha.UserInfo user_info = 21;

Returns
Type	Description
`boolean`	Whether the userInfo 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()

mergeBoostSpec(SearchRequest.BoostSpec value)

public SearchRequest.Builder mergeBoostSpec(SearchRequest.BoostSpec value)

Boost specification to boost certain documents. For more information on boosting, see Boosting

.google.cloud.discoveryengine.v1alpha.SearchRequest.BoostSpec boost_spec = 10;

Parameter
Name	Description
`value`	`SearchRequest.BoostSpec`

Returns
Type	Description
`SearchRequest.Builder`

mergeContentSearchSpec(SearchRequest.ContentSearchSpec value)

public SearchRequest.Builder mergeContentSearchSpec(SearchRequest.ContentSearchSpec value)

A specification for configuring the behavior of content search.

.google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec content_search_spec = 24;

Parameter
Name	Description
`value`	`SearchRequest.ContentSearchSpec`

Returns
Type	Description
`SearchRequest.Builder`

mergeEmbeddingSpec(SearchRequest.EmbeddingSpec value)

public SearchRequest.Builder mergeEmbeddingSpec(SearchRequest.EmbeddingSpec value)

If [SearchRequest.embedding_spec.embedding_vectors.field_path][] is not provided, it will use [ServingConfig.embedding_config.field_paths][].

.google.cloud.discoveryengine.v1alpha.SearchRequest.EmbeddingSpec embedding_spec = 23;

Parameter
Name	Description
`value`	`SearchRequest.EmbeddingSpec`

Returns
Type	Description
`SearchRequest.Builder`

mergeFrom(SearchRequest other)

public SearchRequest.Builder mergeFrom(SearchRequest other)

Parameter
Name	Description
`other`	`SearchRequest`

Returns
Type	Description
`SearchRequest.Builder`

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

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

Returns
Type	Description
`SearchRequest.Builder`

Overrides

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

Exceptions
Type	Description
`IOException`

mergeFrom(Message other)

public SearchRequest.Builder mergeFrom(Message other)

Parameter
Name	Description
`other`	`Message`

Returns
Type	Description
`SearchRequest.Builder`

Overrides

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

mergeImageQuery(SearchRequest.ImageQuery value)

public SearchRequest.Builder mergeImageQuery(SearchRequest.ImageQuery value)

Raw image query.

.google.cloud.discoveryengine.v1alpha.SearchRequest.ImageQuery image_query = 19;

Parameter
Name	Description
`value`	`SearchRequest.ImageQuery`

Returns
Type	Description
`SearchRequest.Builder`

mergeQueryExpansionSpec(SearchRequest.QueryExpansionSpec value)

public SearchRequest.Builder mergeQueryExpansionSpec(SearchRequest.QueryExpansionSpec value)

The query expansion specification that specifies the conditions under which query expansion occurs.

.google.cloud.discoveryengine.v1alpha.SearchRequest.QueryExpansionSpec query_expansion_spec = 13;

Parameter
Name	Description
`value`	`SearchRequest.QueryExpansionSpec`

Returns
Type	Description
`SearchRequest.Builder`

mergeSpellCorrectionSpec(SearchRequest.SpellCorrectionSpec value)

public SearchRequest.Builder mergeSpellCorrectionSpec(SearchRequest.SpellCorrectionSpec value)

The spell correction specification that specifies the mode under which spell correction takes effect.

.google.cloud.discoveryengine.v1alpha.SearchRequest.SpellCorrectionSpec spell_correction_spec = 14;

Parameter
Name	Description
`value`	`SearchRequest.SpellCorrectionSpec`

Returns
Type	Description
`SearchRequest.Builder`

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SearchRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`SearchRequest.Builder`

Overrides

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

mergeUserInfo(UserInfo value)

public SearchRequest.Builder mergeUserInfo(UserInfo value)

Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce device_type for analytics.

.google.cloud.discoveryengine.v1alpha.UserInfo user_info = 21;

Parameter
Name	Description
`value`	`UserInfo`

Returns
Type	Description
`SearchRequest.Builder`

putAllParams(Map<String,Value> values)

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

Additional search parameters.

For public website search only, supported values are:

user_country_code: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. Example: user_country_code: "au"

For available codes see Country Codes
search_type: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. Example: search_type: 1

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

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

Returns
Type	Description
`SearchRequest.Builder`

putAllUserLabels(Map<String,String> values)

public SearchRequest.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 = 22;

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

Returns
Type	Description
`SearchRequest.Builder`

putParams(String key, Value value)

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

Additional search parameters.

For public website search only, supported values are:

user_country_code: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. Example: user_country_code: "au"

For available codes see Country Codes
search_type: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. Example: search_type: 1

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

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

Returns
Type	Description
`SearchRequest.Builder`

putUserLabels(String key, String value)

public SearchRequest.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 = 22;

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

Returns
Type	Description
`SearchRequest.Builder`

removeFacetSpecs(int index)

public SearchRequest.Builder removeFacetSpecs(int index)

Facet specifications for faceted search. If empty, no facets are returned.

A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.

repeated .google.cloud.discoveryengine.v1alpha.SearchRequest.FacetSpec facet_specs = 9;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`SearchRequest.Builder`

removeParams(String key)

public SearchRequest.Builder removeParams(String key)

Additional search parameters.

For public website search only, supported values are:

user_country_code: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. Example: user_country_code: "au"

For available codes see Country Codes
search_type: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. Example: search_type: 1

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

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`SearchRequest.Builder`

removeUserLabels(String key)

public SearchRequest.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 = 22;

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`SearchRequest.Builder`

setBoostSpec(SearchRequest.BoostSpec value)

public SearchRequest.Builder setBoostSpec(SearchRequest.BoostSpec value)

Boost specification to boost certain documents. For more information on boosting, see Boosting

.google.cloud.discoveryengine.v1alpha.SearchRequest.BoostSpec boost_spec = 10;

Parameter
Name	Description
`value`	`SearchRequest.BoostSpec`

Returns
Type	Description
`SearchRequest.Builder`

setBoostSpec(SearchRequest.BoostSpec.Builder builderForValue)

public SearchRequest.Builder setBoostSpec(SearchRequest.BoostSpec.Builder builderForValue)

Boost specification to boost certain documents. For more information on boosting, see Boosting

.google.cloud.discoveryengine.v1alpha.SearchRequest.BoostSpec boost_spec = 10;

Parameter
Name	Description
`builderForValue`	`SearchRequest.BoostSpec.Builder`

Returns
Type	Description
`SearchRequest.Builder`

setBranch(String value)

public SearchRequest.Builder setBranch(String value)

The branch resource name, such as projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0.

Use default_branch as the branch ID or leave this field empty, to search documents under the default branch.

string branch = 2 [(.google.api.resource_reference) = { ... }

Parameter
Name	Description
`value`	`String` The branch to set.

Returns
Type	Description
`SearchRequest.Builder`	This builder for chaining.

setBranchBytes(ByteString value)

public SearchRequest.Builder setBranchBytes(ByteString value)

The branch resource name, such as projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0.

Use default_branch as the branch ID or leave this field empty, to search documents under the default branch.

string branch = 2 [(.google.api.resource_reference) = { ... }

Parameter
Name	Description
`value`	`ByteString` The bytes for branch to set.

Returns
Type	Description
`SearchRequest.Builder`	This builder for chaining.

setContentSearchSpec(SearchRequest.ContentSearchSpec value)

public SearchRequest.Builder setContentSearchSpec(SearchRequest.ContentSearchSpec value)

A specification for configuring the behavior of content search.

.google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec content_search_spec = 24;

Parameter
Name	Description
`value`	`SearchRequest.ContentSearchSpec`

Returns
Type	Description
`SearchRequest.Builder`

setContentSearchSpec(SearchRequest.ContentSearchSpec.Builder builderForValue)

public SearchRequest.Builder setContentSearchSpec(SearchRequest.ContentSearchSpec.Builder builderForValue)

A specification for configuring the behavior of content search.

.google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec content_search_spec = 24;

Parameter
Name	Description
`builderForValue`	`SearchRequest.ContentSearchSpec.Builder`

Returns
Type	Description
`SearchRequest.Builder`

setEmbeddingSpec(SearchRequest.EmbeddingSpec value)

public SearchRequest.Builder setEmbeddingSpec(SearchRequest.EmbeddingSpec value)

If [SearchRequest.embedding_spec.embedding_vectors.field_path][] is not provided, it will use [ServingConfig.embedding_config.field_paths][].

.google.cloud.discoveryengine.v1alpha.SearchRequest.EmbeddingSpec embedding_spec = 23;

Parameter
Name	Description
`value`	`SearchRequest.EmbeddingSpec`

Returns
Type	Description
`SearchRequest.Builder`

setEmbeddingSpec(SearchRequest.EmbeddingSpec.Builder builderForValue)

public SearchRequest.Builder setEmbeddingSpec(SearchRequest.EmbeddingSpec.Builder builderForValue)

If [SearchRequest.embedding_spec.embedding_vectors.field_path][] is not provided, it will use [ServingConfig.embedding_config.field_paths][].

.google.cloud.discoveryengine.v1alpha.SearchRequest.EmbeddingSpec embedding_spec = 23;

Parameter
Name	Description
`builderForValue`	`SearchRequest.EmbeddingSpec.Builder`

Returns
Type	Description
`SearchRequest.Builder`

setFacetSpecs(int index, SearchRequest.FacetSpec value)

public SearchRequest.Builder setFacetSpecs(int index, SearchRequest.FacetSpec value)

Facet specifications for faceted search. If empty, no facets are returned.

A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.

repeated .google.cloud.discoveryengine.v1alpha.SearchRequest.FacetSpec facet_specs = 9;

Parameters
Name	Description
`index`	`int`
`value`	`SearchRequest.FacetSpec`

Returns
Type	Description
`SearchRequest.Builder`

setFacetSpecs(int index, SearchRequest.FacetSpec.Builder builderForValue)

public SearchRequest.Builder setFacetSpecs(int index, SearchRequest.FacetSpec.Builder builderForValue)

Facet specifications for faceted search. If empty, no facets are returned.

A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.

repeated .google.cloud.discoveryengine.v1alpha.SearchRequest.FacetSpec facet_specs = 9;

Parameters
Name	Description
`index`	`int`
`builderForValue`	`SearchRequest.FacetSpec.Builder`

Returns
Type	Description
`SearchRequest.Builder`

setField(Descriptors.FieldDescriptor field, Object value)

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

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

Returns
Type	Description
`SearchRequest.Builder`

Overrides

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

setFilter(String value)

public SearchRequest.Builder setFilter(String value)

The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive.

If this field is unrecognizable, an INVALID_ARGUMENT is returned.

For more information about filtering including syntax and filter operators, see Filter

string filter = 7;

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

Returns
Type	Description
`SearchRequest.Builder`	This builder for chaining.

setFilterBytes(ByteString value)

public SearchRequest.Builder setFilterBytes(ByteString value)

The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive.

If this field is unrecognizable, an INVALID_ARGUMENT is returned.

For more information about filtering including syntax and filter operators, see Filter

string filter = 7;

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

Returns
Type	Description
`SearchRequest.Builder`	This builder for chaining.

setImageQuery(SearchRequest.ImageQuery value)

public SearchRequest.Builder setImageQuery(SearchRequest.ImageQuery value)

Raw image query.

.google.cloud.discoveryengine.v1alpha.SearchRequest.ImageQuery image_query = 19;

Parameter
Name	Description
`value`	`SearchRequest.ImageQuery`

Returns
Type	Description
`SearchRequest.Builder`

setImageQuery(SearchRequest.ImageQuery.Builder builderForValue)

public SearchRequest.Builder setImageQuery(SearchRequest.ImageQuery.Builder builderForValue)

Raw image query.

.google.cloud.discoveryengine.v1alpha.SearchRequest.ImageQuery image_query = 19;

Parameter
Name	Description
`builderForValue`	`SearchRequest.ImageQuery.Builder`

Returns
Type	Description
`SearchRequest.Builder`

setOffset(int value)

public SearchRequest.Builder setOffset(int value)

If this field is negative, an INVALID_ARGUMENT is returned.

int32 offset = 6;

Parameter
Name	Description
`value`	`int` The offset to set.

Returns
Type	Description
`SearchRequest.Builder`	This builder for chaining.

setOrderBy(String value)

public SearchRequest.Builder setOrderBy(String value)

If this field is unrecognizable, an INVALID_ARGUMENT is returned.

string order_by = 8;

Parameter
Name	Description
`value`	`String` The orderBy to set.

Returns
Type	Description
`SearchRequest.Builder`	This builder for chaining.

setOrderByBytes(ByteString value)

public SearchRequest.Builder setOrderByBytes(ByteString value)

If this field is unrecognizable, an INVALID_ARGUMENT is returned.

string order_by = 8;

Parameter
Name	Description
`value`	`ByteString` The bytes for orderBy to set.

Returns
Type	Description
`SearchRequest.Builder`	This builder for chaining.

setPageSize(int value)

public SearchRequest.Builder setPageSize(int value)

Maximum number of Documents to return. If unspecified, defaults to a reasonable value. The maximum allowed value is

Values above 100 are coerced to 100.

If this field is negative, an INVALID_ARGUMENT is returned.

int32 page_size = 4;

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

Returns
Type	Description
`SearchRequest.Builder`	This builder for chaining.

setPageToken(String value)

public SearchRequest.Builder setPageToken(String value)

A page token received from a previous SearchService.Search call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.

string page_token = 5;

Parameter
Name	Description
`value`	`String` The pageToken to set.

Returns
Type	Description
`SearchRequest.Builder`	This builder for chaining.

setPageTokenBytes(ByteString value)

public SearchRequest.Builder setPageTokenBytes(ByteString value)

A page token received from a previous SearchService.Search call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.

string page_token = 5;

Parameter
Name	Description
`value`	`ByteString` The bytes for pageToken to set.

Returns
Type	Description
`SearchRequest.Builder`	This builder for chaining.

setQuery(String value)

public SearchRequest.Builder setQuery(String value)

Raw search query.

string query = 3;

Parameter
Name	Description
`value`	`String` The query to set.

Returns
Type	Description
`SearchRequest.Builder`	This builder for chaining.

setQueryBytes(ByteString value)

public SearchRequest.Builder setQueryBytes(ByteString value)

Raw search query.

string query = 3;

Parameter
Name	Description
`value`	`ByteString` The bytes for query to set.

Returns
Type	Description
`SearchRequest.Builder`	This builder for chaining.

setQueryExpansionSpec(SearchRequest.QueryExpansionSpec value)

public SearchRequest.Builder setQueryExpansionSpec(SearchRequest.QueryExpansionSpec value)

The query expansion specification that specifies the conditions under which query expansion occurs.

.google.cloud.discoveryengine.v1alpha.SearchRequest.QueryExpansionSpec query_expansion_spec = 13;

Parameter
Name	Description
`value`	`SearchRequest.QueryExpansionSpec`

Returns
Type	Description
`SearchRequest.Builder`

setQueryExpansionSpec(SearchRequest.QueryExpansionSpec.Builder builderForValue)

public SearchRequest.Builder setQueryExpansionSpec(SearchRequest.QueryExpansionSpec.Builder builderForValue)

The query expansion specification that specifies the conditions under which query expansion occurs.

.google.cloud.discoveryengine.v1alpha.SearchRequest.QueryExpansionSpec query_expansion_spec = 13;

Parameter
Name	Description
`builderForValue`	`SearchRequest.QueryExpansionSpec.Builder`

Returns
Type	Description
`SearchRequest.Builder`

setRankingExpression(String value)

public SearchRequest.Builder setRankingExpression(String value)

ranking_expression = function, { " + ", function }; Supported functions:
double * relevance_score
double * dotProduct(embedding_field_path) Function variables: relevance_score: pre-defined keywords, used for measure relevance between query and document. embedding_field_path: the document embedding field used with query embedding vector. dotProduct: embedding function between embedding_field_path and query embedding vector.

Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be 0.5 * relevance_score + 0.3 * dotProduct(doc_embedding).

string ranking_expression = 26;

Parameter
Name	Description
`value`	`String` The rankingExpression to set.

Returns
Type	Description
`SearchRequest.Builder`	This builder for chaining.

setRankingExpressionBytes(ByteString value)

public SearchRequest.Builder setRankingExpressionBytes(ByteString value)

ranking_expression = function, { " + ", function }; Supported functions:
double * relevance_score
double * dotProduct(embedding_field_path) Function variables: relevance_score: pre-defined keywords, used for measure relevance between query and document. embedding_field_path: the document embedding field used with query embedding vector. dotProduct: embedding function between embedding_field_path and query embedding vector.

Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be 0.5 * relevance_score + 0.3 * dotProduct(doc_embedding).

string ranking_expression = 26;

Parameter
Name	Description
`value`	`ByteString` The bytes for rankingExpression to set.

Returns
Type	Description
`SearchRequest.Builder`	This builder for chaining.

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

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

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

Returns
Type	Description
`SearchRequest.Builder`

Overrides

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

setSafeSearch(boolean value)

public SearchRequest.Builder setSafeSearch(boolean value)

Whether to turn on safe search. This is only supported for website search.

bool safe_search = 20;

Parameter
Name	Description
`value`	`boolean` The safeSearch to set.

Returns
Type	Description
`SearchRequest.Builder`	This builder for chaining.

setServingConfig(String value)

public SearchRequest.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
`SearchRequest.Builder`	This builder for chaining.

setServingConfigBytes(ByteString value)

public SearchRequest.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
`SearchRequest.Builder`	This builder for chaining.

setSpellCorrectionSpec(SearchRequest.SpellCorrectionSpec value)

public SearchRequest.Builder setSpellCorrectionSpec(SearchRequest.SpellCorrectionSpec value)

The spell correction specification that specifies the mode under which spell correction takes effect.

.google.cloud.discoveryengine.v1alpha.SearchRequest.SpellCorrectionSpec spell_correction_spec = 14;

Parameter
Name	Description
`value`	`SearchRequest.SpellCorrectionSpec`

Returns
Type	Description
`SearchRequest.Builder`

setSpellCorrectionSpec(SearchRequest.SpellCorrectionSpec.Builder builderForValue)

public SearchRequest.Builder setSpellCorrectionSpec(SearchRequest.SpellCorrectionSpec.Builder builderForValue)

The spell correction specification that specifies the mode under which spell correction takes effect.

.google.cloud.discoveryengine.v1alpha.SearchRequest.SpellCorrectionSpec spell_correction_spec = 14;

Parameter
Name	Description
`builderForValue`	`SearchRequest.SpellCorrectionSpec.Builder`

Returns
Type	Description
`SearchRequest.Builder`

setUnknownFields(UnknownFieldSet unknownFields)

public final SearchRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`SearchRequest.Builder`

Overrides

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

setUserInfo(UserInfo value)

public SearchRequest.Builder setUserInfo(UserInfo value)

Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce device_type for analytics.

.google.cloud.discoveryengine.v1alpha.UserInfo user_info = 21;

Parameter
Name	Description
`value`	`UserInfo`

Returns
Type	Description
`SearchRequest.Builder`

setUserInfo(UserInfo.Builder builderForValue)

public SearchRequest.Builder setUserInfo(UserInfo.Builder builderForValue)

Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce device_type for analytics.

.google.cloud.discoveryengine.v1alpha.UserInfo user_info = 21;

Parameter
Name	Description
`builderForValue`	`UserInfo.Builder`

Returns
Type	Description
`SearchRequest.Builder`

setUserPseudoId(String value)

public SearchRequest.Builder setUserPseudoId(String value)

This field should NOT have a fixed value such as unknown_visitor.

This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id

The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.

string user_pseudo_id = 15;

Parameter
Name	Description
`value`	`String` The userPseudoId to set.

Returns
Type	Description
`SearchRequest.Builder`	This builder for chaining.

setUserPseudoIdBytes(ByteString value)

public SearchRequest.Builder setUserPseudoIdBytes(ByteString value)

This field should NOT have a fixed value such as unknown_visitor.

This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id

The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.

string user_pseudo_id = 15;

Parameter
Name	Description
`value`	`ByteString` The bytes for userPseudoId to set.

Returns
Type	Description
`SearchRequest.Builder`	This builder for chaining.