- 0.49.0 (latest)
- 0.48.0
- 0.47.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.37.0
- 0.36.0
- 0.35.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.24.0
- 0.23.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.0
- 0.13.0
- 0.12.0
- 0.11.0
- 0.10.0
- 0.9.0
- 0.8.0
- 0.7.0
- 0.5.0
- 0.4.0
- 0.3.0
- 0.2.0
- 0.1.0
public static final class SearchRequest.Builder extends GeneratedMessageV3.Builder<SearchRequest.Builder> implements SearchRequestOrBuilderRequest message for SearchService.Search method.
Protobuf type google.cloud.discoveryengine.v1beta.SearchRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > SearchRequest.BuilderImplements
SearchRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addAllDataStoreSpecs(Iterable<? extends SearchRequest.DataStoreSpec> values)
public SearchRequest.Builder addAllDataStoreSpecs(Iterable<? extends SearchRequest.DataStoreSpec> values)Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level.
repeated .google.cloud.discoveryengine.v1beta.SearchRequest.DataStoreSpec data_store_specs = 32;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<? extends com.google.cloud.discoveryengine.v1beta.SearchRequest.DataStoreSpec> |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.Builder |
|
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.v1beta.SearchRequest.FacetSpec facet_specs = 9;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<? extends com.google.cloud.discoveryengine.v1beta.SearchRequest.FacetSpec> |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.Builder |
|
addDataStoreSpecs(SearchRequest.DataStoreSpec value)
public SearchRequest.Builder addDataStoreSpecs(SearchRequest.DataStoreSpec value)Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level.
repeated .google.cloud.discoveryengine.v1beta.SearchRequest.DataStoreSpec data_store_specs = 32;
| Parameter | |
|---|---|
| Name | Description |
value |
SearchRequest.DataStoreSpec |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.Builder |
|
addDataStoreSpecs(SearchRequest.DataStoreSpec.Builder builderForValue)
public SearchRequest.Builder addDataStoreSpecs(SearchRequest.DataStoreSpec.Builder builderForValue)Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level.
repeated .google.cloud.discoveryengine.v1beta.SearchRequest.DataStoreSpec data_store_specs = 32;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
SearchRequest.DataStoreSpec.Builder |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.Builder |
|
addDataStoreSpecs(int index, SearchRequest.DataStoreSpec value)
public SearchRequest.Builder addDataStoreSpecs(int index, SearchRequest.DataStoreSpec value)Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level.
repeated .google.cloud.discoveryengine.v1beta.SearchRequest.DataStoreSpec data_store_specs = 32;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
SearchRequest.DataStoreSpec |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.Builder |
|
addDataStoreSpecs(int index, SearchRequest.DataStoreSpec.Builder builderForValue)
public SearchRequest.Builder addDataStoreSpecs(int index, SearchRequest.DataStoreSpec.Builder builderForValue)Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level.
repeated .google.cloud.discoveryengine.v1beta.SearchRequest.DataStoreSpec data_store_specs = 32;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
SearchRequest.DataStoreSpec.Builder |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.Builder |
|
addDataStoreSpecsBuilder()
public SearchRequest.DataStoreSpec.Builder addDataStoreSpecsBuilder()Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level.
repeated .google.cloud.discoveryengine.v1beta.SearchRequest.DataStoreSpec data_store_specs = 32;
| Returns | |
|---|---|
| Type | Description |
SearchRequest.DataStoreSpec.Builder |
|
addDataStoreSpecsBuilder(int index)
public SearchRequest.DataStoreSpec.Builder addDataStoreSpecsBuilder(int index)Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level.
repeated .google.cloud.discoveryengine.v1beta.SearchRequest.DataStoreSpec data_store_specs = 32;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.DataStoreSpec.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.v1beta.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.v1beta.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.v1beta.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.v1beta.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.v1beta.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.v1beta.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 |
|
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 |
|
clearBoostSpec()
public SearchRequest.Builder clearBoostSpec()Boost specification to boost certain documents. For more information on boosting, see Boosting
.google.cloud.discoveryengine.v1beta.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. |
clearCanonicalFilter()
public SearchRequest.Builder clearCanonicalFilter()The default filter that is applied when a user performs a search without checking any filters on the search page.
The filter applied to every search request when quality improvement such as query expansion is needed. In the case a query does not have a sufficient amount of results this filter will be used to determine whether or not to enable the query expansion flow. The original filter will still be used for the query expanded search. This field is strongly recommended to achieve high search quality.
For more information about filter syntax, see SearchRequest.filter.
string canonical_filter = 29;
| 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.v1beta.SearchRequest.ContentSearchSpec content_search_spec = 24;
| Returns | |
|---|---|
| Type | Description |
SearchRequest.Builder |
|
clearDataStoreSpecs()
public SearchRequest.Builder clearDataStoreSpecs()Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level.
repeated .google.cloud.discoveryengine.v1beta.SearchRequest.DataStoreSpec data_store_specs = 32;
| 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.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path.
If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path.
.google.cloud.discoveryengine.v1beta.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.v1beta.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 |
|
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.v1beta.SearchRequest.ImageQuery image_query = 19;
| Returns | |
|---|---|
| Type | Description |
SearchRequest.Builder |
|
clearLanguageCode()
public SearchRequest.Builder clearLanguageCode()The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see Standard fields. This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate.
string language_code = 35;
| Returns | |
|---|---|
| Type | Description |
SearchRequest.Builder |
This builder for chaining. |
clearNaturalLanguageQueryUnderstandingSpec()
public SearchRequest.Builder clearNaturalLanguageQueryUnderstandingSpec() If naturalLanguageQueryUnderstandingSpec is not specified, no additional
natural language query understanding will be done.
.google.cloud.discoveryengine.v1beta.SearchRequest.NaturalLanguageQueryUnderstandingSpec natural_language_query_understanding_spec = 28;
| 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 |
|
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 the website search results, see
Order web search
results.
For more information on ordering the healthcare search results, see
Order healthcare search
results.
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. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value.
- Websites with basic indexing: Default
10, Maximum25. - Websites with advanced indexing: Default
25, Maximum50. Other: Default
50, Maximum100.If this field is negative, an
INVALID_ARGUMENTis 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.v1beta.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 joined 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. |
clearRegionCode()
public SearchRequest.Builder clearRegionCode()The Unicode country/region code (CLDR) of a location, such as "US" and "419". For more information, see Standard fields. If set, then results will be boosted based on the region_code provided.
string region_code = 36;
| Returns | |
|---|---|
| Type | Description |
SearchRequest.Builder |
This builder for chaining. |
clearRelevanceThreshold()
public SearchRequest.Builder clearRelevanceThreshold()The relevance threshold of the search results.
Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information.
.google.cloud.discoveryengine.v1beta.SearchRequest.RelevanceThreshold relevance_threshold = 44;
| 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. |
clearSearchAsYouTypeSpec()
public SearchRequest.Builder clearSearchAsYouTypeSpec()Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical.
.google.cloud.discoveryengine.v1beta.SearchRequest.SearchAsYouTypeSpec search_as_you_type_spec = 31;
| Returns | |
|---|---|
| Type | Description |
SearchRequest.Builder |
|
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. |
clearSession()
public SearchRequest.Builder clearSession()The session resource name. Optional.
Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls.
Example #1 (multi-turn /search API calls):
- Call /search API with the auto-session mode (see below).
Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?".
Example #2 (coordination between /search API calls and /answer API calls):
- Call /search API with the auto-session mode (see below).
Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call.
Auto-session mode: when
projects/.../sessions/-is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually.Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.
string session = 41 [(.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
SearchRequest.Builder |
This builder for chaining. |
clearSessionSpec()
public SearchRequest.Builder clearSessionSpec()Session specification.
Can be used only when session is set.
.google.cloud.discoveryengine.v1beta.SearchRequest.SessionSpec session_spec = 42;
| Returns | |
|---|---|
| Type | Description |
SearchRequest.Builder |
|
clearSpellCorrectionSpec()
public SearchRequest.Builder clearSpellCorrectionSpec()The spell correction specification that specifies the mode under which spell correction takes effect.
.google.cloud.discoveryengine.v1beta.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.v1beta.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 |
|
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. For 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. For 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.v1beta.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.v1beta.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.v1beta.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. |
getCanonicalFilter()
public String getCanonicalFilter()The default filter that is applied when a user performs a search without checking any filters on the search page.
The filter applied to every search request when quality improvement such as query expansion is needed. In the case a query does not have a sufficient amount of results this filter will be used to determine whether or not to enable the query expansion flow. The original filter will still be used for the query expanded search. This field is strongly recommended to achieve high search quality.
For more information about filter syntax, see SearchRequest.filter.
string canonical_filter = 29;
| Returns | |
|---|---|
| Type | Description |
String |
The canonicalFilter. |
getCanonicalFilterBytes()
public ByteString getCanonicalFilterBytes()The default filter that is applied when a user performs a search without checking any filters on the search page.
The filter applied to every search request when quality improvement such as query expansion is needed. In the case a query does not have a sufficient amount of results this filter will be used to determine whether or not to enable the query expansion flow. The original filter will still be used for the query expanded search. This field is strongly recommended to achieve high search quality.
For more information about filter syntax, see SearchRequest.filter.
string canonical_filter = 29;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for canonicalFilter. |
getContentSearchSpec()
public SearchRequest.ContentSearchSpec getContentSearchSpec()A specification for configuring the behavior of content search.
.google.cloud.discoveryengine.v1beta.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.v1beta.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.v1beta.SearchRequest.ContentSearchSpec content_search_spec = 24;
| Returns | |
|---|---|
| Type | Description |
SearchRequest.ContentSearchSpecOrBuilder |
|
getDataStoreSpecs(int index)
public SearchRequest.DataStoreSpec getDataStoreSpecs(int index)Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level.
repeated .google.cloud.discoveryengine.v1beta.SearchRequest.DataStoreSpec data_store_specs = 32;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.DataStoreSpec |
|
getDataStoreSpecsBuilder(int index)
public SearchRequest.DataStoreSpec.Builder getDataStoreSpecsBuilder(int index)Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level.
repeated .google.cloud.discoveryengine.v1beta.SearchRequest.DataStoreSpec data_store_specs = 32;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.DataStoreSpec.Builder |
|
getDataStoreSpecsBuilderList()
public List<SearchRequest.DataStoreSpec.Builder> getDataStoreSpecsBuilderList()Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level.
repeated .google.cloud.discoveryengine.v1beta.SearchRequest.DataStoreSpec data_store_specs = 32;
| Returns | |
|---|---|
| Type | Description |
List<Builder> |
|
getDataStoreSpecsCount()
public int getDataStoreSpecsCount()Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level.
repeated .google.cloud.discoveryengine.v1beta.SearchRequest.DataStoreSpec data_store_specs = 32;
| Returns | |
|---|---|
| Type | Description |
int |
|
getDataStoreSpecsList()
public List<SearchRequest.DataStoreSpec> getDataStoreSpecsList()Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level.
repeated .google.cloud.discoveryengine.v1beta.SearchRequest.DataStoreSpec data_store_specs = 32;
| Returns | |
|---|---|
| Type | Description |
List<DataStoreSpec> |
|
getDataStoreSpecsOrBuilder(int index)
public SearchRequest.DataStoreSpecOrBuilder getDataStoreSpecsOrBuilder(int index)Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level.
repeated .google.cloud.discoveryengine.v1beta.SearchRequest.DataStoreSpec data_store_specs = 32;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.DataStoreSpecOrBuilder |
|
getDataStoreSpecsOrBuilderList()
public List<? extends SearchRequest.DataStoreSpecOrBuilder> getDataStoreSpecsOrBuilderList()Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level.
repeated .google.cloud.discoveryengine.v1beta.SearchRequest.DataStoreSpec data_store_specs = 32;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.discoveryengine.v1beta.SearchRequest.DataStoreSpecOrBuilder> |
|
getDefaultInstanceForType()
public SearchRequest getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
SearchRequest |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getEmbeddingSpec()
public SearchRequest.EmbeddingSpec getEmbeddingSpec()Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path.
If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path.
.google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec embedding_spec = 23;
| Returns | |
|---|---|
| Type | Description |
SearchRequest.EmbeddingSpec |
The embeddingSpec. |
getEmbeddingSpecBuilder()
public SearchRequest.EmbeddingSpec.Builder getEmbeddingSpecBuilder()Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path.
If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path.
.google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec embedding_spec = 23;
| Returns | |
|---|---|
| Type | Description |
SearchRequest.EmbeddingSpec.Builder |
|
getEmbeddingSpecOrBuilder()
public SearchRequest.EmbeddingSpecOrBuilder getEmbeddingSpecOrBuilder()Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path.
If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path.
.google.cloud.discoveryengine.v1beta.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.v1beta.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.v1beta.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.v1beta.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.v1beta.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.v1beta.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.v1beta.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.v1beta.SearchRequest.FacetSpec facet_specs = 9;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.discoveryengine.v1beta.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.
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 |
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.
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 |
ByteString |
The bytes for filter. |
getImageQuery()
public SearchRequest.ImageQuery getImageQuery()Raw image query.
.google.cloud.discoveryengine.v1beta.SearchRequest.ImageQuery image_query = 19;
| Returns | |
|---|---|
| Type | Description |
SearchRequest.ImageQuery |
The imageQuery. |
getImageQueryBuilder()
public SearchRequest.ImageQuery.Builder getImageQueryBuilder()Raw image query.
.google.cloud.discoveryengine.v1beta.SearchRequest.ImageQuery image_query = 19;
| Returns | |
|---|---|
| Type | Description |
SearchRequest.ImageQuery.Builder |
|
getImageQueryOrBuilder()
public SearchRequest.ImageQueryOrBuilder getImageQueryOrBuilder()Raw image query.
.google.cloud.discoveryengine.v1beta.SearchRequest.ImageQuery image_query = 19;
| Returns | |
|---|---|
| Type | Description |
SearchRequest.ImageQueryOrBuilder |
|
getLanguageCode()
public String getLanguageCode()The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see Standard fields. This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate.
string language_code = 35;
| Returns | |
|---|---|
| Type | Description |
String |
The languageCode. |
getLanguageCodeBytes()
public ByteString getLanguageCodeBytes()The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see Standard fields. This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate.
string language_code = 35;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for languageCode. |
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> |
|
getNaturalLanguageQueryUnderstandingSpec()
public SearchRequest.NaturalLanguageQueryUnderstandingSpec getNaturalLanguageQueryUnderstandingSpec() If naturalLanguageQueryUnderstandingSpec is not specified, no additional
natural language query understanding will be done.
.google.cloud.discoveryengine.v1beta.SearchRequest.NaturalLanguageQueryUnderstandingSpec natural_language_query_understanding_spec = 28;
| Returns | |
|---|---|
| Type | Description |
SearchRequest.NaturalLanguageQueryUnderstandingSpec |
The naturalLanguageQueryUnderstandingSpec. |
getNaturalLanguageQueryUnderstandingSpecBuilder()
public SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder getNaturalLanguageQueryUnderstandingSpecBuilder() If naturalLanguageQueryUnderstandingSpec is not specified, no additional
natural language query understanding will be done.
.google.cloud.discoveryengine.v1beta.SearchRequest.NaturalLanguageQueryUnderstandingSpec natural_language_query_understanding_spec = 28;
| Returns | |
|---|---|
| Type | Description |
SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder |
|
getNaturalLanguageQueryUnderstandingSpecOrBuilder()
public SearchRequest.NaturalLanguageQueryUnderstandingSpecOrBuilder getNaturalLanguageQueryUnderstandingSpecOrBuilder() If naturalLanguageQueryUnderstandingSpec is not specified, no additional
natural language query understanding will be done.
.google.cloud.discoveryengine.v1beta.SearchRequest.NaturalLanguageQueryUnderstandingSpec natural_language_query_understanding_spec = 28;
| Returns | |
|---|---|
| Type | Description |
SearchRequest.NaturalLanguageQueryUnderstandingSpecOrBuilder |
|
getOffset()
public int getOffset()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 |
int |
The offset. |
getOrderBy()
public String getOrderBy() 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 the website search results, see
Order web search
results.
For more information on ordering the healthcare search results, see
Order healthcare search
results.
If this field is unrecognizable, an INVALID_ARGUMENT is returned.
string order_by = 8;
| Returns | |
|---|---|
| Type | Description |
String |
The orderBy. |
getOrderByBytes()
public ByteString getOrderByBytes() 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 the website search results, see
Order web search
results.
For more information on ordering the healthcare search results, see
Order healthcare search
results.
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. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value.
- Websites with basic indexing: Default
10, Maximum25. - Websites with advanced indexing: Default
25, Maximum50. Other: Default
50, Maximum100.If this field is negative, an
INVALID_ARGUMENTis 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. For 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. For 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. For 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. For 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. For 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. For 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. For 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. For 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.v1beta.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.v1beta.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.v1beta.SearchRequest.QueryExpansionSpec query_expansion_spec = 13;
| Returns | |
|---|---|
| Type | Description |
SearchRequest.QueryExpansionSpecOrBuilder |
|
getRankingExpression()
public String getRankingExpression()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 joined 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 |
String |
The rankingExpression. |
getRankingExpressionBytes()
public ByteString getRankingExpressionBytes()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 joined 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 |
ByteString |
The bytes for rankingExpression. |
getRegionCode()
public String getRegionCode()The Unicode country/region code (CLDR) of a location, such as "US" and "419". For more information, see Standard fields. If set, then results will be boosted based on the region_code provided.
string region_code = 36;
| Returns | |
|---|---|
| Type | Description |
String |
The regionCode. |
getRegionCodeBytes()
public ByteString getRegionCodeBytes()The Unicode country/region code (CLDR) of a location, such as "US" and "419". For more information, see Standard fields. If set, then results will be boosted based on the region_code provided.
string region_code = 36;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for regionCode. |
getRelevanceThreshold()
public SearchRequest.RelevanceThreshold getRelevanceThreshold()The relevance threshold of the search results.
Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information.
.google.cloud.discoveryengine.v1beta.SearchRequest.RelevanceThreshold relevance_threshold = 44;
| Returns | |
|---|---|
| Type | Description |
SearchRequest.RelevanceThreshold |
The relevanceThreshold. |
getRelevanceThresholdValue()
public int getRelevanceThresholdValue()The relevance threshold of the search results.
Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information.
.google.cloud.discoveryengine.v1beta.SearchRequest.RelevanceThreshold relevance_threshold = 44;
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for relevanceThreshold. |
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. |
getSearchAsYouTypeSpec()
public SearchRequest.SearchAsYouTypeSpec getSearchAsYouTypeSpec()Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical.
.google.cloud.discoveryengine.v1beta.SearchRequest.SearchAsYouTypeSpec search_as_you_type_spec = 31;
| Returns | |
|---|---|
| Type | Description |
SearchRequest.SearchAsYouTypeSpec |
The searchAsYouTypeSpec. |
getSearchAsYouTypeSpecBuilder()
public SearchRequest.SearchAsYouTypeSpec.Builder getSearchAsYouTypeSpecBuilder()Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical.
.google.cloud.discoveryengine.v1beta.SearchRequest.SearchAsYouTypeSpec search_as_you_type_spec = 31;
| Returns | |
|---|---|
| Type | Description |
SearchRequest.SearchAsYouTypeSpec.Builder |
|
getSearchAsYouTypeSpecOrBuilder()
public SearchRequest.SearchAsYouTypeSpecOrBuilder getSearchAsYouTypeSpecOrBuilder()Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical.
.google.cloud.discoveryengine.v1beta.SearchRequest.SearchAsYouTypeSpec search_as_you_type_spec = 31;
| Returns | |
|---|---|
| Type | Description |
SearchRequest.SearchAsYouTypeSpecOrBuilder |
|
getServingConfig()
public String getServingConfig() 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 |
String |
The servingConfig. |
getServingConfigBytes()
public ByteString getServingConfigBytes() 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 |
ByteString |
The bytes for servingConfig. |
getSession()
public String getSession()The session resource name. Optional.
Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls.
Example #1 (multi-turn /search API calls):
- Call /search API with the auto-session mode (see below).
Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?".
Example #2 (coordination between /search API calls and /answer API calls):
- Call /search API with the auto-session mode (see below).
Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call.
Auto-session mode: when
projects/.../sessions/-is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually.Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.
string session = 41 [(.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
String |
The session. |
getSessionBytes()
public ByteString getSessionBytes()The session resource name. Optional.
Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls.
Example #1 (multi-turn /search API calls):
- Call /search API with the auto-session mode (see below).
Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?".
Example #2 (coordination between /search API calls and /answer API calls):
- Call /search API with the auto-session mode (see below).
Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call.
Auto-session mode: when
projects/.../sessions/-is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually.Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.
string session = 41 [(.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for session. |
getSessionSpec()
public SearchRequest.SessionSpec getSessionSpec()Session specification.
Can be used only when session is set.
.google.cloud.discoveryengine.v1beta.SearchRequest.SessionSpec session_spec = 42;
| Returns | |
|---|---|
| Type | Description |
SearchRequest.SessionSpec |
The sessionSpec. |
getSessionSpecBuilder()
public SearchRequest.SessionSpec.Builder getSessionSpecBuilder()Session specification.
Can be used only when session is set.
.google.cloud.discoveryengine.v1beta.SearchRequest.SessionSpec session_spec = 42;
| Returns | |
|---|---|
| Type | Description |
SearchRequest.SessionSpec.Builder |
|
getSessionSpecOrBuilder()
public SearchRequest.SessionSpecOrBuilder getSessionSpecOrBuilder()Session specification.
Can be used only when session is set.
.google.cloud.discoveryengine.v1beta.SearchRequest.SessionSpec session_spec = 42;
| Returns | |
|---|---|
| Type | Description |
SearchRequest.SessionSpecOrBuilder |
|
getSpellCorrectionSpec()
public SearchRequest.SpellCorrectionSpec getSpellCorrectionSpec()The spell correction specification that specifies the mode under which spell correction takes effect.
.google.cloud.discoveryengine.v1beta.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.v1beta.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.v1beta.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.v1beta.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.v1beta.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.v1beta.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()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 |
String |
The userPseudoId. |
getUserPseudoIdBytes()
public ByteString getUserPseudoIdBytes()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 |
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.v1beta.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.v1beta.SearchRequest.ContentSearchSpec content_search_spec = 24;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the contentSearchSpec field is set. |
hasEmbeddingSpec()
public boolean hasEmbeddingSpec()Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path.
If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path.
.google.cloud.discoveryengine.v1beta.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.v1beta.SearchRequest.ImageQuery image_query = 19;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the imageQuery field is set. |
hasNaturalLanguageQueryUnderstandingSpec()
public boolean hasNaturalLanguageQueryUnderstandingSpec() If naturalLanguageQueryUnderstandingSpec is not specified, no additional
natural language query understanding will be done.
.google.cloud.discoveryengine.v1beta.SearchRequest.NaturalLanguageQueryUnderstandingSpec natural_language_query_understanding_spec = 28;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the naturalLanguageQueryUnderstandingSpec field is set. |
hasQueryExpansionSpec()
public boolean hasQueryExpansionSpec()The query expansion specification that specifies the conditions under which query expansion occurs.
.google.cloud.discoveryengine.v1beta.SearchRequest.QueryExpansionSpec query_expansion_spec = 13;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the queryExpansionSpec field is set. |
hasSearchAsYouTypeSpec()
public boolean hasSearchAsYouTypeSpec()Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical.
.google.cloud.discoveryengine.v1beta.SearchRequest.SearchAsYouTypeSpec search_as_you_type_spec = 31;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the searchAsYouTypeSpec field is set. |
hasSessionSpec()
public boolean hasSessionSpec()Session specification.
Can be used only when session is set.
.google.cloud.discoveryengine.v1beta.SearchRequest.SessionSpec session_spec = 42;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the sessionSpec field is set. |
hasSpellCorrectionSpec()
public boolean hasSpellCorrectionSpec()The spell correction specification that specifies the mode under which spell correction takes effect.
.google.cloud.discoveryengine.v1beta.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.v1beta.UserInfo user_info = 21;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the userInfo field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
internalGetMutableMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
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.v1beta.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.v1beta.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)Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path.
If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path.
.google.cloud.discoveryengine.v1beta.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 |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public SearchRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.Builder |
|
mergeImageQuery(SearchRequest.ImageQuery value)
public SearchRequest.Builder mergeImageQuery(SearchRequest.ImageQuery value)Raw image query.
.google.cloud.discoveryengine.v1beta.SearchRequest.ImageQuery image_query = 19;
| Parameter | |
|---|---|
| Name | Description |
value |
SearchRequest.ImageQuery |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.Builder |
|
mergeNaturalLanguageQueryUnderstandingSpec(SearchRequest.NaturalLanguageQueryUnderstandingSpec value)
public SearchRequest.Builder mergeNaturalLanguageQueryUnderstandingSpec(SearchRequest.NaturalLanguageQueryUnderstandingSpec value) If naturalLanguageQueryUnderstandingSpec is not specified, no additional
natural language query understanding will be done.
.google.cloud.discoveryengine.v1beta.SearchRequest.NaturalLanguageQueryUnderstandingSpec natural_language_query_understanding_spec = 28;
| Parameter | |
|---|---|
| Name | Description |
value |
SearchRequest.NaturalLanguageQueryUnderstandingSpec |
| 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.v1beta.SearchRequest.QueryExpansionSpec query_expansion_spec = 13;
| Parameter | |
|---|---|
| Name | Description |
value |
SearchRequest.QueryExpansionSpec |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.Builder |
|
mergeSearchAsYouTypeSpec(SearchRequest.SearchAsYouTypeSpec value)
public SearchRequest.Builder mergeSearchAsYouTypeSpec(SearchRequest.SearchAsYouTypeSpec value)Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical.
.google.cloud.discoveryengine.v1beta.SearchRequest.SearchAsYouTypeSpec search_as_you_type_spec = 31;
| Parameter | |
|---|---|
| Name | Description |
value |
SearchRequest.SearchAsYouTypeSpec |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.Builder |
|
mergeSessionSpec(SearchRequest.SessionSpec value)
public SearchRequest.Builder mergeSessionSpec(SearchRequest.SessionSpec value)Session specification.
Can be used only when session is set.
.google.cloud.discoveryengine.v1beta.SearchRequest.SessionSpec session_spec = 42;
| Parameter | |
|---|---|
| Name | Description |
value |
SearchRequest.SessionSpec |
| 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.v1beta.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 |
|
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.v1beta.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. For 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. For 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. For 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. For example,search_type: 1
map<string, .google.protobuf.Value> params = 11;
| Parameters | |
|---|---|
| Name | Description |
key |
String |
value |
Value |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.Builder |
|
putParamsBuilderIfAbsent(String key)
public Value.Builder putParamsBuilderIfAbsent(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. For 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. For example,search_type: 1
map<string, .google.protobuf.Value> params = 11;
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
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 |
|
removeDataStoreSpecs(int index)
public SearchRequest.Builder removeDataStoreSpecs(int index)Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level.
repeated .google.cloud.discoveryengine.v1beta.SearchRequest.DataStoreSpec data_store_specs = 32;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| 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.v1beta.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. For 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. For 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.v1beta.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.v1beta.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 |
StringThe 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 |
ByteStringThe bytes for branch to set. |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.Builder |
This builder for chaining. |
setCanonicalFilter(String value)
public SearchRequest.Builder setCanonicalFilter(String value)The default filter that is applied when a user performs a search without checking any filters on the search page.
The filter applied to every search request when quality improvement such as query expansion is needed. In the case a query does not have a sufficient amount of results this filter will be used to determine whether or not to enable the query expansion flow. The original filter will still be used for the query expanded search. This field is strongly recommended to achieve high search quality.
For more information about filter syntax, see SearchRequest.filter.
string canonical_filter = 29;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe canonicalFilter to set. |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.Builder |
This builder for chaining. |
setCanonicalFilterBytes(ByteString value)
public SearchRequest.Builder setCanonicalFilterBytes(ByteString value)The default filter that is applied when a user performs a search without checking any filters on the search page.
The filter applied to every search request when quality improvement such as query expansion is needed. In the case a query does not have a sufficient amount of results this filter will be used to determine whether or not to enable the query expansion flow. The original filter will still be used for the query expanded search. This field is strongly recommended to achieve high search quality.
For more information about filter syntax, see SearchRequest.filter.
string canonical_filter = 29;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for canonicalFilter 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.v1beta.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.v1beta.SearchRequest.ContentSearchSpec content_search_spec = 24;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
SearchRequest.ContentSearchSpec.Builder |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.Builder |
|
setDataStoreSpecs(int index, SearchRequest.DataStoreSpec value)
public SearchRequest.Builder setDataStoreSpecs(int index, SearchRequest.DataStoreSpec value)Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level.
repeated .google.cloud.discoveryengine.v1beta.SearchRequest.DataStoreSpec data_store_specs = 32;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
SearchRequest.DataStoreSpec |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.Builder |
|
setDataStoreSpecs(int index, SearchRequest.DataStoreSpec.Builder builderForValue)
public SearchRequest.Builder setDataStoreSpecs(int index, SearchRequest.DataStoreSpec.Builder builderForValue)Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level.
repeated .google.cloud.discoveryengine.v1beta.SearchRequest.DataStoreSpec data_store_specs = 32;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
SearchRequest.DataStoreSpec.Builder |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.Builder |
|
setEmbeddingSpec(SearchRequest.EmbeddingSpec value)
public SearchRequest.Builder setEmbeddingSpec(SearchRequest.EmbeddingSpec value)Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path.
If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path.
.google.cloud.discoveryengine.v1beta.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)Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path.
If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path.
.google.cloud.discoveryengine.v1beta.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.v1beta.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.v1beta.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 |
|
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.
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;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe 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.
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;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe 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.v1beta.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.v1beta.SearchRequest.ImageQuery image_query = 19;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
SearchRequest.ImageQuery.Builder |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.Builder |
|
setLanguageCode(String value)
public SearchRequest.Builder setLanguageCode(String value)The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see Standard fields. This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate.
string language_code = 35;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe languageCode to set. |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.Builder |
This builder for chaining. |
setLanguageCodeBytes(ByteString value)
public SearchRequest.Builder setLanguageCodeBytes(ByteString value)The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see Standard fields. This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate.
string language_code = 35;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for languageCode to set. |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.Builder |
This builder for chaining. |
setNaturalLanguageQueryUnderstandingSpec(SearchRequest.NaturalLanguageQueryUnderstandingSpec value)
public SearchRequest.Builder setNaturalLanguageQueryUnderstandingSpec(SearchRequest.NaturalLanguageQueryUnderstandingSpec value) If naturalLanguageQueryUnderstandingSpec is not specified, no additional
natural language query understanding will be done.
.google.cloud.discoveryengine.v1beta.SearchRequest.NaturalLanguageQueryUnderstandingSpec natural_language_query_understanding_spec = 28;
| Parameter | |
|---|---|
| Name | Description |
value |
SearchRequest.NaturalLanguageQueryUnderstandingSpec |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.Builder |
|
setNaturalLanguageQueryUnderstandingSpec(SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder builderForValue)
public SearchRequest.Builder setNaturalLanguageQueryUnderstandingSpec(SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder builderForValue) If naturalLanguageQueryUnderstandingSpec is not specified, no additional
natural language query understanding will be done.
.google.cloud.discoveryengine.v1beta.SearchRequest.NaturalLanguageQueryUnderstandingSpec natural_language_query_understanding_spec = 28;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.Builder |
|
setOffset(int value)
public SearchRequest.Builder setOffset(int value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
intThe offset to set. |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.Builder |
This builder for chaining. |
setOrderBy(String value)
public SearchRequest.Builder setOrderBy(String value) 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 the website search results, see
Order web search
results.
For more information on ordering the healthcare search results, see
Order healthcare search
results.
If this field is unrecognizable, an INVALID_ARGUMENT is returned.
string order_by = 8;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe orderBy to set. |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.Builder |
This builder for chaining. |
setOrderByBytes(ByteString value)
public SearchRequest.Builder setOrderByBytes(ByteString value) 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 the website search results, see
Order web search
results.
For more information on ordering the healthcare search results, see
Order healthcare search
results.
If this field is unrecognizable, an INVALID_ARGUMENT is returned.
string order_by = 8;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe 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. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value.
- Websites with basic indexing: Default
10, Maximum25. - Websites with advanced indexing: Default
25, Maximum50. Other: Default
50, Maximum100.If this field is negative, an
INVALID_ARGUMENTis returned.
int32 page_size = 4;
| Parameter | |
|---|---|
| Name | Description |
value |
intThe 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 |
StringThe 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 |
ByteStringThe 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 |
StringThe 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 |
ByteStringThe 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.v1beta.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.v1beta.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)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 joined 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;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe rankingExpression to set. |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.Builder |
This builder for chaining. |
setRankingExpressionBytes(ByteString value)
public SearchRequest.Builder setRankingExpressionBytes(ByteString value)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 joined 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;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for rankingExpression to set. |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.Builder |
This builder for chaining. |
setRegionCode(String value)
public SearchRequest.Builder setRegionCode(String value)The Unicode country/region code (CLDR) of a location, such as "US" and "419". For more information, see Standard fields. If set, then results will be boosted based on the region_code provided.
string region_code = 36;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe regionCode to set. |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.Builder |
This builder for chaining. |
setRegionCodeBytes(ByteString value)
public SearchRequest.Builder setRegionCodeBytes(ByteString value)The Unicode country/region code (CLDR) of a location, such as "US" and "419". For more information, see Standard fields. If set, then results will be boosted based on the region_code provided.
string region_code = 36;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for regionCode to set. |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.Builder |
This builder for chaining. |
setRelevanceThreshold(SearchRequest.RelevanceThreshold value)
public SearchRequest.Builder setRelevanceThreshold(SearchRequest.RelevanceThreshold value)The relevance threshold of the search results.
Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information.
.google.cloud.discoveryengine.v1beta.SearchRequest.RelevanceThreshold relevance_threshold = 44;
| Parameter | |
|---|---|
| Name | Description |
value |
SearchRequest.RelevanceThresholdThe relevanceThreshold to set. |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.Builder |
This builder for chaining. |
setRelevanceThresholdValue(int value)
public SearchRequest.Builder setRelevanceThresholdValue(int value)The relevance threshold of the search results.
Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information.
.google.cloud.discoveryengine.v1beta.SearchRequest.RelevanceThreshold relevance_threshold = 44;
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for relevanceThreshold 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 |
|
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 |
booleanThe safeSearch to set. |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.Builder |
This builder for chaining. |
setSearchAsYouTypeSpec(SearchRequest.SearchAsYouTypeSpec value)
public SearchRequest.Builder setSearchAsYouTypeSpec(SearchRequest.SearchAsYouTypeSpec value)Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical.
.google.cloud.discoveryengine.v1beta.SearchRequest.SearchAsYouTypeSpec search_as_you_type_spec = 31;
| Parameter | |
|---|---|
| Name | Description |
value |
SearchRequest.SearchAsYouTypeSpec |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.Builder |
|
setSearchAsYouTypeSpec(SearchRequest.SearchAsYouTypeSpec.Builder builderForValue)
public SearchRequest.Builder setSearchAsYouTypeSpec(SearchRequest.SearchAsYouTypeSpec.Builder builderForValue)Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical.
.google.cloud.discoveryengine.v1beta.SearchRequest.SearchAsYouTypeSpec search_as_you_type_spec = 31;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
SearchRequest.SearchAsYouTypeSpec.Builder |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.Builder |
|
setServingConfig(String value)
public SearchRequest.Builder setServingConfig(String value) 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) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe servingConfig to set. |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.Builder |
This builder for chaining. |
setServingConfigBytes(ByteString value)
public SearchRequest.Builder setServingConfigBytes(ByteString value) 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) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for servingConfig to set. |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.Builder |
This builder for chaining. |
setSession(String value)
public SearchRequest.Builder setSession(String value)The session resource name. Optional.
Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls.
Example #1 (multi-turn /search API calls):
- Call /search API with the auto-session mode (see below).
Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?".
Example #2 (coordination between /search API calls and /answer API calls):
- Call /search API with the auto-session mode (see below).
Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call.
Auto-session mode: when
projects/.../sessions/-is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually.Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.
string session = 41 [(.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe session to set. |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.Builder |
This builder for chaining. |
setSessionBytes(ByteString value)
public SearchRequest.Builder setSessionBytes(ByteString value)The session resource name. Optional.
Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls.
Example #1 (multi-turn /search API calls):
- Call /search API with the auto-session mode (see below).
Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?".
Example #2 (coordination between /search API calls and /answer API calls):
- Call /search API with the auto-session mode (see below).
Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call.
Auto-session mode: when
projects/.../sessions/-is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually.Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.
string session = 41 [(.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for session to set. |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.Builder |
This builder for chaining. |
setSessionSpec(SearchRequest.SessionSpec value)
public SearchRequest.Builder setSessionSpec(SearchRequest.SessionSpec value)Session specification.
Can be used only when session is set.
.google.cloud.discoveryengine.v1beta.SearchRequest.SessionSpec session_spec = 42;
| Parameter | |
|---|---|
| Name | Description |
value |
SearchRequest.SessionSpec |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.Builder |
|
setSessionSpec(SearchRequest.SessionSpec.Builder builderForValue)
public SearchRequest.Builder setSessionSpec(SearchRequest.SessionSpec.Builder builderForValue)Session specification.
Can be used only when session is set.
.google.cloud.discoveryengine.v1beta.SearchRequest.SessionSpec session_spec = 42;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
SearchRequest.SessionSpec.Builder |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.Builder |
|
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.v1beta.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.v1beta.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 |
|
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.v1beta.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.v1beta.UserInfo user_info = 21;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
UserInfo.Builder |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.Builder |
|
setUserPseudoId(String value)
public SearchRequest.Builder setUserPseudoId(String value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe userPseudoId to set. |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.Builder |
This builder for chaining. |
setUserPseudoIdBytes(ByteString value)
public SearchRequest.Builder setUserPseudoIdBytes(ByteString value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for userPseudoId to set. |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.Builder |
This builder for chaining. |