| Modifier and Type | Method and Description |
|---|---|
SearchRequest.Builder |
SearchRequest.Builder.addAllDataStoreSpecs(Iterable<? extends SearchRequest.DataStoreSpec> values)
Specs defining dataStores to filter on in a search call and configurations
for those dataStores.
|
SearchRequest.Builder |
SearchRequest.Builder.addAllFacetSpecs(Iterable<? extends SearchRequest.FacetSpec> values)
Facet specifications for faceted search.
|
SearchRequest.Builder |
SearchRequest.Builder.addDataStoreSpecs(int index,
SearchRequest.DataStoreSpec.Builder builderForValue)
Specs defining dataStores to filter on in a search call and configurations
for those dataStores.
|
SearchRequest.Builder |
SearchRequest.Builder.addDataStoreSpecs(int index,
SearchRequest.DataStoreSpec value)
Specs defining dataStores to filter on in a search call and configurations
for those dataStores.
|
SearchRequest.Builder |
SearchRequest.Builder.addDataStoreSpecs(SearchRequest.DataStoreSpec.Builder builderForValue)
Specs defining dataStores to filter on in a search call and configurations
for those dataStores.
|
SearchRequest.Builder |
SearchRequest.Builder.addDataStoreSpecs(SearchRequest.DataStoreSpec value)
Specs defining dataStores to filter on in a search call and configurations
for those dataStores.
|
SearchRequest.Builder |
SearchRequest.Builder.addFacetSpecs(int index,
SearchRequest.FacetSpec.Builder builderForValue)
Facet specifications for faceted search.
|
SearchRequest.Builder |
SearchRequest.Builder.addFacetSpecs(int index,
SearchRequest.FacetSpec value)
Facet specifications for faceted search.
|
SearchRequest.Builder |
SearchRequest.Builder.addFacetSpecs(SearchRequest.FacetSpec.Builder builderForValue)
Facet specifications for faceted search.
|
SearchRequest.Builder |
SearchRequest.Builder.addFacetSpecs(SearchRequest.FacetSpec value)
Facet specifications for faceted search.
|
SearchRequest.Builder |
SearchRequest.Builder.addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
SearchRequest.Builder |
SearchRequest.Builder.clear() |
SearchRequest.Builder |
SearchRequest.Builder.clearBoostSpec()
Boost specification to boost certain documents.
|
SearchRequest.Builder |
SearchRequest.Builder.clearBranch()
The branch resource name, such as
`projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`.
|
SearchRequest.Builder |
SearchRequest.Builder.clearCanonicalFilter()
The default filter that is applied when a user performs a search without
checking any filters on the search page.
|
SearchRequest.Builder |
SearchRequest.Builder.clearContentSearchSpec()
A specification for configuring the behavior of content search.
|
SearchRequest.Builder |
SearchRequest.Builder.clearCustomFineTuningSpec()
Custom fine tuning configs.
|
SearchRequest.Builder |
SearchRequest.Builder.clearDataStoreSpecs()
Specs defining dataStores to filter on in a search call and configurations
for those dataStores.
|
SearchRequest.Builder |
SearchRequest.Builder.clearEmbeddingSpec()
Uses the provided embedding to do additional semantic document retrieval.
|
SearchRequest.Builder |
SearchRequest.Builder.clearFacetSpecs()
Facet specifications for faceted search.
|
SearchRequest.Builder |
SearchRequest.Builder.clearField(com.google.protobuf.Descriptors.FieldDescriptor field) |
SearchRequest.Builder |
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.
|
SearchRequest.Builder |
SearchRequest.Builder.clearImageQuery()
Raw image query.
|
SearchRequest.Builder |
SearchRequest.Builder.clearLanguageCode()
The BCP-47 language code, such as "en-US" or "sr-Latn".
|
SearchRequest.Builder |
SearchRequest.Builder.clearNaturalLanguageQueryUnderstandingSpec()
If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional
natural language query understanding will be done.
|
SearchRequest.Builder |
SearchRequest.Builder.clearOffset()
A 0-indexed integer that specifies the current offset (that is, starting
result location, amongst the
[Document][google.cloud.discoveryengine.v1alpha.Document]s deemed by the
API as relevant) in search results.
|
SearchRequest.Builder |
SearchRequest.Builder.clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) |
SearchRequest.Builder |
SearchRequest.Builder.clearOrderBy()
The order in which documents are returned.
|
SearchRequest.Builder |
SearchRequest.Builder.clearPageSize()
Maximum number of
[Document][google.cloud.discoveryengine.v1alpha.Document]s to return.
|
SearchRequest.Builder |
SearchRequest.Builder.clearPageToken()
A page token received from a previous
[SearchService.Search][google.cloud.discoveryengine.v1alpha.SearchService.Search]
call.
|
SearchRequest.Builder |
SearchRequest.Builder.clearParams() |
SearchRequest.Builder |
SearchRequest.Builder.clearQuery()
Raw search query.
|
SearchRequest.Builder |
SearchRequest.Builder.clearQueryExpansionSpec()
The query expansion specification that specifies the conditions under which
query expansion occurs.
|
SearchRequest.Builder |
SearchRequest.Builder.clearRankingExpression()
The ranking expression controls the customized ranking on retrieval
documents.
|
SearchRequest.Builder |
SearchRequest.Builder.clearRegionCode()
The Unicode country/region code (CLDR) of a location, such as "US" and
"419".
|
SearchRequest.Builder |
SearchRequest.Builder.clearRelevanceThreshold()
The relevance threshold of the search results.
|
SearchRequest.Builder |
SearchRequest.Builder.clearSafeSearch()
Whether to turn on safe search.
|
SearchRequest.Builder |
SearchRequest.Builder.clearSearchAsYouTypeSpec()
Search as you type configuration.
|
SearchRequest.Builder |
SearchRequest.Builder.clearServingConfig()
Required.
|
SearchRequest.Builder |
SearchRequest.Builder.clearSession()
The session resource name.
|
SearchRequest.Builder |
SearchRequest.Builder.clearSessionSpec()
Session specification.
|
SearchRequest.Builder |
SearchRequest.Builder.clearSpellCorrectionSpec()
The spell correction specification that specifies the mode under
which spell correction takes effect.
|
SearchRequest.Builder |
SearchRequest.Builder.clearUserInfo()
Information about the end user.
|
SearchRequest.Builder |
SearchRequest.Builder.clearUserLabels() |
SearchRequest.Builder |
SearchRequest.Builder.clearUserPseudoId()
A unique identifier for tracking visitors.
|
SearchRequest.Builder |
SearchRequest.Builder.clone() |
SearchRequest.Builder |
Evaluation.EvaluationSpec.Builder.getSearchRequestBuilder()
Required.
|
SearchRequest.Builder |
SearchRequest.Builder.mergeBoostSpec(SearchRequest.BoostSpec value)
Boost specification to boost certain documents.
|
SearchRequest.Builder |
SearchRequest.Builder.mergeContentSearchSpec(SearchRequest.ContentSearchSpec value)
A specification for configuring the behavior of content search.
|
SearchRequest.Builder |
SearchRequest.Builder.mergeCustomFineTuningSpec(CustomFineTuningSpec value)
Custom fine tuning configs.
|
SearchRequest.Builder |
SearchRequest.Builder.mergeEmbeddingSpec(SearchRequest.EmbeddingSpec value)
Uses the provided embedding to do additional semantic document retrieval.
|
SearchRequest.Builder |
SearchRequest.Builder.mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
SearchRequest.Builder |
SearchRequest.Builder.mergeFrom(com.google.protobuf.Message other) |
SearchRequest.Builder |
SearchRequest.Builder.mergeFrom(SearchRequest other) |
SearchRequest.Builder |
SearchRequest.Builder.mergeImageQuery(SearchRequest.ImageQuery value)
Raw image query.
|
SearchRequest.Builder |
SearchRequest.Builder.mergeNaturalLanguageQueryUnderstandingSpec(SearchRequest.NaturalLanguageQueryUnderstandingSpec value)
If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional
natural language query understanding will be done.
|
SearchRequest.Builder |
SearchRequest.Builder.mergeQueryExpansionSpec(SearchRequest.QueryExpansionSpec value)
The query expansion specification that specifies the conditions under which
query expansion occurs.
|
SearchRequest.Builder |
SearchRequest.Builder.mergeSearchAsYouTypeSpec(SearchRequest.SearchAsYouTypeSpec value)
Search as you type configuration.
|
SearchRequest.Builder |
SearchRequest.Builder.mergeSessionSpec(SearchRequest.SessionSpec value)
Session specification.
|
SearchRequest.Builder |
SearchRequest.Builder.mergeSpellCorrectionSpec(SearchRequest.SpellCorrectionSpec value)
The spell correction specification that specifies the mode under
which spell correction takes effect.
|
SearchRequest.Builder |
SearchRequest.Builder.mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
SearchRequest.Builder |
SearchRequest.Builder.mergeUserInfo(UserInfo value)
Information about the end user.
|
static SearchRequest.Builder |
SearchRequest.newBuilder() |
static SearchRequest.Builder |
SearchRequest.newBuilder(SearchRequest prototype) |
SearchRequest.Builder |
SearchRequest.newBuilderForType() |
protected SearchRequest.Builder |
SearchRequest.newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
SearchRequest.Builder |
SearchRequest.Builder.putAllParams(Map<String,com.google.protobuf.Value> values)
Additional search parameters.
|
SearchRequest.Builder |
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
|
SearchRequest.Builder |
SearchRequest.Builder.putParams(String key,
com.google.protobuf.Value value)
Additional search parameters.
|
SearchRequest.Builder |
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
|
SearchRequest.Builder |
SearchRequest.Builder.removeDataStoreSpecs(int index)
Specs defining dataStores to filter on in a search call and configurations
for those dataStores.
|
SearchRequest.Builder |
SearchRequest.Builder.removeFacetSpecs(int index)
Facet specifications for faceted search.
|
SearchRequest.Builder |
SearchRequest.Builder.removeParams(String key)
Additional search parameters.
|
SearchRequest.Builder |
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
|
SearchRequest.Builder |
SearchRequest.Builder.setBoostSpec(SearchRequest.BoostSpec.Builder builderForValue)
Boost specification to boost certain documents.
|
SearchRequest.Builder |
SearchRequest.Builder.setBoostSpec(SearchRequest.BoostSpec value)
Boost specification to boost certain documents.
|
SearchRequest.Builder |
SearchRequest.Builder.setBranch(String value)
The branch resource name, such as
`projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`.
|
SearchRequest.Builder |
SearchRequest.Builder.setBranchBytes(com.google.protobuf.ByteString value)
The branch resource name, such as
`projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`.
|
SearchRequest.Builder |
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.
|
SearchRequest.Builder |
SearchRequest.Builder.setCanonicalFilterBytes(com.google.protobuf.ByteString value)
The default filter that is applied when a user performs a search without
checking any filters on the search page.
|
SearchRequest.Builder |
SearchRequest.Builder.setContentSearchSpec(SearchRequest.ContentSearchSpec.Builder builderForValue)
A specification for configuring the behavior of content search.
|
SearchRequest.Builder |
SearchRequest.Builder.setContentSearchSpec(SearchRequest.ContentSearchSpec value)
A specification for configuring the behavior of content search.
|
SearchRequest.Builder |
SearchRequest.Builder.setCustomFineTuningSpec(CustomFineTuningSpec.Builder builderForValue)
Custom fine tuning configs.
|
SearchRequest.Builder |
SearchRequest.Builder.setCustomFineTuningSpec(CustomFineTuningSpec value)
Custom fine tuning configs.
|
SearchRequest.Builder |
SearchRequest.Builder.setDataStoreSpecs(int index,
SearchRequest.DataStoreSpec.Builder builderForValue)
Specs defining dataStores to filter on in a search call and configurations
for those dataStores.
|
SearchRequest.Builder |
SearchRequest.Builder.setDataStoreSpecs(int index,
SearchRequest.DataStoreSpec value)
Specs defining dataStores to filter on in a search call and configurations
for those dataStores.
|
SearchRequest.Builder |
SearchRequest.Builder.setEmbeddingSpec(SearchRequest.EmbeddingSpec.Builder builderForValue)
Uses the provided embedding to do additional semantic document retrieval.
|
SearchRequest.Builder |
SearchRequest.Builder.setEmbeddingSpec(SearchRequest.EmbeddingSpec value)
Uses the provided embedding to do additional semantic document retrieval.
|
SearchRequest.Builder |
SearchRequest.Builder.setFacetSpecs(int index,
SearchRequest.FacetSpec.Builder builderForValue)
Facet specifications for faceted search.
|
SearchRequest.Builder |
SearchRequest.Builder.setFacetSpecs(int index,
SearchRequest.FacetSpec value)
Facet specifications for faceted search.
|
SearchRequest.Builder |
SearchRequest.Builder.setField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
SearchRequest.Builder |
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.
|
SearchRequest.Builder |
SearchRequest.Builder.setFilterBytes(com.google.protobuf.ByteString value)
The filter syntax consists of an expression language for constructing a
predicate from one or more fields of the documents being filtered.
|
SearchRequest.Builder |
SearchRequest.Builder.setImageQuery(SearchRequest.ImageQuery.Builder builderForValue)
Raw image query.
|
SearchRequest.Builder |
SearchRequest.Builder.setImageQuery(SearchRequest.ImageQuery value)
Raw image query.
|
SearchRequest.Builder |
SearchRequest.Builder.setLanguageCode(String value)
The BCP-47 language code, such as "en-US" or "sr-Latn".
|
SearchRequest.Builder |
SearchRequest.Builder.setLanguageCodeBytes(com.google.protobuf.ByteString value)
The BCP-47 language code, such as "en-US" or "sr-Latn".
|
SearchRequest.Builder |
SearchRequest.Builder.setNaturalLanguageQueryUnderstandingSpec(SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder builderForValue)
If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional
natural language query understanding will be done.
|
SearchRequest.Builder |
SearchRequest.Builder.setNaturalLanguageQueryUnderstandingSpec(SearchRequest.NaturalLanguageQueryUnderstandingSpec value)
If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional
natural language query understanding will be done.
|
SearchRequest.Builder |
SearchRequest.Builder.setOffset(int value)
A 0-indexed integer that specifies the current offset (that is, starting
result location, amongst the
[Document][google.cloud.discoveryengine.v1alpha.Document]s deemed by the
API as relevant) in search results.
|
SearchRequest.Builder |
SearchRequest.Builder.setOrderBy(String value)
The order in which documents are returned.
|
SearchRequest.Builder |
SearchRequest.Builder.setOrderByBytes(com.google.protobuf.ByteString value)
The order in which documents are returned.
|
SearchRequest.Builder |
SearchRequest.Builder.setPageSize(int value)
Maximum number of
[Document][google.cloud.discoveryengine.v1alpha.Document]s to return.
|
SearchRequest.Builder |
SearchRequest.Builder.setPageToken(String value)
A page token received from a previous
[SearchService.Search][google.cloud.discoveryengine.v1alpha.SearchService.Search]
call.
|
SearchRequest.Builder |
SearchRequest.Builder.setPageTokenBytes(com.google.protobuf.ByteString value)
A page token received from a previous
[SearchService.Search][google.cloud.discoveryengine.v1alpha.SearchService.Search]
call.
|
SearchRequest.Builder |
SearchRequest.Builder.setQuery(String value)
Raw search query.
|
SearchRequest.Builder |
SearchRequest.Builder.setQueryBytes(com.google.protobuf.ByteString value)
Raw search query.
|
SearchRequest.Builder |
SearchRequest.Builder.setQueryExpansionSpec(SearchRequest.QueryExpansionSpec.Builder builderForValue)
The query expansion specification that specifies the conditions under which
query expansion occurs.
|
SearchRequest.Builder |
SearchRequest.Builder.setQueryExpansionSpec(SearchRequest.QueryExpansionSpec value)
The query expansion specification that specifies the conditions under which
query expansion occurs.
|
SearchRequest.Builder |
SearchRequest.Builder.setRankingExpression(String value)
The ranking expression controls the customized ranking on retrieval
documents.
|
SearchRequest.Builder |
SearchRequest.Builder.setRankingExpressionBytes(com.google.protobuf.ByteString value)
The ranking expression controls the customized ranking on retrieval
documents.
|
SearchRequest.Builder |
SearchRequest.Builder.setRegionCode(String value)
The Unicode country/region code (CLDR) of a location, such as "US" and
"419".
|
SearchRequest.Builder |
SearchRequest.Builder.setRegionCodeBytes(com.google.protobuf.ByteString value)
The Unicode country/region code (CLDR) of a location, such as "US" and
"419".
|
SearchRequest.Builder |
SearchRequest.Builder.setRelevanceThreshold(SearchRequest.RelevanceThreshold value)
The relevance threshold of the search results.
|
SearchRequest.Builder |
SearchRequest.Builder.setRelevanceThresholdValue(int value)
The relevance threshold of the search results.
|
SearchRequest.Builder |
SearchRequest.Builder.setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
int index,
Object value) |
SearchRequest.Builder |
SearchRequest.Builder.setSafeSearch(boolean value)
Whether to turn on safe search.
|
SearchRequest.Builder |
SearchRequest.Builder.setSearchAsYouTypeSpec(SearchRequest.SearchAsYouTypeSpec.Builder builderForValue)
Search as you type configuration.
|
SearchRequest.Builder |
SearchRequest.Builder.setSearchAsYouTypeSpec(SearchRequest.SearchAsYouTypeSpec value)
Search as you type configuration.
|
SearchRequest.Builder |
SearchRequest.Builder.setServingConfig(String value)
Required.
|
SearchRequest.Builder |
SearchRequest.Builder.setServingConfigBytes(com.google.protobuf.ByteString value)
Required.
|
SearchRequest.Builder |
SearchRequest.Builder.setSession(String value)
The session resource name.
|
SearchRequest.Builder |
SearchRequest.Builder.setSessionBytes(com.google.protobuf.ByteString value)
The session resource name.
|
SearchRequest.Builder |
SearchRequest.Builder.setSessionSpec(SearchRequest.SessionSpec.Builder builderForValue)
Session specification.
|
SearchRequest.Builder |
SearchRequest.Builder.setSessionSpec(SearchRequest.SessionSpec value)
Session specification.
|
SearchRequest.Builder |
SearchRequest.Builder.setSpellCorrectionSpec(SearchRequest.SpellCorrectionSpec.Builder builderForValue)
The spell correction specification that specifies the mode under
which spell correction takes effect.
|
SearchRequest.Builder |
SearchRequest.Builder.setSpellCorrectionSpec(SearchRequest.SpellCorrectionSpec value)
The spell correction specification that specifies the mode under
which spell correction takes effect.
|
SearchRequest.Builder |
SearchRequest.Builder.setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
SearchRequest.Builder |
SearchRequest.Builder.setUserInfo(UserInfo.Builder builderForValue)
Information about the end user.
|
SearchRequest.Builder |
SearchRequest.Builder.setUserInfo(UserInfo value)
Information about the end user.
|
SearchRequest.Builder |
SearchRequest.Builder.setUserPseudoId(String value)
A unique identifier for tracking visitors.
|
SearchRequest.Builder |
SearchRequest.Builder.setUserPseudoIdBytes(com.google.protobuf.ByteString value)
A unique identifier for tracking visitors.
|
SearchRequest.Builder |
SearchRequest.toBuilder() |
| Modifier and Type | Method and Description |
|---|---|
Evaluation.EvaluationSpec.Builder |
Evaluation.EvaluationSpec.Builder.setSearchRequest(SearchRequest.Builder builderForValue)
Required.
|
Copyright © 2024 Google LLC. All rights reserved.