Package com.google.cloud.discoveryengine.v1

Interface SearchRequestOrBuilder

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 Details

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

    • getFacetSpecsList

      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.v1.SearchRequest.FacetSpec facet_specs = 9;

    • getFacetSpecs

      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.v1.SearchRequest.FacetSpec facet_specs = 9;

    • getFacetSpecsCount

      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.v1.SearchRequest.FacetSpec facet_specs = 9;

    • getFacetSpecsOrBuilderList

      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.v1.SearchRequest.FacetSpec facet_specs = 9;

    • getFacetSpecsOrBuilder

      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.v1.SearchRequest.FacetSpec facet_specs = 9;

    • hasBoostSpec

      boolean hasBoostSpec()
       Boost specification to boost certain documents.
 For more information on boosting, see
 [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)
      .google.cloud.discoveryengine.v1.SearchRequest.BoostSpec boost_spec = 10;
      Returns:
      Whether the boostSpec field is set.

    • getBoostSpec

      SearchRequest.BoostSpec getBoostSpec()
       Boost specification to boost certain documents.
 For more information on boosting, see
 [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)
      .google.cloud.discoveryengine.v1.SearchRequest.BoostSpec boost_spec = 10;
      Returns:
      The boostSpec.

    • getBoostSpecOrBuilder

      SearchRequest.BoostSpecOrBuilder getBoostSpecOrBuilder()
       Boost specification to boost certain documents.
 For more information on boosting, see
 [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)
      .google.cloud.discoveryengine.v1.SearchRequest.BoostSpec boost_spec = 10;

    • getParamsCount

      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](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes)

 * `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;

    • containsParams

      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](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes)

 * `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;

    • getParams

      @Deprecated Map<String,com.google.protobuf.Value> getParams()
      Deprecated.
      Use getParamsMap() instead.

    • getParamsMap

      Map<String,com.google.protobuf.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](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes)

 * `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;

    • getParamsOrDefault

      com.google.protobuf.Value getParamsOrDefault(String key, com.google.protobuf.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](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes)

 * `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;

    • getParamsOrThrow

      com.google.protobuf.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](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes)

 * `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;

    • hasQueryExpansionSpec

      boolean hasQueryExpansionSpec()
       The query expansion specification that specifies the conditions under which
 query expansion occurs.
      .google.cloud.discoveryengine.v1.SearchRequest.QueryExpansionSpec query_expansion_spec = 13;
      Returns:
      Whether the queryExpansionSpec field is set.

    • getQueryExpansionSpec

      SearchRequest.QueryExpansionSpec getQueryExpansionSpec()
       The query expansion specification that specifies the conditions under which
 query expansion occurs.
      .google.cloud.discoveryengine.v1.SearchRequest.QueryExpansionSpec query_expansion_spec = 13;
      Returns:
      The queryExpansionSpec.

    • getQueryExpansionSpecOrBuilder

      SearchRequest.QueryExpansionSpecOrBuilder getQueryExpansionSpecOrBuilder()
       The query expansion specification that specifies the conditions under which
 query expansion occurs.
      .google.cloud.discoveryengine.v1.SearchRequest.QueryExpansionSpec query_expansion_spec = 13;

    • hasSpellCorrectionSpec

      boolean hasSpellCorrectionSpec()
       The spell correction specification that specifies the mode under
 which spell correction takes effect.
      .google.cloud.discoveryengine.v1.SearchRequest.SpellCorrectionSpec spell_correction_spec = 14;
      Returns:
      Whether the spellCorrectionSpec field is set.

    • getSpellCorrectionSpec

      SearchRequest.SpellCorrectionSpec getSpellCorrectionSpec()
       The spell correction specification that specifies the mode under
 which spell correction takes effect.
      .google.cloud.discoveryengine.v1.SearchRequest.SpellCorrectionSpec spell_correction_spec = 14;
      Returns:
      The spellCorrectionSpec.

    • getSpellCorrectionSpecOrBuilder

      SearchRequest.SpellCorrectionSpecOrBuilder getSpellCorrectionSpecOrBuilder()
       The spell correction specification that specifies the mode under
 which spell correction takes effect.
      .google.cloud.discoveryengine.v1.SearchRequest.SpellCorrectionSpec spell_correction_spec = 14;

    • getUserPseudoId

      String getUserPseudoId()
       Optional. 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][google.cloud.discoveryengine.v1.UserEvent.user_pseudo_id]
 and
 [CompleteQueryRequest.user_pseudo_id][google.cloud.discoveryengine.v1.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 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The userPseudoId.

    • getUserPseudoIdBytes

      com.google.protobuf.ByteString getUserPseudoIdBytes()
       Optional. 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][google.cloud.discoveryengine.v1.UserEvent.user_pseudo_id]
 and
 [CompleteQueryRequest.user_pseudo_id][google.cloud.discoveryengine.v1.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 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for userPseudoId.

    • hasContentSearchSpec

      boolean hasContentSearchSpec()
       A specification for configuring the behavior of content search.
      .google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec content_search_spec = 24;
      Returns:
      Whether the contentSearchSpec field is set.

    • getContentSearchSpec

      SearchRequest.ContentSearchSpec getContentSearchSpec()
       A specification for configuring the behavior of content search.
      .google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec content_search_spec = 24;
      Returns:
      The contentSearchSpec.

    • getContentSearchSpecOrBuilder

      SearchRequest.ContentSearchSpecOrBuilder getContentSearchSpecOrBuilder()
       A specification for configuring the behavior of content search.
      .google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec content_search_spec = 24;

    • getRankingExpression

      String getRankingExpression()
       Optional. The ranking expression controls the customized ranking on
 retrieval documents. This overrides
 [ServingConfig.ranking_expression][google.cloud.discoveryengine.v1.ServingConfig.ranking_expression].
 The syntax and supported features depend on the
 `ranking_expression_backend` value. If `ranking_expression_backend` is not
 provided, it defaults to `RANK_BY_EMBEDDING`.

 If
 [ranking_expression_backend][google.cloud.discoveryengine.v1.SearchRequest.ranking_expression_backend]
 is not provided or set to `RANK_BY_EMBEDDING`, it should be 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)`.

 If
 [ranking_expression_backend][google.cloud.discoveryengine.v1.SearchRequest.ranking_expression_backend]
 is set to `RANK_BY_FORMULA`, the following expression types (and
 combinations of those chained using + or
 * operators) are supported:

 * `double`
 * `signal`
 * `log(signal)`
 * `exp(signal)`
 * `rr(signal, double > 0)`  -- reciprocal rank transformation with second
 argument being a denominator constant.
 * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise.
 * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns
 signal2 | double, else returns signal1.

 Here are a few examples of ranking formulas that use the supported
 ranking expression types:

 - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)`
 -- mostly rank by the logarithm of `keyword_similarity_score` with slight
 `semantic_smilarity_score` adjustment.
 - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 *
 is_nan(keyword_similarity_score)` -- rank by the exponent of
 `semantic_similarity_score` filling the value with 0 if it's NaN, also
 add constant 0.3 adjustment to the final score if
 `semantic_similarity_score` is NaN.
 - `0.2 * rr(semantic_similarity_score, 16) + 0.8 *
 rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank
 of `keyword_similarity_score` with slight adjustment of reciprocal rank
 of `semantic_smilarity_score`.

 The following signals are supported:

 * `semantic_similarity_score`: semantic similarity adjustment that is
 calculated using the embeddings generated by a proprietary Google model.
 This score determines how semantically similar a search query is to a
 document.
 * `keyword_similarity_score`: keyword match adjustment uses the Best
 Match 25 (BM25) ranking function. This score is calculated using a
 probabilistic model to estimate the probability that a document is
 relevant to a given query.
 * `relevance_score`: semantic relevance adjustment that uses a
 proprietary Google model to determine the meaning and intent behind a
 user's query in context with the content in the documents.
 * `pctr_rank`: predicted conversion rate adjustment as a rank use
 predicted Click-through rate (pCTR) to gauge the relevance and
 attractiveness of a search result from a user's perspective. A higher
 pCTR suggests that the result is more likely to satisfy the user's query
 and intent, making it a valuable signal for ranking.
 * `freshness_rank`: freshness adjustment as a rank
 * `document_age`: The time in hours elapsed since the document was last
 updated, a floating-point number (e.g., 0.25 means 15 minutes).
 * `topicality_rank`: topicality adjustment as a rank. Uses proprietary
 Google model to determine the keyword-based overlap between the query and
 the document.
 * `base_rank`: the default rank of the result
      string ranking_expression = 26 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The rankingExpression.

    • getRankingExpressionBytes

      com.google.protobuf.ByteString getRankingExpressionBytes()
       Optional. The ranking expression controls the customized ranking on
 retrieval documents. This overrides
 [ServingConfig.ranking_expression][google.cloud.discoveryengine.v1.ServingConfig.ranking_expression].
 The syntax and supported features depend on the
 `ranking_expression_backend` value. If `ranking_expression_backend` is not
 provided, it defaults to `RANK_BY_EMBEDDING`.

 If
 [ranking_expression_backend][google.cloud.discoveryengine.v1.SearchRequest.ranking_expression_backend]
 is not provided or set to `RANK_BY_EMBEDDING`, it should be 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)`.

 If
 [ranking_expression_backend][google.cloud.discoveryengine.v1.SearchRequest.ranking_expression_backend]
 is set to `RANK_BY_FORMULA`, the following expression types (and
 combinations of those chained using + or
 * operators) are supported:

 * `double`
 * `signal`
 * `log(signal)`
 * `exp(signal)`
 * `rr(signal, double > 0)`  -- reciprocal rank transformation with second
 argument being a denominator constant.
 * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise.
 * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns
 signal2 | double, else returns signal1.

 Here are a few examples of ranking formulas that use the supported
 ranking expression types:

 - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)`
 -- mostly rank by the logarithm of `keyword_similarity_score` with slight
 `semantic_smilarity_score` adjustment.
 - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 *
 is_nan(keyword_similarity_score)` -- rank by the exponent of
 `semantic_similarity_score` filling the value with 0 if it's NaN, also
 add constant 0.3 adjustment to the final score if
 `semantic_similarity_score` is NaN.
 - `0.2 * rr(semantic_similarity_score, 16) + 0.8 *
 rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank
 of `keyword_similarity_score` with slight adjustment of reciprocal rank
 of `semantic_smilarity_score`.

 The following signals are supported:

 * `semantic_similarity_score`: semantic similarity adjustment that is
 calculated using the embeddings generated by a proprietary Google model.
 This score determines how semantically similar a search query is to a
 document.
 * `keyword_similarity_score`: keyword match adjustment uses the Best
 Match 25 (BM25) ranking function. This score is calculated using a
 probabilistic model to estimate the probability that a document is
 relevant to a given query.
 * `relevance_score`: semantic relevance adjustment that uses a
 proprietary Google model to determine the meaning and intent behind a
 user's query in context with the content in the documents.
 * `pctr_rank`: predicted conversion rate adjustment as a rank use
 predicted Click-through rate (pCTR) to gauge the relevance and
 attractiveness of a search result from a user's perspective. A higher
 pCTR suggests that the result is more likely to satisfy the user's query
 and intent, making it a valuable signal for ranking.
 * `freshness_rank`: freshness adjustment as a rank
 * `document_age`: The time in hours elapsed since the document was last
 updated, a floating-point number (e.g., 0.25 means 15 minutes).
 * `topicality_rank`: topicality adjustment as a rank. Uses proprietary
 Google model to determine the keyword-based overlap between the query and
 the document.
 * `base_rank`: the default rank of the result
      string ranking_expression = 26 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for rankingExpression.

    • getRankingExpressionBackendValue

      int getRankingExpressionBackendValue()
       Optional. The backend to use for the ranking expression evaluation.
      .google.cloud.discoveryengine.v1.SearchRequest.RankingExpressionBackend ranking_expression_backend = 53 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The enum numeric value on the wire for rankingExpressionBackend.

    • getRankingExpressionBackend

      SearchRequest.RankingExpressionBackend getRankingExpressionBackend()
       Optional. The backend to use for the ranking expression evaluation.
      .google.cloud.discoveryengine.v1.SearchRequest.RankingExpressionBackend ranking_expression_backend = 53 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The rankingExpressionBackend.

    • getSafeSearch

      boolean getSafeSearch()
       Whether to turn on safe search. This is only supported for
 website search.
      bool safe_search = 20;
      Returns:
      The safeSearch.

    • getUserLabelsCount

      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](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 for more details.
      map<string, string> user_labels = 22;

    • containsUserLabels

      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](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 for more details.
      map<string, string> user_labels = 22;

    • getUserLabels

      @Deprecated Map<String,String> getUserLabels()
      Deprecated.
      Use getUserLabelsMap() instead.

    • getUserLabelsMap

      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](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 for more details.
      map<string, string> user_labels = 22;

    • getUserLabelsOrDefault

      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](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 for more details.
      map<string, string> user_labels = 22;

    • getUserLabelsOrThrow

      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](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 for more details.
      map<string, string> user_labels = 22;

    • hasNaturalLanguageQueryUnderstandingSpec

      boolean hasNaturalLanguageQueryUnderstandingSpec()
       Optional. Config for natural language query understanding capabilities,
 such as extracting structured field filters from the query. Refer to [this
 documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries)
 for more information.
 If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional
 natural language query understanding will be done.
      .google.cloud.discoveryengine.v1.SearchRequest.NaturalLanguageQueryUnderstandingSpec natural_language_query_understanding_spec = 28 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the naturalLanguageQueryUnderstandingSpec field is set.

    • getNaturalLanguageQueryUnderstandingSpec

      SearchRequest.NaturalLanguageQueryUnderstandingSpec getNaturalLanguageQueryUnderstandingSpec()
       Optional. Config for natural language query understanding capabilities,
 such as extracting structured field filters from the query. Refer to [this
 documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries)
 for more information.
 If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional
 natural language query understanding will be done.
      .google.cloud.discoveryengine.v1.SearchRequest.NaturalLanguageQueryUnderstandingSpec natural_language_query_understanding_spec = 28 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The naturalLanguageQueryUnderstandingSpec.

    • getNaturalLanguageQueryUnderstandingSpecOrBuilder

      SearchRequest.NaturalLanguageQueryUnderstandingSpecOrBuilder getNaturalLanguageQueryUnderstandingSpecOrBuilder()
       Optional. Config for natural language query understanding capabilities,
 such as extracting structured field filters from the query. Refer to [this
 documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries)
 for more information.
 If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional
 natural language query understanding will be done.
      .google.cloud.discoveryengine.v1.SearchRequest.NaturalLanguageQueryUnderstandingSpec natural_language_query_understanding_spec = 28 [(.google.api.field_behavior) = OPTIONAL];

    • hasSearchAsYouTypeSpec

      boolean hasSearchAsYouTypeSpec()
       Search as you type configuration. Only supported for the
 [IndustryVertical.MEDIA][google.cloud.discoveryengine.v1.IndustryVertical.MEDIA]
 vertical.
      .google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec search_as_you_type_spec = 31;
      Returns:
      Whether the searchAsYouTypeSpec field is set.

    • getSearchAsYouTypeSpec

      SearchRequest.SearchAsYouTypeSpec getSearchAsYouTypeSpec()
       Search as you type configuration. Only supported for the
 [IndustryVertical.MEDIA][google.cloud.discoveryengine.v1.IndustryVertical.MEDIA]
 vertical.
      .google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec search_as_you_type_spec = 31;
      Returns:
      The searchAsYouTypeSpec.

    • getSearchAsYouTypeSpecOrBuilder

      SearchRequest.SearchAsYouTypeSpecOrBuilder getSearchAsYouTypeSpecOrBuilder()
       Search as you type configuration. Only supported for the
 [IndustryVertical.MEDIA][google.cloud.discoveryengine.v1.IndustryVertical.MEDIA]
 vertical.
      .google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec search_as_you_type_spec = 31;

    • hasDisplaySpec

      boolean hasDisplaySpec()
       Optional. Config for display feature, like match highlighting on search
 results.
      .google.cloud.discoveryengine.v1.SearchRequest.DisplaySpec display_spec = 38 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the displaySpec field is set.

    • getDisplaySpec

      SearchRequest.DisplaySpec getDisplaySpec()
       Optional. Config for display feature, like match highlighting on search
 results.
      .google.cloud.discoveryengine.v1.SearchRequest.DisplaySpec display_spec = 38 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The displaySpec.

    • getDisplaySpecOrBuilder

      SearchRequest.DisplaySpecOrBuilder getDisplaySpecOrBuilder()
       Optional. Config for display feature, like match highlighting on search
 results.
      .google.cloud.discoveryengine.v1.SearchRequest.DisplaySpec display_spec = 38 [(.google.api.field_behavior) = OPTIONAL];

    • getCrowdingSpecsList

      List<SearchRequest.CrowdingSpec> getCrowdingSpecsList()
       Optional. Crowding specifications for improving result diversity.
 If multiple CrowdingSpecs are specified, crowding will be evaluated on
 each unique combination of the `field` values, and max_count will be the
 maximum value of `max_count` across all CrowdingSpecs.
 For example, if the first CrowdingSpec has `field` = "color" and
 `max_count` = 3, and the second CrowdingSpec has `field` = "size" and
 `max_count` = 2, then after 3 documents that share the same color AND size
 have been returned, subsequent ones should be
 removed or demoted.
      repeated .google.cloud.discoveryengine.v1.SearchRequest.CrowdingSpec crowding_specs = 40 [(.google.api.field_behavior) = OPTIONAL];

    • getCrowdingSpecs

      SearchRequest.CrowdingSpec getCrowdingSpecs(int index)
       Optional. Crowding specifications for improving result diversity.
 If multiple CrowdingSpecs are specified, crowding will be evaluated on
 each unique combination of the `field` values, and max_count will be the
 maximum value of `max_count` across all CrowdingSpecs.
 For example, if the first CrowdingSpec has `field` = "color" and
 `max_count` = 3, and the second CrowdingSpec has `field` = "size" and
 `max_count` = 2, then after 3 documents that share the same color AND size
 have been returned, subsequent ones should be
 removed or demoted.
      repeated .google.cloud.discoveryengine.v1.SearchRequest.CrowdingSpec crowding_specs = 40 [(.google.api.field_behavior) = OPTIONAL];

    • getCrowdingSpecsCount

      int getCrowdingSpecsCount()
       Optional. Crowding specifications for improving result diversity.
 If multiple CrowdingSpecs are specified, crowding will be evaluated on
 each unique combination of the `field` values, and max_count will be the
 maximum value of `max_count` across all CrowdingSpecs.
 For example, if the first CrowdingSpec has `field` = "color" and
 `max_count` = 3, and the second CrowdingSpec has `field` = "size" and
 `max_count` = 2, then after 3 documents that share the same color AND size
 have been returned, subsequent ones should be
 removed or demoted.
      repeated .google.cloud.discoveryengine.v1.SearchRequest.CrowdingSpec crowding_specs = 40 [(.google.api.field_behavior) = OPTIONAL];

    • getCrowdingSpecsOrBuilderList

      List<? extends SearchRequest.CrowdingSpecOrBuilder> getCrowdingSpecsOrBuilderList()
       Optional. Crowding specifications for improving result diversity.
 If multiple CrowdingSpecs are specified, crowding will be evaluated on
 each unique combination of the `field` values, and max_count will be the
 maximum value of `max_count` across all CrowdingSpecs.
 For example, if the first CrowdingSpec has `field` = "color" and
 `max_count` = 3, and the second CrowdingSpec has `field` = "size" and
 `max_count` = 2, then after 3 documents that share the same color AND size
 have been returned, subsequent ones should be
 removed or demoted.
      repeated .google.cloud.discoveryengine.v1.SearchRequest.CrowdingSpec crowding_specs = 40 [(.google.api.field_behavior) = OPTIONAL];

    • getCrowdingSpecsOrBuilder

      SearchRequest.CrowdingSpecOrBuilder getCrowdingSpecsOrBuilder(int index)
       Optional. Crowding specifications for improving result diversity.
 If multiple CrowdingSpecs are specified, crowding will be evaluated on
 each unique combination of the `field` values, and max_count will be the
 maximum value of `max_count` across all CrowdingSpecs.
 For example, if the first CrowdingSpec has `field` = "color" and
 `max_count` = 3, and the second CrowdingSpec has `field` = "size" and
 `max_count` = 2, then after 3 documents that share the same color AND size
 have been returned, subsequent ones should be
 removed or demoted.
      repeated .google.cloud.discoveryengine.v1.SearchRequest.CrowdingSpec crowding_specs = 40 [(.google.api.field_behavior) = OPTIONAL];

    • getSession

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

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

    • getSessionBytes

      com.google.protobuf.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 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 /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.

 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:
      The bytes for session.

    • hasSessionSpec

      boolean hasSessionSpec()
       Session specification.

 Can be used only when `session` is set.
      .google.cloud.discoveryengine.v1.SearchRequest.SessionSpec session_spec = 42;
      Returns:
      Whether the sessionSpec field is set.

    • getSessionSpec

      SearchRequest.SessionSpec getSessionSpec()
       Session specification.

 Can be used only when `session` is set.
      .google.cloud.discoveryengine.v1.SearchRequest.SessionSpec session_spec = 42;
      Returns:
      The sessionSpec.

    • getSessionSpecOrBuilder

      SearchRequest.SessionSpecOrBuilder getSessionSpecOrBuilder()
       Session specification.

 Can be used only when `session` is set.
      .google.cloud.discoveryengine.v1.SearchRequest.SessionSpec session_spec = 42;

    • getRelevanceThresholdValue

      int getRelevanceThresholdValue()
       The global relevance threshold of the search results.

 Defaults to Google defined threshold, leveraging a balance of
 precision and recall to deliver both highly accurate results and
 comprehensive coverage of relevant information.

 If more granular relevance filtering is required, use the
 `relevance_filter_spec` instead.

 This feature is not supported for healthcare search.
      .google.cloud.discoveryengine.v1.SearchRequest.RelevanceThreshold relevance_threshold = 44;
      Returns:
      The enum numeric value on the wire for relevanceThreshold.

    • getRelevanceThreshold

      SearchRequest.RelevanceThreshold getRelevanceThreshold()
       The global relevance threshold of the search results.

 Defaults to Google defined threshold, leveraging a balance of
 precision and recall to deliver both highly accurate results and
 comprehensive coverage of relevant information.

 If more granular relevance filtering is required, use the
 `relevance_filter_spec` instead.

 This feature is not supported for healthcare search.
      .google.cloud.discoveryengine.v1.SearchRequest.RelevanceThreshold relevance_threshold = 44;
      Returns:
      The relevanceThreshold.

    • hasRelevanceScoreSpec

      boolean hasRelevanceScoreSpec()
       Optional. The specification for returning the relevance score.
      .google.cloud.discoveryengine.v1.SearchRequest.RelevanceScoreSpec relevance_score_spec = 52 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the relevanceScoreSpec field is set.

    • getRelevanceScoreSpec

      SearchRequest.RelevanceScoreSpec getRelevanceScoreSpec()
       Optional. The specification for returning the relevance score.
      .google.cloud.discoveryengine.v1.SearchRequest.RelevanceScoreSpec relevance_score_spec = 52 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The relevanceScoreSpec.

    • getRelevanceScoreSpecOrBuilder

      SearchRequest.RelevanceScoreSpecOrBuilder getRelevanceScoreSpecOrBuilder()
       Optional. The specification for returning the relevance score.
      .google.cloud.discoveryengine.v1.SearchRequest.RelevanceScoreSpec relevance_score_spec = 52 [(.google.api.field_behavior) = OPTIONAL];