SearchRequestOrBuilder (proto-google-cloud-discoveryengine-v1 0.84.0 API)

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

SearchRequest, SearchRequest.Builder
```
@Generated
public interface SearchRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder
```

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`containsParams(String key)` Additional search parameters.
`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
`SearchRequest.BoostSpec`	`getBoostSpec()` Boost specification to boost certain documents.
`SearchRequest.BoostSpecOrBuilder`	`getBoostSpecOrBuilder()` Boost specification to boost certain documents.
`String`	`getBranch()` The branch resource name, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`.
`com.google.protobuf.ByteString`	`getBranchBytes()` The branch resource name, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`.
`String`	`getCanonicalFilter()` The default filter that is applied when a user performs a search without checking any filters on the search page.
`com.google.protobuf.ByteString`	`getCanonicalFilterBytes()` The default filter that is applied when a user performs a search without checking any filters on the search page.
`SearchRequest.ContentSearchSpec`	`getContentSearchSpec()` A specification for configuring the behavior of content search.
`SearchRequest.ContentSearchSpecOrBuilder`	`getContentSearchSpecOrBuilder()` A specification for configuring the behavior of content search.
`SearchRequest.CrowdingSpec`	`getCrowdingSpecs(int index)` Optional.
`int`	`getCrowdingSpecsCount()` Optional.
`List<SearchRequest.CrowdingSpec>`	`getCrowdingSpecsList()` Optional.
`SearchRequest.CrowdingSpecOrBuilder`	`getCrowdingSpecsOrBuilder(int index)` Optional.
`List<? extends SearchRequest.CrowdingSpecOrBuilder>`	`getCrowdingSpecsOrBuilderList()` Optional.
`SearchRequest.DataStoreSpec`	`getDataStoreSpecs(int index)` Specifications that define the specific [DataStore][google.cloud.discoveryengine.v1.DataStore]s to be searched, along with configurations for those data stores.
`int`	`getDataStoreSpecsCount()` Specifications that define the specific [DataStore][google.cloud.discoveryengine.v1.DataStore]s to be searched, along with configurations for those data stores.
`List<SearchRequest.DataStoreSpec>`	`getDataStoreSpecsList()` Specifications that define the specific [DataStore][google.cloud.discoveryengine.v1.DataStore]s to be searched, along with configurations for those data stores.
`SearchRequest.DataStoreSpecOrBuilder`	`getDataStoreSpecsOrBuilder(int index)` Specifications that define the specific [DataStore][google.cloud.discoveryengine.v1.DataStore]s to be searched, along with configurations for those data stores.
`List<? extends SearchRequest.DataStoreSpecOrBuilder>`	`getDataStoreSpecsOrBuilderList()` Specifications that define the specific [DataStore][google.cloud.discoveryengine.v1.DataStore]s to be searched, along with configurations for those data stores.
`SearchRequest.DisplaySpec`	`getDisplaySpec()` Optional.
`SearchRequest.DisplaySpecOrBuilder`	`getDisplaySpecOrBuilder()` Optional.
`SearchRequest.FacetSpec`	`getFacetSpecs(int index)` Facet specifications for faceted search.
`int`	`getFacetSpecsCount()` Facet specifications for faceted search.
`List<SearchRequest.FacetSpec>`	`getFacetSpecsList()` Facet specifications for faceted search.
`SearchRequest.FacetSpecOrBuilder`	`getFacetSpecsOrBuilder(int index)` Facet specifications for faceted search.
`List<? extends SearchRequest.FacetSpecOrBuilder>`	`getFacetSpecsOrBuilderList()` Facet specifications for faceted search.
`String`	`getFilter()` The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered.
`com.google.protobuf.ByteString`	`getFilterBytes()` The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered.
`SearchRequest.ImageQuery`	`getImageQuery()` Raw image query.
`SearchRequest.ImageQueryOrBuilder`	`getImageQueryOrBuilder()` Raw image query.
`String`	`getLanguageCode()` The BCP-47 language code, such as "en-US" or "sr-Latn".
`com.google.protobuf.ByteString`	`getLanguageCodeBytes()` The BCP-47 language code, such as "en-US" or "sr-Latn".
`SearchRequest.NaturalLanguageQueryUnderstandingSpec`	`getNaturalLanguageQueryUnderstandingSpec()` Optional.
`SearchRequest.NaturalLanguageQueryUnderstandingSpecOrBuilder`	`getNaturalLanguageQueryUnderstandingSpecOrBuilder()` Optional.
`int`	`getOffset()` A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the [Document][google.cloud.discoveryengine.v1.Document]s deemed by the API as relevant) in search results.
`int`	`getOneBoxPageSize()` The maximum number of results to return for OneBox.
`String`	`getOrderBy()` The order in which documents are returned.
`com.google.protobuf.ByteString`	`getOrderByBytes()` The order in which documents are returned.
`String`	`getPageCategories(int index)` Optional.
`com.google.protobuf.ByteString`	`getPageCategoriesBytes(int index)` Optional.
`int`	`getPageCategoriesCount()` Optional.
`List<String>`	`getPageCategoriesList()` Optional.
`int`	`getPageSize()` Maximum number of [Document][google.cloud.discoveryengine.v1.Document]s to return.
`String`	`getPageToken()` A page token received from a previous [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search] call.
`com.google.protobuf.ByteString`	`getPageTokenBytes()` A page token received from a previous [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search] call.
`Map<String,com.google.protobuf.Value>`	`getParams()` Deprecated.
`int`	`getParamsCount()` Additional search parameters.
`Map<String,com.google.protobuf.Value>`	`getParamsMap()` Additional search parameters.
`com.google.protobuf.Value`	`getParamsOrDefault(String key, com.google.protobuf.Value defaultValue)` Additional search parameters.
`com.google.protobuf.Value`	`getParamsOrThrow(String key)` Additional search parameters.
`String`	`getQuery()` Raw search query.
`com.google.protobuf.ByteString`	`getQueryBytes()` Raw search query.
`SearchRequest.QueryExpansionSpec`	`getQueryExpansionSpec()` The query expansion specification that specifies the conditions under which query expansion occurs.
`SearchRequest.QueryExpansionSpecOrBuilder`	`getQueryExpansionSpecOrBuilder()` The query expansion specification that specifies the conditions under which query expansion occurs.
`String`	`getRankingExpression()` Optional.
`SearchRequest.RankingExpressionBackend`	`getRankingExpressionBackend()` Optional.
`int`	`getRankingExpressionBackendValue()` Optional.
`com.google.protobuf.ByteString`	`getRankingExpressionBytes()` Optional.
`SearchRequest.RelevanceScoreSpec`	`getRelevanceScoreSpec()` Optional.
`SearchRequest.RelevanceScoreSpecOrBuilder`	`getRelevanceScoreSpecOrBuilder()` Optional.
`SearchRequest.RelevanceThreshold`	`getRelevanceThreshold()` The global relevance threshold of the search results.
`int`	`getRelevanceThresholdValue()` The global relevance threshold of the search results.
`boolean`	`getSafeSearch()` Whether to turn on safe search.
`SearchRequest.SearchAsYouTypeSpec`	`getSearchAsYouTypeSpec()` Search as you type configuration.
`SearchRequest.SearchAsYouTypeSpecOrBuilder`	`getSearchAsYouTypeSpecOrBuilder()` Search as you type configuration.
`String`	`getServingConfig()` Required.
`com.google.protobuf.ByteString`	`getServingConfigBytes()` Required.
`String`	`getSession()` The session resource name.
`com.google.protobuf.ByteString`	`getSessionBytes()` The session resource name.
`SearchRequest.SessionSpec`	`getSessionSpec()` Session specification.
`SearchRequest.SessionSpecOrBuilder`	`getSessionSpecOrBuilder()` Session specification.
`SearchRequest.SpellCorrectionSpec`	`getSpellCorrectionSpec()` The spell correction specification that specifies the mode under which spell correction takes effect.
`SearchRequest.SpellCorrectionSpecOrBuilder`	`getSpellCorrectionSpecOrBuilder()` The spell correction specification that specifies the mode under which spell correction takes effect.
`UserInfo`	`getUserInfo()` Information about the end user.
`UserInfoOrBuilder`	`getUserInfoOrBuilder()` Information about the end user.
`Map<String,String>`	`getUserLabels()` Deprecated.
`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
`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
`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
`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
`String`	`getUserPseudoId()` Optional.
`com.google.protobuf.ByteString`	`getUserPseudoIdBytes()` Optional.
`boolean`	`hasBoostSpec()` Boost specification to boost certain documents.
`boolean`	`hasContentSearchSpec()` A specification for configuring the behavior of content search.
`boolean`	`hasDisplaySpec()` Optional.
`boolean`	`hasImageQuery()` Raw image query.
`boolean`	`hasNaturalLanguageQueryUnderstandingSpec()` Optional.
`boolean`	`hasQueryExpansionSpec()` The query expansion specification that specifies the conditions under which query expansion occurs.
`boolean`	`hasRelevanceScoreSpec()` Optional.
`boolean`	`hasSearchAsYouTypeSpec()` Search as you type configuration.
`boolean`	`hasSessionSpec()` Session specification.
`boolean`	`hasSpellCorrectionSpec()` The spell correction specification that specifies the mode under which spell correction takes effect.
`boolean`	`hasUserInfo()` Information about the end user.

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitialized

Method Detail

getServingConfig

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:: The servingConfig.

getServingConfigBytes

com.google.protobuf.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:: The bytes for servingConfig.

getBranch

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:: The branch.

getBranchBytes

com.google.protobuf.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:: The bytes for branch.

getQuery
```
String getQuery()
```
```
 Raw search query.
 
```
string query = 3;
Returns:

The query.

getQueryBytes

com.google.protobuf.ByteString getQueryBytes()

 Raw search query.

string query = 3;

Returns:: The bytes for query.

getPageCategoriesList

List<String> getPageCategoriesList()

 Optional. The categories associated with a category page. Must be set for
 category navigation queries to achieve good search quality. The format
 should be the same as
 [PageInfo.page_category][google.cloud.discoveryengine.v1.PageInfo.page_category].
 This field is the equivalent of the query for browse (navigation) queries.
 It's used by the browse model when the query is empty.

 If the field is empty, it will not be used by the browse model.
 If the field contains more than one element, only the first element will
 be used.

 To represent full path of a category, use '>' character to separate
 different hierarchies. If '>' is part of the category name, replace it with
 other character(s).
 For example, `Graphics Cards > RTX>4090 > Founders Edition` where "RTX >
 4090" represents one level, can be rewritten as `Graphics Cards > RTX_4090
 > Founders Edition`

repeated string page_categories = 63 [(.google.api.field_behavior) = OPTIONAL];

Returns:: A list containing the pageCategories.

getPageCategoriesCount

int getPageCategoriesCount()

 Optional. The categories associated with a category page. Must be set for
 category navigation queries to achieve good search quality. The format
 should be the same as
 [PageInfo.page_category][google.cloud.discoveryengine.v1.PageInfo.page_category].
 This field is the equivalent of the query for browse (navigation) queries.
 It's used by the browse model when the query is empty.

 If the field is empty, it will not be used by the browse model.
 If the field contains more than one element, only the first element will
 be used.

 To represent full path of a category, use '>' character to separate
 different hierarchies. If '>' is part of the category name, replace it with
 other character(s).
 For example, `Graphics Cards > RTX>4090 > Founders Edition` where "RTX >
 4090" represents one level, can be rewritten as `Graphics Cards > RTX_4090
 > Founders Edition`

repeated string page_categories = 63 [(.google.api.field_behavior) = OPTIONAL];

Returns:: The count of pageCategories.

getPageCategories

String getPageCategories(int index)

 Optional. The categories associated with a category page. Must be set for
 category navigation queries to achieve good search quality. The format
 should be the same as
 [PageInfo.page_category][google.cloud.discoveryengine.v1.PageInfo.page_category].
 This field is the equivalent of the query for browse (navigation) queries.
 It's used by the browse model when the query is empty.

 If the field is empty, it will not be used by the browse model.
 If the field contains more than one element, only the first element will
 be used.

 To represent full path of a category, use '>' character to separate
 different hierarchies. If '>' is part of the category name, replace it with
 other character(s).
 For example, `Graphics Cards > RTX>4090 > Founders Edition` where "RTX >
 4090" represents one level, can be rewritten as `Graphics Cards > RTX_4090
 > Founders Edition`

repeated string page_categories = 63 [(.google.api.field_behavior) = OPTIONAL];

Parameters:: index - The index of the element to return.
Returns:: The pageCategories at the given index.

getPageCategoriesBytes

com.google.protobuf.ByteString getPageCategoriesBytes(int index)

 Optional. The categories associated with a category page. Must be set for
 category navigation queries to achieve good search quality. The format
 should be the same as
 [PageInfo.page_category][google.cloud.discoveryengine.v1.PageInfo.page_category].
 This field is the equivalent of the query for browse (navigation) queries.
 It's used by the browse model when the query is empty.

 If the field is empty, it will not be used by the browse model.
 If the field contains more than one element, only the first element will
 be used.

 To represent full path of a category, use '>' character to separate
 different hierarchies. If '>' is part of the category name, replace it with
 other character(s).
 For example, `Graphics Cards > RTX>4090 > Founders Edition` where "RTX >
 4090" represents one level, can be rewritten as `Graphics Cards > RTX_4090
 > Founders Edition`

repeated string page_categories = 63 [(.google.api.field_behavior) = OPTIONAL];

Parameters:: index - The index of the value to return.
Returns:: The bytes of the pageCategories at the given index.

hasImageQuery
```
boolean hasImageQuery()
```
```
 Raw image query.
 
```
.google.cloud.discoveryengine.v1.SearchRequest.ImageQuery image_query = 19;
Returns:

Whether the imageQuery field is set.

getImageQuery
```
SearchRequest.ImageQuery getImageQuery()
```
```
 Raw image query.
 
```
.google.cloud.discoveryengine.v1.SearchRequest.ImageQuery image_query = 19;
Returns:

The imageQuery.

getImageQueryOrBuilder
```
SearchRequest.ImageQueryOrBuilder getImageQueryOrBuilder()
```
```
 Raw image query.
 
```
.google.cloud.discoveryengine.v1.SearchRequest.ImageQuery image_query = 19;

getPageSize

int getPageSize()

 Maximum number of [Document][google.cloud.discoveryengine.v1.Document]s 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`, Maximum `25`.
 * Websites with advanced indexing: Default `25`, Maximum `50`.
 * Other: Default `50`, Maximum `100`.

 If this field is negative, an  `INVALID_ARGUMENT` is returned.

int32 page_size = 4;

Returns:: The pageSize.

getPageToken

String getPageToken()

 A page token received from a previous
 [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search]
 call. Provide this to retrieve the subsequent page.

 When paginating, all other parameters provided to
 [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search]
 must match the call that provided the page token. Otherwise, an
 `INVALID_ARGUMENT`  error is returned.

string page_token = 5;

Returns:: The pageToken.

getPageTokenBytes

com.google.protobuf.ByteString getPageTokenBytes()

 A page token received from a previous
 [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search]
 call. Provide this to retrieve the subsequent page.

 When paginating, all other parameters provided to
 [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search]
 must match the call that provided the page token. Otherwise, an
 `INVALID_ARGUMENT`  error is returned.

string page_token = 5;

Returns:: The bytes for pageToken.

getOffset

int getOffset()

 A 0-indexed integer that specifies the current offset (that is, starting
 result location, amongst the
 [Document][google.cloud.discoveryengine.v1.Document]s deemed by the API as
 relevant) in search results. This field is only considered if
 [page_token][google.cloud.discoveryengine.v1.SearchRequest.page_token] is
 unset.

 If this field is negative, an  `INVALID_ARGUMENT`  is returned.

 A large offset may be capped to a reasonable threshold.

int32 offset = 6;

Returns:: The offset.

getOneBoxPageSize

int getOneBoxPageSize()

 The maximum number of results to return for OneBox.
 This applies to each OneBox type individually.
 Default number is 10.

int32 one_box_page_size = 47;

Returns:: The oneBoxPageSize.

getDataStoreSpecsList

List<SearchRequest.DataStoreSpec> getDataStoreSpecsList()

 Specifications that define the specific
 [DataStore][google.cloud.discoveryengine.v1.DataStore]s to be searched,
 along with configurations for those data stores. This is only considered
 for [Engine][google.cloud.discoveryengine.v1.Engine]s with multiple data
 stores. For engines with a single data store, the specs directly under
 [SearchRequest][google.cloud.discoveryengine.v1.SearchRequest] should be
 used.


 repeated .google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec data_store_specs = 32;

getDataStoreSpecs

SearchRequest.DataStoreSpec getDataStoreSpecs(int index)

 Specifications that define the specific
 [DataStore][google.cloud.discoveryengine.v1.DataStore]s to be searched,
 along with configurations for those data stores. This is only considered
 for [Engine][google.cloud.discoveryengine.v1.Engine]s with multiple data
 stores. For engines with a single data store, the specs directly under
 [SearchRequest][google.cloud.discoveryengine.v1.SearchRequest] should be
 used.


 repeated .google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec data_store_specs = 32;

getDataStoreSpecsCount

int getDataStoreSpecsCount()

 Specifications that define the specific
 [DataStore][google.cloud.discoveryengine.v1.DataStore]s to be searched,
 along with configurations for those data stores. This is only considered
 for [Engine][google.cloud.discoveryengine.v1.Engine]s with multiple data
 stores. For engines with a single data store, the specs directly under
 [SearchRequest][google.cloud.discoveryengine.v1.SearchRequest] should be
 used.


 repeated .google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec data_store_specs = 32;

getDataStoreSpecsOrBuilderList

List<? extends SearchRequest.DataStoreSpecOrBuilder> getDataStoreSpecsOrBuilderList()

 Specifications that define the specific
 [DataStore][google.cloud.discoveryengine.v1.DataStore]s to be searched,
 along with configurations for those data stores. This is only considered
 for [Engine][google.cloud.discoveryengine.v1.Engine]s with multiple data
 stores. For engines with a single data store, the specs directly under
 [SearchRequest][google.cloud.discoveryengine.v1.SearchRequest] should be
 used.


 repeated .google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec data_store_specs = 32;

getDataStoreSpecsOrBuilder

SearchRequest.DataStoreSpecOrBuilder getDataStoreSpecsOrBuilder(int index)

 Specifications that define the specific
 [DataStore][google.cloud.discoveryengine.v1.DataStore]s to be searched,
 along with configurations for those data stores. This is only considered
 for [Engine][google.cloud.discoveryengine.v1.Engine]s with multiple data
 stores. For engines with a single data store, the specs directly under
 [SearchRequest][google.cloud.discoveryengine.v1.SearchRequest] should be
 used.


 repeated .google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec data_store_specs = 32;

getFilter

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](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)

string filter = 7;

Returns:: The filter.

getFilterBytes

com.google.protobuf.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](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)

string filter = 7;

Returns:: The bytes for filter.

getCanonicalFilter

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][google.cloud.discoveryengine.v1.SearchRequest.filter].

string canonical_filter = 29;

Returns:: The canonicalFilter.

getCanonicalFilterBytes

com.google.protobuf.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][google.cloud.discoveryengine.v1.SearchRequest.filter].

string canonical_filter = 29;

Returns:: The bytes for canonicalFilter.

getOrderBy

String getOrderBy()

 The order in which documents are returned. Documents can be ordered by
 a field in an [Document][google.cloud.discoveryengine.v1.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](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results).
 For more information on ordering the healthcare search results, see
 [Order healthcare search
 results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results).
 If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.

string order_by = 8;

Returns:: The orderBy.

getOrderByBytes

com.google.protobuf.ByteString getOrderByBytes()

 The order in which documents are returned. Documents can be ordered by
 a field in an [Document][google.cloud.discoveryengine.v1.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](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results).
 For more information on ordering the healthcare search results, see
 [Order healthcare search
 results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results).
 If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.

string order_by = 8;

Returns:: The bytes for orderBy.

hasUserInfo

boolean hasUserInfo()

 Information about the end user.
 Highly recommended for analytics and personalization.
 [UserInfo.user_agent][google.cloud.discoveryengine.v1.UserInfo.user_agent]
 is used to deduce `device_type` for analytics.

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

Returns:: Whether the userInfo field is set.

getUserInfo

UserInfo getUserInfo()

 Information about the end user.
 Highly recommended for analytics and personalization.
 [UserInfo.user_agent][google.cloud.discoveryengine.v1.UserInfo.user_agent]
 is used to deduce `device_type` for analytics.

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

Returns:: The userInfo.

getUserInfoOrBuilder

UserInfoOrBuilder getUserInfoOrBuilder()

 Information about the end user.
 Highly recommended for analytics and personalization.
 [UserInfo.user_agent][google.cloud.discoveryengine.v1.UserInfo.user_agent]
 is used to deduce `device_type` for analytics.

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

getLanguageCode

String getLanguageCode()

 The BCP-47 language code, such as "en-US" or "sr-Latn". For more
 information, see [Standard
 fields](https://cloud.google.com/apis/design/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:: The languageCode.

getLanguageCodeBytes

com.google.protobuf.ByteString getLanguageCodeBytes()

 The BCP-47 language code, such as "en-US" or "sr-Latn". For more
 information, see [Standard
 fields](https://cloud.google.com/apis/design/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:: The bytes for languageCode.